1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
16 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ========================================================================= */
37 /* some generic helper functions */
38 /* ========================================================================= */
40 /* ------------------------------------------------------------------------- */
41 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
46 char *newline = STRING_NEWLINE;
48 vfprintf(stream, format, ap);
50 fprintf(stream, "%s", newline);
53 static void fprintf_newline(FILE *stream, char *format, ...)
60 vfprintf_newline(stream, format, ap);
65 void fprintf_line(FILE *stream, char *line_chars, int line_length)
69 for (i = 0; i < line_length; i++)
70 fprintf(stream, "%s", line_chars);
72 fprintf_newline(stream, "");
75 void printf_line(char *line_chars, int line_length)
77 fprintf_line(stdout, line_chars, line_length);
80 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
82 fprintf(stdout, "%s", prefix);
83 fprintf_line(stdout, line_chars, line_length);
87 /* ------------------------------------------------------------------------- */
88 /* string functions */
89 /* ------------------------------------------------------------------------- */
91 /* int2str() returns a number converted to a string;
92 the used memory is static, but will be overwritten by later calls,
93 so if you want to save the result, copy it to a private string buffer;
94 there can be 10 local calls of int2str() without buffering the result --
95 the 11th call will then destroy the result from the first call and so on.
98 char *int2str(int number, int size)
100 static char shift_array[10][40];
101 static int shift_counter = 0;
102 char *s = shift_array[shift_counter];
104 shift_counter = (shift_counter + 1) % 10;
111 sprintf(s, " %09d", number);
112 return &s[strlen(s) - size];
116 sprintf(s, "%d", number);
122 /* something similar to "int2str()" above, but allocates its own memory
123 and has a different interface; we cannot use "itoa()", because this
124 seems to be already defined when cross-compiling to the win32 target */
126 char *i_to_a(unsigned int i)
128 static char *a = NULL;
132 if (i > 2147483647) /* yes, this is a kludge */
135 a = checked_malloc(10 + 1);
143 /* calculate base-2 logarithm of argument (rounded down to integer;
144 this function returns the number of the highest bit set in argument) */
146 int log_2(unsigned int x)
152 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
159 boolean getTokenValueFromString(char *string, char **token, char **value)
161 return getTokenValueFromSetupLine(string, token, value);
165 /* ------------------------------------------------------------------------- */
166 /* counter functions */
167 /* ------------------------------------------------------------------------- */
169 #if defined(PLATFORM_MSDOS)
170 volatile unsigned long counter = 0;
172 void increment_counter()
177 END_OF_FUNCTION(increment_counter);
181 /* maximal allowed length of a command line option */
182 #define MAX_OPTION_LEN 256
185 static unsigned long mainCounter(int mode)
187 static unsigned long base_ms = 0;
188 unsigned long current_ms;
189 unsigned long counter_ms;
191 current_ms = SDL_GetTicks();
193 /* reset base time in case of counter initializing or wrap-around */
194 if (mode == INIT_COUNTER || current_ms < base_ms)
195 base_ms = current_ms;
197 counter_ms = current_ms - base_ms;
199 return counter_ms; /* return milliseconds since last init */
202 #else /* !TARGET_SDL */
204 #if defined(PLATFORM_UNIX)
205 static unsigned long mainCounter(int mode)
207 static struct timeval base_time = { 0, 0 };
208 struct timeval current_time;
209 unsigned long counter_ms;
211 gettimeofday(¤t_time, NULL);
213 /* reset base time in case of counter initializing or wrap-around */
214 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
215 base_time = current_time;
217 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
218 + (current_time.tv_usec - base_time.tv_usec) / 1000;
220 return counter_ms; /* return milliseconds since last init */
222 #endif /* PLATFORM_UNIX */
223 #endif /* !TARGET_SDL */
225 void InitCounter() /* set counter back to zero */
227 #if !defined(PLATFORM_MSDOS)
228 mainCounter(INIT_COUNTER);
230 LOCK_VARIABLE(counter);
231 LOCK_FUNCTION(increment_counter);
232 install_int_ex(increment_counter, BPS_TO_TIMER(100));
236 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
238 #if !defined(PLATFORM_MSDOS)
239 return mainCounter(READ_COUNTER);
241 return (counter * 10);
245 static void sleep_milliseconds(unsigned long milliseconds_delay)
247 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
251 /* we want to wait only a few ms -- if we assume that we have a
252 kernel timer resolution of 10 ms, we would wait far to long;
253 therefore it's better to do a short interval of busy waiting
254 to get our sleeping time more accurate */
256 unsigned long base_counter = Counter(), actual_counter = Counter();
258 while (actual_counter < base_counter + milliseconds_delay &&
259 actual_counter >= base_counter)
260 actual_counter = Counter();
264 #if defined(TARGET_SDL)
265 SDL_Delay(milliseconds_delay);
266 #elif defined(TARGET_ALLEGRO)
267 rest(milliseconds_delay);
269 struct timeval delay;
271 delay.tv_sec = milliseconds_delay / 1000;
272 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
274 if (select(0, NULL, NULL, NULL, &delay) != 0)
275 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
280 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
282 sleep_milliseconds(delay);
285 boolean FrameReached(unsigned long *frame_counter_var,
286 unsigned long frame_delay)
288 unsigned long actual_frame_counter = FrameCounter;
290 if (actual_frame_counter >= *frame_counter_var &&
291 actual_frame_counter < *frame_counter_var + frame_delay)
294 *frame_counter_var = actual_frame_counter;
299 boolean DelayReached(unsigned long *counter_var,
302 unsigned long actual_counter = Counter();
304 if (actual_counter >= *counter_var &&
305 actual_counter < *counter_var + delay)
308 *counter_var = actual_counter;
313 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
315 unsigned long actual_counter;
319 actual_counter = Counter();
321 if (actual_counter >= *counter_var &&
322 actual_counter < *counter_var + delay)
323 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
328 *counter_var = actual_counter;
332 /* ------------------------------------------------------------------------- */
333 /* random generator functions */
334 /* ------------------------------------------------------------------------- */
336 unsigned int init_random_number(int nr, long seed)
338 if (seed == NEW_RANDOMIZE)
340 #if defined(TARGET_SDL)
341 seed = (long)SDL_GetTicks();
343 struct timeval current_time;
345 gettimeofday(¤t_time, NULL);
346 seed = (long)current_time.tv_usec;
350 srandom_linux_libc(nr, (unsigned int) seed);
352 return (unsigned int) seed;
355 unsigned int get_random_number(int nr, int max)
357 return (max > 0 ? random_linux_libc(nr) % max : 0);
361 /* ------------------------------------------------------------------------- */
362 /* system info functions */
363 /* ------------------------------------------------------------------------- */
365 #if !defined(PLATFORM_MSDOS)
366 static char *get_corrected_real_name(char *real_name)
368 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
369 char *from_ptr = real_name;
370 char *to_ptr = real_name_new;
372 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
373 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
375 /* the name field read from "passwd" file may also contain additional
376 user information, separated by commas, which will be removed here */
377 if (*from_ptr == ',')
380 /* the user's real name may contain 'ß' characters (german sharp s),
381 which have no equivalent in upper case letters (used by our fonts) */
382 if (*from_ptr == 'ß')
389 *to_ptr++ = *from_ptr++;
394 return real_name_new;
400 static char *login_name = NULL;
402 #if defined(PLATFORM_WIN32)
403 if (login_name == NULL)
405 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
406 login_name = checked_malloc(buffer_size);
408 if (GetUserName(login_name, &buffer_size) == 0)
409 strcpy(login_name, ANONYMOUS_NAME);
412 if (login_name == NULL)
416 if ((pwd = getpwuid(getuid())) == NULL)
417 login_name = ANONYMOUS_NAME;
419 login_name = getStringCopy(pwd->pw_name);
428 static char *real_name = NULL;
430 #if defined(PLATFORM_WIN32)
431 if (real_name == NULL)
433 static char buffer[MAX_USERNAME_LEN + 1];
434 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
436 if (GetUserName(buffer, &buffer_size) != 0)
437 real_name = get_corrected_real_name(buffer);
439 real_name = ANONYMOUS_NAME;
441 #elif defined(PLATFORM_UNIX)
442 if (real_name == NULL)
446 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
447 real_name = get_corrected_real_name(pwd->pw_gecos);
449 real_name = ANONYMOUS_NAME;
452 real_name = ANONYMOUS_NAME;
459 /* ------------------------------------------------------------------------- */
460 /* path manipulation functions */
461 /* ------------------------------------------------------------------------- */
463 static char *getLastPathSeparatorPtr(char *filename)
465 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
467 if (last_separator == NULL) /* also try DOS/Windows variant */
468 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
470 return last_separator;
473 char *getBaseNamePtr(char *filename)
475 char *last_separator = getLastPathSeparatorPtr(filename);
477 if (last_separator != NULL)
478 return last_separator + 1; /* separator found: strip base path */
480 return filename; /* no separator found: filename has no path */
483 char *getBaseName(char *filename)
485 return getStringCopy(getBaseNamePtr(filename));
488 char *getBasePath(char *filename)
490 char *basepath = getStringCopy(filename);
491 char *last_separator = getLastPathSeparatorPtr(basepath);
493 if (last_separator != NULL)
494 *last_separator = '\0'; /* separator found: strip basename */
496 basepath = "."; /* no separator found: use current path */
502 /* ------------------------------------------------------------------------- */
503 /* various string functions */
504 /* ------------------------------------------------------------------------- */
506 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
508 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
511 sprintf(complete_string, "%s%s%s", s1, sep, s2);
513 return complete_string;
516 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
518 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
519 strlen(s2) + strlen(sep) +
522 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
524 return complete_string;
527 char *getStringCat2(char *s1, char *s2)
529 return getStringCat2WithSeparator(s1, s2, "");
532 char *getStringCat3(char *s1, char *s2, char *s3)
534 return getStringCat3WithSeparator(s1, s2, s3, "");
537 char *getPath2(char *path1, char *path2)
539 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
542 char *getPath3(char *path1, char *path2, char *path3)
544 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
547 char *getStringCopy(char *s)
554 s_copy = checked_malloc(strlen(s) + 1);
560 char *getStringToLower(char *s)
562 char *s_copy = checked_malloc(strlen(s) + 1);
563 char *s_ptr = s_copy;
566 *s_ptr++ = tolower(*s++);
572 void setString(char **old_value, char *new_value)
574 checked_free(*old_value);
576 *old_value = getStringCopy(new_value);
579 boolean strEqual(char *s1, char *s2)
581 return (s1 == NULL && s2 == NULL ? TRUE :
582 s1 == NULL && s2 != NULL ? FALSE :
583 s1 != NULL && s2 == NULL ? FALSE :
584 strcmp(s1, s2) == 0);
588 /* ------------------------------------------------------------------------- */
589 /* command line option handling functions */
590 /* ------------------------------------------------------------------------- */
592 void GetOptions(char *argv[], void (*print_usage_function)(void))
594 char *ro_base_path = RO_BASE_PATH;
595 char *rw_base_path = RW_BASE_PATH;
596 char **options_left = &argv[1];
598 #if !defined(PLATFORM_MACOSX)
599 /* if the program is configured to start from current directory (default),
600 determine program package directory (KDE/Konqueror does not do this by
601 itself and fails otherwise); on Mac OS X, the program binary is stored
602 in an application package directory -- do not try to use this directory
603 as the program data directory (Mac OS X handles this correctly anyway) */
605 if (strEqual(ro_base_path, "."))
606 ro_base_path = program.command_basepath;
607 if (strEqual(rw_base_path, "."))
608 rw_base_path = program.command_basepath;
611 /* initialize global program options */
612 options.display_name = NULL;
613 options.server_host = NULL;
614 options.server_port = 0;
615 options.ro_base_directory = ro_base_path;
616 options.rw_base_directory = rw_base_path;
617 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
618 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
619 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
620 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
621 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
622 options.execute_command = NULL;
623 options.serveronly = FALSE;
624 options.network = FALSE;
625 options.verbose = FALSE;
626 options.debug = FALSE;
628 #if !defined(PLATFORM_UNIX)
629 if (*options_left == NULL) /* no options given -- enable verbose mode */
630 options.verbose = TRUE;
633 while (*options_left)
635 char option_str[MAX_OPTION_LEN];
636 char *option = options_left[0];
637 char *next_option = options_left[1];
638 char *option_arg = NULL;
639 int option_len = strlen(option);
641 if (option_len >= MAX_OPTION_LEN)
642 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
644 strcpy(option_str, option); /* copy argument into buffer */
647 if (strEqual(option, "--")) /* stop scanning arguments */
650 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
653 option_arg = strchr(option, '=');
654 if (option_arg == NULL) /* no '=' in option */
655 option_arg = next_option;
658 *option_arg++ = '\0'; /* cut argument from option */
659 if (*option_arg == '\0') /* no argument after '=' */
660 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
663 option_len = strlen(option);
665 if (strEqual(option, "-"))
666 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
667 else if (strncmp(option, "-help", option_len) == 0)
669 print_usage_function();
673 else if (strncmp(option, "-display", option_len) == 0)
675 if (option_arg == NULL)
676 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
678 options.display_name = option_arg;
679 if (option_arg == next_option)
682 else if (strncmp(option, "-basepath", option_len) == 0)
684 if (option_arg == NULL)
685 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
687 /* this should be extended to separate options for ro and rw data */
688 options.ro_base_directory = ro_base_path = option_arg;
689 options.rw_base_directory = rw_base_path = option_arg;
690 if (option_arg == next_option)
693 /* adjust paths for sub-directories in base directory accordingly */
694 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
695 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
696 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
697 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
698 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
700 else if (strncmp(option, "-levels", option_len) == 0)
702 if (option_arg == NULL)
703 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
705 options.level_directory = option_arg;
706 if (option_arg == next_option)
709 else if (strncmp(option, "-graphics", option_len) == 0)
711 if (option_arg == NULL)
712 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
714 options.graphics_directory = option_arg;
715 if (option_arg == next_option)
718 else if (strncmp(option, "-sounds", option_len) == 0)
720 if (option_arg == NULL)
721 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
723 options.sounds_directory = option_arg;
724 if (option_arg == next_option)
727 else if (strncmp(option, "-music", option_len) == 0)
729 if (option_arg == NULL)
730 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
732 options.music_directory = option_arg;
733 if (option_arg == next_option)
736 else if (strncmp(option, "-network", option_len) == 0)
738 options.network = TRUE;
740 else if (strncmp(option, "-serveronly", option_len) == 0)
742 options.serveronly = TRUE;
744 else if (strncmp(option, "-verbose", option_len) == 0)
746 options.verbose = TRUE;
748 else if (strncmp(option, "-debug", option_len) == 0)
750 options.debug = TRUE;
752 else if (strncmp(option, "-execute", option_len) == 0)
754 if (option_arg == NULL)
755 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
757 options.execute_command = option_arg;
758 if (option_arg == next_option)
761 /* when doing batch processing, always enable verbose mode (warnings) */
762 options.verbose = TRUE;
764 else if (*option == '-')
766 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
768 else if (options.server_host == NULL)
770 options.server_host = *options_left;
772 else if (options.server_port == 0)
774 options.server_port = atoi(*options_left);
775 if (options.server_port < 1024)
776 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
779 Error(ERR_EXIT_HELP, "too many arguments");
786 /* ------------------------------------------------------------------------- */
787 /* error handling functions */
788 /* ------------------------------------------------------------------------- */
790 /* used by SetError() and GetError() to store internal error messages */
791 static char internal_error[1024]; /* this is bad */
793 void SetError(char *format, ...)
797 va_start(ap, format);
798 vsprintf(internal_error, format, ap);
804 return internal_error;
807 void Error(int mode, char *format, ...)
809 static boolean last_line_was_separator = FALSE;
810 char *process_name = "";
812 /* display warnings only when running in verbose mode */
813 if (mode & ERR_WARN && !options.verbose)
816 if (mode == ERR_INFO_LINE)
818 if (!last_line_was_separator)
819 fprintf_line(program.error_file, format, 79);
821 last_line_was_separator = TRUE;
826 last_line_was_separator = FALSE;
828 if (mode & ERR_SOUND_SERVER)
829 process_name = " sound server";
830 else if (mode & ERR_NETWORK_SERVER)
831 process_name = " network server";
832 else if (mode & ERR_NETWORK_CLIENT)
833 process_name = " network client **";
839 fprintf(program.error_file, "%s%s: ", program.command_basename,
843 fprintf(program.error_file, "warning: ");
845 va_start(ap, format);
846 vfprintf_newline(program.error_file, format, ap);
851 fprintf_newline(program.error_file,
852 "%s: Try option '--help' for more information.",
853 program.command_basename);
856 fprintf_newline(program.error_file, "%s%s: aborting",
857 program.command_basename, process_name);
861 if (mode & ERR_FROM_SERVER)
862 exit(1); /* child process: normal exit */
864 program.exit_function(1); /* main process: clean up stuff */
869 /* ------------------------------------------------------------------------- */
870 /* checked memory allocation and freeing functions */
871 /* ------------------------------------------------------------------------- */
873 void *checked_malloc(unsigned long size)
880 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
885 void *checked_calloc(unsigned long size)
889 ptr = calloc(1, size);
892 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
897 void *checked_realloc(void *ptr, unsigned long size)
899 ptr = realloc(ptr, size);
902 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
907 void checked_free(void *ptr)
909 if (ptr != NULL) /* this check should be done by free() anyway */
914 /* ------------------------------------------------------------------------- */
915 /* various helper functions */
916 /* ------------------------------------------------------------------------- */
918 inline void swap_numbers(int *i1, int *i2)
926 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
938 /* the "put" variants of the following file access functions check for the file
939 pointer being != NULL and return the number of bytes they have or would have
940 written; this allows for chunk writing functions to first determine the size
941 of the (not yet written) chunk, write the correct chunk size and finally
942 write the chunk itself */
944 int getFile8BitInteger(FILE *file)
949 int putFile8BitInteger(FILE *file, int value)
957 int getFile16BitInteger(FILE *file, int byte_order)
959 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
960 return ((fgetc(file) << 8) |
962 else /* BYTE_ORDER_LITTLE_ENDIAN */
963 return ((fgetc(file) << 0) |
967 int putFile16BitInteger(FILE *file, int value, int byte_order)
971 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
973 fputc((value >> 8) & 0xff, file);
974 fputc((value >> 0) & 0xff, file);
976 else /* BYTE_ORDER_LITTLE_ENDIAN */
978 fputc((value >> 0) & 0xff, file);
979 fputc((value >> 8) & 0xff, file);
986 int getFile32BitInteger(FILE *file, int byte_order)
988 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
989 return ((fgetc(file) << 24) |
990 (fgetc(file) << 16) |
993 else /* BYTE_ORDER_LITTLE_ENDIAN */
994 return ((fgetc(file) << 0) |
996 (fgetc(file) << 16) |
997 (fgetc(file) << 24));
1000 int putFile32BitInteger(FILE *file, int value, int byte_order)
1004 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1006 fputc((value >> 24) & 0xff, file);
1007 fputc((value >> 16) & 0xff, file);
1008 fputc((value >> 8) & 0xff, file);
1009 fputc((value >> 0) & 0xff, file);
1011 else /* BYTE_ORDER_LITTLE_ENDIAN */
1013 fputc((value >> 0) & 0xff, file);
1014 fputc((value >> 8) & 0xff, file);
1015 fputc((value >> 16) & 0xff, file);
1016 fputc((value >> 24) & 0xff, file);
1023 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1026 const int chunk_name_length = 4;
1028 /* read chunk name */
1029 fgets(chunk_name, chunk_name_length + 1, file);
1031 if (chunk_size != NULL)
1033 /* read chunk size */
1034 *chunk_size = getFile32BitInteger(file, byte_order);
1037 return (feof(file) || ferror(file) ? FALSE : TRUE);
1040 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1045 /* write chunk name */
1047 fputs(chunk_name, file);
1049 num_bytes += strlen(chunk_name);
1051 if (chunk_size >= 0)
1053 /* write chunk size */
1055 putFile32BitInteger(file, chunk_size, byte_order);
1063 int getFileVersion(FILE *file)
1065 int version_major = fgetc(file);
1066 int version_minor = fgetc(file);
1067 int version_patch = fgetc(file);
1068 int version_build = fgetc(file);
1070 return VERSION_IDENT(version_major, version_minor, version_patch,
1074 int putFileVersion(FILE *file, int version)
1078 int version_major = VERSION_MAJOR(version);
1079 int version_minor = VERSION_MINOR(version);
1080 int version_patch = VERSION_PATCH(version);
1081 int version_build = VERSION_BUILD(version);
1083 fputc(version_major, file);
1084 fputc(version_minor, file);
1085 fputc(version_patch, file);
1086 fputc(version_build, file);
1092 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1096 for(i = 0; i < bytes && !feof(file); i++)
1097 buffer[i] = fgetc(file);
1100 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1104 for(i = 0; i < bytes; i++)
1105 fputc(buffer[i], file);
1108 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1110 while (bytes-- && !feof(file))
1114 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1121 /* ------------------------------------------------------------------------- */
1122 /* functions to translate key identifiers between different format */
1123 /* ------------------------------------------------------------------------- */
1125 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1126 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1127 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1128 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1130 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1139 /* normal cursor keys */
1140 { KSYM_Left, "XK_Left", "cursor left" },
1141 { KSYM_Right, "XK_Right", "cursor right" },
1142 { KSYM_Up, "XK_Up", "cursor up" },
1143 { KSYM_Down, "XK_Down", "cursor down" },
1145 /* keypad cursor keys */
1147 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1148 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1149 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1150 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1153 /* other keypad keys */
1154 #ifdef KSYM_KP_Enter
1155 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1156 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1157 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1158 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1159 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1160 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1164 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1165 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1166 { KSYM_Control_L, "XK_Control_L", "left control" },
1167 { KSYM_Control_R, "XK_Control_R", "right control" },
1168 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1169 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1170 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1171 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1172 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1173 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1174 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1175 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1177 /* some special keys */
1178 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1179 { KSYM_Delete, "XK_Delete", "delete" },
1180 { KSYM_Insert, "XK_Insert", "insert" },
1181 { KSYM_Tab, "XK_Tab", "tab" },
1182 { KSYM_Home, "XK_Home", "home" },
1183 { KSYM_End, "XK_End", "end" },
1184 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1185 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1186 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1188 /* ASCII 0x20 to 0x40 keys (except numbers) */
1189 { KSYM_space, "XK_space", "space" },
1190 { KSYM_exclam, "XK_exclam", "!" },
1191 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1192 { KSYM_numbersign, "XK_numbersign", "#" },
1193 { KSYM_dollar, "XK_dollar", "$" },
1194 { KSYM_percent, "XK_percent", "%" },
1195 { KSYM_ampersand, "XK_ampersand", "&" },
1196 { KSYM_apostrophe, "XK_apostrophe", "'" },
1197 { KSYM_parenleft, "XK_parenleft", "(" },
1198 { KSYM_parenright, "XK_parenright", ")" },
1199 { KSYM_asterisk, "XK_asterisk", "*" },
1200 { KSYM_plus, "XK_plus", "+" },
1201 { KSYM_comma, "XK_comma", "," },
1202 { KSYM_minus, "XK_minus", "-" },
1203 { KSYM_period, "XK_period", "." },
1204 { KSYM_slash, "XK_slash", "/" },
1205 { KSYM_colon, "XK_colon", ":" },
1206 { KSYM_semicolon, "XK_semicolon", ";" },
1207 { KSYM_less, "XK_less", "<" },
1208 { KSYM_equal, "XK_equal", "=" },
1209 { KSYM_greater, "XK_greater", ">" },
1210 { KSYM_question, "XK_question", "?" },
1211 { KSYM_at, "XK_at", "@" },
1213 /* more ASCII keys */
1214 { KSYM_bracketleft, "XK_bracketleft", "[" },
1215 { KSYM_backslash, "XK_backslash", "\\" },
1216 { KSYM_bracketright,"XK_bracketright", "]" },
1217 { KSYM_asciicircum, "XK_asciicircum", "^" },
1218 { KSYM_underscore, "XK_underscore", "_" },
1219 { KSYM_grave, "XK_grave", "grave" },
1220 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1221 { KSYM_braceleft, "XK_braceleft", "brace left" },
1222 { KSYM_bar, "XK_bar", "bar" },
1223 { KSYM_braceright, "XK_braceright", "brace right" },
1224 { KSYM_asciitilde, "XK_asciitilde", "~" },
1226 /* special (non-ASCII) keys */
1227 { KSYM_degree, "XK_degree", "°" },
1228 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1229 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1230 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1231 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1232 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1233 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1234 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1236 /* end-of-array identifier */
1242 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1244 static char name_buffer[30];
1247 if (key >= KSYM_A && key <= KSYM_Z)
1248 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1249 else if (key >= KSYM_a && key <= KSYM_z)
1250 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1251 else if (key >= KSYM_0 && key <= KSYM_9)
1252 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1253 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1254 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1255 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1256 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1257 else if (key == KSYM_UNDEFINED)
1258 strcpy(name_buffer, "(undefined)");
1265 if (key == translate_key[i].key)
1267 strcpy(name_buffer, translate_key[i].name);
1271 while (translate_key[++i].name);
1273 if (!translate_key[i].name)
1274 strcpy(name_buffer, "(unknown)");
1277 *name = name_buffer;
1279 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1281 static char name_buffer[30];
1284 if (key >= KSYM_A && key <= KSYM_Z)
1285 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1286 else if (key >= KSYM_a && key <= KSYM_z)
1287 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1288 else if (key >= KSYM_0 && key <= KSYM_9)
1289 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1290 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1291 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1292 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1293 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1294 else if (key == KSYM_UNDEFINED)
1295 strcpy(name_buffer, "[undefined]");
1302 if (key == translate_key[i].key)
1304 strcpy(name_buffer, translate_key[i].x11name);
1308 while (translate_key[++i].x11name);
1310 if (!translate_key[i].x11name)
1311 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1314 *x11name = name_buffer;
1316 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1318 Key key = KSYM_UNDEFINED;
1323 if (strEqual(translate_key[i].name, *name))
1325 key = translate_key[i].key;
1329 while (translate_key[++i].x11name);
1331 if (key == KSYM_UNDEFINED)
1332 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1336 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1338 Key key = KSYM_UNDEFINED;
1339 char *name_ptr = *x11name;
1341 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1343 char c = name_ptr[3];
1345 if (c >= 'A' && c <= 'Z')
1346 key = KSYM_A + (Key)(c - 'A');
1347 else if (c >= 'a' && c <= 'z')
1348 key = KSYM_a + (Key)(c - 'a');
1349 else if (c >= '0' && c <= '9')
1350 key = KSYM_0 + (Key)(c - '0');
1352 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1354 char c = name_ptr[6];
1356 if (c >= '0' && c <= '9')
1357 key = KSYM_KP_0 + (Key)(c - '0');
1359 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1361 char c1 = name_ptr[4];
1362 char c2 = name_ptr[5];
1365 if ((c1 >= '0' && c1 <= '9') &&
1366 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1367 d = atoi(&name_ptr[4]);
1369 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1370 key = KSYM_F1 + (Key)(d - 1);
1372 else if (strncmp(name_ptr, "XK_", 3) == 0)
1378 if (strEqual(name_ptr, translate_key[i].x11name))
1380 key = translate_key[i].key;
1384 while (translate_key[++i].x11name);
1386 else if (strncmp(name_ptr, "0x", 2) == 0)
1388 unsigned long value = 0;
1394 char c = *name_ptr++;
1397 if (c >= '0' && c <= '9')
1399 else if (c >= 'a' && c <= 'f')
1400 d = (int)(c - 'a' + 10);
1401 else if (c >= 'A' && c <= 'F')
1402 d = (int)(c - 'A' + 10);
1410 value = value * 16 + d;
1421 char *getKeyNameFromKey(Key key)
1425 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1429 char *getX11KeyNameFromKey(Key key)
1433 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1437 Key getKeyFromKeyName(char *name)
1441 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1445 Key getKeyFromX11KeyName(char *x11name)
1449 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1453 char getCharFromKey(Key key)
1455 char *keyname = getKeyNameFromKey(key);
1458 if (strlen(keyname) == 1)
1460 else if (strEqual(keyname, "space"))
1466 char getValidConfigValueChar(char c)
1468 if (c == '#' || /* used to mark comments */
1469 c == '\\') /* used to mark continued lines */
1476 /* ------------------------------------------------------------------------- */
1477 /* functions to translate string identifiers to integer or boolean value */
1478 /* ------------------------------------------------------------------------- */
1480 int get_integer_from_string(char *s)
1482 static char *number_text[][3] =
1484 { "0", "zero", "null", },
1485 { "1", "one", "first" },
1486 { "2", "two", "second" },
1487 { "3", "three", "third" },
1488 { "4", "four", "fourth" },
1489 { "5", "five", "fifth" },
1490 { "6", "six", "sixth" },
1491 { "7", "seven", "seventh" },
1492 { "8", "eight", "eighth" },
1493 { "9", "nine", "ninth" },
1494 { "10", "ten", "tenth" },
1495 { "11", "eleven", "eleventh" },
1496 { "12", "twelve", "twelfth" },
1498 { NULL, NULL, NULL },
1502 char *s_lower = getStringToLower(s);
1505 for (i = 0; number_text[i][0] != NULL; i++)
1506 for (j = 0; j < 3; j++)
1507 if (strEqual(s_lower, number_text[i][j]))
1512 if (strEqual(s_lower, "false"))
1514 else if (strEqual(s_lower, "true"))
1525 boolean get_boolean_from_string(char *s)
1527 char *s_lower = getStringToLower(s);
1528 boolean result = FALSE;
1530 if (strEqual(s_lower, "true") ||
1531 strEqual(s_lower, "yes") ||
1532 strEqual(s_lower, "on") ||
1533 get_integer_from_string(s) == 1)
1542 /* ------------------------------------------------------------------------- */
1543 /* functions for generic lists */
1544 /* ------------------------------------------------------------------------- */
1546 ListNode *newListNode()
1548 return checked_calloc(sizeof(ListNode));
1551 void addNodeToList(ListNode **node_first, char *key, void *content)
1553 ListNode *node_new = newListNode();
1555 node_new->key = getStringCopy(key);
1556 node_new->content = content;
1557 node_new->next = *node_first;
1558 *node_first = node_new;
1561 void deleteNodeFromList(ListNode **node_first, char *key,
1562 void (*destructor_function)(void *))
1564 if (node_first == NULL || *node_first == NULL)
1567 if (strEqual((*node_first)->key, key))
1569 checked_free((*node_first)->key);
1570 if (destructor_function)
1571 destructor_function((*node_first)->content);
1572 *node_first = (*node_first)->next;
1575 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1578 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1580 if (node_first == NULL)
1583 if (strEqual(node_first->key, key))
1586 return getNodeFromKey(node_first->next, key);
1589 int getNumNodes(ListNode *node_first)
1591 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1594 void dumpList(ListNode *node_first)
1596 ListNode *node = node_first;
1600 printf("['%s' (%d)]\n", node->key,
1601 ((struct ListNodeInfo *)node->content)->num_references);
1605 printf("[%d nodes]\n", getNumNodes(node_first));
1609 /* ------------------------------------------------------------------------- */
1610 /* functions for checking files and filenames */
1611 /* ------------------------------------------------------------------------- */
1613 boolean fileExists(char *filename)
1615 if (filename == NULL)
1618 return (access(filename, F_OK) == 0);
1621 boolean fileHasPrefix(char *basename, char *prefix)
1623 static char *basename_lower = NULL;
1624 int basename_length, prefix_length;
1626 checked_free(basename_lower);
1628 if (basename == NULL || prefix == NULL)
1631 basename_lower = getStringToLower(basename);
1632 basename_length = strlen(basename_lower);
1633 prefix_length = strlen(prefix);
1635 if (basename_length > prefix_length + 1 &&
1636 basename_lower[prefix_length] == '.' &&
1637 strncmp(basename_lower, prefix, prefix_length) == 0)
1643 boolean fileHasSuffix(char *basename, char *suffix)
1645 static char *basename_lower = NULL;
1646 int basename_length, suffix_length;
1648 checked_free(basename_lower);
1650 if (basename == NULL || suffix == NULL)
1653 basename_lower = getStringToLower(basename);
1654 basename_length = strlen(basename_lower);
1655 suffix_length = strlen(suffix);
1657 if (basename_length > suffix_length + 1 &&
1658 basename_lower[basename_length - suffix_length - 1] == '.' &&
1659 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1665 boolean FileIsGraphic(char *filename)
1667 char *basename = getBaseNamePtr(filename);
1669 return fileHasSuffix(basename, "pcx");
1672 boolean FileIsSound(char *filename)
1674 char *basename = getBaseNamePtr(filename);
1676 return fileHasSuffix(basename, "wav");
1679 boolean FileIsMusic(char *filename)
1681 char *basename = getBaseNamePtr(filename);
1683 if (FileIsSound(basename))
1686 #if defined(TARGET_SDL)
1687 if (fileHasPrefix(basename, "mod") ||
1688 fileHasSuffix(basename, "mod") ||
1689 fileHasSuffix(basename, "s3m") ||
1690 fileHasSuffix(basename, "it") ||
1691 fileHasSuffix(basename, "xm") ||
1692 fileHasSuffix(basename, "midi") ||
1693 fileHasSuffix(basename, "mid") ||
1694 fileHasSuffix(basename, "mp3") ||
1695 fileHasSuffix(basename, "ogg"))
1702 boolean FileIsArtworkType(char *basename, int type)
1704 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1705 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1706 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1712 /* ------------------------------------------------------------------------- */
1713 /* functions for loading artwork configuration information */
1714 /* ------------------------------------------------------------------------- */
1716 char *get_mapped_token(char *token)
1718 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1719 static char *map_token_prefix[][2] =
1721 { "char_procent", "char_percent" },
1726 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1728 int len_token_prefix = strlen(map_token_prefix[i][0]);
1730 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1731 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1737 /* This function checks if a string <s> of the format "string1, string2, ..."
1738 exactly contains a string <s_contained>. */
1740 static boolean string_has_parameter(char *s, char *s_contained)
1744 if (s == NULL || s_contained == NULL)
1747 if (strlen(s_contained) > strlen(s))
1750 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1752 char next_char = s[strlen(s_contained)];
1754 /* check if next character is delimiter or whitespace */
1755 return (next_char == ',' || next_char == '\0' ||
1756 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1759 /* check if string contains another parameter string after a comma */
1760 substring = strchr(s, ',');
1761 if (substring == NULL) /* string does not contain a comma */
1764 /* advance string pointer to next character after the comma */
1767 /* skip potential whitespaces after the comma */
1768 while (*substring == ' ' || *substring == '\t')
1771 return string_has_parameter(substring, s_contained);
1774 int get_parameter_value(char *value_raw, char *suffix, int type)
1776 char *value = getStringToLower(value_raw);
1777 int result = 0; /* probably a save default value */
1779 if (strEqual(suffix, ".direction"))
1781 result = (strEqual(value, "left") ? MV_LEFT :
1782 strEqual(value, "right") ? MV_RIGHT :
1783 strEqual(value, "up") ? MV_UP :
1784 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1786 else if (strEqual(suffix, ".align"))
1788 result = (strEqual(value, "left") ? ALIGN_LEFT :
1789 strEqual(value, "right") ? ALIGN_RIGHT :
1790 strEqual(value, "center") ? ALIGN_CENTER :
1791 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1793 else if (strEqual(suffix, ".valign"))
1795 result = (strEqual(value, "top") ? VALIGN_TOP :
1796 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1797 strEqual(value, "middle") ? VALIGN_MIDDLE :
1798 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1800 else if (strEqual(suffix, ".anim_mode"))
1802 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1803 string_has_parameter(value, "loop") ? ANIM_LOOP :
1804 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1805 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1806 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1807 string_has_parameter(value, "random") ? ANIM_RANDOM :
1808 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1809 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1810 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1811 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1812 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1813 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1814 string_has_parameter(value, "fade") ? ANIM_FADE :
1815 string_has_parameter(value, "crossfade") ? ANIM_CROSSFADE :
1818 if (string_has_parameter(value, "reverse"))
1819 result |= ANIM_REVERSE;
1821 if (string_has_parameter(value, "opaque_player"))
1822 result |= ANIM_OPAQUE_PLAYER;
1824 if (string_has_parameter(value, "static_panel"))
1825 result |= ANIM_STATIC_PANEL;
1827 else if (strEqual(suffix, ".font"))
1829 result = gfx.get_font_from_token_function(value);
1831 else /* generic parameter of type integer or boolean */
1833 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1834 type == TYPE_INTEGER ? get_integer_from_string(value) :
1835 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1836 ARG_UNDEFINED_VALUE);
1844 int get_token_parameter_value(char *token, char *value_raw)
1848 if (token == NULL || value_raw == NULL)
1849 return ARG_UNDEFINED_VALUE;
1851 suffix = strrchr(token, '.');
1856 if (strncmp(suffix, ".font", 5) == 0)
1860 /* !!! OPTIMIZE THIS BY USING HASH !!! */
1861 for (i = 0; i < NUM_FONTS; i++)
1862 if (strEqual(value_raw, font_info[i].token_name))
1865 /* if font not found, use reliable default value */
1866 return FONT_INITIAL_1;
1870 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
1873 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1875 static struct ScreenModeInfo screen_mode;
1876 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1877 char *screen_mode_string_copy;
1878 char *screen_mode_string_pos_w;
1879 char *screen_mode_string_pos_h;
1881 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1884 screen_mode_string_copy = getStringCopy(screen_mode_string);
1886 screen_mode_string_pos_w = screen_mode_string_copy;
1887 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1888 *screen_mode_string_pos_h++ = '\0';
1890 screen_mode.width = atoi(screen_mode_string_pos_w);
1891 screen_mode.height = atoi(screen_mode_string_pos_h);
1893 return &screen_mode;
1896 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1899 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1900 float aspect_ratio_new;
1905 *x = i * aspect_ratio + 0.000001;
1908 aspect_ratio_new = (float)*x / (float)*y;
1912 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1915 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1916 struct ListNodeInfo ***, int *);
1918 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1919 struct ConfigTypeInfo *suffix_list,
1920 char **ignore_tokens,
1921 int num_file_list_entries)
1923 struct FileInfo *file_list;
1924 int num_file_list_entries_found = 0;
1925 int num_suffix_list_entries = 0;
1929 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1931 for (i = 0; suffix_list[i].token != NULL; i++)
1932 num_suffix_list_entries++;
1934 /* always start with reliable default values */
1935 for (i = 0; i < num_file_list_entries; i++)
1937 file_list[i].token = NULL;
1939 file_list[i].default_filename = NULL;
1940 file_list[i].filename = NULL;
1942 if (num_suffix_list_entries > 0)
1944 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1946 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1947 file_list[i].parameter = checked_calloc(parameter_array_size);
1949 for (j = 0; j < num_suffix_list_entries; j++)
1951 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1952 setString(&file_list[i].parameter[j], suffix_list[j].value);
1955 file_list[i].redefined = FALSE;
1956 file_list[i].fallback_to_default = FALSE;
1961 for (i = 0; config_list[i].token != NULL; i++)
1963 int len_config_token = strlen(config_list[i].token);
1964 int len_config_value = strlen(config_list[i].value);
1965 boolean is_file_entry = TRUE;
1967 for (j = 0; suffix_list[j].token != NULL; j++)
1969 int len_suffix = strlen(suffix_list[j].token);
1971 if (len_suffix < len_config_token &&
1972 strEqual(&config_list[i].token[len_config_token - len_suffix],
1973 suffix_list[j].token))
1975 setString(&file_list[list_pos].default_parameter[j],
1976 config_list[i].value);
1978 is_file_entry = FALSE;
1983 /* the following tokens are no file definitions, but other config tokens */
1984 for (j = 0; ignore_tokens[j] != NULL; j++)
1985 if (strEqual(config_list[i].token, ignore_tokens[j]))
1986 is_file_entry = FALSE;
1993 if (list_pos >= num_file_list_entries)
1996 /* simple sanity check if this is really a file definition */
1997 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
1998 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
1999 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2001 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2002 config_list[i].token, config_list[i].value);
2003 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2006 file_list[list_pos].token = config_list[i].token;
2007 file_list[list_pos].default_filename = config_list[i].value;
2010 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2015 num_file_list_entries_found = list_pos + 1;
2016 if (num_file_list_entries_found != num_file_list_entries)
2018 Error(ERR_INFO_LINE, "-");
2019 Error(ERR_INFO, "inconsistant config list information:");
2020 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2021 num_file_list_entries);
2022 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2023 num_file_list_entries_found);
2024 Error(ERR_EXIT, "please fix");
2028 printf("::: ---------- DONE ----------\n");
2034 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2036 int len_token = strlen(token);
2037 int len_suffix = strlen(suffix);
2039 if (start_pos < 0) /* compare suffix from end of string */
2040 start_pos += len_token;
2042 if (start_pos < 0 || start_pos + len_suffix > len_token)
2045 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2048 if (token[start_pos + len_suffix] == '\0')
2051 if (token[start_pos + len_suffix] == '.')
2057 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2059 static void read_token_parameters(SetupFileHash *setup_file_hash,
2060 struct ConfigTypeInfo *suffix_list,
2061 struct FileInfo *file_list_entry)
2063 /* check for config token that is the base token without any suffixes */
2064 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2065 char *known_token_value = KNOWN_TOKEN_VALUE;
2068 if (filename != NULL)
2070 setString(&file_list_entry->filename, filename);
2072 /* when file definition found, set all parameters to default values */
2073 for (i = 0; suffix_list[i].token != NULL; i++)
2074 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2076 file_list_entry->redefined = TRUE;
2078 /* mark config file token as well known from default config */
2079 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2082 /* check for config tokens that can be build by base token and suffixes */
2083 for (i = 0; suffix_list[i].token != NULL; i++)
2085 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2086 char *value = getHashEntry(setup_file_hash, token);
2090 setString(&file_list_entry->parameter[i], value);
2092 /* mark config file token as well known from default config */
2093 setHashEntry(setup_file_hash, token, known_token_value);
2100 static void add_dynamic_file_list_entry(struct FileInfo **list,
2101 int *num_list_entries,
2102 SetupFileHash *extra_file_hash,
2103 struct ConfigTypeInfo *suffix_list,
2104 int num_suffix_list_entries,
2107 struct FileInfo *new_list_entry;
2108 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2110 (*num_list_entries)++;
2111 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2112 new_list_entry = &(*list)[*num_list_entries - 1];
2114 new_list_entry->token = getStringCopy(token);
2115 new_list_entry->default_filename = NULL;
2116 new_list_entry->filename = NULL;
2117 new_list_entry->parameter = checked_calloc(parameter_array_size);
2119 new_list_entry->redefined = FALSE;
2120 new_list_entry->fallback_to_default = FALSE;
2122 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2125 static void add_property_mapping(struct PropertyMapping **list,
2126 int *num_list_entries,
2127 int base_index, int ext1_index,
2128 int ext2_index, int ext3_index,
2131 struct PropertyMapping *new_list_entry;
2133 (*num_list_entries)++;
2134 *list = checked_realloc(*list,
2135 *num_list_entries * sizeof(struct PropertyMapping));
2136 new_list_entry = &(*list)[*num_list_entries - 1];
2138 new_list_entry->base_index = base_index;
2139 new_list_entry->ext1_index = ext1_index;
2140 new_list_entry->ext2_index = ext2_index;
2141 new_list_entry->ext3_index = ext3_index;
2143 new_list_entry->artwork_index = artwork_index;
2146 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2149 struct FileInfo *file_list = artwork_info->file_list;
2150 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2151 char **base_prefixes = artwork_info->base_prefixes;
2152 char **ext1_suffixes = artwork_info->ext1_suffixes;
2153 char **ext2_suffixes = artwork_info->ext2_suffixes;
2154 char **ext3_suffixes = artwork_info->ext3_suffixes;
2155 char **ignore_tokens = artwork_info->ignore_tokens;
2156 int num_file_list_entries = artwork_info->num_file_list_entries;
2157 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2158 int num_base_prefixes = artwork_info->num_base_prefixes;
2159 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2160 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2161 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2162 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2163 SetupFileHash *setup_file_hash, *valid_file_hash;
2164 SetupFileHash *extra_file_hash, *empty_file_hash;
2165 char *known_token_value = KNOWN_TOKEN_VALUE;
2168 if (filename == NULL)
2172 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2175 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2178 /* separate valid (defined) from empty (undefined) config token values */
2179 valid_file_hash = newSetupFileHash();
2180 empty_file_hash = newSetupFileHash();
2181 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2183 char *value = HASH_ITERATION_VALUE(itr);
2185 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2186 HASH_ITERATION_TOKEN(itr), value);
2188 END_HASH_ITERATION(setup_file_hash, itr)
2190 /* at this point, we do not need the setup file hash anymore -- free it */
2191 freeSetupFileHash(setup_file_hash);
2193 /* map deprecated to current tokens (using prefix match and replace) */
2194 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2196 char *token = HASH_ITERATION_TOKEN(itr);
2197 char *mapped_token = get_mapped_token(token);
2199 if (mapped_token != NULL)
2201 char *value = HASH_ITERATION_VALUE(itr);
2203 /* add mapped token */
2204 setHashEntry(valid_file_hash, mapped_token, value);
2206 /* ignore old token (by setting it to "known" keyword) */
2207 setHashEntry(valid_file_hash, token, known_token_value);
2212 END_HASH_ITERATION(valid_file_hash, itr)
2214 /* read parameters for all known config file tokens */
2215 for (i = 0; i < num_file_list_entries; i++)
2216 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2218 /* set all tokens that can be ignored here to "known" keyword */
2219 for (i = 0; i < num_ignore_tokens; i++)
2220 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2222 /* copy all unknown config file tokens to extra config hash */
2223 extra_file_hash = newSetupFileHash();
2224 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2226 char *value = HASH_ITERATION_VALUE(itr);
2228 if (!strEqual(value, known_token_value))
2229 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2231 END_HASH_ITERATION(valid_file_hash, itr)
2233 /* at this point, we do not need the valid file hash anymore -- free it */
2234 freeSetupFileHash(valid_file_hash);
2236 /* now try to determine valid, dynamically defined config tokens */
2238 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2240 struct FileInfo **dynamic_file_list =
2241 &artwork_info->dynamic_file_list;
2242 int *num_dynamic_file_list_entries =
2243 &artwork_info->num_dynamic_file_list_entries;
2244 struct PropertyMapping **property_mapping =
2245 &artwork_info->property_mapping;
2246 int *num_property_mapping_entries =
2247 &artwork_info->num_property_mapping_entries;
2248 int current_summarized_file_list_entry =
2249 artwork_info->num_file_list_entries +
2250 artwork_info->num_dynamic_file_list_entries;
2251 char *token = HASH_ITERATION_TOKEN(itr);
2252 int len_token = strlen(token);
2254 boolean base_prefix_found = FALSE;
2255 boolean parameter_suffix_found = FALSE;
2258 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2261 /* skip all parameter definitions (handled by read_token_parameters()) */
2262 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2264 int len_suffix = strlen(suffix_list[i].token);
2266 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2267 parameter_suffix_found = TRUE;
2270 if (parameter_suffix_found)
2273 /* ---------- step 0: search for matching base prefix ---------- */
2276 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2278 char *base_prefix = base_prefixes[i];
2279 int len_base_prefix = strlen(base_prefix);
2280 boolean ext1_suffix_found = FALSE;
2281 boolean ext2_suffix_found = FALSE;
2282 boolean ext3_suffix_found = FALSE;
2283 boolean exact_match = FALSE;
2284 int base_index = -1;
2285 int ext1_index = -1;
2286 int ext2_index = -1;
2287 int ext3_index = -1;
2289 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2291 if (!base_prefix_found)
2296 if (start_pos + len_base_prefix == len_token) /* exact match */
2300 add_dynamic_file_list_entry(dynamic_file_list,
2301 num_dynamic_file_list_entries,
2304 num_suffix_list_entries,
2306 add_property_mapping(property_mapping,
2307 num_property_mapping_entries,
2308 base_index, -1, -1, -1,
2309 current_summarized_file_list_entry);
2314 if (IS_PARENT_PROCESS())
2315 printf("---> examining token '%s': search 1st suffix ...\n", token);
2318 /* ---------- step 1: search for matching first suffix ---------- */
2320 start_pos += len_base_prefix;
2321 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2323 char *ext1_suffix = ext1_suffixes[j];
2324 int len_ext1_suffix = strlen(ext1_suffix);
2326 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2328 if (!ext1_suffix_found)
2333 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2337 add_dynamic_file_list_entry(dynamic_file_list,
2338 num_dynamic_file_list_entries,
2341 num_suffix_list_entries,
2343 add_property_mapping(property_mapping,
2344 num_property_mapping_entries,
2345 base_index, ext1_index, -1, -1,
2346 current_summarized_file_list_entry);
2350 start_pos += len_ext1_suffix;
2357 if (IS_PARENT_PROCESS())
2358 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2361 /* ---------- step 2: search for matching second suffix ---------- */
2363 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2365 char *ext2_suffix = ext2_suffixes[k];
2366 int len_ext2_suffix = strlen(ext2_suffix);
2368 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2370 if (!ext2_suffix_found)
2375 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2379 add_dynamic_file_list_entry(dynamic_file_list,
2380 num_dynamic_file_list_entries,
2383 num_suffix_list_entries,
2385 add_property_mapping(property_mapping,
2386 num_property_mapping_entries,
2387 base_index, ext1_index, ext2_index, -1,
2388 current_summarized_file_list_entry);
2392 start_pos += len_ext2_suffix;
2399 if (IS_PARENT_PROCESS())
2400 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2403 /* ---------- step 3: search for matching third suffix ---------- */
2405 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2407 char *ext3_suffix = ext3_suffixes[l];
2408 int len_ext3_suffix = strlen(ext3_suffix);
2410 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2412 if (!ext3_suffix_found)
2417 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2421 add_dynamic_file_list_entry(dynamic_file_list,
2422 num_dynamic_file_list_entries,
2425 num_suffix_list_entries,
2427 add_property_mapping(property_mapping,
2428 num_property_mapping_entries,
2429 base_index, ext1_index, ext2_index, ext3_index,
2430 current_summarized_file_list_entry);
2436 END_HASH_ITERATION(extra_file_hash, itr)
2438 if (artwork_info->num_dynamic_file_list_entries > 0)
2440 artwork_info->dynamic_artwork_list =
2441 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2442 artwork_info->sizeof_artwork_list_entry);
2445 if (options.verbose && IS_PARENT_PROCESS())
2447 SetupFileList *setup_file_list, *list;
2448 boolean dynamic_tokens_found = FALSE;
2449 boolean unknown_tokens_found = FALSE;
2450 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2452 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2453 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2455 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2457 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2458 dynamic_tokens_found = TRUE;
2460 unknown_tokens_found = TRUE;
2462 END_HASH_ITERATION(extra_file_hash, itr)
2464 if (options.debug && dynamic_tokens_found)
2466 Error(ERR_INFO_LINE, "-");
2467 Error(ERR_INFO, "dynamic token(s) found in config file:");
2468 Error(ERR_INFO, "- config file: '%s'", filename);
2470 for (list = setup_file_list; list != NULL; list = list->next)
2472 char *value = getHashEntry(extra_file_hash, list->token);
2474 if (value != NULL && strEqual(value, known_token_value))
2475 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2478 Error(ERR_INFO_LINE, "-");
2481 if (unknown_tokens_found)
2483 Error(ERR_INFO_LINE, "-");
2484 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2485 Error(ERR_INFO, "- config file: '%s'", filename);
2487 for (list = setup_file_list; list != NULL; list = list->next)
2489 char *value = getHashEntry(extra_file_hash, list->token);
2491 if (value != NULL && !strEqual(value, known_token_value))
2492 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2495 Error(ERR_INFO_LINE, "-");
2498 if (undefined_values_found)
2500 Error(ERR_INFO_LINE, "-");
2501 Error(ERR_INFO, "warning: undefined values found in config file:");
2502 Error(ERR_INFO, "- config file: '%s'", filename);
2504 for (list = setup_file_list; list != NULL; list = list->next)
2506 char *value = getHashEntry(empty_file_hash, list->token);
2509 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2512 Error(ERR_INFO_LINE, "-");
2515 freeSetupFileList(setup_file_list);
2518 freeSetupFileHash(extra_file_hash);
2519 freeSetupFileHash(empty_file_hash);
2522 for (i = 0; i < num_file_list_entries; i++)
2524 printf("'%s' ", file_list[i].token);
2525 if (file_list[i].filename)
2526 printf("-> '%s'\n", file_list[i].filename);
2528 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2533 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2535 struct FileInfo *file_list = artwork_info->file_list;
2536 int num_file_list_entries = artwork_info->num_file_list_entries;
2537 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2538 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2541 DrawInitText("Loading artwork config", 120, FC_GREEN);
2542 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2544 /* always start with reliable default values */
2545 for (i = 0; i < num_file_list_entries; i++)
2547 setString(&file_list[i].filename, file_list[i].default_filename);
2549 for (j = 0; j < num_suffix_list_entries; j++)
2550 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2552 file_list[i].redefined = FALSE;
2553 file_list[i].fallback_to_default = FALSE;
2556 /* free previous dynamic artwork file array */
2557 if (artwork_info->dynamic_file_list != NULL)
2559 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2561 free(artwork_info->dynamic_file_list[i].token);
2562 free(artwork_info->dynamic_file_list[i].filename);
2563 free(artwork_info->dynamic_file_list[i].parameter);
2566 free(artwork_info->dynamic_file_list);
2567 artwork_info->dynamic_file_list = NULL;
2569 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2570 &artwork_info->num_dynamic_file_list_entries);
2573 /* free previous property mapping */
2574 if (artwork_info->property_mapping != NULL)
2576 free(artwork_info->property_mapping);
2578 artwork_info->property_mapping = NULL;
2579 artwork_info->num_property_mapping_entries = 0;
2582 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2584 /* first look for special artwork configured in level series config */
2585 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2587 if (fileExists(filename_base))
2588 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2591 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2593 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2594 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2597 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2598 struct ListNodeInfo **listnode)
2602 char *filename = (*listnode)->source_filename;
2604 if (--(*listnode)->num_references <= 0)
2605 deleteNodeFromList(&artwork_info->content_list, filename,
2606 artwork_info->free_artwork);
2612 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2613 struct ListNodeInfo **listnode,
2614 struct FileInfo *file_list_entry)
2624 char *basename = file_list_entry->filename;
2625 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2627 if (filename == NULL)
2629 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2631 basename = file_list_entry->default_filename;
2633 /* dynamic artwork has no default filename / skip empty default artwork */
2634 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2637 file_list_entry->fallback_to_default = TRUE;
2639 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2641 filename = getCustomArtworkFilename(basename, artwork_info->type);
2643 if (filename == NULL)
2645 int error_mode = ERR_WARN;
2647 /* we can get away without sounds and music, but not without graphics */
2648 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2649 error_mode = ERR_EXIT;
2651 Error(error_mode, "cannot find default artwork file '%s'", basename);
2657 /* check if the old and the new artwork file are the same */
2658 if (*listnode && strEqual((*listnode)->source_filename, filename))
2660 /* The old and new artwork are the same (have the same filename and path).
2661 This usually means that this artwork does not exist in this artwork set
2662 and a fallback to the existing artwork is done. */
2665 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2671 /* delete existing artwork file entry */
2672 deleteArtworkListEntry(artwork_info, listnode);
2674 /* check if the new artwork file already exists in the list of artworks */
2675 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2678 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2681 *listnode = (struct ListNodeInfo *)node->content;
2682 (*listnode)->num_references++;
2687 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2688 DrawInitText(basename, 150, FC_YELLOW);
2690 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2693 printf("[adding new artwork '%s']\n", filename);
2696 (*listnode)->num_references = 1;
2697 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2702 int error_mode = ERR_WARN;
2704 /* we can get away without sounds and music, but not without graphics */
2705 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2706 error_mode = ERR_EXIT;
2708 Error(error_mode, "cannot load artwork file '%s'", basename);
2713 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2714 struct ListNodeInfo **listnode,
2715 struct FileInfo *file_list_entry)
2718 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2721 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2723 deleteArtworkListEntry(artwork_info, listnode);
2727 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2730 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2732 struct FileInfo *file_list = artwork_info->file_list;
2733 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2734 int num_file_list_entries = artwork_info->num_file_list_entries;
2735 int num_dynamic_file_list_entries =
2736 artwork_info->num_dynamic_file_list_entries;
2739 for (i = 0; i < num_file_list_entries; i++)
2740 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2743 for (i = 0; i < num_dynamic_file_list_entries; i++)
2744 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2745 &dynamic_file_list[i]);
2748 dumpList(artwork_info->content_list);
2752 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2753 struct ListNodeInfo ***list,
2754 int *num_list_entries)
2761 for (i = 0; i < *num_list_entries; i++)
2762 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2766 *num_list_entries = 0;
2769 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2771 if (artwork_info == NULL)
2774 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2775 &artwork_info->num_file_list_entries);
2777 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2778 &artwork_info->num_dynamic_file_list_entries);
2782 /* ------------------------------------------------------------------------- */
2783 /* functions only needed for non-Unix (non-command-line) systems */
2784 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2785 /* (now also added for Windows, to create files in user data directory) */
2786 /* ------------------------------------------------------------------------- */
2788 char *getErrorFilename(char *basename)
2790 return getPath2(getUserGameDataDir(), basename);
2793 void openErrorFile()
2795 InitUserDataDirectory();
2797 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2798 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2799 program.error_filename);
2802 void closeErrorFile()
2804 if (program.error_file != stderr) /* do not close stream 'stderr' */
2805 fclose(program.error_file);
2808 void dumpErrorFile()
2810 FILE *error_file = fopen(program.error_filename, MODE_READ);
2812 if (error_file != NULL)
2814 while (!feof(error_file))
2815 fputc(fgetc(error_file), stderr);
2821 void NotifyUserAboutErrorFile()
2823 #if defined(PLATFORM_WIN32)
2824 char *title_text = getStringCat2(program.program_title, " Error Message");
2825 char *error_text = getStringCat2("The program was aborted due to an error; "
2826 "for details, see the following error file:"
2827 STRING_NEWLINE, program.error_filename);
2829 MessageBox(NULL, error_text, title_text, MB_OK);
2834 /* ------------------------------------------------------------------------- */
2835 /* the following is only for debugging purpose and normally not used */
2836 /* ------------------------------------------------------------------------- */
2840 #define DEBUG_NUM_TIMESTAMPS 3
2841 #define DEBUG_TIME_IN_MICROSECONDS 0
2843 #if DEBUG_TIME_IN_MICROSECONDS
2844 static double Counter_Microseconds()
2846 static struct timeval base_time = { 0, 0 };
2847 struct timeval current_time;
2850 gettimeofday(¤t_time, NULL);
2852 /* reset base time in case of wrap-around */
2853 if (current_time.tv_sec < base_time.tv_sec)
2854 base_time = current_time;
2857 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
2858 ((double)(current_time.tv_usec - base_time.tv_usec));
2860 return counter; /* return microseconds since last init */
2864 void debug_print_timestamp(int counter_nr, char *message)
2866 #if DEBUG_TIME_IN_MICROSECONDS
2867 static double counter[DEBUG_NUM_TIMESTAMPS][2];
2869 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2870 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2872 counter[counter_nr][0] = Counter_Microseconds();
2875 printf("%s %.3f ms\n", message,
2876 (counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2878 counter[counter_nr][1] = counter[counter_nr][0];
2880 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2882 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2883 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2885 counter[counter_nr][0] = Counter();
2888 printf("%s %.3f s\n", message,
2889 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2891 counter[counter_nr][1] = counter[counter_nr][0];
2895 void debug_print_parent_only(char *format, ...)
2897 if (!IS_PARENT_PROCESS())
2904 va_start(ap, format);
2905 vprintf(format, ap);