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),
666 unsigned long (*get_cmd_switch_function)(char *))
668 char *ro_base_path = RO_BASE_PATH;
669 char *rw_base_path = RW_BASE_PATH;
670 char **options_left = &argv[1];
672 #if !defined(PLATFORM_MACOSX)
673 /* if the program is configured to start from current directory (default),
674 determine program package directory (KDE/Konqueror does not do this by
675 itself and fails otherwise); on Mac OS X, the program binary is stored
676 in an application package directory -- do not try to use this directory
677 as the program data directory (Mac OS X handles this correctly anyway) */
679 if (strEqual(ro_base_path, "."))
680 ro_base_path = program.command_basepath;
681 if (strEqual(rw_base_path, "."))
682 rw_base_path = program.command_basepath;
685 /* initialize global program options */
686 options.display_name = NULL;
687 options.server_host = NULL;
688 options.server_port = 0;
690 options.ro_base_directory = ro_base_path;
691 options.rw_base_directory = rw_base_path;
692 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
693 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
694 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
695 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
696 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
697 options.execute_command = NULL;
699 options.serveronly = FALSE;
700 options.network = FALSE;
701 options.verbose = FALSE;
702 options.debug = FALSE;
703 options.debug_x11_sync = FALSE;
705 options.cmd_switches = 0;
707 #if !defined(PLATFORM_UNIX)
708 if (*options_left == NULL) /* no options given -- enable verbose mode */
709 options.verbose = TRUE;
712 while (*options_left)
714 char option_str[MAX_OPTION_LEN];
715 char *option = options_left[0];
716 char *next_option = options_left[1];
717 char *option_arg = NULL;
718 int option_len = strlen(option);
720 if (option_len >= MAX_OPTION_LEN)
721 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
723 strcpy(option_str, option); /* copy argument into buffer */
726 if (strEqual(option, "--")) /* stop scanning arguments */
729 if (strPrefix(option, "--")) /* treat '--' like '-' */
732 option_arg = strchr(option, '=');
733 if (option_arg == NULL) /* no '=' in option */
734 option_arg = next_option;
737 *option_arg++ = '\0'; /* cut argument from option */
738 if (*option_arg == '\0') /* no argument after '=' */
739 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
742 option_len = strlen(option);
744 if (strEqual(option, "-"))
745 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
746 else if (strncmp(option, "-help", option_len) == 0)
748 print_usage_function();
752 else if (strncmp(option, "-display", option_len) == 0)
754 if (option_arg == NULL)
755 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
757 options.display_name = option_arg;
758 if (option_arg == next_option)
761 else if (strncmp(option, "-basepath", option_len) == 0)
763 if (option_arg == NULL)
764 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
766 /* this should be extended to separate options for ro and rw data */
767 options.ro_base_directory = ro_base_path = option_arg;
768 options.rw_base_directory = rw_base_path = option_arg;
769 if (option_arg == next_option)
772 /* adjust paths for sub-directories in base directory accordingly */
773 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
774 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
775 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
776 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
777 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
779 else if (strncmp(option, "-levels", option_len) == 0)
781 if (option_arg == NULL)
782 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
784 options.level_directory = option_arg;
785 if (option_arg == next_option)
788 else if (strncmp(option, "-graphics", option_len) == 0)
790 if (option_arg == NULL)
791 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
793 options.graphics_directory = option_arg;
794 if (option_arg == next_option)
797 else if (strncmp(option, "-sounds", option_len) == 0)
799 if (option_arg == NULL)
800 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
802 options.sounds_directory = option_arg;
803 if (option_arg == next_option)
806 else if (strncmp(option, "-music", option_len) == 0)
808 if (option_arg == NULL)
809 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
811 options.music_directory = option_arg;
812 if (option_arg == next_option)
815 else if (strncmp(option, "-network", option_len) == 0)
817 options.network = TRUE;
819 else if (strncmp(option, "-serveronly", option_len) == 0)
821 options.serveronly = TRUE;
823 else if (strncmp(option, "-verbose", option_len) == 0)
825 options.verbose = TRUE;
827 else if (strncmp(option, "-debug", option_len) == 0)
829 options.debug = TRUE;
831 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
833 options.debug_x11_sync = TRUE;
835 else if (strPrefix(option, "-D"))
837 char *switch_string = &option[2];
838 unsigned long switch_value;
840 if (*switch_string == '\0')
841 Error(ERR_EXIT_HELP, "empty switch ignored");
843 switch_value = get_cmd_switch_function(switch_string);
845 if (switch_value == 0)
846 Error(ERR_EXIT_HELP, "unknown switch '%s'", switch_string);
848 options.cmd_switches |= switch_value;
850 else if (strncmp(option, "-execute", option_len) == 0)
852 if (option_arg == NULL)
853 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
855 options.execute_command = option_arg;
856 if (option_arg == next_option)
859 /* when doing batch processing, always enable verbose mode (warnings) */
860 options.verbose = TRUE;
862 else if (*option == '-')
864 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
866 else if (options.server_host == NULL)
868 options.server_host = *options_left;
870 else if (options.server_port == 0)
872 options.server_port = atoi(*options_left);
873 if (options.server_port < 1024)
874 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
877 Error(ERR_EXIT_HELP, "too many arguments");
884 /* ------------------------------------------------------------------------- */
885 /* error handling functions */
886 /* ------------------------------------------------------------------------- */
888 /* used by SetError() and GetError() to store internal error messages */
889 static char internal_error[1024]; /* this is bad */
891 void SetError(char *format, ...)
895 va_start(ap, format);
896 vsprintf(internal_error, format, ap);
902 return internal_error;
905 void Error(int mode, char *format, ...)
907 static boolean last_line_was_separator = FALSE;
908 char *process_name = "";
910 /* display warnings only when running in verbose mode */
911 if (mode & ERR_WARN && !options.verbose)
914 if (mode == ERR_INFO_LINE)
916 if (!last_line_was_separator)
917 fprintf_line(program.error_file, format, 79);
919 last_line_was_separator = TRUE;
924 last_line_was_separator = FALSE;
926 if (mode & ERR_SOUND_SERVER)
927 process_name = " sound server";
928 else if (mode & ERR_NETWORK_SERVER)
929 process_name = " network server";
930 else if (mode & ERR_NETWORK_CLIENT)
931 process_name = " network client **";
937 fprintf(program.error_file, "%s%s: ", program.command_basename,
941 fprintf(program.error_file, "warning: ");
943 va_start(ap, format);
944 vfprintf_newline(program.error_file, format, ap);
949 fprintf_newline(program.error_file,
950 "%s: Try option '--help' for more information.",
951 program.command_basename);
954 fprintf_newline(program.error_file, "%s%s: aborting",
955 program.command_basename, process_name);
959 if (mode & ERR_FROM_SERVER)
960 exit(1); /* child process: normal exit */
962 program.exit_function(1); /* main process: clean up stuff */
967 /* ------------------------------------------------------------------------- */
968 /* checked memory allocation and freeing functions */
969 /* ------------------------------------------------------------------------- */
971 void *checked_malloc(unsigned long size)
978 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
983 void *checked_calloc(unsigned long size)
987 ptr = calloc(1, size);
990 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
995 void *checked_realloc(void *ptr, unsigned long size)
997 ptr = realloc(ptr, size);
1000 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1005 void checked_free(void *ptr)
1007 if (ptr != NULL) /* this check should be done by free() anyway */
1011 void clear_mem(void *ptr, unsigned long size)
1013 #if defined(PLATFORM_WIN32)
1014 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1015 char *cptr = (char *)ptr;
1020 memset(ptr, 0, size);
1025 /* ------------------------------------------------------------------------- */
1026 /* various helper functions */
1027 /* ------------------------------------------------------------------------- */
1029 inline void swap_numbers(int *i1, int *i2)
1037 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1049 /* the "put" variants of the following file access functions check for the file
1050 pointer being != NULL and return the number of bytes they have or would have
1051 written; this allows for chunk writing functions to first determine the size
1052 of the (not yet written) chunk, write the correct chunk size and finally
1053 write the chunk itself */
1055 int getFile8BitInteger(FILE *file)
1060 int putFile8BitInteger(FILE *file, int value)
1068 int getFile16BitInteger(FILE *file, int byte_order)
1070 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1071 return ((fgetc(file) << 8) |
1072 (fgetc(file) << 0));
1073 else /* BYTE_ORDER_LITTLE_ENDIAN */
1074 return ((fgetc(file) << 0) |
1075 (fgetc(file) << 8));
1078 int putFile16BitInteger(FILE *file, int value, int byte_order)
1082 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1084 fputc((value >> 8) & 0xff, file);
1085 fputc((value >> 0) & 0xff, file);
1087 else /* BYTE_ORDER_LITTLE_ENDIAN */
1089 fputc((value >> 0) & 0xff, file);
1090 fputc((value >> 8) & 0xff, file);
1097 int getFile32BitInteger(FILE *file, int byte_order)
1099 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1100 return ((fgetc(file) << 24) |
1101 (fgetc(file) << 16) |
1102 (fgetc(file) << 8) |
1103 (fgetc(file) << 0));
1104 else /* BYTE_ORDER_LITTLE_ENDIAN */
1105 return ((fgetc(file) << 0) |
1106 (fgetc(file) << 8) |
1107 (fgetc(file) << 16) |
1108 (fgetc(file) << 24));
1111 int putFile32BitInteger(FILE *file, int value, int byte_order)
1115 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1117 fputc((value >> 24) & 0xff, file);
1118 fputc((value >> 16) & 0xff, file);
1119 fputc((value >> 8) & 0xff, file);
1120 fputc((value >> 0) & 0xff, file);
1122 else /* BYTE_ORDER_LITTLE_ENDIAN */
1124 fputc((value >> 0) & 0xff, file);
1125 fputc((value >> 8) & 0xff, file);
1126 fputc((value >> 16) & 0xff, file);
1127 fputc((value >> 24) & 0xff, file);
1134 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1137 const int chunk_name_length = 4;
1139 /* read chunk name */
1140 fgets(chunk_name, chunk_name_length + 1, file);
1142 if (chunk_size != NULL)
1144 /* read chunk size */
1145 *chunk_size = getFile32BitInteger(file, byte_order);
1148 return (feof(file) || ferror(file) ? FALSE : TRUE);
1151 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1156 /* write chunk name */
1158 fputs(chunk_name, file);
1160 num_bytes += strlen(chunk_name);
1162 if (chunk_size >= 0)
1164 /* write chunk size */
1166 putFile32BitInteger(file, chunk_size, byte_order);
1174 int getFileVersion(FILE *file)
1176 int version_major = fgetc(file);
1177 int version_minor = fgetc(file);
1178 int version_patch = fgetc(file);
1179 int version_build = fgetc(file);
1181 return VERSION_IDENT(version_major, version_minor, version_patch,
1185 int putFileVersion(FILE *file, int version)
1189 int version_major = VERSION_MAJOR(version);
1190 int version_minor = VERSION_MINOR(version);
1191 int version_patch = VERSION_PATCH(version);
1192 int version_build = VERSION_BUILD(version);
1194 fputc(version_major, file);
1195 fputc(version_minor, file);
1196 fputc(version_patch, file);
1197 fputc(version_build, file);
1203 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1207 for(i = 0; i < bytes && !feof(file); i++)
1208 buffer[i] = fgetc(file);
1211 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1215 for(i = 0; i < bytes; i++)
1216 fputc(buffer[i], file);
1219 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1221 while (bytes-- && !feof(file))
1225 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1232 /* ------------------------------------------------------------------------- */
1233 /* functions to translate key identifiers between different format */
1234 /* ------------------------------------------------------------------------- */
1236 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1237 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1238 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1239 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1241 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1250 /* normal cursor keys */
1251 { KSYM_Left, "XK_Left", "cursor left" },
1252 { KSYM_Right, "XK_Right", "cursor right" },
1253 { KSYM_Up, "XK_Up", "cursor up" },
1254 { KSYM_Down, "XK_Down", "cursor down" },
1256 /* keypad cursor keys */
1258 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1259 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1260 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1261 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1264 /* other keypad keys */
1265 #ifdef KSYM_KP_Enter
1266 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1267 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1268 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1269 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1270 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1271 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1275 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1276 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1277 { KSYM_Control_L, "XK_Control_L", "left control" },
1278 { KSYM_Control_R, "XK_Control_R", "right control" },
1279 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1280 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1281 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1282 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1283 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1284 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1285 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1286 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1288 /* some special keys */
1289 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1290 { KSYM_Delete, "XK_Delete", "delete" },
1291 { KSYM_Insert, "XK_Insert", "insert" },
1292 { KSYM_Tab, "XK_Tab", "tab" },
1293 { KSYM_Home, "XK_Home", "home" },
1294 { KSYM_End, "XK_End", "end" },
1295 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1296 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1297 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1299 /* ASCII 0x20 to 0x40 keys (except numbers) */
1300 { KSYM_space, "XK_space", "space" },
1301 { KSYM_exclam, "XK_exclam", "!" },
1302 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1303 { KSYM_numbersign, "XK_numbersign", "#" },
1304 { KSYM_dollar, "XK_dollar", "$" },
1305 { KSYM_percent, "XK_percent", "%" },
1306 { KSYM_ampersand, "XK_ampersand", "&" },
1307 { KSYM_apostrophe, "XK_apostrophe", "'" },
1308 { KSYM_parenleft, "XK_parenleft", "(" },
1309 { KSYM_parenright, "XK_parenright", ")" },
1310 { KSYM_asterisk, "XK_asterisk", "*" },
1311 { KSYM_plus, "XK_plus", "+" },
1312 { KSYM_comma, "XK_comma", "," },
1313 { KSYM_minus, "XK_minus", "-" },
1314 { KSYM_period, "XK_period", "." },
1315 { KSYM_slash, "XK_slash", "/" },
1316 { KSYM_colon, "XK_colon", ":" },
1317 { KSYM_semicolon, "XK_semicolon", ";" },
1318 { KSYM_less, "XK_less", "<" },
1319 { KSYM_equal, "XK_equal", "=" },
1320 { KSYM_greater, "XK_greater", ">" },
1321 { KSYM_question, "XK_question", "?" },
1322 { KSYM_at, "XK_at", "@" },
1324 /* more ASCII keys */
1325 { KSYM_bracketleft, "XK_bracketleft", "[" },
1326 { KSYM_backslash, "XK_backslash", "\\" },
1327 { KSYM_bracketright,"XK_bracketright", "]" },
1328 { KSYM_asciicircum, "XK_asciicircum", "^" },
1329 { KSYM_underscore, "XK_underscore", "_" },
1330 { KSYM_grave, "XK_grave", "grave" },
1331 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1332 { KSYM_braceleft, "XK_braceleft", "brace left" },
1333 { KSYM_bar, "XK_bar", "bar" },
1334 { KSYM_braceright, "XK_braceright", "brace right" },
1335 { KSYM_asciitilde, "XK_asciitilde", "~" },
1337 /* special (non-ASCII) keys */
1338 { KSYM_degree, "XK_degree", "°" },
1339 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1340 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1341 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1342 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1343 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1344 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1345 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1347 /* end-of-array identifier */
1353 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1355 static char name_buffer[30];
1358 if (key >= KSYM_A && key <= KSYM_Z)
1359 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1360 else if (key >= KSYM_a && key <= KSYM_z)
1361 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1362 else if (key >= KSYM_0 && key <= KSYM_9)
1363 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1364 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1365 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1366 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1367 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1368 else if (key == KSYM_UNDEFINED)
1369 strcpy(name_buffer, "(undefined)");
1376 if (key == translate_key[i].key)
1378 strcpy(name_buffer, translate_key[i].name);
1382 while (translate_key[++i].name);
1384 if (!translate_key[i].name)
1385 strcpy(name_buffer, "(unknown)");
1388 *name = name_buffer;
1390 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1392 static char name_buffer[30];
1395 if (key >= KSYM_A && key <= KSYM_Z)
1396 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1397 else if (key >= KSYM_a && key <= KSYM_z)
1398 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1399 else if (key >= KSYM_0 && key <= KSYM_9)
1400 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1401 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1402 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1403 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1404 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1405 else if (key == KSYM_UNDEFINED)
1406 strcpy(name_buffer, "[undefined]");
1413 if (key == translate_key[i].key)
1415 strcpy(name_buffer, translate_key[i].x11name);
1419 while (translate_key[++i].x11name);
1421 if (!translate_key[i].x11name)
1422 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1425 *x11name = name_buffer;
1427 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1429 Key key = KSYM_UNDEFINED;
1434 if (strEqual(translate_key[i].name, *name))
1436 key = translate_key[i].key;
1440 while (translate_key[++i].x11name);
1442 if (key == KSYM_UNDEFINED)
1443 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1447 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1449 Key key = KSYM_UNDEFINED;
1450 char *name_ptr = *x11name;
1452 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1454 char c = name_ptr[3];
1456 if (c >= 'A' && c <= 'Z')
1457 key = KSYM_A + (Key)(c - 'A');
1458 else if (c >= 'a' && c <= 'z')
1459 key = KSYM_a + (Key)(c - 'a');
1460 else if (c >= '0' && c <= '9')
1461 key = KSYM_0 + (Key)(c - '0');
1463 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1465 char c = name_ptr[6];
1467 if (c >= '0' && c <= '9')
1468 key = KSYM_KP_0 + (Key)(c - '0');
1470 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1472 char c1 = name_ptr[4];
1473 char c2 = name_ptr[5];
1476 if ((c1 >= '0' && c1 <= '9') &&
1477 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1478 d = atoi(&name_ptr[4]);
1480 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1481 key = KSYM_F1 + (Key)(d - 1);
1483 else if (strPrefix(name_ptr, "XK_"))
1489 if (strEqual(name_ptr, translate_key[i].x11name))
1491 key = translate_key[i].key;
1495 while (translate_key[++i].x11name);
1497 else if (strPrefix(name_ptr, "0x"))
1499 unsigned long value = 0;
1505 char c = *name_ptr++;
1508 if (c >= '0' && c <= '9')
1510 else if (c >= 'a' && c <= 'f')
1511 d = (int)(c - 'a' + 10);
1512 else if (c >= 'A' && c <= 'F')
1513 d = (int)(c - 'A' + 10);
1521 value = value * 16 + d;
1532 char *getKeyNameFromKey(Key key)
1536 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1540 char *getX11KeyNameFromKey(Key key)
1544 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1548 Key getKeyFromKeyName(char *name)
1552 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1556 Key getKeyFromX11KeyName(char *x11name)
1560 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1564 char getCharFromKey(Key key)
1566 char *keyname = getKeyNameFromKey(key);
1569 if (strlen(keyname) == 1)
1571 else if (strEqual(keyname, "space"))
1577 char getValidConfigValueChar(char c)
1579 if (c == '#' || /* used to mark comments */
1580 c == '\\') /* used to mark continued lines */
1587 /* ------------------------------------------------------------------------- */
1588 /* functions to translate string identifiers to integer or boolean value */
1589 /* ------------------------------------------------------------------------- */
1591 int get_integer_from_string(char *s)
1593 static char *number_text[][3] =
1595 { "0", "zero", "null", },
1596 { "1", "one", "first" },
1597 { "2", "two", "second" },
1598 { "3", "three", "third" },
1599 { "4", "four", "fourth" },
1600 { "5", "five", "fifth" },
1601 { "6", "six", "sixth" },
1602 { "7", "seven", "seventh" },
1603 { "8", "eight", "eighth" },
1604 { "9", "nine", "ninth" },
1605 { "10", "ten", "tenth" },
1606 { "11", "eleven", "eleventh" },
1607 { "12", "twelve", "twelfth" },
1609 { NULL, NULL, NULL },
1613 char *s_lower = getStringToLower(s);
1616 for (i = 0; number_text[i][0] != NULL; i++)
1617 for (j = 0; j < 3; j++)
1618 if (strEqual(s_lower, number_text[i][j]))
1623 if (strEqual(s_lower, "false") ||
1624 strEqual(s_lower, "no") ||
1625 strEqual(s_lower, "off"))
1627 else if (strEqual(s_lower, "true") ||
1628 strEqual(s_lower, "yes") ||
1629 strEqual(s_lower, "on"))
1640 boolean get_boolean_from_string(char *s)
1642 char *s_lower = getStringToLower(s);
1643 boolean result = FALSE;
1645 if (strEqual(s_lower, "true") ||
1646 strEqual(s_lower, "yes") ||
1647 strEqual(s_lower, "on") ||
1648 get_integer_from_string(s) == 1)
1656 int get_switch3_from_string(char *s)
1658 char *s_lower = getStringToLower(s);
1661 if (strEqual(s_lower, "true") ||
1662 strEqual(s_lower, "yes") ||
1663 strEqual(s_lower, "on") ||
1664 get_integer_from_string(s) == 1)
1666 else if (strEqual(s_lower, "auto"))
1675 /* ------------------------------------------------------------------------- */
1676 /* functions for generic lists */
1677 /* ------------------------------------------------------------------------- */
1679 ListNode *newListNode()
1681 return checked_calloc(sizeof(ListNode));
1684 void addNodeToList(ListNode **node_first, char *key, void *content)
1686 ListNode *node_new = newListNode();
1688 node_new->key = getStringCopy(key);
1689 node_new->content = content;
1690 node_new->next = *node_first;
1691 *node_first = node_new;
1694 void deleteNodeFromList(ListNode **node_first, char *key,
1695 void (*destructor_function)(void *))
1697 if (node_first == NULL || *node_first == NULL)
1700 if (strEqual((*node_first)->key, key))
1702 checked_free((*node_first)->key);
1703 if (destructor_function)
1704 destructor_function((*node_first)->content);
1705 *node_first = (*node_first)->next;
1708 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1711 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1713 if (node_first == NULL)
1716 if (strEqual(node_first->key, key))
1719 return getNodeFromKey(node_first->next, key);
1722 int getNumNodes(ListNode *node_first)
1724 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1727 void dumpList(ListNode *node_first)
1729 ListNode *node = node_first;
1733 printf("['%s' (%d)]\n", node->key,
1734 ((struct ListNodeInfo *)node->content)->num_references);
1738 printf("[%d nodes]\n", getNumNodes(node_first));
1742 /* ------------------------------------------------------------------------- */
1743 /* functions for checking files and filenames */
1744 /* ------------------------------------------------------------------------- */
1746 boolean fileExists(char *filename)
1748 if (filename == NULL)
1751 return (access(filename, F_OK) == 0);
1754 boolean fileHasPrefix(char *basename, char *prefix)
1756 static char *basename_lower = NULL;
1757 int basename_length, prefix_length;
1759 checked_free(basename_lower);
1761 if (basename == NULL || prefix == NULL)
1764 basename_lower = getStringToLower(basename);
1765 basename_length = strlen(basename_lower);
1766 prefix_length = strlen(prefix);
1768 if (basename_length > prefix_length + 1 &&
1769 basename_lower[prefix_length] == '.' &&
1770 strncmp(basename_lower, prefix, prefix_length) == 0)
1776 boolean fileHasSuffix(char *basename, char *suffix)
1778 static char *basename_lower = NULL;
1779 int basename_length, suffix_length;
1781 checked_free(basename_lower);
1783 if (basename == NULL || suffix == NULL)
1786 basename_lower = getStringToLower(basename);
1787 basename_length = strlen(basename_lower);
1788 suffix_length = strlen(suffix);
1790 if (basename_length > suffix_length + 1 &&
1791 basename_lower[basename_length - suffix_length - 1] == '.' &&
1792 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1798 boolean FileIsGraphic(char *filename)
1800 char *basename = getBaseNamePtr(filename);
1802 return fileHasSuffix(basename, "pcx");
1805 boolean FileIsSound(char *filename)
1807 char *basename = getBaseNamePtr(filename);
1809 return fileHasSuffix(basename, "wav");
1812 boolean FileIsMusic(char *filename)
1814 char *basename = getBaseNamePtr(filename);
1816 if (FileIsSound(basename))
1819 #if defined(TARGET_SDL)
1820 if (fileHasPrefix(basename, "mod") ||
1821 fileHasSuffix(basename, "mod") ||
1822 fileHasSuffix(basename, "s3m") ||
1823 fileHasSuffix(basename, "it") ||
1824 fileHasSuffix(basename, "xm") ||
1825 fileHasSuffix(basename, "midi") ||
1826 fileHasSuffix(basename, "mid") ||
1827 fileHasSuffix(basename, "mp3") ||
1828 fileHasSuffix(basename, "ogg"))
1835 boolean FileIsArtworkType(char *basename, int type)
1837 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1838 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1839 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1845 /* ------------------------------------------------------------------------- */
1846 /* functions for loading artwork configuration information */
1847 /* ------------------------------------------------------------------------- */
1849 char *get_mapped_token(char *token)
1851 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1852 static char *map_token_prefix[][2] =
1854 { "char_procent", "char_percent" },
1859 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1861 int len_token_prefix = strlen(map_token_prefix[i][0]);
1863 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1864 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1870 /* This function checks if a string <s> of the format "string1, string2, ..."
1871 exactly contains a string <s_contained>. */
1873 static boolean string_has_parameter(char *s, char *s_contained)
1877 if (s == NULL || s_contained == NULL)
1880 if (strlen(s_contained) > strlen(s))
1883 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1885 char next_char = s[strlen(s_contained)];
1887 /* check if next character is delimiter or whitespace */
1888 return (next_char == ',' || next_char == '\0' ||
1889 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1892 /* check if string contains another parameter string after a comma */
1893 substring = strchr(s, ',');
1894 if (substring == NULL) /* string does not contain a comma */
1897 /* advance string pointer to next character after the comma */
1900 /* skip potential whitespaces after the comma */
1901 while (*substring == ' ' || *substring == '\t')
1904 return string_has_parameter(substring, s_contained);
1907 int get_parameter_value(char *value_raw, char *suffix, int type)
1909 char *value = getStringToLower(value_raw);
1910 int result = 0; /* probably a save default value */
1912 if (strEqual(suffix, ".direction"))
1914 result = (strEqual(value, "left") ? MV_LEFT :
1915 strEqual(value, "right") ? MV_RIGHT :
1916 strEqual(value, "up") ? MV_UP :
1917 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1919 else if (strEqual(suffix, ".align"))
1921 result = (strEqual(value, "left") ? ALIGN_LEFT :
1922 strEqual(value, "right") ? ALIGN_RIGHT :
1923 strEqual(value, "center") ? ALIGN_CENTER :
1924 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1926 else if (strEqual(suffix, ".valign"))
1928 result = (strEqual(value, "top") ? VALIGN_TOP :
1929 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1930 strEqual(value, "middle") ? VALIGN_MIDDLE :
1931 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1933 else if (strEqual(suffix, ".anim_mode"))
1935 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1936 string_has_parameter(value, "loop") ? ANIM_LOOP :
1937 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1938 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1939 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1940 string_has_parameter(value, "random") ? ANIM_RANDOM :
1941 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1942 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1943 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1944 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1945 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1946 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1949 if (string_has_parameter(value, "reverse"))
1950 result |= ANIM_REVERSE;
1952 if (string_has_parameter(value, "opaque_player"))
1953 result |= ANIM_OPAQUE_PLAYER;
1955 if (string_has_parameter(value, "static_panel"))
1956 result |= ANIM_STATIC_PANEL;
1958 else if (strEqual(suffix, ".fade_mode"))
1960 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
1961 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
1962 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
1963 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
1967 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
1969 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
1972 result = gfx.get_font_from_token_function(value);
1974 else /* generic parameter of type integer or boolean */
1976 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1977 type == TYPE_INTEGER ? get_integer_from_string(value) :
1978 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1979 ARG_UNDEFINED_VALUE);
1987 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1989 static struct ScreenModeInfo screen_mode;
1990 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1991 char *screen_mode_string_copy;
1992 char *screen_mode_string_pos_w;
1993 char *screen_mode_string_pos_h;
1995 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1998 screen_mode_string_copy = getStringCopy(screen_mode_string);
2000 screen_mode_string_pos_w = screen_mode_string_copy;
2001 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2002 *screen_mode_string_pos_h++ = '\0';
2004 screen_mode.width = atoi(screen_mode_string_pos_w);
2005 screen_mode.height = atoi(screen_mode_string_pos_h);
2007 return &screen_mode;
2010 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2013 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2014 float aspect_ratio_new;
2019 *x = i * aspect_ratio + 0.000001;
2022 aspect_ratio_new = (float)*x / (float)*y;
2026 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2029 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2030 struct ListNodeInfo ***, int *);
2032 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2033 struct ConfigTypeInfo *suffix_list,
2034 char **ignore_tokens,
2035 int num_file_list_entries)
2037 struct FileInfo *file_list;
2038 int num_file_list_entries_found = 0;
2039 int num_suffix_list_entries = 0;
2043 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2045 for (i = 0; suffix_list[i].token != NULL; i++)
2046 num_suffix_list_entries++;
2048 /* always start with reliable default values */
2049 for (i = 0; i < num_file_list_entries; i++)
2051 file_list[i].token = NULL;
2053 file_list[i].default_filename = NULL;
2054 file_list[i].filename = NULL;
2056 if (num_suffix_list_entries > 0)
2058 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2060 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2061 file_list[i].parameter = checked_calloc(parameter_array_size);
2063 for (j = 0; j < num_suffix_list_entries; j++)
2065 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2066 setString(&file_list[i].parameter[j], suffix_list[j].value);
2069 file_list[i].redefined = FALSE;
2070 file_list[i].fallback_to_default = FALSE;
2071 file_list[i].default_is_cloned = FALSE;
2076 for (i = 0; config_list[i].token != NULL; i++)
2078 int len_config_token = strlen(config_list[i].token);
2079 int len_config_value = strlen(config_list[i].value);
2080 boolean is_file_entry = TRUE;
2082 for (j = 0; suffix_list[j].token != NULL; j++)
2084 int len_suffix = strlen(suffix_list[j].token);
2086 if (len_suffix < len_config_token &&
2087 strEqual(&config_list[i].token[len_config_token - len_suffix],
2088 suffix_list[j].token))
2090 setString(&file_list[list_pos].default_parameter[j],
2091 config_list[i].value);
2093 is_file_entry = FALSE;
2098 /* the following tokens are no file definitions, but other config tokens */
2099 for (j = 0; ignore_tokens[j] != NULL; j++)
2100 if (strEqual(config_list[i].token, ignore_tokens[j]))
2101 is_file_entry = FALSE;
2108 if (list_pos >= num_file_list_entries)
2111 /* simple sanity check if this is really a file definition */
2112 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2113 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2114 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2116 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2117 config_list[i].token, config_list[i].value);
2118 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2121 file_list[list_pos].token = config_list[i].token;
2122 file_list[list_pos].default_filename = config_list[i].value;
2125 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2129 if (strSuffix(config_list[i].token, ".clone_from"))
2130 file_list[list_pos].default_is_cloned = TRUE;
2133 num_file_list_entries_found = list_pos + 1;
2134 if (num_file_list_entries_found != num_file_list_entries)
2136 Error(ERR_INFO_LINE, "-");
2137 Error(ERR_INFO, "inconsistant config list information:");
2138 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2139 num_file_list_entries);
2140 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2141 num_file_list_entries_found);
2142 Error(ERR_EXIT, "please fix");
2146 printf("::: ---------- DONE ----------\n");
2152 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2154 int len_token = strlen(token);
2155 int len_suffix = strlen(suffix);
2157 if (start_pos < 0) /* compare suffix from end of string */
2158 start_pos += len_token;
2160 if (start_pos < 0 || start_pos + len_suffix > len_token)
2163 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2166 if (token[start_pos + len_suffix] == '\0')
2169 if (token[start_pos + len_suffix] == '.')
2175 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2177 static void read_token_parameters(SetupFileHash *setup_file_hash,
2178 struct ConfigTypeInfo *suffix_list,
2179 struct FileInfo *file_list_entry)
2181 /* check for config token that is the base token without any suffixes */
2182 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2183 char *known_token_value = KNOWN_TOKEN_VALUE;
2186 if (filename != NULL)
2188 setString(&file_list_entry->filename, filename);
2190 /* when file definition found, set all parameters to default values */
2191 for (i = 0; suffix_list[i].token != NULL; i++)
2192 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2194 file_list_entry->redefined = TRUE;
2196 /* mark config file token as well known from default config */
2197 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2200 /* check for config tokens that can be build by base token and suffixes */
2201 for (i = 0; suffix_list[i].token != NULL; i++)
2203 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2204 char *value = getHashEntry(setup_file_hash, token);
2208 setString(&file_list_entry->parameter[i], value);
2210 /* mark config file token as well known from default config */
2211 setHashEntry(setup_file_hash, token, known_token_value);
2218 static void add_dynamic_file_list_entry(struct FileInfo **list,
2219 int *num_list_entries,
2220 SetupFileHash *extra_file_hash,
2221 struct ConfigTypeInfo *suffix_list,
2222 int num_suffix_list_entries,
2225 struct FileInfo *new_list_entry;
2226 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2228 (*num_list_entries)++;
2229 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2230 new_list_entry = &(*list)[*num_list_entries - 1];
2232 new_list_entry->token = getStringCopy(token);
2233 new_list_entry->default_filename = NULL;
2234 new_list_entry->filename = NULL;
2235 new_list_entry->parameter = checked_calloc(parameter_array_size);
2237 new_list_entry->redefined = FALSE;
2238 new_list_entry->fallback_to_default = FALSE;
2239 new_list_entry->default_is_cloned = FALSE;
2241 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2244 static void add_property_mapping(struct PropertyMapping **list,
2245 int *num_list_entries,
2246 int base_index, int ext1_index,
2247 int ext2_index, int ext3_index,
2250 struct PropertyMapping *new_list_entry;
2252 (*num_list_entries)++;
2253 *list = checked_realloc(*list,
2254 *num_list_entries * sizeof(struct PropertyMapping));
2255 new_list_entry = &(*list)[*num_list_entries - 1];
2257 new_list_entry->base_index = base_index;
2258 new_list_entry->ext1_index = ext1_index;
2259 new_list_entry->ext2_index = ext2_index;
2260 new_list_entry->ext3_index = ext3_index;
2262 new_list_entry->artwork_index = artwork_index;
2265 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2268 struct FileInfo *file_list = artwork_info->file_list;
2269 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2270 char **base_prefixes = artwork_info->base_prefixes;
2271 char **ext1_suffixes = artwork_info->ext1_suffixes;
2272 char **ext2_suffixes = artwork_info->ext2_suffixes;
2273 char **ext3_suffixes = artwork_info->ext3_suffixes;
2274 char **ignore_tokens = artwork_info->ignore_tokens;
2275 int num_file_list_entries = artwork_info->num_file_list_entries;
2276 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2277 int num_base_prefixes = artwork_info->num_base_prefixes;
2278 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2279 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2280 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2281 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2282 SetupFileHash *setup_file_hash, *valid_file_hash;
2283 SetupFileHash *extra_file_hash, *empty_file_hash;
2284 char *known_token_value = KNOWN_TOKEN_VALUE;
2287 if (filename == NULL)
2291 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2294 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2297 /* separate valid (defined) from empty (undefined) config token values */
2298 valid_file_hash = newSetupFileHash();
2299 empty_file_hash = newSetupFileHash();
2300 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2302 char *value = HASH_ITERATION_VALUE(itr);
2304 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2305 HASH_ITERATION_TOKEN(itr), value);
2307 END_HASH_ITERATION(setup_file_hash, itr)
2309 /* at this point, we do not need the setup file hash anymore -- free it */
2310 freeSetupFileHash(setup_file_hash);
2312 /* map deprecated to current tokens (using prefix match and replace) */
2313 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2315 char *token = HASH_ITERATION_TOKEN(itr);
2316 char *mapped_token = get_mapped_token(token);
2318 if (mapped_token != NULL)
2320 char *value = HASH_ITERATION_VALUE(itr);
2322 /* add mapped token */
2323 setHashEntry(valid_file_hash, mapped_token, value);
2325 /* ignore old token (by setting it to "known" keyword) */
2326 setHashEntry(valid_file_hash, token, known_token_value);
2331 END_HASH_ITERATION(valid_file_hash, itr)
2333 /* read parameters for all known config file tokens */
2334 for (i = 0; i < num_file_list_entries; i++)
2335 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2337 /* set all tokens that can be ignored here to "known" keyword */
2338 for (i = 0; i < num_ignore_tokens; i++)
2339 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2341 /* copy all unknown config file tokens to extra config hash */
2342 extra_file_hash = newSetupFileHash();
2343 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2345 char *value = HASH_ITERATION_VALUE(itr);
2347 if (!strEqual(value, known_token_value))
2348 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2350 END_HASH_ITERATION(valid_file_hash, itr)
2352 /* at this point, we do not need the valid file hash anymore -- free it */
2353 freeSetupFileHash(valid_file_hash);
2355 /* now try to determine valid, dynamically defined config tokens */
2357 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2359 struct FileInfo **dynamic_file_list =
2360 &artwork_info->dynamic_file_list;
2361 int *num_dynamic_file_list_entries =
2362 &artwork_info->num_dynamic_file_list_entries;
2363 struct PropertyMapping **property_mapping =
2364 &artwork_info->property_mapping;
2365 int *num_property_mapping_entries =
2366 &artwork_info->num_property_mapping_entries;
2367 int current_summarized_file_list_entry =
2368 artwork_info->num_file_list_entries +
2369 artwork_info->num_dynamic_file_list_entries;
2370 char *token = HASH_ITERATION_TOKEN(itr);
2371 int len_token = strlen(token);
2373 boolean base_prefix_found = FALSE;
2374 boolean parameter_suffix_found = FALSE;
2377 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2380 /* skip all parameter definitions (handled by read_token_parameters()) */
2381 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2383 int len_suffix = strlen(suffix_list[i].token);
2385 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2386 parameter_suffix_found = TRUE;
2389 if (parameter_suffix_found)
2392 /* ---------- step 0: search for matching base prefix ---------- */
2395 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2397 char *base_prefix = base_prefixes[i];
2398 int len_base_prefix = strlen(base_prefix);
2399 boolean ext1_suffix_found = FALSE;
2400 boolean ext2_suffix_found = FALSE;
2401 boolean ext3_suffix_found = FALSE;
2402 boolean exact_match = FALSE;
2403 int base_index = -1;
2404 int ext1_index = -1;
2405 int ext2_index = -1;
2406 int ext3_index = -1;
2408 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2410 if (!base_prefix_found)
2416 if (IS_PARENT_PROCESS())
2417 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2420 if (start_pos + len_base_prefix == len_token) /* exact match */
2425 if (IS_PARENT_PROCESS())
2426 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2429 add_dynamic_file_list_entry(dynamic_file_list,
2430 num_dynamic_file_list_entries,
2433 num_suffix_list_entries,
2435 add_property_mapping(property_mapping,
2436 num_property_mapping_entries,
2437 base_index, -1, -1, -1,
2438 current_summarized_file_list_entry);
2443 if (IS_PARENT_PROCESS())
2444 printf("---> examining token '%s': search 1st suffix ...\n", token);
2447 /* ---------- step 1: search for matching first suffix ---------- */
2449 start_pos += len_base_prefix;
2450 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2452 char *ext1_suffix = ext1_suffixes[j];
2453 int len_ext1_suffix = strlen(ext1_suffix);
2455 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2457 if (!ext1_suffix_found)
2463 if (IS_PARENT_PROCESS())
2464 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2467 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2472 if (IS_PARENT_PROCESS())
2473 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2476 add_dynamic_file_list_entry(dynamic_file_list,
2477 num_dynamic_file_list_entries,
2480 num_suffix_list_entries,
2482 add_property_mapping(property_mapping,
2483 num_property_mapping_entries,
2484 base_index, ext1_index, -1, -1,
2485 current_summarized_file_list_entry);
2489 start_pos += len_ext1_suffix;
2496 if (IS_PARENT_PROCESS())
2497 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2500 /* ---------- step 2: search for matching second suffix ---------- */
2502 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2504 char *ext2_suffix = ext2_suffixes[k];
2505 int len_ext2_suffix = strlen(ext2_suffix);
2507 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2509 if (!ext2_suffix_found)
2515 if (IS_PARENT_PROCESS())
2516 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2519 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2524 if (IS_PARENT_PROCESS())
2525 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2528 add_dynamic_file_list_entry(dynamic_file_list,
2529 num_dynamic_file_list_entries,
2532 num_suffix_list_entries,
2534 add_property_mapping(property_mapping,
2535 num_property_mapping_entries,
2536 base_index, ext1_index, ext2_index, -1,
2537 current_summarized_file_list_entry);
2541 start_pos += len_ext2_suffix;
2548 if (IS_PARENT_PROCESS())
2549 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2552 /* ---------- step 3: search for matching third suffix ---------- */
2554 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2556 char *ext3_suffix = ext3_suffixes[l];
2557 int len_ext3_suffix = strlen(ext3_suffix);
2559 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2561 if (!ext3_suffix_found)
2567 if (IS_PARENT_PROCESS())
2568 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2571 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2576 if (IS_PARENT_PROCESS())
2577 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2580 add_dynamic_file_list_entry(dynamic_file_list,
2581 num_dynamic_file_list_entries,
2584 num_suffix_list_entries,
2586 add_property_mapping(property_mapping,
2587 num_property_mapping_entries,
2588 base_index, ext1_index, ext2_index, ext3_index,
2589 current_summarized_file_list_entry);
2595 END_HASH_ITERATION(extra_file_hash, itr)
2597 if (artwork_info->num_dynamic_file_list_entries > 0)
2599 artwork_info->dynamic_artwork_list =
2600 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2601 artwork_info->sizeof_artwork_list_entry);
2604 if (options.verbose && IS_PARENT_PROCESS())
2606 SetupFileList *setup_file_list, *list;
2607 boolean dynamic_tokens_found = FALSE;
2608 boolean unknown_tokens_found = FALSE;
2609 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2611 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2612 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2614 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2616 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2617 dynamic_tokens_found = TRUE;
2619 unknown_tokens_found = TRUE;
2621 END_HASH_ITERATION(extra_file_hash, itr)
2623 if (options.debug && dynamic_tokens_found)
2625 Error(ERR_INFO_LINE, "-");
2626 Error(ERR_INFO, "dynamic token(s) found in config file:");
2627 Error(ERR_INFO, "- config file: '%s'", filename);
2629 for (list = setup_file_list; list != NULL; list = list->next)
2631 char *value = getHashEntry(extra_file_hash, list->token);
2633 if (value != NULL && strEqual(value, known_token_value))
2634 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2637 Error(ERR_INFO_LINE, "-");
2640 if (unknown_tokens_found)
2642 Error(ERR_INFO_LINE, "-");
2643 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2644 Error(ERR_INFO, "- config file: '%s'", filename);
2646 for (list = setup_file_list; list != NULL; list = list->next)
2648 char *value = getHashEntry(extra_file_hash, list->token);
2650 if (value != NULL && !strEqual(value, known_token_value))
2651 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2654 Error(ERR_INFO_LINE, "-");
2657 if (undefined_values_found)
2659 Error(ERR_INFO_LINE, "-");
2660 Error(ERR_INFO, "warning: undefined values found in config file:");
2661 Error(ERR_INFO, "- config file: '%s'", filename);
2663 for (list = setup_file_list; list != NULL; list = list->next)
2665 char *value = getHashEntry(empty_file_hash, list->token);
2668 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2671 Error(ERR_INFO_LINE, "-");
2674 freeSetupFileList(setup_file_list);
2677 freeSetupFileHash(extra_file_hash);
2678 freeSetupFileHash(empty_file_hash);
2681 for (i = 0; i < num_file_list_entries; i++)
2683 printf("'%s' ", file_list[i].token);
2684 if (file_list[i].filename)
2685 printf("-> '%s'\n", file_list[i].filename);
2687 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2692 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2694 struct FileInfo *file_list = artwork_info->file_list;
2695 int num_file_list_entries = artwork_info->num_file_list_entries;
2696 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2697 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2700 DrawInitText("Loading artwork config", 120, FC_GREEN);
2701 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2703 /* always start with reliable default values */
2704 for (i = 0; i < num_file_list_entries; i++)
2706 setString(&file_list[i].filename, file_list[i].default_filename);
2708 for (j = 0; j < num_suffix_list_entries; j++)
2709 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2711 file_list[i].redefined = FALSE;
2712 file_list[i].fallback_to_default = FALSE;
2715 /* free previous dynamic artwork file array */
2716 if (artwork_info->dynamic_file_list != NULL)
2718 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2720 free(artwork_info->dynamic_file_list[i].token);
2721 free(artwork_info->dynamic_file_list[i].filename);
2722 free(artwork_info->dynamic_file_list[i].parameter);
2725 free(artwork_info->dynamic_file_list);
2726 artwork_info->dynamic_file_list = NULL;
2728 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2729 &artwork_info->num_dynamic_file_list_entries);
2732 /* free previous property mapping */
2733 if (artwork_info->property_mapping != NULL)
2735 free(artwork_info->property_mapping);
2737 artwork_info->property_mapping = NULL;
2738 artwork_info->num_property_mapping_entries = 0;
2742 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2744 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2747 /* first look for special artwork configured in level series config */
2748 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2751 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2752 leveldir_current->graphics_set,
2753 leveldir_current->graphics_path);
2756 if (fileExists(filename_base))
2757 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2760 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2762 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2763 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2766 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2767 struct ListNodeInfo **listnode)
2771 char *filename = (*listnode)->source_filename;
2773 if (--(*listnode)->num_references <= 0)
2774 deleteNodeFromList(&artwork_info->content_list, filename,
2775 artwork_info->free_artwork);
2781 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2782 struct ListNodeInfo **listnode,
2783 struct FileInfo *file_list_entry)
2793 char *basename = file_list_entry->filename;
2794 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2796 if (filename == NULL)
2798 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2800 basename = file_list_entry->default_filename;
2802 /* fail for cloned default artwork that has no default filename defined */
2803 if (file_list_entry->default_is_cloned &&
2804 strEqual(basename, UNDEFINED_FILENAME))
2806 int error_mode = ERR_WARN;
2808 /* we can get away without sounds and music, but not without graphics */
2809 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2810 error_mode = ERR_EXIT;
2812 Error(error_mode, "token '%s' was cloned and has no default filename",
2813 file_list_entry->token);
2818 /* dynamic artwork has no default filename / skip empty default artwork */
2819 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2822 file_list_entry->fallback_to_default = TRUE;
2824 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2826 filename = getCustomArtworkFilename(basename, artwork_info->type);
2828 if (filename == NULL)
2830 int error_mode = ERR_WARN;
2832 /* we can get away without sounds and music, but not without graphics */
2833 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2834 error_mode = ERR_EXIT;
2836 Error(error_mode, "cannot find default artwork file '%s'", basename);
2842 /* check if the old and the new artwork file are the same */
2843 if (*listnode && strEqual((*listnode)->source_filename, filename))
2845 /* The old and new artwork are the same (have the same filename and path).
2846 This usually means that this artwork does not exist in this artwork set
2847 and a fallback to the existing artwork is done. */
2850 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2856 /* delete existing artwork file entry */
2857 deleteArtworkListEntry(artwork_info, listnode);
2859 /* check if the new artwork file already exists in the list of artworks */
2860 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2863 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2866 *listnode = (struct ListNodeInfo *)node->content;
2867 (*listnode)->num_references++;
2872 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2873 DrawInitText(basename, 150, FC_YELLOW);
2875 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2878 printf("[adding new artwork '%s']\n", filename);
2881 (*listnode)->num_references = 1;
2882 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2887 int error_mode = ERR_WARN;
2889 /* we can get away without sounds and music, but not without graphics */
2890 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2891 error_mode = ERR_EXIT;
2893 Error(error_mode, "cannot load artwork file '%s'", basename);
2899 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2900 struct ListNodeInfo **listnode,
2901 struct FileInfo *file_list_entry)
2904 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2907 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2909 deleteArtworkListEntry(artwork_info, listnode);
2913 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2916 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2918 struct FileInfo *file_list = artwork_info->file_list;
2919 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2920 int num_file_list_entries = artwork_info->num_file_list_entries;
2921 int num_dynamic_file_list_entries =
2922 artwork_info->num_dynamic_file_list_entries;
2925 for (i = 0; i < num_file_list_entries; i++)
2926 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2929 for (i = 0; i < num_dynamic_file_list_entries; i++)
2930 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2931 &dynamic_file_list[i]);
2934 dumpList(artwork_info->content_list);
2938 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2939 struct ListNodeInfo ***list,
2940 int *num_list_entries)
2947 for (i = 0; i < *num_list_entries; i++)
2948 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2952 *num_list_entries = 0;
2955 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2957 if (artwork_info == NULL)
2960 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2961 &artwork_info->num_file_list_entries);
2963 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2964 &artwork_info->num_dynamic_file_list_entries);
2968 /* ------------------------------------------------------------------------- */
2969 /* functions only needed for non-Unix (non-command-line) systems */
2970 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2971 /* (now also added for Windows, to create files in user data directory) */
2972 /* ------------------------------------------------------------------------- */
2974 char *getErrorFilename(char *basename)
2976 return getPath2(getUserGameDataDir(), basename);
2979 void openErrorFile()
2981 InitUserDataDirectory();
2983 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2984 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2985 program.error_filename);
2988 void closeErrorFile()
2990 if (program.error_file != stderr) /* do not close stream 'stderr' */
2991 fclose(program.error_file);
2994 void dumpErrorFile()
2996 FILE *error_file = fopen(program.error_filename, MODE_READ);
2998 if (error_file != NULL)
3000 while (!feof(error_file))
3001 fputc(fgetc(error_file), stderr);
3007 void NotifyUserAboutErrorFile()
3009 #if defined(PLATFORM_WIN32)
3010 char *title_text = getStringCat2(program.program_title, " Error Message");
3011 char *error_text = getStringCat2("The program was aborted due to an error; "
3012 "for details, see the following error file:"
3013 STRING_NEWLINE, program.error_filename);
3015 MessageBox(NULL, error_text, title_text, MB_OK);
3020 /* ------------------------------------------------------------------------- */
3021 /* the following is only for debugging purpose and normally not used */
3022 /* ------------------------------------------------------------------------- */
3026 #define DEBUG_NUM_TIMESTAMPS 5
3027 #define DEBUG_TIME_IN_MICROSECONDS 0
3029 #if DEBUG_TIME_IN_MICROSECONDS
3030 static double Counter_Microseconds()
3032 static struct timeval base_time = { 0, 0 };
3033 struct timeval current_time;
3036 gettimeofday(¤t_time, NULL);
3038 /* reset base time in case of wrap-around */
3039 if (current_time.tv_sec < base_time.tv_sec)
3040 base_time = current_time;
3043 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3044 ((double)(current_time.tv_usec - base_time.tv_usec));
3046 return counter; /* return microseconds since last init */
3050 char *debug_print_timestamp_get_padding(int padding_size)
3052 static char *padding = NULL;
3053 int max_padding_size = 100;
3055 if (padding == NULL)
3057 padding = checked_calloc(max_padding_size + 1);
3058 memset(padding, ' ', max_padding_size);
3061 return &padding[MAX(0, max_padding_size - padding_size)];
3064 void debug_print_timestamp(int counter_nr, char *message)
3066 int indent_size = 8;
3067 int padding_size = 40;
3068 float timestamp_interval;
3071 Error(ERR_EXIT, "debugging: invalid negative counter");
3072 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3073 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3075 #if DEBUG_TIME_IN_MICROSECONDS
3076 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3079 counter[counter_nr][0] = Counter_Microseconds();
3081 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3084 counter[counter_nr][0] = Counter();
3087 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3088 counter[counter_nr][1] = counter[counter_nr][0];
3091 printf("%s%s%s %.3f %s\n",
3092 debug_print_timestamp_get_padding(counter_nr * indent_size),
3094 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3095 timestamp_interval / 1000,
3099 void debug_print_parent_only(char *format, ...)
3101 if (!IS_PARENT_PROCESS())
3108 va_start(ap, format);
3109 vprintf(format, ap);