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 /* default random seed */
341 seed = (long)time(NULL); // seconds since the epoch
343 #if !defined(PLATFORM_WIN32)
344 /* add some more randomness */
345 struct timeval current_time;
347 gettimeofday(¤t_time, NULL);
349 seed += (long)current_time.tv_usec; // microseconds since the epoch
352 #if defined(TARGET_SDL)
353 /* add some more randomness */
354 seed += (long)SDL_GetTicks(); // milliseconds since SDL init
358 /* add some more randomness */
359 seed += GetSimpleRandom(1000000);
363 srandom_linux_libc(nr, (unsigned int) seed);
365 return (unsigned int) seed;
368 unsigned int get_random_number(int nr, int max)
370 return (max > 0 ? random_linux_libc(nr) % max : 0);
374 /* ------------------------------------------------------------------------- */
375 /* system info functions */
376 /* ------------------------------------------------------------------------- */
378 #if !defined(PLATFORM_MSDOS)
379 static char *get_corrected_real_name(char *real_name)
381 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
382 char *from_ptr = real_name;
383 char *to_ptr = real_name_new;
385 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
386 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
388 /* the name field read from "passwd" file may also contain additional
389 user information, separated by commas, which will be removed here */
390 if (*from_ptr == ',')
393 /* the user's real name may contain 'ß' characters (german sharp s),
394 which have no equivalent in upper case letters (used by our fonts) */
395 if (*from_ptr == 'ß')
402 *to_ptr++ = *from_ptr++;
407 return real_name_new;
413 static char *login_name = NULL;
415 #if defined(PLATFORM_WIN32)
416 if (login_name == NULL)
418 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
419 login_name = checked_malloc(buffer_size);
421 if (GetUserName(login_name, &buffer_size) == 0)
422 strcpy(login_name, ANONYMOUS_NAME);
425 if (login_name == NULL)
429 if ((pwd = getpwuid(getuid())) == NULL)
430 login_name = ANONYMOUS_NAME;
432 login_name = getStringCopy(pwd->pw_name);
441 static char *real_name = NULL;
443 #if defined(PLATFORM_WIN32)
444 if (real_name == NULL)
446 static char buffer[MAX_USERNAME_LEN + 1];
447 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
449 if (GetUserName(buffer, &buffer_size) != 0)
450 real_name = get_corrected_real_name(buffer);
452 real_name = ANONYMOUS_NAME;
454 #elif defined(PLATFORM_UNIX)
455 if (real_name == NULL)
459 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
460 real_name = get_corrected_real_name(pwd->pw_gecos);
462 real_name = ANONYMOUS_NAME;
465 real_name = ANONYMOUS_NAME;
472 /* ------------------------------------------------------------------------- */
473 /* path manipulation functions */
474 /* ------------------------------------------------------------------------- */
476 static char *getLastPathSeparatorPtr(char *filename)
478 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
480 if (last_separator == NULL) /* also try DOS/Windows variant */
481 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
483 return last_separator;
486 char *getBaseNamePtr(char *filename)
488 char *last_separator = getLastPathSeparatorPtr(filename);
490 if (last_separator != NULL)
491 return last_separator + 1; /* separator found: strip base path */
493 return filename; /* no separator found: filename has no path */
496 char *getBaseName(char *filename)
498 return getStringCopy(getBaseNamePtr(filename));
501 char *getBasePath(char *filename)
503 char *basepath = getStringCopy(filename);
504 char *last_separator = getLastPathSeparatorPtr(basepath);
506 if (last_separator != NULL)
507 *last_separator = '\0'; /* separator found: strip basename */
509 basepath = "."; /* no separator found: use current path */
515 /* ------------------------------------------------------------------------- */
516 /* various string functions */
517 /* ------------------------------------------------------------------------- */
519 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
521 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
524 sprintf(complete_string, "%s%s%s", s1, sep, s2);
526 return complete_string;
529 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
531 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
532 strlen(s2) + strlen(sep) +
535 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
537 return complete_string;
540 char *getStringCat2(char *s1, char *s2)
542 return getStringCat2WithSeparator(s1, s2, "");
545 char *getStringCat3(char *s1, char *s2, char *s3)
547 return getStringCat3WithSeparator(s1, s2, s3, "");
550 char *getPath2(char *path1, char *path2)
552 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
555 char *getPath3(char *path1, char *path2, char *path3)
557 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
560 char *getStringCopy(char *s)
567 s_copy = checked_malloc(strlen(s) + 1);
573 char *getStringCopyN(char *s, int n)
576 int s_len = MAX(0, n);
581 s_copy = checked_malloc(s_len + 1);
582 strncpy(s_copy, s, s_len);
583 s_copy[s_len] = '\0';
588 char *getStringToLower(char *s)
590 char *s_copy = checked_malloc(strlen(s) + 1);
591 char *s_ptr = s_copy;
594 *s_ptr++ = tolower(*s++);
600 void setString(char **old_value, char *new_value)
602 checked_free(*old_value);
604 *old_value = getStringCopy(new_value);
607 boolean strEqual(char *s1, char *s2)
609 return (s1 == NULL && s2 == NULL ? TRUE :
610 s1 == NULL && s2 != NULL ? FALSE :
611 s1 != NULL && s2 == NULL ? FALSE :
612 strcmp(s1, s2) == 0);
615 boolean strEqualN(char *s1, char *s2, int n)
617 return (s1 == NULL && s2 == NULL ? TRUE :
618 s1 == NULL && s2 != NULL ? FALSE :
619 s1 != NULL && s2 == NULL ? FALSE :
620 strncmp(s1, s2, n) == 0);
623 boolean strPrefix(char *s, char *prefix)
625 return (s == NULL && prefix == NULL ? TRUE :
626 s == NULL && prefix != NULL ? FALSE :
627 s != NULL && prefix == NULL ? FALSE :
628 strncmp(s, prefix, strlen(prefix)) == 0);
631 boolean strSuffix(char *s, char *suffix)
633 return (s == NULL && suffix == NULL ? TRUE :
634 s == NULL && suffix != NULL ? FALSE :
635 s != NULL && suffix == NULL ? FALSE :
636 strlen(s) < strlen(suffix) ? FALSE :
637 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
641 /* ------------------------------------------------------------------------- */
642 /* command line option handling functions */
643 /* ------------------------------------------------------------------------- */
645 void GetOptions(char *argv[], void (*print_usage_function)(void))
647 char *ro_base_path = RO_BASE_PATH;
648 char *rw_base_path = RW_BASE_PATH;
649 char **options_left = &argv[1];
651 #if !defined(PLATFORM_MACOSX)
652 /* if the program is configured to start from current directory (default),
653 determine program package directory (KDE/Konqueror does not do this by
654 itself and fails otherwise); on Mac OS X, the program binary is stored
655 in an application package directory -- do not try to use this directory
656 as the program data directory (Mac OS X handles this correctly anyway) */
658 if (strEqual(ro_base_path, "."))
659 ro_base_path = program.command_basepath;
660 if (strEqual(rw_base_path, "."))
661 rw_base_path = program.command_basepath;
664 /* initialize global program options */
665 options.display_name = NULL;
666 options.server_host = NULL;
667 options.server_port = 0;
668 options.ro_base_directory = ro_base_path;
669 options.rw_base_directory = rw_base_path;
670 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
671 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
672 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
673 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
674 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
675 options.execute_command = NULL;
676 options.serveronly = FALSE;
677 options.network = FALSE;
678 options.verbose = FALSE;
679 options.debug = FALSE;
680 options.debug_x11_sync = FALSE;
682 #if !defined(PLATFORM_UNIX)
683 if (*options_left == NULL) /* no options given -- enable verbose mode */
684 options.verbose = TRUE;
687 while (*options_left)
689 char option_str[MAX_OPTION_LEN];
690 char *option = options_left[0];
691 char *next_option = options_left[1];
692 char *option_arg = NULL;
693 int option_len = strlen(option);
695 if (option_len >= MAX_OPTION_LEN)
696 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
698 strcpy(option_str, option); /* copy argument into buffer */
701 if (strEqual(option, "--")) /* stop scanning arguments */
704 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
707 option_arg = strchr(option, '=');
708 if (option_arg == NULL) /* no '=' in option */
709 option_arg = next_option;
712 *option_arg++ = '\0'; /* cut argument from option */
713 if (*option_arg == '\0') /* no argument after '=' */
714 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
717 option_len = strlen(option);
719 if (strEqual(option, "-"))
720 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
721 else if (strncmp(option, "-help", option_len) == 0)
723 print_usage_function();
727 else if (strncmp(option, "-display", option_len) == 0)
729 if (option_arg == NULL)
730 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
732 options.display_name = option_arg;
733 if (option_arg == next_option)
736 else if (strncmp(option, "-basepath", option_len) == 0)
738 if (option_arg == NULL)
739 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
741 /* this should be extended to separate options for ro and rw data */
742 options.ro_base_directory = ro_base_path = option_arg;
743 options.rw_base_directory = rw_base_path = option_arg;
744 if (option_arg == next_option)
747 /* adjust paths for sub-directories in base directory accordingly */
748 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
749 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
750 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
751 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
752 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
754 else if (strncmp(option, "-levels", option_len) == 0)
756 if (option_arg == NULL)
757 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
759 options.level_directory = option_arg;
760 if (option_arg == next_option)
763 else if (strncmp(option, "-graphics", option_len) == 0)
765 if (option_arg == NULL)
766 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
768 options.graphics_directory = option_arg;
769 if (option_arg == next_option)
772 else if (strncmp(option, "-sounds", option_len) == 0)
774 if (option_arg == NULL)
775 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
777 options.sounds_directory = option_arg;
778 if (option_arg == next_option)
781 else if (strncmp(option, "-music", option_len) == 0)
783 if (option_arg == NULL)
784 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
786 options.music_directory = option_arg;
787 if (option_arg == next_option)
790 else if (strncmp(option, "-network", option_len) == 0)
792 options.network = TRUE;
794 else if (strncmp(option, "-serveronly", option_len) == 0)
796 options.serveronly = TRUE;
798 else if (strncmp(option, "-verbose", option_len) == 0)
800 options.verbose = TRUE;
802 else if (strncmp(option, "-debug", option_len) == 0)
804 options.debug = TRUE;
806 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
808 options.debug_x11_sync = TRUE;
810 else if (strncmp(option, "-execute", option_len) == 0)
812 if (option_arg == NULL)
813 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
815 options.execute_command = option_arg;
816 if (option_arg == next_option)
819 /* when doing batch processing, always enable verbose mode (warnings) */
820 options.verbose = TRUE;
822 else if (*option == '-')
824 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
826 else if (options.server_host == NULL)
828 options.server_host = *options_left;
830 else if (options.server_port == 0)
832 options.server_port = atoi(*options_left);
833 if (options.server_port < 1024)
834 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
837 Error(ERR_EXIT_HELP, "too many arguments");
844 /* ------------------------------------------------------------------------- */
845 /* error handling functions */
846 /* ------------------------------------------------------------------------- */
848 /* used by SetError() and GetError() to store internal error messages */
849 static char internal_error[1024]; /* this is bad */
851 void SetError(char *format, ...)
855 va_start(ap, format);
856 vsprintf(internal_error, format, ap);
862 return internal_error;
865 void Error(int mode, char *format, ...)
867 static boolean last_line_was_separator = FALSE;
868 char *process_name = "";
870 /* display warnings only when running in verbose mode */
871 if (mode & ERR_WARN && !options.verbose)
874 if (mode == ERR_INFO_LINE)
876 if (!last_line_was_separator)
877 fprintf_line(program.error_file, format, 79);
879 last_line_was_separator = TRUE;
884 last_line_was_separator = FALSE;
886 if (mode & ERR_SOUND_SERVER)
887 process_name = " sound server";
888 else if (mode & ERR_NETWORK_SERVER)
889 process_name = " network server";
890 else if (mode & ERR_NETWORK_CLIENT)
891 process_name = " network client **";
897 fprintf(program.error_file, "%s%s: ", program.command_basename,
901 fprintf(program.error_file, "warning: ");
903 va_start(ap, format);
904 vfprintf_newline(program.error_file, format, ap);
909 fprintf_newline(program.error_file,
910 "%s: Try option '--help' for more information.",
911 program.command_basename);
914 fprintf_newline(program.error_file, "%s%s: aborting",
915 program.command_basename, process_name);
919 if (mode & ERR_FROM_SERVER)
920 exit(1); /* child process: normal exit */
922 program.exit_function(1); /* main process: clean up stuff */
927 /* ------------------------------------------------------------------------- */
928 /* checked memory allocation and freeing functions */
929 /* ------------------------------------------------------------------------- */
931 void *checked_malloc(unsigned long size)
938 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
943 void *checked_calloc(unsigned long size)
947 ptr = calloc(1, size);
950 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
955 void *checked_realloc(void *ptr, unsigned long size)
957 ptr = realloc(ptr, size);
960 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
965 void checked_free(void *ptr)
967 if (ptr != NULL) /* this check should be done by free() anyway */
971 void clear_mem(void *ptr, unsigned long size)
973 #if defined(PLATFORM_WIN32)
974 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
975 char *cptr = (char *)ptr;
980 memset(ptr, 0, size);
985 /* ------------------------------------------------------------------------- */
986 /* various helper functions */
987 /* ------------------------------------------------------------------------- */
989 inline void swap_numbers(int *i1, int *i2)
997 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1009 /* the "put" variants of the following file access functions check for the file
1010 pointer being != NULL and return the number of bytes they have or would have
1011 written; this allows for chunk writing functions to first determine the size
1012 of the (not yet written) chunk, write the correct chunk size and finally
1013 write the chunk itself */
1015 int getFile8BitInteger(FILE *file)
1020 int putFile8BitInteger(FILE *file, int value)
1028 int getFile16BitInteger(FILE *file, int byte_order)
1030 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1031 return ((fgetc(file) << 8) |
1032 (fgetc(file) << 0));
1033 else /* BYTE_ORDER_LITTLE_ENDIAN */
1034 return ((fgetc(file) << 0) |
1035 (fgetc(file) << 8));
1038 int putFile16BitInteger(FILE *file, int value, int byte_order)
1042 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1044 fputc((value >> 8) & 0xff, file);
1045 fputc((value >> 0) & 0xff, file);
1047 else /* BYTE_ORDER_LITTLE_ENDIAN */
1049 fputc((value >> 0) & 0xff, file);
1050 fputc((value >> 8) & 0xff, file);
1057 int getFile32BitInteger(FILE *file, int byte_order)
1059 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1060 return ((fgetc(file) << 24) |
1061 (fgetc(file) << 16) |
1062 (fgetc(file) << 8) |
1063 (fgetc(file) << 0));
1064 else /* BYTE_ORDER_LITTLE_ENDIAN */
1065 return ((fgetc(file) << 0) |
1066 (fgetc(file) << 8) |
1067 (fgetc(file) << 16) |
1068 (fgetc(file) << 24));
1071 int putFile32BitInteger(FILE *file, int value, int byte_order)
1075 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1077 fputc((value >> 24) & 0xff, file);
1078 fputc((value >> 16) & 0xff, file);
1079 fputc((value >> 8) & 0xff, file);
1080 fputc((value >> 0) & 0xff, file);
1082 else /* BYTE_ORDER_LITTLE_ENDIAN */
1084 fputc((value >> 0) & 0xff, file);
1085 fputc((value >> 8) & 0xff, file);
1086 fputc((value >> 16) & 0xff, file);
1087 fputc((value >> 24) & 0xff, file);
1094 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1097 const int chunk_name_length = 4;
1099 /* read chunk name */
1100 fgets(chunk_name, chunk_name_length + 1, file);
1102 if (chunk_size != NULL)
1104 /* read chunk size */
1105 *chunk_size = getFile32BitInteger(file, byte_order);
1108 return (feof(file) || ferror(file) ? FALSE : TRUE);
1111 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1116 /* write chunk name */
1118 fputs(chunk_name, file);
1120 num_bytes += strlen(chunk_name);
1122 if (chunk_size >= 0)
1124 /* write chunk size */
1126 putFile32BitInteger(file, chunk_size, byte_order);
1134 int getFileVersion(FILE *file)
1136 int version_major = fgetc(file);
1137 int version_minor = fgetc(file);
1138 int version_patch = fgetc(file);
1139 int version_build = fgetc(file);
1141 return VERSION_IDENT(version_major, version_minor, version_patch,
1145 int putFileVersion(FILE *file, int version)
1149 int version_major = VERSION_MAJOR(version);
1150 int version_minor = VERSION_MINOR(version);
1151 int version_patch = VERSION_PATCH(version);
1152 int version_build = VERSION_BUILD(version);
1154 fputc(version_major, file);
1155 fputc(version_minor, file);
1156 fputc(version_patch, file);
1157 fputc(version_build, file);
1163 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1167 for(i = 0; i < bytes && !feof(file); i++)
1168 buffer[i] = fgetc(file);
1171 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1175 for(i = 0; i < bytes; i++)
1176 fputc(buffer[i], file);
1179 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1181 while (bytes-- && !feof(file))
1185 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1192 /* ------------------------------------------------------------------------- */
1193 /* functions to translate key identifiers between different format */
1194 /* ------------------------------------------------------------------------- */
1196 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1197 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1198 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1199 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1201 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1210 /* normal cursor keys */
1211 { KSYM_Left, "XK_Left", "cursor left" },
1212 { KSYM_Right, "XK_Right", "cursor right" },
1213 { KSYM_Up, "XK_Up", "cursor up" },
1214 { KSYM_Down, "XK_Down", "cursor down" },
1216 /* keypad cursor keys */
1218 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1219 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1220 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1221 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1224 /* other keypad keys */
1225 #ifdef KSYM_KP_Enter
1226 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1227 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1228 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1229 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1230 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1231 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1235 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1236 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1237 { KSYM_Control_L, "XK_Control_L", "left control" },
1238 { KSYM_Control_R, "XK_Control_R", "right control" },
1239 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1240 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1241 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1242 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1243 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1244 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1245 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1246 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1248 /* some special keys */
1249 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1250 { KSYM_Delete, "XK_Delete", "delete" },
1251 { KSYM_Insert, "XK_Insert", "insert" },
1252 { KSYM_Tab, "XK_Tab", "tab" },
1253 { KSYM_Home, "XK_Home", "home" },
1254 { KSYM_End, "XK_End", "end" },
1255 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1256 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1257 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1259 /* ASCII 0x20 to 0x40 keys (except numbers) */
1260 { KSYM_space, "XK_space", "space" },
1261 { KSYM_exclam, "XK_exclam", "!" },
1262 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1263 { KSYM_numbersign, "XK_numbersign", "#" },
1264 { KSYM_dollar, "XK_dollar", "$" },
1265 { KSYM_percent, "XK_percent", "%" },
1266 { KSYM_ampersand, "XK_ampersand", "&" },
1267 { KSYM_apostrophe, "XK_apostrophe", "'" },
1268 { KSYM_parenleft, "XK_parenleft", "(" },
1269 { KSYM_parenright, "XK_parenright", ")" },
1270 { KSYM_asterisk, "XK_asterisk", "*" },
1271 { KSYM_plus, "XK_plus", "+" },
1272 { KSYM_comma, "XK_comma", "," },
1273 { KSYM_minus, "XK_minus", "-" },
1274 { KSYM_period, "XK_period", "." },
1275 { KSYM_slash, "XK_slash", "/" },
1276 { KSYM_colon, "XK_colon", ":" },
1277 { KSYM_semicolon, "XK_semicolon", ";" },
1278 { KSYM_less, "XK_less", "<" },
1279 { KSYM_equal, "XK_equal", "=" },
1280 { KSYM_greater, "XK_greater", ">" },
1281 { KSYM_question, "XK_question", "?" },
1282 { KSYM_at, "XK_at", "@" },
1284 /* more ASCII keys */
1285 { KSYM_bracketleft, "XK_bracketleft", "[" },
1286 { KSYM_backslash, "XK_backslash", "\\" },
1287 { KSYM_bracketright,"XK_bracketright", "]" },
1288 { KSYM_asciicircum, "XK_asciicircum", "^" },
1289 { KSYM_underscore, "XK_underscore", "_" },
1290 { KSYM_grave, "XK_grave", "grave" },
1291 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1292 { KSYM_braceleft, "XK_braceleft", "brace left" },
1293 { KSYM_bar, "XK_bar", "bar" },
1294 { KSYM_braceright, "XK_braceright", "brace right" },
1295 { KSYM_asciitilde, "XK_asciitilde", "~" },
1297 /* special (non-ASCII) keys */
1298 { KSYM_degree, "XK_degree", "°" },
1299 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1300 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1301 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1302 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1303 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1304 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1305 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1307 /* end-of-array identifier */
1313 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1315 static char name_buffer[30];
1318 if (key >= KSYM_A && key <= KSYM_Z)
1319 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1320 else if (key >= KSYM_a && key <= KSYM_z)
1321 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1322 else if (key >= KSYM_0 && key <= KSYM_9)
1323 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1324 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1325 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1326 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1327 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1328 else if (key == KSYM_UNDEFINED)
1329 strcpy(name_buffer, "(undefined)");
1336 if (key == translate_key[i].key)
1338 strcpy(name_buffer, translate_key[i].name);
1342 while (translate_key[++i].name);
1344 if (!translate_key[i].name)
1345 strcpy(name_buffer, "(unknown)");
1348 *name = name_buffer;
1350 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1352 static char name_buffer[30];
1355 if (key >= KSYM_A && key <= KSYM_Z)
1356 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1357 else if (key >= KSYM_a && key <= KSYM_z)
1358 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1359 else if (key >= KSYM_0 && key <= KSYM_9)
1360 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1361 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1362 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1363 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1364 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1365 else if (key == KSYM_UNDEFINED)
1366 strcpy(name_buffer, "[undefined]");
1373 if (key == translate_key[i].key)
1375 strcpy(name_buffer, translate_key[i].x11name);
1379 while (translate_key[++i].x11name);
1381 if (!translate_key[i].x11name)
1382 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1385 *x11name = name_buffer;
1387 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1389 Key key = KSYM_UNDEFINED;
1394 if (strEqual(translate_key[i].name, *name))
1396 key = translate_key[i].key;
1400 while (translate_key[++i].x11name);
1402 if (key == KSYM_UNDEFINED)
1403 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1407 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1409 Key key = KSYM_UNDEFINED;
1410 char *name_ptr = *x11name;
1412 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1414 char c = name_ptr[3];
1416 if (c >= 'A' && c <= 'Z')
1417 key = KSYM_A + (Key)(c - 'A');
1418 else if (c >= 'a' && c <= 'z')
1419 key = KSYM_a + (Key)(c - 'a');
1420 else if (c >= '0' && c <= '9')
1421 key = KSYM_0 + (Key)(c - '0');
1423 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1425 char c = name_ptr[6];
1427 if (c >= '0' && c <= '9')
1428 key = KSYM_KP_0 + (Key)(c - '0');
1430 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1432 char c1 = name_ptr[4];
1433 char c2 = name_ptr[5];
1436 if ((c1 >= '0' && c1 <= '9') &&
1437 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1438 d = atoi(&name_ptr[4]);
1440 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1441 key = KSYM_F1 + (Key)(d - 1);
1443 else if (strncmp(name_ptr, "XK_", 3) == 0)
1449 if (strEqual(name_ptr, translate_key[i].x11name))
1451 key = translate_key[i].key;
1455 while (translate_key[++i].x11name);
1457 else if (strncmp(name_ptr, "0x", 2) == 0)
1459 unsigned long value = 0;
1465 char c = *name_ptr++;
1468 if (c >= '0' && c <= '9')
1470 else if (c >= 'a' && c <= 'f')
1471 d = (int)(c - 'a' + 10);
1472 else if (c >= 'A' && c <= 'F')
1473 d = (int)(c - 'A' + 10);
1481 value = value * 16 + d;
1492 char *getKeyNameFromKey(Key key)
1496 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1500 char *getX11KeyNameFromKey(Key key)
1504 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1508 Key getKeyFromKeyName(char *name)
1512 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1516 Key getKeyFromX11KeyName(char *x11name)
1520 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1524 char getCharFromKey(Key key)
1526 char *keyname = getKeyNameFromKey(key);
1529 if (strlen(keyname) == 1)
1531 else if (strEqual(keyname, "space"))
1537 char getValidConfigValueChar(char c)
1539 if (c == '#' || /* used to mark comments */
1540 c == '\\') /* used to mark continued lines */
1547 /* ------------------------------------------------------------------------- */
1548 /* functions to translate string identifiers to integer or boolean value */
1549 /* ------------------------------------------------------------------------- */
1551 int get_integer_from_string(char *s)
1553 static char *number_text[][3] =
1555 { "0", "zero", "null", },
1556 { "1", "one", "first" },
1557 { "2", "two", "second" },
1558 { "3", "three", "third" },
1559 { "4", "four", "fourth" },
1560 { "5", "five", "fifth" },
1561 { "6", "six", "sixth" },
1562 { "7", "seven", "seventh" },
1563 { "8", "eight", "eighth" },
1564 { "9", "nine", "ninth" },
1565 { "10", "ten", "tenth" },
1566 { "11", "eleven", "eleventh" },
1567 { "12", "twelve", "twelfth" },
1569 { NULL, NULL, NULL },
1573 char *s_lower = getStringToLower(s);
1576 for (i = 0; number_text[i][0] != NULL; i++)
1577 for (j = 0; j < 3; j++)
1578 if (strEqual(s_lower, number_text[i][j]))
1583 if (strEqual(s_lower, "false") ||
1584 strEqual(s_lower, "no") ||
1585 strEqual(s_lower, "off"))
1587 else if (strEqual(s_lower, "true") ||
1588 strEqual(s_lower, "yes") ||
1589 strEqual(s_lower, "on"))
1600 boolean get_boolean_from_string(char *s)
1602 char *s_lower = getStringToLower(s);
1603 boolean result = FALSE;
1605 if (strEqual(s_lower, "true") ||
1606 strEqual(s_lower, "yes") ||
1607 strEqual(s_lower, "on") ||
1608 get_integer_from_string(s) == 1)
1616 int get_switch3_from_string(char *s)
1618 char *s_lower = getStringToLower(s);
1621 if (strEqual(s_lower, "true") ||
1622 strEqual(s_lower, "yes") ||
1623 strEqual(s_lower, "on") ||
1624 get_integer_from_string(s) == 1)
1626 else if (strEqual(s_lower, "auto"))
1635 /* ------------------------------------------------------------------------- */
1636 /* functions for generic lists */
1637 /* ------------------------------------------------------------------------- */
1639 ListNode *newListNode()
1641 return checked_calloc(sizeof(ListNode));
1644 void addNodeToList(ListNode **node_first, char *key, void *content)
1646 ListNode *node_new = newListNode();
1648 node_new->key = getStringCopy(key);
1649 node_new->content = content;
1650 node_new->next = *node_first;
1651 *node_first = node_new;
1654 void deleteNodeFromList(ListNode **node_first, char *key,
1655 void (*destructor_function)(void *))
1657 if (node_first == NULL || *node_first == NULL)
1660 if (strEqual((*node_first)->key, key))
1662 checked_free((*node_first)->key);
1663 if (destructor_function)
1664 destructor_function((*node_first)->content);
1665 *node_first = (*node_first)->next;
1668 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1671 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1673 if (node_first == NULL)
1676 if (strEqual(node_first->key, key))
1679 return getNodeFromKey(node_first->next, key);
1682 int getNumNodes(ListNode *node_first)
1684 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1687 void dumpList(ListNode *node_first)
1689 ListNode *node = node_first;
1693 printf("['%s' (%d)]\n", node->key,
1694 ((struct ListNodeInfo *)node->content)->num_references);
1698 printf("[%d nodes]\n", getNumNodes(node_first));
1702 /* ------------------------------------------------------------------------- */
1703 /* functions for checking files and filenames */
1704 /* ------------------------------------------------------------------------- */
1706 boolean fileExists(char *filename)
1708 if (filename == NULL)
1711 return (access(filename, F_OK) == 0);
1714 boolean fileHasPrefix(char *basename, char *prefix)
1716 static char *basename_lower = NULL;
1717 int basename_length, prefix_length;
1719 checked_free(basename_lower);
1721 if (basename == NULL || prefix == NULL)
1724 basename_lower = getStringToLower(basename);
1725 basename_length = strlen(basename_lower);
1726 prefix_length = strlen(prefix);
1728 if (basename_length > prefix_length + 1 &&
1729 basename_lower[prefix_length] == '.' &&
1730 strncmp(basename_lower, prefix, prefix_length) == 0)
1736 boolean fileHasSuffix(char *basename, char *suffix)
1738 static char *basename_lower = NULL;
1739 int basename_length, suffix_length;
1741 checked_free(basename_lower);
1743 if (basename == NULL || suffix == NULL)
1746 basename_lower = getStringToLower(basename);
1747 basename_length = strlen(basename_lower);
1748 suffix_length = strlen(suffix);
1750 if (basename_length > suffix_length + 1 &&
1751 basename_lower[basename_length - suffix_length - 1] == '.' &&
1752 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1758 boolean FileIsGraphic(char *filename)
1760 char *basename = getBaseNamePtr(filename);
1762 return fileHasSuffix(basename, "pcx");
1765 boolean FileIsSound(char *filename)
1767 char *basename = getBaseNamePtr(filename);
1769 return fileHasSuffix(basename, "wav");
1772 boolean FileIsMusic(char *filename)
1774 char *basename = getBaseNamePtr(filename);
1776 if (FileIsSound(basename))
1779 #if defined(TARGET_SDL)
1780 if (fileHasPrefix(basename, "mod") ||
1781 fileHasSuffix(basename, "mod") ||
1782 fileHasSuffix(basename, "s3m") ||
1783 fileHasSuffix(basename, "it") ||
1784 fileHasSuffix(basename, "xm") ||
1785 fileHasSuffix(basename, "midi") ||
1786 fileHasSuffix(basename, "mid") ||
1787 fileHasSuffix(basename, "mp3") ||
1788 fileHasSuffix(basename, "ogg"))
1795 boolean FileIsArtworkType(char *basename, int type)
1797 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1798 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1799 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1805 /* ------------------------------------------------------------------------- */
1806 /* functions for loading artwork configuration information */
1807 /* ------------------------------------------------------------------------- */
1809 char *get_mapped_token(char *token)
1811 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1812 static char *map_token_prefix[][2] =
1814 { "char_procent", "char_percent" },
1819 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1821 int len_token_prefix = strlen(map_token_prefix[i][0]);
1823 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1824 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1830 /* This function checks if a string <s> of the format "string1, string2, ..."
1831 exactly contains a string <s_contained>. */
1833 static boolean string_has_parameter(char *s, char *s_contained)
1837 if (s == NULL || s_contained == NULL)
1840 if (strlen(s_contained) > strlen(s))
1843 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1845 char next_char = s[strlen(s_contained)];
1847 /* check if next character is delimiter or whitespace */
1848 return (next_char == ',' || next_char == '\0' ||
1849 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1852 /* check if string contains another parameter string after a comma */
1853 substring = strchr(s, ',');
1854 if (substring == NULL) /* string does not contain a comma */
1857 /* advance string pointer to next character after the comma */
1860 /* skip potential whitespaces after the comma */
1861 while (*substring == ' ' || *substring == '\t')
1864 return string_has_parameter(substring, s_contained);
1867 int get_parameter_value(char *value_raw, char *suffix, int type)
1869 char *value = getStringToLower(value_raw);
1870 int result = 0; /* probably a save default value */
1872 if (strEqual(suffix, ".direction"))
1874 result = (strEqual(value, "left") ? MV_LEFT :
1875 strEqual(value, "right") ? MV_RIGHT :
1876 strEqual(value, "up") ? MV_UP :
1877 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1879 else if (strEqual(suffix, ".align"))
1881 result = (strEqual(value, "left") ? ALIGN_LEFT :
1882 strEqual(value, "right") ? ALIGN_RIGHT :
1883 strEqual(value, "center") ? ALIGN_CENTER :
1884 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1886 else if (strEqual(suffix, ".valign"))
1888 result = (strEqual(value, "top") ? VALIGN_TOP :
1889 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1890 strEqual(value, "middle") ? VALIGN_MIDDLE :
1891 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1893 else if (strEqual(suffix, ".anim_mode"))
1895 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1896 string_has_parameter(value, "loop") ? ANIM_LOOP :
1897 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1898 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1899 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1900 string_has_parameter(value, "random") ? ANIM_RANDOM :
1901 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1902 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1903 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1904 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1905 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1906 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1909 if (string_has_parameter(value, "reverse"))
1910 result |= ANIM_REVERSE;
1912 if (string_has_parameter(value, "opaque_player"))
1913 result |= ANIM_OPAQUE_PLAYER;
1915 if (string_has_parameter(value, "static_panel"))
1916 result |= ANIM_STATIC_PANEL;
1918 else if (strEqual(suffix, ".fade_mode"))
1920 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
1921 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
1922 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
1923 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
1927 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
1929 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
1932 result = gfx.get_font_from_token_function(value);
1934 else /* generic parameter of type integer or boolean */
1936 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1937 type == TYPE_INTEGER ? get_integer_from_string(value) :
1938 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1939 ARG_UNDEFINED_VALUE);
1947 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1949 static struct ScreenModeInfo screen_mode;
1950 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1951 char *screen_mode_string_copy;
1952 char *screen_mode_string_pos_w;
1953 char *screen_mode_string_pos_h;
1955 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1958 screen_mode_string_copy = getStringCopy(screen_mode_string);
1960 screen_mode_string_pos_w = screen_mode_string_copy;
1961 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1962 *screen_mode_string_pos_h++ = '\0';
1964 screen_mode.width = atoi(screen_mode_string_pos_w);
1965 screen_mode.height = atoi(screen_mode_string_pos_h);
1967 return &screen_mode;
1970 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1973 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1974 float aspect_ratio_new;
1979 *x = i * aspect_ratio + 0.000001;
1982 aspect_ratio_new = (float)*x / (float)*y;
1986 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1989 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1990 struct ListNodeInfo ***, int *);
1992 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1993 struct ConfigTypeInfo *suffix_list,
1994 char **ignore_tokens,
1995 int num_file_list_entries)
1997 struct FileInfo *file_list;
1998 int num_file_list_entries_found = 0;
1999 int num_suffix_list_entries = 0;
2003 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2005 for (i = 0; suffix_list[i].token != NULL; i++)
2006 num_suffix_list_entries++;
2008 /* always start with reliable default values */
2009 for (i = 0; i < num_file_list_entries; i++)
2011 file_list[i].token = NULL;
2013 file_list[i].default_filename = NULL;
2014 file_list[i].filename = NULL;
2016 if (num_suffix_list_entries > 0)
2018 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2020 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2021 file_list[i].parameter = checked_calloc(parameter_array_size);
2023 for (j = 0; j < num_suffix_list_entries; j++)
2025 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2026 setString(&file_list[i].parameter[j], suffix_list[j].value);
2029 file_list[i].redefined = FALSE;
2030 file_list[i].fallback_to_default = FALSE;
2031 file_list[i].default_is_cloned = FALSE;
2036 for (i = 0; config_list[i].token != NULL; i++)
2038 int len_config_token = strlen(config_list[i].token);
2039 int len_config_value = strlen(config_list[i].value);
2040 boolean is_file_entry = TRUE;
2042 for (j = 0; suffix_list[j].token != NULL; j++)
2044 int len_suffix = strlen(suffix_list[j].token);
2046 if (len_suffix < len_config_token &&
2047 strEqual(&config_list[i].token[len_config_token - len_suffix],
2048 suffix_list[j].token))
2050 setString(&file_list[list_pos].default_parameter[j],
2051 config_list[i].value);
2053 is_file_entry = FALSE;
2058 /* the following tokens are no file definitions, but other config tokens */
2059 for (j = 0; ignore_tokens[j] != NULL; j++)
2060 if (strEqual(config_list[i].token, ignore_tokens[j]))
2061 is_file_entry = FALSE;
2068 if (list_pos >= num_file_list_entries)
2071 /* simple sanity check if this is really a file definition */
2072 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2073 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2074 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2076 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2077 config_list[i].token, config_list[i].value);
2078 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2081 file_list[list_pos].token = config_list[i].token;
2082 file_list[list_pos].default_filename = config_list[i].value;
2085 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2089 if (strSuffix(config_list[i].token, ".clone_from"))
2090 file_list[list_pos].default_is_cloned = TRUE;
2093 num_file_list_entries_found = list_pos + 1;
2094 if (num_file_list_entries_found != num_file_list_entries)
2096 Error(ERR_INFO_LINE, "-");
2097 Error(ERR_INFO, "inconsistant config list information:");
2098 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2099 num_file_list_entries);
2100 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2101 num_file_list_entries_found);
2102 Error(ERR_EXIT, "please fix");
2106 printf("::: ---------- DONE ----------\n");
2112 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2114 int len_token = strlen(token);
2115 int len_suffix = strlen(suffix);
2117 if (start_pos < 0) /* compare suffix from end of string */
2118 start_pos += len_token;
2120 if (start_pos < 0 || start_pos + len_suffix > len_token)
2123 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2126 if (token[start_pos + len_suffix] == '\0')
2129 if (token[start_pos + len_suffix] == '.')
2135 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2137 static void read_token_parameters(SetupFileHash *setup_file_hash,
2138 struct ConfigTypeInfo *suffix_list,
2139 struct FileInfo *file_list_entry)
2141 /* check for config token that is the base token without any suffixes */
2142 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2143 char *known_token_value = KNOWN_TOKEN_VALUE;
2146 if (filename != NULL)
2148 setString(&file_list_entry->filename, filename);
2150 /* when file definition found, set all parameters to default values */
2151 for (i = 0; suffix_list[i].token != NULL; i++)
2152 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2154 file_list_entry->redefined = TRUE;
2156 /* mark config file token as well known from default config */
2157 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2160 /* check for config tokens that can be build by base token and suffixes */
2161 for (i = 0; suffix_list[i].token != NULL; i++)
2163 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2164 char *value = getHashEntry(setup_file_hash, token);
2168 setString(&file_list_entry->parameter[i], value);
2170 /* mark config file token as well known from default config */
2171 setHashEntry(setup_file_hash, token, known_token_value);
2178 static void add_dynamic_file_list_entry(struct FileInfo **list,
2179 int *num_list_entries,
2180 SetupFileHash *extra_file_hash,
2181 struct ConfigTypeInfo *suffix_list,
2182 int num_suffix_list_entries,
2185 struct FileInfo *new_list_entry;
2186 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2188 (*num_list_entries)++;
2189 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2190 new_list_entry = &(*list)[*num_list_entries - 1];
2192 new_list_entry->token = getStringCopy(token);
2193 new_list_entry->default_filename = NULL;
2194 new_list_entry->filename = NULL;
2195 new_list_entry->parameter = checked_calloc(parameter_array_size);
2197 new_list_entry->redefined = FALSE;
2198 new_list_entry->fallback_to_default = FALSE;
2199 new_list_entry->default_is_cloned = FALSE;
2201 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2204 static void add_property_mapping(struct PropertyMapping **list,
2205 int *num_list_entries,
2206 int base_index, int ext1_index,
2207 int ext2_index, int ext3_index,
2210 struct PropertyMapping *new_list_entry;
2212 (*num_list_entries)++;
2213 *list = checked_realloc(*list,
2214 *num_list_entries * sizeof(struct PropertyMapping));
2215 new_list_entry = &(*list)[*num_list_entries - 1];
2217 new_list_entry->base_index = base_index;
2218 new_list_entry->ext1_index = ext1_index;
2219 new_list_entry->ext2_index = ext2_index;
2220 new_list_entry->ext3_index = ext3_index;
2222 new_list_entry->artwork_index = artwork_index;
2225 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2228 struct FileInfo *file_list = artwork_info->file_list;
2229 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2230 char **base_prefixes = artwork_info->base_prefixes;
2231 char **ext1_suffixes = artwork_info->ext1_suffixes;
2232 char **ext2_suffixes = artwork_info->ext2_suffixes;
2233 char **ext3_suffixes = artwork_info->ext3_suffixes;
2234 char **ignore_tokens = artwork_info->ignore_tokens;
2235 int num_file_list_entries = artwork_info->num_file_list_entries;
2236 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2237 int num_base_prefixes = artwork_info->num_base_prefixes;
2238 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2239 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2240 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2241 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2242 SetupFileHash *setup_file_hash, *valid_file_hash;
2243 SetupFileHash *extra_file_hash, *empty_file_hash;
2244 char *known_token_value = KNOWN_TOKEN_VALUE;
2247 if (filename == NULL)
2251 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2254 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2257 /* separate valid (defined) from empty (undefined) config token values */
2258 valid_file_hash = newSetupFileHash();
2259 empty_file_hash = newSetupFileHash();
2260 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2262 char *value = HASH_ITERATION_VALUE(itr);
2264 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2265 HASH_ITERATION_TOKEN(itr), value);
2267 END_HASH_ITERATION(setup_file_hash, itr)
2269 /* at this point, we do not need the setup file hash anymore -- free it */
2270 freeSetupFileHash(setup_file_hash);
2272 /* map deprecated to current tokens (using prefix match and replace) */
2273 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2275 char *token = HASH_ITERATION_TOKEN(itr);
2276 char *mapped_token = get_mapped_token(token);
2278 if (mapped_token != NULL)
2280 char *value = HASH_ITERATION_VALUE(itr);
2282 /* add mapped token */
2283 setHashEntry(valid_file_hash, mapped_token, value);
2285 /* ignore old token (by setting it to "known" keyword) */
2286 setHashEntry(valid_file_hash, token, known_token_value);
2291 END_HASH_ITERATION(valid_file_hash, itr)
2293 /* read parameters for all known config file tokens */
2294 for (i = 0; i < num_file_list_entries; i++)
2295 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2297 /* set all tokens that can be ignored here to "known" keyword */
2298 for (i = 0; i < num_ignore_tokens; i++)
2299 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2301 /* copy all unknown config file tokens to extra config hash */
2302 extra_file_hash = newSetupFileHash();
2303 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2305 char *value = HASH_ITERATION_VALUE(itr);
2307 if (!strEqual(value, known_token_value))
2308 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2310 END_HASH_ITERATION(valid_file_hash, itr)
2312 /* at this point, we do not need the valid file hash anymore -- free it */
2313 freeSetupFileHash(valid_file_hash);
2315 /* now try to determine valid, dynamically defined config tokens */
2317 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2319 struct FileInfo **dynamic_file_list =
2320 &artwork_info->dynamic_file_list;
2321 int *num_dynamic_file_list_entries =
2322 &artwork_info->num_dynamic_file_list_entries;
2323 struct PropertyMapping **property_mapping =
2324 &artwork_info->property_mapping;
2325 int *num_property_mapping_entries =
2326 &artwork_info->num_property_mapping_entries;
2327 int current_summarized_file_list_entry =
2328 artwork_info->num_file_list_entries +
2329 artwork_info->num_dynamic_file_list_entries;
2330 char *token = HASH_ITERATION_TOKEN(itr);
2331 int len_token = strlen(token);
2333 boolean base_prefix_found = FALSE;
2334 boolean parameter_suffix_found = FALSE;
2337 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2340 /* skip all parameter definitions (handled by read_token_parameters()) */
2341 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2343 int len_suffix = strlen(suffix_list[i].token);
2345 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2346 parameter_suffix_found = TRUE;
2349 if (parameter_suffix_found)
2352 /* ---------- step 0: search for matching base prefix ---------- */
2355 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2357 char *base_prefix = base_prefixes[i];
2358 int len_base_prefix = strlen(base_prefix);
2359 boolean ext1_suffix_found = FALSE;
2360 boolean ext2_suffix_found = FALSE;
2361 boolean ext3_suffix_found = FALSE;
2362 boolean exact_match = FALSE;
2363 int base_index = -1;
2364 int ext1_index = -1;
2365 int ext2_index = -1;
2366 int ext3_index = -1;
2368 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2370 if (!base_prefix_found)
2376 if (IS_PARENT_PROCESS())
2377 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2380 if (start_pos + len_base_prefix == len_token) /* exact match */
2385 if (IS_PARENT_PROCESS())
2386 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2389 add_dynamic_file_list_entry(dynamic_file_list,
2390 num_dynamic_file_list_entries,
2393 num_suffix_list_entries,
2395 add_property_mapping(property_mapping,
2396 num_property_mapping_entries,
2397 base_index, -1, -1, -1,
2398 current_summarized_file_list_entry);
2403 if (IS_PARENT_PROCESS())
2404 printf("---> examining token '%s': search 1st suffix ...\n", token);
2407 /* ---------- step 1: search for matching first suffix ---------- */
2409 start_pos += len_base_prefix;
2410 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2412 char *ext1_suffix = ext1_suffixes[j];
2413 int len_ext1_suffix = strlen(ext1_suffix);
2415 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2417 if (!ext1_suffix_found)
2423 if (IS_PARENT_PROCESS())
2424 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2427 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2432 if (IS_PARENT_PROCESS())
2433 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2436 add_dynamic_file_list_entry(dynamic_file_list,
2437 num_dynamic_file_list_entries,
2440 num_suffix_list_entries,
2442 add_property_mapping(property_mapping,
2443 num_property_mapping_entries,
2444 base_index, ext1_index, -1, -1,
2445 current_summarized_file_list_entry);
2449 start_pos += len_ext1_suffix;
2456 if (IS_PARENT_PROCESS())
2457 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2460 /* ---------- step 2: search for matching second suffix ---------- */
2462 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2464 char *ext2_suffix = ext2_suffixes[k];
2465 int len_ext2_suffix = strlen(ext2_suffix);
2467 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2469 if (!ext2_suffix_found)
2475 if (IS_PARENT_PROCESS())
2476 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2479 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2484 if (IS_PARENT_PROCESS())
2485 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2488 add_dynamic_file_list_entry(dynamic_file_list,
2489 num_dynamic_file_list_entries,
2492 num_suffix_list_entries,
2494 add_property_mapping(property_mapping,
2495 num_property_mapping_entries,
2496 base_index, ext1_index, ext2_index, -1,
2497 current_summarized_file_list_entry);
2501 start_pos += len_ext2_suffix;
2508 if (IS_PARENT_PROCESS())
2509 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2512 /* ---------- step 3: search for matching third suffix ---------- */
2514 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2516 char *ext3_suffix = ext3_suffixes[l];
2517 int len_ext3_suffix = strlen(ext3_suffix);
2519 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2521 if (!ext3_suffix_found)
2527 if (IS_PARENT_PROCESS())
2528 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2531 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2536 if (IS_PARENT_PROCESS())
2537 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2540 add_dynamic_file_list_entry(dynamic_file_list,
2541 num_dynamic_file_list_entries,
2544 num_suffix_list_entries,
2546 add_property_mapping(property_mapping,
2547 num_property_mapping_entries,
2548 base_index, ext1_index, ext2_index, ext3_index,
2549 current_summarized_file_list_entry);
2555 END_HASH_ITERATION(extra_file_hash, itr)
2557 if (artwork_info->num_dynamic_file_list_entries > 0)
2559 artwork_info->dynamic_artwork_list =
2560 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2561 artwork_info->sizeof_artwork_list_entry);
2564 if (options.verbose && IS_PARENT_PROCESS())
2566 SetupFileList *setup_file_list, *list;
2567 boolean dynamic_tokens_found = FALSE;
2568 boolean unknown_tokens_found = FALSE;
2569 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2571 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2572 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2574 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2576 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2577 dynamic_tokens_found = TRUE;
2579 unknown_tokens_found = TRUE;
2581 END_HASH_ITERATION(extra_file_hash, itr)
2583 if (options.debug && dynamic_tokens_found)
2585 Error(ERR_INFO_LINE, "-");
2586 Error(ERR_INFO, "dynamic token(s) found in config file:");
2587 Error(ERR_INFO, "- config file: '%s'", filename);
2589 for (list = setup_file_list; list != NULL; list = list->next)
2591 char *value = getHashEntry(extra_file_hash, list->token);
2593 if (value != NULL && strEqual(value, known_token_value))
2594 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2597 Error(ERR_INFO_LINE, "-");
2600 if (unknown_tokens_found)
2602 Error(ERR_INFO_LINE, "-");
2603 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2604 Error(ERR_INFO, "- config file: '%s'", filename);
2606 for (list = setup_file_list; list != NULL; list = list->next)
2608 char *value = getHashEntry(extra_file_hash, list->token);
2610 if (value != NULL && !strEqual(value, known_token_value))
2611 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2614 Error(ERR_INFO_LINE, "-");
2617 if (undefined_values_found)
2619 Error(ERR_INFO_LINE, "-");
2620 Error(ERR_INFO, "warning: undefined values found in config file:");
2621 Error(ERR_INFO, "- config file: '%s'", filename);
2623 for (list = setup_file_list; list != NULL; list = list->next)
2625 char *value = getHashEntry(empty_file_hash, list->token);
2628 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2631 Error(ERR_INFO_LINE, "-");
2634 freeSetupFileList(setup_file_list);
2637 freeSetupFileHash(extra_file_hash);
2638 freeSetupFileHash(empty_file_hash);
2641 for (i = 0; i < num_file_list_entries; i++)
2643 printf("'%s' ", file_list[i].token);
2644 if (file_list[i].filename)
2645 printf("-> '%s'\n", file_list[i].filename);
2647 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2652 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2654 struct FileInfo *file_list = artwork_info->file_list;
2655 int num_file_list_entries = artwork_info->num_file_list_entries;
2656 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2657 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2660 DrawInitText("Loading artwork config", 120, FC_GREEN);
2661 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2663 /* always start with reliable default values */
2664 for (i = 0; i < num_file_list_entries; i++)
2666 setString(&file_list[i].filename, file_list[i].default_filename);
2668 for (j = 0; j < num_suffix_list_entries; j++)
2669 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2671 file_list[i].redefined = FALSE;
2672 file_list[i].fallback_to_default = FALSE;
2675 /* free previous dynamic artwork file array */
2676 if (artwork_info->dynamic_file_list != NULL)
2678 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2680 free(artwork_info->dynamic_file_list[i].token);
2681 free(artwork_info->dynamic_file_list[i].filename);
2682 free(artwork_info->dynamic_file_list[i].parameter);
2685 free(artwork_info->dynamic_file_list);
2686 artwork_info->dynamic_file_list = NULL;
2688 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2689 &artwork_info->num_dynamic_file_list_entries);
2692 /* free previous property mapping */
2693 if (artwork_info->property_mapping != NULL)
2695 free(artwork_info->property_mapping);
2697 artwork_info->property_mapping = NULL;
2698 artwork_info->num_property_mapping_entries = 0;
2702 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2704 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2707 /* first look for special artwork configured in level series config */
2708 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2711 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2712 leveldir_current->graphics_set,
2713 leveldir_current->graphics_path);
2716 if (fileExists(filename_base))
2717 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2720 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2722 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2723 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2726 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2727 struct ListNodeInfo **listnode)
2731 char *filename = (*listnode)->source_filename;
2733 if (--(*listnode)->num_references <= 0)
2734 deleteNodeFromList(&artwork_info->content_list, filename,
2735 artwork_info->free_artwork);
2741 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2742 struct ListNodeInfo **listnode,
2743 struct FileInfo *file_list_entry)
2753 char *basename = file_list_entry->filename;
2754 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2756 if (filename == NULL)
2758 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2760 basename = file_list_entry->default_filename;
2762 /* fail for cloned default artwork that has no default filename defined */
2763 if (file_list_entry->default_is_cloned &&
2764 strEqual(basename, UNDEFINED_FILENAME))
2766 int error_mode = ERR_WARN;
2768 /* we can get away without sounds and music, but not without graphics */
2769 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2770 error_mode = ERR_EXIT;
2772 Error(error_mode, "token '%s' was cloned and has no default filename",
2773 file_list_entry->token);
2778 /* dynamic artwork has no default filename / skip empty default artwork */
2779 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2782 file_list_entry->fallback_to_default = TRUE;
2784 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2786 filename = getCustomArtworkFilename(basename, artwork_info->type);
2788 if (filename == NULL)
2790 int error_mode = ERR_WARN;
2792 /* we can get away without sounds and music, but not without graphics */
2793 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2794 error_mode = ERR_EXIT;
2796 Error(error_mode, "cannot find default artwork file '%s'", basename);
2802 /* check if the old and the new artwork file are the same */
2803 if (*listnode && strEqual((*listnode)->source_filename, filename))
2805 /* The old and new artwork are the same (have the same filename and path).
2806 This usually means that this artwork does not exist in this artwork set
2807 and a fallback to the existing artwork is done. */
2810 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2816 /* delete existing artwork file entry */
2817 deleteArtworkListEntry(artwork_info, listnode);
2819 /* check if the new artwork file already exists in the list of artworks */
2820 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2823 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2826 *listnode = (struct ListNodeInfo *)node->content;
2827 (*listnode)->num_references++;
2832 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2833 DrawInitText(basename, 150, FC_YELLOW);
2835 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2838 printf("[adding new artwork '%s']\n", filename);
2841 (*listnode)->num_references = 1;
2842 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2847 int error_mode = ERR_WARN;
2849 /* we can get away without sounds and music, but not without graphics */
2850 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2851 error_mode = ERR_EXIT;
2853 Error(error_mode, "cannot load artwork file '%s'", basename);
2859 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2860 struct ListNodeInfo **listnode,
2861 struct FileInfo *file_list_entry)
2864 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2867 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2869 deleteArtworkListEntry(artwork_info, listnode);
2873 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2876 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2878 struct FileInfo *file_list = artwork_info->file_list;
2879 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2880 int num_file_list_entries = artwork_info->num_file_list_entries;
2881 int num_dynamic_file_list_entries =
2882 artwork_info->num_dynamic_file_list_entries;
2885 for (i = 0; i < num_file_list_entries; i++)
2886 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2889 for (i = 0; i < num_dynamic_file_list_entries; i++)
2890 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2891 &dynamic_file_list[i]);
2894 dumpList(artwork_info->content_list);
2898 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2899 struct ListNodeInfo ***list,
2900 int *num_list_entries)
2907 for (i = 0; i < *num_list_entries; i++)
2908 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2912 *num_list_entries = 0;
2915 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2917 if (artwork_info == NULL)
2920 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2921 &artwork_info->num_file_list_entries);
2923 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2924 &artwork_info->num_dynamic_file_list_entries);
2928 /* ------------------------------------------------------------------------- */
2929 /* functions only needed for non-Unix (non-command-line) systems */
2930 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2931 /* (now also added for Windows, to create files in user data directory) */
2932 /* ------------------------------------------------------------------------- */
2934 char *getErrorFilename(char *basename)
2936 return getPath2(getUserGameDataDir(), basename);
2939 void openErrorFile()
2941 InitUserDataDirectory();
2943 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2944 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2945 program.error_filename);
2948 void closeErrorFile()
2950 if (program.error_file != stderr) /* do not close stream 'stderr' */
2951 fclose(program.error_file);
2954 void dumpErrorFile()
2956 FILE *error_file = fopen(program.error_filename, MODE_READ);
2958 if (error_file != NULL)
2960 while (!feof(error_file))
2961 fputc(fgetc(error_file), stderr);
2967 void NotifyUserAboutErrorFile()
2969 #if defined(PLATFORM_WIN32)
2970 char *title_text = getStringCat2(program.program_title, " Error Message");
2971 char *error_text = getStringCat2("The program was aborted due to an error; "
2972 "for details, see the following error file:"
2973 STRING_NEWLINE, program.error_filename);
2975 MessageBox(NULL, error_text, title_text, MB_OK);
2980 /* ------------------------------------------------------------------------- */
2981 /* the following is only for debugging purpose and normally not used */
2982 /* ------------------------------------------------------------------------- */
2986 #define DEBUG_NUM_TIMESTAMPS 5
2987 #define DEBUG_TIME_IN_MICROSECONDS 0
2989 #if DEBUG_TIME_IN_MICROSECONDS
2990 static double Counter_Microseconds()
2992 static struct timeval base_time = { 0, 0 };
2993 struct timeval current_time;
2996 gettimeofday(¤t_time, NULL);
2998 /* reset base time in case of wrap-around */
2999 if (current_time.tv_sec < base_time.tv_sec)
3000 base_time = current_time;
3003 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3004 ((double)(current_time.tv_usec - base_time.tv_usec));
3006 return counter; /* return microseconds since last init */
3010 char *debug_print_timestamp_get_padding(int padding_size)
3012 static char *padding = NULL;
3013 int max_padding_size = 100;
3015 if (padding == NULL)
3017 padding = checked_calloc(max_padding_size + 1);
3018 memset(padding, ' ', max_padding_size);
3021 return &padding[MAX(0, max_padding_size - padding_size)];
3024 void debug_print_timestamp(int counter_nr, char *message)
3026 int indent_size = 8;
3027 int padding_size = 40;
3028 float timestamp_interval;
3031 Error(ERR_EXIT, "debugging: invalid negative counter");
3032 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3033 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3035 #if DEBUG_TIME_IN_MICROSECONDS
3036 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3039 counter[counter_nr][0] = Counter_Microseconds();
3041 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3044 counter[counter_nr][0] = Counter();
3047 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3048 counter[counter_nr][1] = counter[counter_nr][0];
3051 printf("%s%s%s %.3f %s\n",
3052 debug_print_timestamp_get_padding(counter_nr * indent_size),
3054 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3055 timestamp_interval / 1000,
3059 void debug_print_parent_only(char *format, ...)
3061 if (!IS_PARENT_PROCESS())
3068 va_start(ap, format);
3069 vprintf(format, ap);