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);
640 boolean strPrefixLower(char *s, char *prefix)
642 char *s_lower = getStringToLower(s);
643 boolean match = strPrefix(s_lower, prefix);
650 boolean strSuffixLower(char *s, char *suffix)
652 char *s_lower = getStringToLower(s);
653 boolean match = strSuffix(s_lower, suffix);
661 /* ------------------------------------------------------------------------- */
662 /* command line option handling functions */
663 /* ------------------------------------------------------------------------- */
665 void GetOptions(char *argv[], void (*print_usage_function)(void))
667 char *ro_base_path = RO_BASE_PATH;
668 char *rw_base_path = RW_BASE_PATH;
669 char **options_left = &argv[1];
671 #if !defined(PLATFORM_MACOSX)
672 /* if the program is configured to start from current directory (default),
673 determine program package directory (KDE/Konqueror does not do this by
674 itself and fails otherwise); on Mac OS X, the program binary is stored
675 in an application package directory -- do not try to use this directory
676 as the program data directory (Mac OS X handles this correctly anyway) */
678 if (strEqual(ro_base_path, "."))
679 ro_base_path = program.command_basepath;
680 if (strEqual(rw_base_path, "."))
681 rw_base_path = program.command_basepath;
684 /* initialize global program options */
685 options.display_name = NULL;
686 options.server_host = NULL;
687 options.server_port = 0;
688 options.ro_base_directory = ro_base_path;
689 options.rw_base_directory = rw_base_path;
690 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
691 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
692 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
693 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
694 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
695 options.execute_command = NULL;
696 options.serveronly = FALSE;
697 options.network = FALSE;
698 options.verbose = FALSE;
699 options.debug = FALSE;
700 options.debug_x11_sync = FALSE;
702 #if !defined(PLATFORM_UNIX)
703 if (*options_left == NULL) /* no options given -- enable verbose mode */
704 options.verbose = TRUE;
707 while (*options_left)
709 char option_str[MAX_OPTION_LEN];
710 char *option = options_left[0];
711 char *next_option = options_left[1];
712 char *option_arg = NULL;
713 int option_len = strlen(option);
715 if (option_len >= MAX_OPTION_LEN)
716 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
718 strcpy(option_str, option); /* copy argument into buffer */
721 if (strEqual(option, "--")) /* stop scanning arguments */
724 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
727 option_arg = strchr(option, '=');
728 if (option_arg == NULL) /* no '=' in option */
729 option_arg = next_option;
732 *option_arg++ = '\0'; /* cut argument from option */
733 if (*option_arg == '\0') /* no argument after '=' */
734 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
737 option_len = strlen(option);
739 if (strEqual(option, "-"))
740 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
741 else if (strncmp(option, "-help", option_len) == 0)
743 print_usage_function();
747 else if (strncmp(option, "-display", option_len) == 0)
749 if (option_arg == NULL)
750 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
752 options.display_name = option_arg;
753 if (option_arg == next_option)
756 else if (strncmp(option, "-basepath", option_len) == 0)
758 if (option_arg == NULL)
759 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
761 /* this should be extended to separate options for ro and rw data */
762 options.ro_base_directory = ro_base_path = option_arg;
763 options.rw_base_directory = rw_base_path = option_arg;
764 if (option_arg == next_option)
767 /* adjust paths for sub-directories in base directory accordingly */
768 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
769 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
770 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
771 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
772 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
774 else if (strncmp(option, "-levels", option_len) == 0)
776 if (option_arg == NULL)
777 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
779 options.level_directory = option_arg;
780 if (option_arg == next_option)
783 else if (strncmp(option, "-graphics", option_len) == 0)
785 if (option_arg == NULL)
786 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
788 options.graphics_directory = option_arg;
789 if (option_arg == next_option)
792 else if (strncmp(option, "-sounds", option_len) == 0)
794 if (option_arg == NULL)
795 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
797 options.sounds_directory = option_arg;
798 if (option_arg == next_option)
801 else if (strncmp(option, "-music", option_len) == 0)
803 if (option_arg == NULL)
804 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
806 options.music_directory = option_arg;
807 if (option_arg == next_option)
810 else if (strncmp(option, "-network", option_len) == 0)
812 options.network = TRUE;
814 else if (strncmp(option, "-serveronly", option_len) == 0)
816 options.serveronly = TRUE;
818 else if (strncmp(option, "-verbose", option_len) == 0)
820 options.verbose = TRUE;
822 else if (strncmp(option, "-debug", option_len) == 0)
824 options.debug = TRUE;
826 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
828 options.debug_x11_sync = TRUE;
830 else if (strncmp(option, "-execute", option_len) == 0)
832 if (option_arg == NULL)
833 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
835 options.execute_command = option_arg;
836 if (option_arg == next_option)
839 /* when doing batch processing, always enable verbose mode (warnings) */
840 options.verbose = TRUE;
842 else if (*option == '-')
844 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
846 else if (options.server_host == NULL)
848 options.server_host = *options_left;
850 else if (options.server_port == 0)
852 options.server_port = atoi(*options_left);
853 if (options.server_port < 1024)
854 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
857 Error(ERR_EXIT_HELP, "too many arguments");
864 /* ------------------------------------------------------------------------- */
865 /* error handling functions */
866 /* ------------------------------------------------------------------------- */
868 /* used by SetError() and GetError() to store internal error messages */
869 static char internal_error[1024]; /* this is bad */
871 void SetError(char *format, ...)
875 va_start(ap, format);
876 vsprintf(internal_error, format, ap);
882 return internal_error;
885 void Error(int mode, char *format, ...)
887 static boolean last_line_was_separator = FALSE;
888 char *process_name = "";
890 /* display warnings only when running in verbose mode */
891 if (mode & ERR_WARN && !options.verbose)
894 if (mode == ERR_INFO_LINE)
896 if (!last_line_was_separator)
897 fprintf_line(program.error_file, format, 79);
899 last_line_was_separator = TRUE;
904 last_line_was_separator = FALSE;
906 if (mode & ERR_SOUND_SERVER)
907 process_name = " sound server";
908 else if (mode & ERR_NETWORK_SERVER)
909 process_name = " network server";
910 else if (mode & ERR_NETWORK_CLIENT)
911 process_name = " network client **";
917 fprintf(program.error_file, "%s%s: ", program.command_basename,
921 fprintf(program.error_file, "warning: ");
923 va_start(ap, format);
924 vfprintf_newline(program.error_file, format, ap);
929 fprintf_newline(program.error_file,
930 "%s: Try option '--help' for more information.",
931 program.command_basename);
934 fprintf_newline(program.error_file, "%s%s: aborting",
935 program.command_basename, process_name);
939 if (mode & ERR_FROM_SERVER)
940 exit(1); /* child process: normal exit */
942 program.exit_function(1); /* main process: clean up stuff */
947 /* ------------------------------------------------------------------------- */
948 /* checked memory allocation and freeing functions */
949 /* ------------------------------------------------------------------------- */
951 void *checked_malloc(unsigned long size)
958 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
963 void *checked_calloc(unsigned long size)
967 ptr = calloc(1, size);
970 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
975 void *checked_realloc(void *ptr, unsigned long size)
977 ptr = realloc(ptr, size);
980 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
985 void checked_free(void *ptr)
987 if (ptr != NULL) /* this check should be done by free() anyway */
991 void clear_mem(void *ptr, unsigned long size)
993 #if defined(PLATFORM_WIN32)
994 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
995 char *cptr = (char *)ptr;
1000 memset(ptr, 0, size);
1005 /* ------------------------------------------------------------------------- */
1006 /* various helper functions */
1007 /* ------------------------------------------------------------------------- */
1009 inline void swap_numbers(int *i1, int *i2)
1017 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1029 /* the "put" variants of the following file access functions check for the file
1030 pointer being != NULL and return the number of bytes they have or would have
1031 written; this allows for chunk writing functions to first determine the size
1032 of the (not yet written) chunk, write the correct chunk size and finally
1033 write the chunk itself */
1035 int getFile8BitInteger(FILE *file)
1040 int putFile8BitInteger(FILE *file, int value)
1048 int getFile16BitInteger(FILE *file, int byte_order)
1050 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1051 return ((fgetc(file) << 8) |
1052 (fgetc(file) << 0));
1053 else /* BYTE_ORDER_LITTLE_ENDIAN */
1054 return ((fgetc(file) << 0) |
1055 (fgetc(file) << 8));
1058 int putFile16BitInteger(FILE *file, int value, int byte_order)
1062 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1064 fputc((value >> 8) & 0xff, file);
1065 fputc((value >> 0) & 0xff, file);
1067 else /* BYTE_ORDER_LITTLE_ENDIAN */
1069 fputc((value >> 0) & 0xff, file);
1070 fputc((value >> 8) & 0xff, file);
1077 int getFile32BitInteger(FILE *file, int byte_order)
1079 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1080 return ((fgetc(file) << 24) |
1081 (fgetc(file) << 16) |
1082 (fgetc(file) << 8) |
1083 (fgetc(file) << 0));
1084 else /* BYTE_ORDER_LITTLE_ENDIAN */
1085 return ((fgetc(file) << 0) |
1086 (fgetc(file) << 8) |
1087 (fgetc(file) << 16) |
1088 (fgetc(file) << 24));
1091 int putFile32BitInteger(FILE *file, int value, int byte_order)
1095 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1097 fputc((value >> 24) & 0xff, file);
1098 fputc((value >> 16) & 0xff, file);
1099 fputc((value >> 8) & 0xff, file);
1100 fputc((value >> 0) & 0xff, file);
1102 else /* BYTE_ORDER_LITTLE_ENDIAN */
1104 fputc((value >> 0) & 0xff, file);
1105 fputc((value >> 8) & 0xff, file);
1106 fputc((value >> 16) & 0xff, file);
1107 fputc((value >> 24) & 0xff, file);
1114 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1117 const int chunk_name_length = 4;
1119 /* read chunk name */
1120 fgets(chunk_name, chunk_name_length + 1, file);
1122 if (chunk_size != NULL)
1124 /* read chunk size */
1125 *chunk_size = getFile32BitInteger(file, byte_order);
1128 return (feof(file) || ferror(file) ? FALSE : TRUE);
1131 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1136 /* write chunk name */
1138 fputs(chunk_name, file);
1140 num_bytes += strlen(chunk_name);
1142 if (chunk_size >= 0)
1144 /* write chunk size */
1146 putFile32BitInteger(file, chunk_size, byte_order);
1154 int getFileVersion(FILE *file)
1156 int version_major = fgetc(file);
1157 int version_minor = fgetc(file);
1158 int version_patch = fgetc(file);
1159 int version_build = fgetc(file);
1161 return VERSION_IDENT(version_major, version_minor, version_patch,
1165 int putFileVersion(FILE *file, int version)
1169 int version_major = VERSION_MAJOR(version);
1170 int version_minor = VERSION_MINOR(version);
1171 int version_patch = VERSION_PATCH(version);
1172 int version_build = VERSION_BUILD(version);
1174 fputc(version_major, file);
1175 fputc(version_minor, file);
1176 fputc(version_patch, file);
1177 fputc(version_build, file);
1183 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1187 for(i = 0; i < bytes && !feof(file); i++)
1188 buffer[i] = fgetc(file);
1191 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1195 for(i = 0; i < bytes; i++)
1196 fputc(buffer[i], file);
1199 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1201 while (bytes-- && !feof(file))
1205 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1212 /* ------------------------------------------------------------------------- */
1213 /* functions to translate key identifiers between different format */
1214 /* ------------------------------------------------------------------------- */
1216 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1217 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1218 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1219 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1221 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1230 /* normal cursor keys */
1231 { KSYM_Left, "XK_Left", "cursor left" },
1232 { KSYM_Right, "XK_Right", "cursor right" },
1233 { KSYM_Up, "XK_Up", "cursor up" },
1234 { KSYM_Down, "XK_Down", "cursor down" },
1236 /* keypad cursor keys */
1238 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1239 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1240 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1241 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1244 /* other keypad keys */
1245 #ifdef KSYM_KP_Enter
1246 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1247 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1248 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1249 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1250 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1251 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1255 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1256 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1257 { KSYM_Control_L, "XK_Control_L", "left control" },
1258 { KSYM_Control_R, "XK_Control_R", "right control" },
1259 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1260 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1261 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1262 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1263 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1264 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1265 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1266 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1268 /* some special keys */
1269 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1270 { KSYM_Delete, "XK_Delete", "delete" },
1271 { KSYM_Insert, "XK_Insert", "insert" },
1272 { KSYM_Tab, "XK_Tab", "tab" },
1273 { KSYM_Home, "XK_Home", "home" },
1274 { KSYM_End, "XK_End", "end" },
1275 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1276 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1277 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1279 /* ASCII 0x20 to 0x40 keys (except numbers) */
1280 { KSYM_space, "XK_space", "space" },
1281 { KSYM_exclam, "XK_exclam", "!" },
1282 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1283 { KSYM_numbersign, "XK_numbersign", "#" },
1284 { KSYM_dollar, "XK_dollar", "$" },
1285 { KSYM_percent, "XK_percent", "%" },
1286 { KSYM_ampersand, "XK_ampersand", "&" },
1287 { KSYM_apostrophe, "XK_apostrophe", "'" },
1288 { KSYM_parenleft, "XK_parenleft", "(" },
1289 { KSYM_parenright, "XK_parenright", ")" },
1290 { KSYM_asterisk, "XK_asterisk", "*" },
1291 { KSYM_plus, "XK_plus", "+" },
1292 { KSYM_comma, "XK_comma", "," },
1293 { KSYM_minus, "XK_minus", "-" },
1294 { KSYM_period, "XK_period", "." },
1295 { KSYM_slash, "XK_slash", "/" },
1296 { KSYM_colon, "XK_colon", ":" },
1297 { KSYM_semicolon, "XK_semicolon", ";" },
1298 { KSYM_less, "XK_less", "<" },
1299 { KSYM_equal, "XK_equal", "=" },
1300 { KSYM_greater, "XK_greater", ">" },
1301 { KSYM_question, "XK_question", "?" },
1302 { KSYM_at, "XK_at", "@" },
1304 /* more ASCII keys */
1305 { KSYM_bracketleft, "XK_bracketleft", "[" },
1306 { KSYM_backslash, "XK_backslash", "\\" },
1307 { KSYM_bracketright,"XK_bracketright", "]" },
1308 { KSYM_asciicircum, "XK_asciicircum", "^" },
1309 { KSYM_underscore, "XK_underscore", "_" },
1310 { KSYM_grave, "XK_grave", "grave" },
1311 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1312 { KSYM_braceleft, "XK_braceleft", "brace left" },
1313 { KSYM_bar, "XK_bar", "bar" },
1314 { KSYM_braceright, "XK_braceright", "brace right" },
1315 { KSYM_asciitilde, "XK_asciitilde", "~" },
1317 /* special (non-ASCII) keys */
1318 { KSYM_degree, "XK_degree", "°" },
1319 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1320 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1321 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1322 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1323 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1324 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1325 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1327 /* end-of-array identifier */
1333 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1335 static char name_buffer[30];
1338 if (key >= KSYM_A && key <= KSYM_Z)
1339 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1340 else if (key >= KSYM_a && key <= KSYM_z)
1341 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1342 else if (key >= KSYM_0 && key <= KSYM_9)
1343 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1344 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1345 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1346 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1347 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1348 else if (key == KSYM_UNDEFINED)
1349 strcpy(name_buffer, "(undefined)");
1356 if (key == translate_key[i].key)
1358 strcpy(name_buffer, translate_key[i].name);
1362 while (translate_key[++i].name);
1364 if (!translate_key[i].name)
1365 strcpy(name_buffer, "(unknown)");
1368 *name = name_buffer;
1370 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1372 static char name_buffer[30];
1375 if (key >= KSYM_A && key <= KSYM_Z)
1376 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1377 else if (key >= KSYM_a && key <= KSYM_z)
1378 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1379 else if (key >= KSYM_0 && key <= KSYM_9)
1380 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1381 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1382 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1383 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1384 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1385 else if (key == KSYM_UNDEFINED)
1386 strcpy(name_buffer, "[undefined]");
1393 if (key == translate_key[i].key)
1395 strcpy(name_buffer, translate_key[i].x11name);
1399 while (translate_key[++i].x11name);
1401 if (!translate_key[i].x11name)
1402 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1405 *x11name = name_buffer;
1407 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1409 Key key = KSYM_UNDEFINED;
1414 if (strEqual(translate_key[i].name, *name))
1416 key = translate_key[i].key;
1420 while (translate_key[++i].x11name);
1422 if (key == KSYM_UNDEFINED)
1423 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1427 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1429 Key key = KSYM_UNDEFINED;
1430 char *name_ptr = *x11name;
1432 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1434 char c = name_ptr[3];
1436 if (c >= 'A' && c <= 'Z')
1437 key = KSYM_A + (Key)(c - 'A');
1438 else if (c >= 'a' && c <= 'z')
1439 key = KSYM_a + (Key)(c - 'a');
1440 else if (c >= '0' && c <= '9')
1441 key = KSYM_0 + (Key)(c - '0');
1443 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1445 char c = name_ptr[6];
1447 if (c >= '0' && c <= '9')
1448 key = KSYM_KP_0 + (Key)(c - '0');
1450 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1452 char c1 = name_ptr[4];
1453 char c2 = name_ptr[5];
1456 if ((c1 >= '0' && c1 <= '9') &&
1457 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1458 d = atoi(&name_ptr[4]);
1460 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1461 key = KSYM_F1 + (Key)(d - 1);
1463 else if (strncmp(name_ptr, "XK_", 3) == 0)
1469 if (strEqual(name_ptr, translate_key[i].x11name))
1471 key = translate_key[i].key;
1475 while (translate_key[++i].x11name);
1477 else if (strncmp(name_ptr, "0x", 2) == 0)
1479 unsigned long value = 0;
1485 char c = *name_ptr++;
1488 if (c >= '0' && c <= '9')
1490 else if (c >= 'a' && c <= 'f')
1491 d = (int)(c - 'a' + 10);
1492 else if (c >= 'A' && c <= 'F')
1493 d = (int)(c - 'A' + 10);
1501 value = value * 16 + d;
1512 char *getKeyNameFromKey(Key key)
1516 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1520 char *getX11KeyNameFromKey(Key key)
1524 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1528 Key getKeyFromKeyName(char *name)
1532 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1536 Key getKeyFromX11KeyName(char *x11name)
1540 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1544 char getCharFromKey(Key key)
1546 char *keyname = getKeyNameFromKey(key);
1549 if (strlen(keyname) == 1)
1551 else if (strEqual(keyname, "space"))
1557 char getValidConfigValueChar(char c)
1559 if (c == '#' || /* used to mark comments */
1560 c == '\\') /* used to mark continued lines */
1567 /* ------------------------------------------------------------------------- */
1568 /* functions to translate string identifiers to integer or boolean value */
1569 /* ------------------------------------------------------------------------- */
1571 int get_integer_from_string(char *s)
1573 static char *number_text[][3] =
1575 { "0", "zero", "null", },
1576 { "1", "one", "first" },
1577 { "2", "two", "second" },
1578 { "3", "three", "third" },
1579 { "4", "four", "fourth" },
1580 { "5", "five", "fifth" },
1581 { "6", "six", "sixth" },
1582 { "7", "seven", "seventh" },
1583 { "8", "eight", "eighth" },
1584 { "9", "nine", "ninth" },
1585 { "10", "ten", "tenth" },
1586 { "11", "eleven", "eleventh" },
1587 { "12", "twelve", "twelfth" },
1589 { NULL, NULL, NULL },
1593 char *s_lower = getStringToLower(s);
1596 for (i = 0; number_text[i][0] != NULL; i++)
1597 for (j = 0; j < 3; j++)
1598 if (strEqual(s_lower, number_text[i][j]))
1603 if (strEqual(s_lower, "false") ||
1604 strEqual(s_lower, "no") ||
1605 strEqual(s_lower, "off"))
1607 else if (strEqual(s_lower, "true") ||
1608 strEqual(s_lower, "yes") ||
1609 strEqual(s_lower, "on"))
1620 boolean get_boolean_from_string(char *s)
1622 char *s_lower = getStringToLower(s);
1623 boolean result = FALSE;
1625 if (strEqual(s_lower, "true") ||
1626 strEqual(s_lower, "yes") ||
1627 strEqual(s_lower, "on") ||
1628 get_integer_from_string(s) == 1)
1636 int get_switch3_from_string(char *s)
1638 char *s_lower = getStringToLower(s);
1641 if (strEqual(s_lower, "true") ||
1642 strEqual(s_lower, "yes") ||
1643 strEqual(s_lower, "on") ||
1644 get_integer_from_string(s) == 1)
1646 else if (strEqual(s_lower, "auto"))
1655 /* ------------------------------------------------------------------------- */
1656 /* functions for generic lists */
1657 /* ------------------------------------------------------------------------- */
1659 ListNode *newListNode()
1661 return checked_calloc(sizeof(ListNode));
1664 void addNodeToList(ListNode **node_first, char *key, void *content)
1666 ListNode *node_new = newListNode();
1668 node_new->key = getStringCopy(key);
1669 node_new->content = content;
1670 node_new->next = *node_first;
1671 *node_first = node_new;
1674 void deleteNodeFromList(ListNode **node_first, char *key,
1675 void (*destructor_function)(void *))
1677 if (node_first == NULL || *node_first == NULL)
1680 if (strEqual((*node_first)->key, key))
1682 checked_free((*node_first)->key);
1683 if (destructor_function)
1684 destructor_function((*node_first)->content);
1685 *node_first = (*node_first)->next;
1688 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1691 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1693 if (node_first == NULL)
1696 if (strEqual(node_first->key, key))
1699 return getNodeFromKey(node_first->next, key);
1702 int getNumNodes(ListNode *node_first)
1704 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1707 void dumpList(ListNode *node_first)
1709 ListNode *node = node_first;
1713 printf("['%s' (%d)]\n", node->key,
1714 ((struct ListNodeInfo *)node->content)->num_references);
1718 printf("[%d nodes]\n", getNumNodes(node_first));
1722 /* ------------------------------------------------------------------------- */
1723 /* functions for checking files and filenames */
1724 /* ------------------------------------------------------------------------- */
1726 boolean fileExists(char *filename)
1728 if (filename == NULL)
1731 return (access(filename, F_OK) == 0);
1734 boolean fileHasPrefix(char *basename, char *prefix)
1736 static char *basename_lower = NULL;
1737 int basename_length, prefix_length;
1739 checked_free(basename_lower);
1741 if (basename == NULL || prefix == NULL)
1744 basename_lower = getStringToLower(basename);
1745 basename_length = strlen(basename_lower);
1746 prefix_length = strlen(prefix);
1748 if (basename_length > prefix_length + 1 &&
1749 basename_lower[prefix_length] == '.' &&
1750 strncmp(basename_lower, prefix, prefix_length) == 0)
1756 boolean fileHasSuffix(char *basename, char *suffix)
1758 static char *basename_lower = NULL;
1759 int basename_length, suffix_length;
1761 checked_free(basename_lower);
1763 if (basename == NULL || suffix == NULL)
1766 basename_lower = getStringToLower(basename);
1767 basename_length = strlen(basename_lower);
1768 suffix_length = strlen(suffix);
1770 if (basename_length > suffix_length + 1 &&
1771 basename_lower[basename_length - suffix_length - 1] == '.' &&
1772 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1778 boolean FileIsGraphic(char *filename)
1780 char *basename = getBaseNamePtr(filename);
1782 return fileHasSuffix(basename, "pcx");
1785 boolean FileIsSound(char *filename)
1787 char *basename = getBaseNamePtr(filename);
1789 return fileHasSuffix(basename, "wav");
1792 boolean FileIsMusic(char *filename)
1794 char *basename = getBaseNamePtr(filename);
1796 if (FileIsSound(basename))
1799 #if defined(TARGET_SDL)
1800 if (fileHasPrefix(basename, "mod") ||
1801 fileHasSuffix(basename, "mod") ||
1802 fileHasSuffix(basename, "s3m") ||
1803 fileHasSuffix(basename, "it") ||
1804 fileHasSuffix(basename, "xm") ||
1805 fileHasSuffix(basename, "midi") ||
1806 fileHasSuffix(basename, "mid") ||
1807 fileHasSuffix(basename, "mp3") ||
1808 fileHasSuffix(basename, "ogg"))
1815 boolean FileIsArtworkType(char *basename, int type)
1817 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1818 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1819 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1825 /* ------------------------------------------------------------------------- */
1826 /* functions for loading artwork configuration information */
1827 /* ------------------------------------------------------------------------- */
1829 char *get_mapped_token(char *token)
1831 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1832 static char *map_token_prefix[][2] =
1834 { "char_procent", "char_percent" },
1839 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1841 int len_token_prefix = strlen(map_token_prefix[i][0]);
1843 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1844 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1850 /* This function checks if a string <s> of the format "string1, string2, ..."
1851 exactly contains a string <s_contained>. */
1853 static boolean string_has_parameter(char *s, char *s_contained)
1857 if (s == NULL || s_contained == NULL)
1860 if (strlen(s_contained) > strlen(s))
1863 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1865 char next_char = s[strlen(s_contained)];
1867 /* check if next character is delimiter or whitespace */
1868 return (next_char == ',' || next_char == '\0' ||
1869 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1872 /* check if string contains another parameter string after a comma */
1873 substring = strchr(s, ',');
1874 if (substring == NULL) /* string does not contain a comma */
1877 /* advance string pointer to next character after the comma */
1880 /* skip potential whitespaces after the comma */
1881 while (*substring == ' ' || *substring == '\t')
1884 return string_has_parameter(substring, s_contained);
1887 int get_parameter_value(char *value_raw, char *suffix, int type)
1889 char *value = getStringToLower(value_raw);
1890 int result = 0; /* probably a save default value */
1892 if (strEqual(suffix, ".direction"))
1894 result = (strEqual(value, "left") ? MV_LEFT :
1895 strEqual(value, "right") ? MV_RIGHT :
1896 strEqual(value, "up") ? MV_UP :
1897 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1899 else if (strEqual(suffix, ".align"))
1901 result = (strEqual(value, "left") ? ALIGN_LEFT :
1902 strEqual(value, "right") ? ALIGN_RIGHT :
1903 strEqual(value, "center") ? ALIGN_CENTER :
1904 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1906 else if (strEqual(suffix, ".valign"))
1908 result = (strEqual(value, "top") ? VALIGN_TOP :
1909 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1910 strEqual(value, "middle") ? VALIGN_MIDDLE :
1911 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1913 else if (strEqual(suffix, ".anim_mode"))
1915 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1916 string_has_parameter(value, "loop") ? ANIM_LOOP :
1917 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1918 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1919 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1920 string_has_parameter(value, "random") ? ANIM_RANDOM :
1921 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1922 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1923 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1924 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1925 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1926 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1929 if (string_has_parameter(value, "reverse"))
1930 result |= ANIM_REVERSE;
1932 if (string_has_parameter(value, "opaque_player"))
1933 result |= ANIM_OPAQUE_PLAYER;
1935 if (string_has_parameter(value, "static_panel"))
1936 result |= ANIM_STATIC_PANEL;
1938 else if (strEqual(suffix, ".fade_mode"))
1940 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
1941 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
1942 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
1943 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
1947 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
1949 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
1952 result = gfx.get_font_from_token_function(value);
1954 else /* generic parameter of type integer or boolean */
1956 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1957 type == TYPE_INTEGER ? get_integer_from_string(value) :
1958 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1959 ARG_UNDEFINED_VALUE);
1967 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1969 static struct ScreenModeInfo screen_mode;
1970 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1971 char *screen_mode_string_copy;
1972 char *screen_mode_string_pos_w;
1973 char *screen_mode_string_pos_h;
1975 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1978 screen_mode_string_copy = getStringCopy(screen_mode_string);
1980 screen_mode_string_pos_w = screen_mode_string_copy;
1981 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1982 *screen_mode_string_pos_h++ = '\0';
1984 screen_mode.width = atoi(screen_mode_string_pos_w);
1985 screen_mode.height = atoi(screen_mode_string_pos_h);
1987 return &screen_mode;
1990 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1993 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1994 float aspect_ratio_new;
1999 *x = i * aspect_ratio + 0.000001;
2002 aspect_ratio_new = (float)*x / (float)*y;
2006 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2009 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2010 struct ListNodeInfo ***, int *);
2012 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2013 struct ConfigTypeInfo *suffix_list,
2014 char **ignore_tokens,
2015 int num_file_list_entries)
2017 struct FileInfo *file_list;
2018 int num_file_list_entries_found = 0;
2019 int num_suffix_list_entries = 0;
2023 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2025 for (i = 0; suffix_list[i].token != NULL; i++)
2026 num_suffix_list_entries++;
2028 /* always start with reliable default values */
2029 for (i = 0; i < num_file_list_entries; i++)
2031 file_list[i].token = NULL;
2033 file_list[i].default_filename = NULL;
2034 file_list[i].filename = NULL;
2036 if (num_suffix_list_entries > 0)
2038 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2040 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2041 file_list[i].parameter = checked_calloc(parameter_array_size);
2043 for (j = 0; j < num_suffix_list_entries; j++)
2045 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2046 setString(&file_list[i].parameter[j], suffix_list[j].value);
2049 file_list[i].redefined = FALSE;
2050 file_list[i].fallback_to_default = FALSE;
2051 file_list[i].default_is_cloned = FALSE;
2056 for (i = 0; config_list[i].token != NULL; i++)
2058 int len_config_token = strlen(config_list[i].token);
2059 int len_config_value = strlen(config_list[i].value);
2060 boolean is_file_entry = TRUE;
2062 for (j = 0; suffix_list[j].token != NULL; j++)
2064 int len_suffix = strlen(suffix_list[j].token);
2066 if (len_suffix < len_config_token &&
2067 strEqual(&config_list[i].token[len_config_token - len_suffix],
2068 suffix_list[j].token))
2070 setString(&file_list[list_pos].default_parameter[j],
2071 config_list[i].value);
2073 is_file_entry = FALSE;
2078 /* the following tokens are no file definitions, but other config tokens */
2079 for (j = 0; ignore_tokens[j] != NULL; j++)
2080 if (strEqual(config_list[i].token, ignore_tokens[j]))
2081 is_file_entry = FALSE;
2088 if (list_pos >= num_file_list_entries)
2091 /* simple sanity check if this is really a file definition */
2092 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2093 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2094 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2096 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2097 config_list[i].token, config_list[i].value);
2098 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2101 file_list[list_pos].token = config_list[i].token;
2102 file_list[list_pos].default_filename = config_list[i].value;
2105 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2109 if (strSuffix(config_list[i].token, ".clone_from"))
2110 file_list[list_pos].default_is_cloned = TRUE;
2113 num_file_list_entries_found = list_pos + 1;
2114 if (num_file_list_entries_found != num_file_list_entries)
2116 Error(ERR_INFO_LINE, "-");
2117 Error(ERR_INFO, "inconsistant config list information:");
2118 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2119 num_file_list_entries);
2120 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2121 num_file_list_entries_found);
2122 Error(ERR_EXIT, "please fix");
2126 printf("::: ---------- DONE ----------\n");
2132 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2134 int len_token = strlen(token);
2135 int len_suffix = strlen(suffix);
2137 if (start_pos < 0) /* compare suffix from end of string */
2138 start_pos += len_token;
2140 if (start_pos < 0 || start_pos + len_suffix > len_token)
2143 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2146 if (token[start_pos + len_suffix] == '\0')
2149 if (token[start_pos + len_suffix] == '.')
2155 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2157 static void read_token_parameters(SetupFileHash *setup_file_hash,
2158 struct ConfigTypeInfo *suffix_list,
2159 struct FileInfo *file_list_entry)
2161 /* check for config token that is the base token without any suffixes */
2162 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2163 char *known_token_value = KNOWN_TOKEN_VALUE;
2166 if (filename != NULL)
2168 setString(&file_list_entry->filename, filename);
2170 /* when file definition found, set all parameters to default values */
2171 for (i = 0; suffix_list[i].token != NULL; i++)
2172 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2174 file_list_entry->redefined = TRUE;
2176 /* mark config file token as well known from default config */
2177 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2180 /* check for config tokens that can be build by base token and suffixes */
2181 for (i = 0; suffix_list[i].token != NULL; i++)
2183 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2184 char *value = getHashEntry(setup_file_hash, token);
2188 setString(&file_list_entry->parameter[i], value);
2190 /* mark config file token as well known from default config */
2191 setHashEntry(setup_file_hash, token, known_token_value);
2198 static void add_dynamic_file_list_entry(struct FileInfo **list,
2199 int *num_list_entries,
2200 SetupFileHash *extra_file_hash,
2201 struct ConfigTypeInfo *suffix_list,
2202 int num_suffix_list_entries,
2205 struct FileInfo *new_list_entry;
2206 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2208 (*num_list_entries)++;
2209 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2210 new_list_entry = &(*list)[*num_list_entries - 1];
2212 new_list_entry->token = getStringCopy(token);
2213 new_list_entry->default_filename = NULL;
2214 new_list_entry->filename = NULL;
2215 new_list_entry->parameter = checked_calloc(parameter_array_size);
2217 new_list_entry->redefined = FALSE;
2218 new_list_entry->fallback_to_default = FALSE;
2219 new_list_entry->default_is_cloned = FALSE;
2221 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2224 static void add_property_mapping(struct PropertyMapping **list,
2225 int *num_list_entries,
2226 int base_index, int ext1_index,
2227 int ext2_index, int ext3_index,
2230 struct PropertyMapping *new_list_entry;
2232 (*num_list_entries)++;
2233 *list = checked_realloc(*list,
2234 *num_list_entries * sizeof(struct PropertyMapping));
2235 new_list_entry = &(*list)[*num_list_entries - 1];
2237 new_list_entry->base_index = base_index;
2238 new_list_entry->ext1_index = ext1_index;
2239 new_list_entry->ext2_index = ext2_index;
2240 new_list_entry->ext3_index = ext3_index;
2242 new_list_entry->artwork_index = artwork_index;
2245 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2248 struct FileInfo *file_list = artwork_info->file_list;
2249 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2250 char **base_prefixes = artwork_info->base_prefixes;
2251 char **ext1_suffixes = artwork_info->ext1_suffixes;
2252 char **ext2_suffixes = artwork_info->ext2_suffixes;
2253 char **ext3_suffixes = artwork_info->ext3_suffixes;
2254 char **ignore_tokens = artwork_info->ignore_tokens;
2255 int num_file_list_entries = artwork_info->num_file_list_entries;
2256 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2257 int num_base_prefixes = artwork_info->num_base_prefixes;
2258 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2259 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2260 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2261 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2262 SetupFileHash *setup_file_hash, *valid_file_hash;
2263 SetupFileHash *extra_file_hash, *empty_file_hash;
2264 char *known_token_value = KNOWN_TOKEN_VALUE;
2267 if (filename == NULL)
2271 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2274 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2277 /* separate valid (defined) from empty (undefined) config token values */
2278 valid_file_hash = newSetupFileHash();
2279 empty_file_hash = newSetupFileHash();
2280 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2282 char *value = HASH_ITERATION_VALUE(itr);
2284 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2285 HASH_ITERATION_TOKEN(itr), value);
2287 END_HASH_ITERATION(setup_file_hash, itr)
2289 /* at this point, we do not need the setup file hash anymore -- free it */
2290 freeSetupFileHash(setup_file_hash);
2292 /* map deprecated to current tokens (using prefix match and replace) */
2293 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2295 char *token = HASH_ITERATION_TOKEN(itr);
2296 char *mapped_token = get_mapped_token(token);
2298 if (mapped_token != NULL)
2300 char *value = HASH_ITERATION_VALUE(itr);
2302 /* add mapped token */
2303 setHashEntry(valid_file_hash, mapped_token, value);
2305 /* ignore old token (by setting it to "known" keyword) */
2306 setHashEntry(valid_file_hash, token, known_token_value);
2311 END_HASH_ITERATION(valid_file_hash, itr)
2313 /* read parameters for all known config file tokens */
2314 for (i = 0; i < num_file_list_entries; i++)
2315 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2317 /* set all tokens that can be ignored here to "known" keyword */
2318 for (i = 0; i < num_ignore_tokens; i++)
2319 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2321 /* copy all unknown config file tokens to extra config hash */
2322 extra_file_hash = newSetupFileHash();
2323 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2325 char *value = HASH_ITERATION_VALUE(itr);
2327 if (!strEqual(value, known_token_value))
2328 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2330 END_HASH_ITERATION(valid_file_hash, itr)
2332 /* at this point, we do not need the valid file hash anymore -- free it */
2333 freeSetupFileHash(valid_file_hash);
2335 /* now try to determine valid, dynamically defined config tokens */
2337 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2339 struct FileInfo **dynamic_file_list =
2340 &artwork_info->dynamic_file_list;
2341 int *num_dynamic_file_list_entries =
2342 &artwork_info->num_dynamic_file_list_entries;
2343 struct PropertyMapping **property_mapping =
2344 &artwork_info->property_mapping;
2345 int *num_property_mapping_entries =
2346 &artwork_info->num_property_mapping_entries;
2347 int current_summarized_file_list_entry =
2348 artwork_info->num_file_list_entries +
2349 artwork_info->num_dynamic_file_list_entries;
2350 char *token = HASH_ITERATION_TOKEN(itr);
2351 int len_token = strlen(token);
2353 boolean base_prefix_found = FALSE;
2354 boolean parameter_suffix_found = FALSE;
2357 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2360 /* skip all parameter definitions (handled by read_token_parameters()) */
2361 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2363 int len_suffix = strlen(suffix_list[i].token);
2365 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2366 parameter_suffix_found = TRUE;
2369 if (parameter_suffix_found)
2372 /* ---------- step 0: search for matching base prefix ---------- */
2375 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2377 char *base_prefix = base_prefixes[i];
2378 int len_base_prefix = strlen(base_prefix);
2379 boolean ext1_suffix_found = FALSE;
2380 boolean ext2_suffix_found = FALSE;
2381 boolean ext3_suffix_found = FALSE;
2382 boolean exact_match = FALSE;
2383 int base_index = -1;
2384 int ext1_index = -1;
2385 int ext2_index = -1;
2386 int ext3_index = -1;
2388 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2390 if (!base_prefix_found)
2396 if (IS_PARENT_PROCESS())
2397 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2400 if (start_pos + len_base_prefix == len_token) /* exact match */
2405 if (IS_PARENT_PROCESS())
2406 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2409 add_dynamic_file_list_entry(dynamic_file_list,
2410 num_dynamic_file_list_entries,
2413 num_suffix_list_entries,
2415 add_property_mapping(property_mapping,
2416 num_property_mapping_entries,
2417 base_index, -1, -1, -1,
2418 current_summarized_file_list_entry);
2423 if (IS_PARENT_PROCESS())
2424 printf("---> examining token '%s': search 1st suffix ...\n", token);
2427 /* ---------- step 1: search for matching first suffix ---------- */
2429 start_pos += len_base_prefix;
2430 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2432 char *ext1_suffix = ext1_suffixes[j];
2433 int len_ext1_suffix = strlen(ext1_suffix);
2435 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2437 if (!ext1_suffix_found)
2443 if (IS_PARENT_PROCESS())
2444 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2447 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2452 if (IS_PARENT_PROCESS())
2453 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2456 add_dynamic_file_list_entry(dynamic_file_list,
2457 num_dynamic_file_list_entries,
2460 num_suffix_list_entries,
2462 add_property_mapping(property_mapping,
2463 num_property_mapping_entries,
2464 base_index, ext1_index, -1, -1,
2465 current_summarized_file_list_entry);
2469 start_pos += len_ext1_suffix;
2476 if (IS_PARENT_PROCESS())
2477 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2480 /* ---------- step 2: search for matching second suffix ---------- */
2482 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2484 char *ext2_suffix = ext2_suffixes[k];
2485 int len_ext2_suffix = strlen(ext2_suffix);
2487 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2489 if (!ext2_suffix_found)
2495 if (IS_PARENT_PROCESS())
2496 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2499 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2504 if (IS_PARENT_PROCESS())
2505 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2508 add_dynamic_file_list_entry(dynamic_file_list,
2509 num_dynamic_file_list_entries,
2512 num_suffix_list_entries,
2514 add_property_mapping(property_mapping,
2515 num_property_mapping_entries,
2516 base_index, ext1_index, ext2_index, -1,
2517 current_summarized_file_list_entry);
2521 start_pos += len_ext2_suffix;
2528 if (IS_PARENT_PROCESS())
2529 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2532 /* ---------- step 3: search for matching third suffix ---------- */
2534 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2536 char *ext3_suffix = ext3_suffixes[l];
2537 int len_ext3_suffix = strlen(ext3_suffix);
2539 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2541 if (!ext3_suffix_found)
2547 if (IS_PARENT_PROCESS())
2548 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2551 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2556 if (IS_PARENT_PROCESS())
2557 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2560 add_dynamic_file_list_entry(dynamic_file_list,
2561 num_dynamic_file_list_entries,
2564 num_suffix_list_entries,
2566 add_property_mapping(property_mapping,
2567 num_property_mapping_entries,
2568 base_index, ext1_index, ext2_index, ext3_index,
2569 current_summarized_file_list_entry);
2575 END_HASH_ITERATION(extra_file_hash, itr)
2577 if (artwork_info->num_dynamic_file_list_entries > 0)
2579 artwork_info->dynamic_artwork_list =
2580 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2581 artwork_info->sizeof_artwork_list_entry);
2584 if (options.verbose && IS_PARENT_PROCESS())
2586 SetupFileList *setup_file_list, *list;
2587 boolean dynamic_tokens_found = FALSE;
2588 boolean unknown_tokens_found = FALSE;
2589 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2591 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2592 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2594 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2596 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2597 dynamic_tokens_found = TRUE;
2599 unknown_tokens_found = TRUE;
2601 END_HASH_ITERATION(extra_file_hash, itr)
2603 if (options.debug && dynamic_tokens_found)
2605 Error(ERR_INFO_LINE, "-");
2606 Error(ERR_INFO, "dynamic token(s) found in config file:");
2607 Error(ERR_INFO, "- config file: '%s'", filename);
2609 for (list = setup_file_list; list != NULL; list = list->next)
2611 char *value = getHashEntry(extra_file_hash, list->token);
2613 if (value != NULL && strEqual(value, known_token_value))
2614 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2617 Error(ERR_INFO_LINE, "-");
2620 if (unknown_tokens_found)
2622 Error(ERR_INFO_LINE, "-");
2623 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2624 Error(ERR_INFO, "- config file: '%s'", filename);
2626 for (list = setup_file_list; list != NULL; list = list->next)
2628 char *value = getHashEntry(extra_file_hash, list->token);
2630 if (value != NULL && !strEqual(value, known_token_value))
2631 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2634 Error(ERR_INFO_LINE, "-");
2637 if (undefined_values_found)
2639 Error(ERR_INFO_LINE, "-");
2640 Error(ERR_INFO, "warning: undefined values found in config file:");
2641 Error(ERR_INFO, "- config file: '%s'", filename);
2643 for (list = setup_file_list; list != NULL; list = list->next)
2645 char *value = getHashEntry(empty_file_hash, list->token);
2648 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2651 Error(ERR_INFO_LINE, "-");
2654 freeSetupFileList(setup_file_list);
2657 freeSetupFileHash(extra_file_hash);
2658 freeSetupFileHash(empty_file_hash);
2661 for (i = 0; i < num_file_list_entries; i++)
2663 printf("'%s' ", file_list[i].token);
2664 if (file_list[i].filename)
2665 printf("-> '%s'\n", file_list[i].filename);
2667 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2672 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2674 struct FileInfo *file_list = artwork_info->file_list;
2675 int num_file_list_entries = artwork_info->num_file_list_entries;
2676 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2677 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2680 DrawInitText("Loading artwork config", 120, FC_GREEN);
2681 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2683 /* always start with reliable default values */
2684 for (i = 0; i < num_file_list_entries; i++)
2686 setString(&file_list[i].filename, file_list[i].default_filename);
2688 for (j = 0; j < num_suffix_list_entries; j++)
2689 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2691 file_list[i].redefined = FALSE;
2692 file_list[i].fallback_to_default = FALSE;
2695 /* free previous dynamic artwork file array */
2696 if (artwork_info->dynamic_file_list != NULL)
2698 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2700 free(artwork_info->dynamic_file_list[i].token);
2701 free(artwork_info->dynamic_file_list[i].filename);
2702 free(artwork_info->dynamic_file_list[i].parameter);
2705 free(artwork_info->dynamic_file_list);
2706 artwork_info->dynamic_file_list = NULL;
2708 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2709 &artwork_info->num_dynamic_file_list_entries);
2712 /* free previous property mapping */
2713 if (artwork_info->property_mapping != NULL)
2715 free(artwork_info->property_mapping);
2717 artwork_info->property_mapping = NULL;
2718 artwork_info->num_property_mapping_entries = 0;
2722 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2724 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2727 /* first look for special artwork configured in level series config */
2728 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2731 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2732 leveldir_current->graphics_set,
2733 leveldir_current->graphics_path);
2736 if (fileExists(filename_base))
2737 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2740 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2742 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2743 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2746 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2747 struct ListNodeInfo **listnode)
2751 char *filename = (*listnode)->source_filename;
2753 if (--(*listnode)->num_references <= 0)
2754 deleteNodeFromList(&artwork_info->content_list, filename,
2755 artwork_info->free_artwork);
2761 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2762 struct ListNodeInfo **listnode,
2763 struct FileInfo *file_list_entry)
2773 char *basename = file_list_entry->filename;
2774 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2776 if (filename == NULL)
2778 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2780 basename = file_list_entry->default_filename;
2782 /* fail for cloned default artwork that has no default filename defined */
2783 if (file_list_entry->default_is_cloned &&
2784 strEqual(basename, UNDEFINED_FILENAME))
2786 int error_mode = ERR_WARN;
2788 /* we can get away without sounds and music, but not without graphics */
2789 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2790 error_mode = ERR_EXIT;
2792 Error(error_mode, "token '%s' was cloned and has no default filename",
2793 file_list_entry->token);
2798 /* dynamic artwork has no default filename / skip empty default artwork */
2799 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2802 file_list_entry->fallback_to_default = TRUE;
2804 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2806 filename = getCustomArtworkFilename(basename, artwork_info->type);
2808 if (filename == NULL)
2810 int error_mode = ERR_WARN;
2812 /* we can get away without sounds and music, but not without graphics */
2813 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2814 error_mode = ERR_EXIT;
2816 Error(error_mode, "cannot find default artwork file '%s'", basename);
2822 /* check if the old and the new artwork file are the same */
2823 if (*listnode && strEqual((*listnode)->source_filename, filename))
2825 /* The old and new artwork are the same (have the same filename and path).
2826 This usually means that this artwork does not exist in this artwork set
2827 and a fallback to the existing artwork is done. */
2830 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2836 /* delete existing artwork file entry */
2837 deleteArtworkListEntry(artwork_info, listnode);
2839 /* check if the new artwork file already exists in the list of artworks */
2840 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2843 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2846 *listnode = (struct ListNodeInfo *)node->content;
2847 (*listnode)->num_references++;
2852 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2853 DrawInitText(basename, 150, FC_YELLOW);
2855 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2858 printf("[adding new artwork '%s']\n", filename);
2861 (*listnode)->num_references = 1;
2862 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2867 int error_mode = ERR_WARN;
2869 /* we can get away without sounds and music, but not without graphics */
2870 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2871 error_mode = ERR_EXIT;
2873 Error(error_mode, "cannot load artwork file '%s'", basename);
2879 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2880 struct ListNodeInfo **listnode,
2881 struct FileInfo *file_list_entry)
2884 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2887 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2889 deleteArtworkListEntry(artwork_info, listnode);
2893 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2896 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2898 struct FileInfo *file_list = artwork_info->file_list;
2899 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2900 int num_file_list_entries = artwork_info->num_file_list_entries;
2901 int num_dynamic_file_list_entries =
2902 artwork_info->num_dynamic_file_list_entries;
2905 for (i = 0; i < num_file_list_entries; i++)
2906 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2909 for (i = 0; i < num_dynamic_file_list_entries; i++)
2910 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2911 &dynamic_file_list[i]);
2914 dumpList(artwork_info->content_list);
2918 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2919 struct ListNodeInfo ***list,
2920 int *num_list_entries)
2927 for (i = 0; i < *num_list_entries; i++)
2928 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2932 *num_list_entries = 0;
2935 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2937 if (artwork_info == NULL)
2940 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2941 &artwork_info->num_file_list_entries);
2943 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2944 &artwork_info->num_dynamic_file_list_entries);
2948 /* ------------------------------------------------------------------------- */
2949 /* functions only needed for non-Unix (non-command-line) systems */
2950 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2951 /* (now also added for Windows, to create files in user data directory) */
2952 /* ------------------------------------------------------------------------- */
2954 char *getErrorFilename(char *basename)
2956 return getPath2(getUserGameDataDir(), basename);
2959 void openErrorFile()
2961 InitUserDataDirectory();
2963 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2964 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2965 program.error_filename);
2968 void closeErrorFile()
2970 if (program.error_file != stderr) /* do not close stream 'stderr' */
2971 fclose(program.error_file);
2974 void dumpErrorFile()
2976 FILE *error_file = fopen(program.error_filename, MODE_READ);
2978 if (error_file != NULL)
2980 while (!feof(error_file))
2981 fputc(fgetc(error_file), stderr);
2987 void NotifyUserAboutErrorFile()
2989 #if defined(PLATFORM_WIN32)
2990 char *title_text = getStringCat2(program.program_title, " Error Message");
2991 char *error_text = getStringCat2("The program was aborted due to an error; "
2992 "for details, see the following error file:"
2993 STRING_NEWLINE, program.error_filename);
2995 MessageBox(NULL, error_text, title_text, MB_OK);
3000 /* ------------------------------------------------------------------------- */
3001 /* the following is only for debugging purpose and normally not used */
3002 /* ------------------------------------------------------------------------- */
3006 #define DEBUG_NUM_TIMESTAMPS 5
3007 #define DEBUG_TIME_IN_MICROSECONDS 0
3009 #if DEBUG_TIME_IN_MICROSECONDS
3010 static double Counter_Microseconds()
3012 static struct timeval base_time = { 0, 0 };
3013 struct timeval current_time;
3016 gettimeofday(¤t_time, NULL);
3018 /* reset base time in case of wrap-around */
3019 if (current_time.tv_sec < base_time.tv_sec)
3020 base_time = current_time;
3023 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3024 ((double)(current_time.tv_usec - base_time.tv_usec));
3026 return counter; /* return microseconds since last init */
3030 char *debug_print_timestamp_get_padding(int padding_size)
3032 static char *padding = NULL;
3033 int max_padding_size = 100;
3035 if (padding == NULL)
3037 padding = checked_calloc(max_padding_size + 1);
3038 memset(padding, ' ', max_padding_size);
3041 return &padding[MAX(0, max_padding_size - padding_size)];
3044 void debug_print_timestamp(int counter_nr, char *message)
3046 int indent_size = 8;
3047 int padding_size = 40;
3048 float timestamp_interval;
3051 Error(ERR_EXIT, "debugging: invalid negative counter");
3052 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3053 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3055 #if DEBUG_TIME_IN_MICROSECONDS
3056 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3059 counter[counter_nr][0] = Counter_Microseconds();
3061 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3064 counter[counter_nr][0] = Counter();
3067 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3068 counter[counter_nr][1] = counter[counter_nr][0];
3071 printf("%s%s%s %.3f %s\n",
3072 debug_print_timestamp_get_padding(counter_nr * indent_size),
3074 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3075 timestamp_interval / 1000,
3079 void debug_print_parent_only(char *format, ...)
3081 if (!IS_PARENT_PROCESS())
3088 va_start(ap, format);
3089 vprintf(format, ap);