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>
25 #if !defined(PLATFORM_WIN32)
27 #include <sys/param.h>
37 /* ========================================================================= */
38 /* some generic helper functions */
39 /* ========================================================================= */
41 /* ------------------------------------------------------------------------- */
42 /* platform independent wrappers for printf() et al. (newline aware) */
43 /* ------------------------------------------------------------------------- */
45 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
47 char *newline = STRING_NEWLINE;
49 vfprintf(stream, format, ap);
51 fprintf(stream, "%s", newline);
54 static void fprintf_newline(FILE *stream, char *format, ...)
61 vfprintf_newline(stream, format, ap);
66 void fprintf_line(FILE *stream, char *line_chars, int line_length)
70 for (i = 0; i < line_length; i++)
71 fprintf(stream, "%s", line_chars);
73 fprintf_newline(stream, "");
76 void printf_line(char *line_chars, int line_length)
78 fprintf_line(stdout, line_chars, line_length);
81 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
83 fprintf(stdout, "%s", prefix);
84 fprintf_line(stdout, line_chars, line_length);
88 /* ------------------------------------------------------------------------- */
89 /* string functions */
90 /* ------------------------------------------------------------------------- */
92 /* int2str() returns a number converted to a string;
93 the used memory is static, but will be overwritten by later calls,
94 so if you want to save the result, copy it to a private string buffer;
95 there can be 10 local calls of int2str() without buffering the result --
96 the 11th call will then destroy the result from the first call and so on.
99 char *int2str(int number, int size)
101 static char shift_array[10][40];
102 static int shift_counter = 0;
103 char *s = shift_array[shift_counter];
105 shift_counter = (shift_counter + 1) % 10;
112 sprintf(s, " %09d", number);
113 return &s[strlen(s) - size];
117 sprintf(s, "%d", number);
123 /* something similar to "int2str()" above, but allocates its own memory
124 and has a different interface; we cannot use "itoa()", because this
125 seems to be already defined when cross-compiling to the win32 target */
127 char *i_to_a(unsigned int i)
129 static char *a = NULL;
133 if (i > 2147483647) /* yes, this is a kludge */
136 a = checked_malloc(10 + 1);
144 /* calculate base-2 logarithm of argument (rounded down to integer;
145 this function returns the number of the highest bit set in argument) */
147 int log_2(unsigned int x)
153 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
160 boolean getTokenValueFromString(char *string, char **token, char **value)
162 return getTokenValueFromSetupLine(string, token, value);
166 /* ------------------------------------------------------------------------- */
167 /* counter functions */
168 /* ------------------------------------------------------------------------- */
170 #if defined(PLATFORM_MSDOS)
171 volatile unsigned int counter = 0;
173 void increment_counter()
178 END_OF_FUNCTION(increment_counter);
182 /* maximal allowed length of a command line option */
183 #define MAX_OPTION_LEN 256
188 static unsigned int getCurrentMS()
190 return SDL_GetTicks();
193 #else /* !TARGET_SDL */
195 #if defined(PLATFORM_UNIX)
196 static unsigned int getCurrentMS()
198 struct timeval current_time;
200 gettimeofday(¤t_time, NULL);
202 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
204 #endif /* PLATFORM_UNIX */
205 #endif /* !TARGET_SDL */
207 static unsigned int mainCounter(int mode)
209 static unsigned int base_ms = 0;
210 unsigned int current_ms;
212 /* get current system milliseconds */
213 current_ms = getCurrentMS();
215 /* reset base timestamp in case of counter reset or wrap-around */
216 if (mode == INIT_COUNTER || current_ms < base_ms)
217 base_ms = current_ms;
219 /* return milliseconds since last counter reset */
220 return current_ms - base_ms;
226 static unsigned int mainCounter(int mode)
228 static unsigned int base_ms = 0;
229 unsigned int current_ms;
230 unsigned int counter_ms;
232 current_ms = SDL_GetTicks();
234 /* reset base time in case of counter initializing or wrap-around */
235 if (mode == INIT_COUNTER || current_ms < base_ms)
236 base_ms = current_ms;
238 counter_ms = current_ms - base_ms;
240 return counter_ms; /* return milliseconds since last init */
243 #else /* !TARGET_SDL */
245 #if defined(PLATFORM_UNIX)
246 static unsigned int mainCounter(int mode)
248 static struct timeval base_time = { 0, 0 };
249 struct timeval current_time;
250 unsigned int counter_ms;
252 gettimeofday(¤t_time, NULL);
254 /* reset base time in case of counter initializing or wrap-around */
255 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
256 base_time = current_time;
258 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
259 + (current_time.tv_usec - base_time.tv_usec) / 1000;
261 return counter_ms; /* return milliseconds since last init */
263 #endif /* PLATFORM_UNIX */
264 #endif /* !TARGET_SDL */
268 void InitCounter() /* set counter back to zero */
270 #if !defined(PLATFORM_MSDOS)
271 mainCounter(INIT_COUNTER);
273 LOCK_VARIABLE(counter);
274 LOCK_FUNCTION(increment_counter);
275 install_int_ex(increment_counter, BPS_TO_TIMER(100));
279 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
281 #if !defined(PLATFORM_MSDOS)
282 return mainCounter(READ_COUNTER);
284 return (counter * 10);
288 static void sleep_milliseconds(unsigned int milliseconds_delay)
290 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
294 /* we want to wait only a few ms -- if we assume that we have a
295 kernel timer resolution of 10 ms, we would wait far to long;
296 therefore it's better to do a short interval of busy waiting
297 to get our sleeping time more accurate */
299 unsigned int base_counter = Counter(), actual_counter = Counter();
301 while (actual_counter < base_counter + milliseconds_delay &&
302 actual_counter >= base_counter)
303 actual_counter = Counter();
307 #if defined(TARGET_SDL)
308 SDL_Delay(milliseconds_delay);
309 #elif defined(TARGET_ALLEGRO)
310 rest(milliseconds_delay);
312 struct timeval delay;
314 delay.tv_sec = milliseconds_delay / 1000;
315 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
317 if (select(0, NULL, NULL, NULL, &delay) != 0)
318 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
323 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
325 sleep_milliseconds(delay);
328 boolean FrameReached(unsigned int *frame_counter_var,
329 unsigned int frame_delay)
331 unsigned int actual_frame_counter = FrameCounter;
333 if (actual_frame_counter >= *frame_counter_var &&
334 actual_frame_counter < *frame_counter_var + frame_delay)
337 *frame_counter_var = actual_frame_counter;
342 boolean DelayReached(unsigned int *counter_var,
345 unsigned int actual_counter = Counter();
347 if (actual_counter >= *counter_var &&
348 actual_counter < *counter_var + delay)
351 *counter_var = actual_counter;
356 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
358 unsigned int actual_counter;
362 actual_counter = Counter();
364 if (actual_counter >= *counter_var &&
365 actual_counter < *counter_var + delay)
366 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
371 *counter_var = actual_counter;
375 /* ------------------------------------------------------------------------- */
376 /* random generator functions */
377 /* ------------------------------------------------------------------------- */
379 unsigned int init_random_number(int nr, int seed)
381 if (seed == NEW_RANDOMIZE)
383 /* default random seed */
384 seed = (int)time(NULL); // seconds since the epoch
386 #if !defined(PLATFORM_WIN32)
387 /* add some more randomness */
388 struct timeval current_time;
390 gettimeofday(¤t_time, NULL);
392 seed += (int)current_time.tv_usec; // microseconds since the epoch
395 #if defined(TARGET_SDL)
396 /* add some more randomness */
397 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
401 /* add some more randomness */
402 seed += GetSimpleRandom(1000000);
406 srandom_linux_libc(nr, (unsigned int) seed);
408 return (unsigned int) seed;
411 unsigned int get_random_number(int nr, int max)
413 return (max > 0 ? random_linux_libc(nr) % max : 0);
417 /* ------------------------------------------------------------------------- */
418 /* system info functions */
419 /* ------------------------------------------------------------------------- */
421 #if !defined(PLATFORM_MSDOS)
422 static char *get_corrected_real_name(char *real_name)
424 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
425 char *from_ptr = real_name;
426 char *to_ptr = real_name_new;
428 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
429 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
431 /* the name field read from "passwd" file may also contain additional
432 user information, separated by commas, which will be removed here */
433 if (*from_ptr == ',')
436 /* the user's real name may contain 'ß' characters (german sharp s),
437 which have no equivalent in upper case letters (used by our fonts) */
438 if (*from_ptr == 'ß')
445 *to_ptr++ = *from_ptr++;
450 return real_name_new;
456 static char *login_name = NULL;
458 #if defined(PLATFORM_WIN32)
459 if (login_name == NULL)
461 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
462 login_name = checked_malloc(buffer_size);
464 if (GetUserName(login_name, &buffer_size) == 0)
465 strcpy(login_name, ANONYMOUS_NAME);
468 if (login_name == NULL)
472 if ((pwd = getpwuid(getuid())) == NULL)
473 login_name = ANONYMOUS_NAME;
475 login_name = getStringCopy(pwd->pw_name);
484 static char *real_name = NULL;
486 #if defined(PLATFORM_WIN32)
487 if (real_name == NULL)
489 static char buffer[MAX_USERNAME_LEN + 1];
490 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
492 if (GetUserName(buffer, &buffer_size) != 0)
493 real_name = get_corrected_real_name(buffer);
495 real_name = ANONYMOUS_NAME;
497 #elif defined(PLATFORM_UNIX)
498 if (real_name == NULL)
502 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
503 real_name = get_corrected_real_name(pwd->pw_gecos);
505 real_name = ANONYMOUS_NAME;
508 real_name = ANONYMOUS_NAME;
514 time_t getFileTimestampEpochSeconds(char *filename)
516 struct stat file_status;
518 if (stat(filename, &file_status) != 0) /* cannot stat file */
521 return file_status.st_mtime;
525 /* ------------------------------------------------------------------------- */
526 /* path manipulation functions */
527 /* ------------------------------------------------------------------------- */
529 static char *getLastPathSeparatorPtr(char *filename)
531 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
533 if (last_separator == NULL) /* also try DOS/Windows variant */
534 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
536 return last_separator;
539 char *getBaseNamePtr(char *filename)
541 char *last_separator = getLastPathSeparatorPtr(filename);
543 if (last_separator != NULL)
544 return last_separator + 1; /* separator found: strip base path */
546 return filename; /* no separator found: filename has no path */
549 char *getBaseName(char *filename)
551 return getStringCopy(getBaseNamePtr(filename));
554 char *getBasePath(char *filename)
556 char *basepath = getStringCopy(filename);
557 char *last_separator = getLastPathSeparatorPtr(basepath);
559 if (last_separator != NULL)
560 *last_separator = '\0'; /* separator found: strip basename */
562 basepath = "."; /* no separator found: use current path */
568 /* ------------------------------------------------------------------------- */
569 /* various string functions */
570 /* ------------------------------------------------------------------------- */
572 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
574 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
577 sprintf(complete_string, "%s%s%s", s1, sep, s2);
579 return complete_string;
582 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
584 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
585 strlen(s2) + strlen(sep) +
588 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
590 return complete_string;
593 char *getStringCat2(char *s1, char *s2)
595 return getStringCat2WithSeparator(s1, s2, "");
598 char *getStringCat3(char *s1, char *s2, char *s3)
600 return getStringCat3WithSeparator(s1, s2, s3, "");
603 char *getPath2(char *path1, char *path2)
605 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
608 char *getPath3(char *path1, char *path2, char *path3)
610 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
613 char *getStringCopy(char *s)
620 s_copy = checked_malloc(strlen(s) + 1);
626 char *getStringCopyN(char *s, int n)
629 int s_len = MAX(0, n);
634 s_copy = checked_malloc(s_len + 1);
635 strncpy(s_copy, s, s_len);
636 s_copy[s_len] = '\0';
641 char *getStringToLower(char *s)
643 char *s_copy = checked_malloc(strlen(s) + 1);
644 char *s_ptr = s_copy;
647 *s_ptr++ = tolower(*s++);
653 void setString(char **old_value, char *new_value)
655 checked_free(*old_value);
657 *old_value = getStringCopy(new_value);
660 boolean strEqual(char *s1, char *s2)
662 return (s1 == NULL && s2 == NULL ? TRUE :
663 s1 == NULL && s2 != NULL ? FALSE :
664 s1 != NULL && s2 == NULL ? FALSE :
665 strcmp(s1, s2) == 0);
668 boolean strEqualN(char *s1, char *s2, int n)
670 return (s1 == NULL && s2 == NULL ? TRUE :
671 s1 == NULL && s2 != NULL ? FALSE :
672 s1 != NULL && s2 == NULL ? FALSE :
673 strncmp(s1, s2, n) == 0);
676 boolean strPrefix(char *s, char *prefix)
678 return (s == NULL && prefix == NULL ? TRUE :
679 s == NULL && prefix != NULL ? FALSE :
680 s != NULL && prefix == NULL ? FALSE :
681 strncmp(s, prefix, strlen(prefix)) == 0);
684 boolean strSuffix(char *s, char *suffix)
686 return (s == NULL && suffix == NULL ? TRUE :
687 s == NULL && suffix != NULL ? FALSE :
688 s != NULL && suffix == NULL ? FALSE :
689 strlen(s) < strlen(suffix) ? FALSE :
690 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
693 boolean strPrefixLower(char *s, char *prefix)
695 char *s_lower = getStringToLower(s);
696 boolean match = strPrefix(s_lower, prefix);
703 boolean strSuffixLower(char *s, char *suffix)
705 char *s_lower = getStringToLower(s);
706 boolean match = strSuffix(s_lower, suffix);
714 /* ------------------------------------------------------------------------- */
715 /* command line option handling functions */
716 /* ------------------------------------------------------------------------- */
718 void GetOptions(char *argv[], void (*print_usage_function)(void))
720 char *ro_base_path = RO_BASE_PATH;
721 char *rw_base_path = RW_BASE_PATH;
722 char **options_left = &argv[1];
724 #if !defined(PLATFORM_MACOSX)
725 /* if the program is configured to start from current directory (default),
726 determine program package directory (KDE/Konqueror does not do this by
727 itself and fails otherwise); on Mac OS X, the program binary is stored
728 in an application package directory -- do not try to use this directory
729 as the program data directory (Mac OS X handles this correctly anyway) */
731 if (strEqual(ro_base_path, "."))
732 ro_base_path = program.command_basepath;
733 if (strEqual(rw_base_path, "."))
734 rw_base_path = program.command_basepath;
737 /* initialize global program options */
738 options.display_name = NULL;
739 options.server_host = NULL;
740 options.server_port = 0;
742 options.ro_base_directory = ro_base_path;
743 options.rw_base_directory = rw_base_path;
744 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
745 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
746 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
747 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
748 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
750 options.execute_command = NULL;
751 options.special_flags = NULL;
753 options.serveronly = FALSE;
754 options.network = FALSE;
755 options.verbose = FALSE;
756 options.debug = FALSE;
757 options.debug_x11_sync = FALSE;
759 #if !defined(PLATFORM_UNIX)
760 if (*options_left == NULL) /* no options given -- enable verbose mode */
761 options.verbose = TRUE;
764 while (*options_left)
766 char option_str[MAX_OPTION_LEN];
767 char *option = options_left[0];
768 char *next_option = options_left[1];
769 char *option_arg = NULL;
770 int option_len = strlen(option);
772 if (option_len >= MAX_OPTION_LEN)
773 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
775 strcpy(option_str, option); /* copy argument into buffer */
778 if (strEqual(option, "--")) /* stop scanning arguments */
781 if (strPrefix(option, "--")) /* treat '--' like '-' */
784 option_arg = strchr(option, '=');
785 if (option_arg == NULL) /* no '=' in option */
786 option_arg = next_option;
789 *option_arg++ = '\0'; /* cut argument from option */
790 if (*option_arg == '\0') /* no argument after '=' */
791 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
794 option_len = strlen(option);
796 if (strEqual(option, "-"))
797 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
798 else if (strncmp(option, "-help", option_len) == 0)
800 print_usage_function();
804 else if (strncmp(option, "-display", option_len) == 0)
806 if (option_arg == NULL)
807 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
809 options.display_name = option_arg;
810 if (option_arg == next_option)
813 else if (strncmp(option, "-basepath", option_len) == 0)
815 if (option_arg == NULL)
816 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
818 /* this should be extended to separate options for ro and rw data */
819 options.ro_base_directory = ro_base_path = option_arg;
820 options.rw_base_directory = rw_base_path = option_arg;
821 if (option_arg == next_option)
824 /* adjust paths for sub-directories in base directory accordingly */
825 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
826 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
827 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
828 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
829 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
831 else if (strncmp(option, "-levels", option_len) == 0)
833 if (option_arg == NULL)
834 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
836 options.level_directory = option_arg;
837 if (option_arg == next_option)
840 else if (strncmp(option, "-graphics", option_len) == 0)
842 if (option_arg == NULL)
843 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
845 options.graphics_directory = option_arg;
846 if (option_arg == next_option)
849 else if (strncmp(option, "-sounds", option_len) == 0)
851 if (option_arg == NULL)
852 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
854 options.sounds_directory = option_arg;
855 if (option_arg == next_option)
858 else if (strncmp(option, "-music", option_len) == 0)
860 if (option_arg == NULL)
861 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
863 options.music_directory = option_arg;
864 if (option_arg == next_option)
867 else if (strncmp(option, "-network", option_len) == 0)
869 options.network = TRUE;
871 else if (strncmp(option, "-serveronly", option_len) == 0)
873 options.serveronly = TRUE;
875 else if (strncmp(option, "-verbose", option_len) == 0)
877 options.verbose = TRUE;
879 else if (strncmp(option, "-debug", option_len) == 0)
881 options.debug = TRUE;
883 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
885 options.debug_x11_sync = TRUE;
887 else if (strPrefix(option, "-D"))
890 options.special_flags = getStringCopy(&option[2]);
892 char *flags_string = &option[2];
893 unsigned int flags_value;
895 if (*flags_string == '\0')
896 Error(ERR_EXIT_HELP, "empty flag ignored");
898 flags_value = get_special_flags_function(flags_string);
900 if (flags_value == 0)
901 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
903 options.special_flags |= flags_value;
906 else if (strncmp(option, "-execute", option_len) == 0)
908 if (option_arg == NULL)
909 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
911 options.execute_command = option_arg;
912 if (option_arg == next_option)
915 /* when doing batch processing, always enable verbose mode (warnings) */
916 options.verbose = TRUE;
918 else if (*option == '-')
920 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
922 else if (options.server_host == NULL)
924 options.server_host = *options_left;
926 else if (options.server_port == 0)
928 options.server_port = atoi(*options_left);
929 if (options.server_port < 1024)
930 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
933 Error(ERR_EXIT_HELP, "too many arguments");
940 /* ------------------------------------------------------------------------- */
941 /* error handling functions */
942 /* ------------------------------------------------------------------------- */
944 /* used by SetError() and GetError() to store internal error messages */
945 static char internal_error[1024]; /* this is bad */
947 void SetError(char *format, ...)
951 va_start(ap, format);
952 vsprintf(internal_error, format, ap);
958 return internal_error;
961 void Error(int mode, char *format, ...)
963 static boolean last_line_was_separator = FALSE;
964 char *process_name = "";
966 /* display warnings only when running in verbose mode */
967 if (mode & ERR_WARN && !options.verbose)
970 if (mode == ERR_INFO_LINE)
972 if (!last_line_was_separator)
973 fprintf_line(program.error_file, format, 79);
975 last_line_was_separator = TRUE;
980 last_line_was_separator = FALSE;
982 if (mode & ERR_SOUND_SERVER)
983 process_name = " sound server";
984 else if (mode & ERR_NETWORK_SERVER)
985 process_name = " network server";
986 else if (mode & ERR_NETWORK_CLIENT)
987 process_name = " network client **";
993 fprintf(program.error_file, "%s%s: ", program.command_basename,
997 fprintf(program.error_file, "warning: ");
999 va_start(ap, format);
1000 vfprintf_newline(program.error_file, format, ap);
1004 if (mode & ERR_HELP)
1005 fprintf_newline(program.error_file,
1006 "%s: Try option '--help' for more information.",
1007 program.command_basename);
1009 if (mode & ERR_EXIT)
1010 fprintf_newline(program.error_file, "%s%s: aborting",
1011 program.command_basename, process_name);
1013 if (mode & ERR_EXIT)
1015 if (mode & ERR_FROM_SERVER)
1016 exit(1); /* child process: normal exit */
1018 program.exit_function(1); /* main process: clean up stuff */
1023 /* ------------------------------------------------------------------------- */
1024 /* checked memory allocation and freeing functions */
1025 /* ------------------------------------------------------------------------- */
1027 void *checked_malloc(unsigned int size)
1034 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1039 void *checked_calloc(unsigned int size)
1043 ptr = calloc(1, size);
1046 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1051 void *checked_realloc(void *ptr, unsigned int size)
1053 ptr = realloc(ptr, size);
1056 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1061 void checked_free(void *ptr)
1063 if (ptr != NULL) /* this check should be done by free() anyway */
1067 void clear_mem(void *ptr, unsigned int size)
1069 #if defined(PLATFORM_WIN32)
1070 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1071 char *cptr = (char *)ptr;
1076 memset(ptr, 0, size);
1081 /* ------------------------------------------------------------------------- */
1082 /* various helper functions */
1083 /* ------------------------------------------------------------------------- */
1085 inline void swap_numbers(int *i1, int *i2)
1093 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1105 /* the "put" variants of the following file access functions check for the file
1106 pointer being != NULL and return the number of bytes they have or would have
1107 written; this allows for chunk writing functions to first determine the size
1108 of the (not yet written) chunk, write the correct chunk size and finally
1109 write the chunk itself */
1111 int getFile8BitInteger(FILE *file)
1116 int putFile8BitInteger(FILE *file, int value)
1124 int getFile16BitInteger(FILE *file, int byte_order)
1126 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1127 return ((fgetc(file) << 8) |
1128 (fgetc(file) << 0));
1129 else /* BYTE_ORDER_LITTLE_ENDIAN */
1130 return ((fgetc(file) << 0) |
1131 (fgetc(file) << 8));
1134 int putFile16BitInteger(FILE *file, int value, int byte_order)
1138 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1140 fputc((value >> 8) & 0xff, file);
1141 fputc((value >> 0) & 0xff, file);
1143 else /* BYTE_ORDER_LITTLE_ENDIAN */
1145 fputc((value >> 0) & 0xff, file);
1146 fputc((value >> 8) & 0xff, file);
1153 int getFile32BitInteger(FILE *file, int byte_order)
1155 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1156 return ((fgetc(file) << 24) |
1157 (fgetc(file) << 16) |
1158 (fgetc(file) << 8) |
1159 (fgetc(file) << 0));
1160 else /* BYTE_ORDER_LITTLE_ENDIAN */
1161 return ((fgetc(file) << 0) |
1162 (fgetc(file) << 8) |
1163 (fgetc(file) << 16) |
1164 (fgetc(file) << 24));
1167 int putFile32BitInteger(FILE *file, int value, int byte_order)
1171 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1173 fputc((value >> 24) & 0xff, file);
1174 fputc((value >> 16) & 0xff, file);
1175 fputc((value >> 8) & 0xff, file);
1176 fputc((value >> 0) & 0xff, file);
1178 else /* BYTE_ORDER_LITTLE_ENDIAN */
1180 fputc((value >> 0) & 0xff, file);
1181 fputc((value >> 8) & 0xff, file);
1182 fputc((value >> 16) & 0xff, file);
1183 fputc((value >> 24) & 0xff, file);
1190 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1193 const int chunk_name_length = 4;
1195 /* read chunk name */
1196 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1199 if (chunk_size != NULL)
1201 /* read chunk size */
1202 *chunk_size = getFile32BitInteger(file, byte_order);
1205 return (feof(file) || ferror(file) ? FALSE : TRUE);
1208 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1213 /* write chunk name */
1215 fputs(chunk_name, file);
1217 num_bytes += strlen(chunk_name);
1219 if (chunk_size >= 0)
1221 /* write chunk size */
1223 putFile32BitInteger(file, chunk_size, byte_order);
1231 int getFileVersion(FILE *file)
1233 int version_major = fgetc(file);
1234 int version_minor = fgetc(file);
1235 int version_patch = fgetc(file);
1236 int version_build = fgetc(file);
1238 return VERSION_IDENT(version_major, version_minor, version_patch,
1242 int putFileVersion(FILE *file, int version)
1246 int version_major = VERSION_MAJOR(version);
1247 int version_minor = VERSION_MINOR(version);
1248 int version_patch = VERSION_PATCH(version);
1249 int version_build = VERSION_BUILD(version);
1251 fputc(version_major, file);
1252 fputc(version_minor, file);
1253 fputc(version_patch, file);
1254 fputc(version_build, file);
1260 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1264 for(i = 0; i < bytes && !feof(file); i++)
1265 buffer[i] = fgetc(file);
1268 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1272 for(i = 0; i < bytes; i++)
1273 fputc(buffer[i], file);
1276 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1278 while (bytes-- && !feof(file))
1282 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1289 /* ------------------------------------------------------------------------- */
1290 /* functions to translate key identifiers between different format */
1291 /* ------------------------------------------------------------------------- */
1293 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1294 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1295 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1296 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1298 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1307 /* normal cursor keys */
1308 { KSYM_Left, "XK_Left", "cursor left" },
1309 { KSYM_Right, "XK_Right", "cursor right" },
1310 { KSYM_Up, "XK_Up", "cursor up" },
1311 { KSYM_Down, "XK_Down", "cursor down" },
1313 /* keypad cursor keys */
1315 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1316 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1317 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1318 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1321 /* other keypad keys */
1322 #ifdef KSYM_KP_Enter
1323 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1324 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1325 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1326 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1327 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1328 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1332 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1333 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1334 { KSYM_Control_L, "XK_Control_L", "left control" },
1335 { KSYM_Control_R, "XK_Control_R", "right control" },
1336 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1337 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1338 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1339 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1340 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1341 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1342 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1343 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1345 /* some special keys */
1346 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1347 { KSYM_Delete, "XK_Delete", "delete" },
1348 { KSYM_Insert, "XK_Insert", "insert" },
1349 { KSYM_Tab, "XK_Tab", "tab" },
1350 { KSYM_Home, "XK_Home", "home" },
1351 { KSYM_End, "XK_End", "end" },
1352 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1353 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1354 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1356 /* ASCII 0x20 to 0x40 keys (except numbers) */
1357 { KSYM_space, "XK_space", "space" },
1358 { KSYM_exclam, "XK_exclam", "!" },
1359 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1360 { KSYM_numbersign, "XK_numbersign", "#" },
1361 { KSYM_dollar, "XK_dollar", "$" },
1362 { KSYM_percent, "XK_percent", "%" },
1363 { KSYM_ampersand, "XK_ampersand", "&" },
1364 { KSYM_apostrophe, "XK_apostrophe", "'" },
1365 { KSYM_parenleft, "XK_parenleft", "(" },
1366 { KSYM_parenright, "XK_parenright", ")" },
1367 { KSYM_asterisk, "XK_asterisk", "*" },
1368 { KSYM_plus, "XK_plus", "+" },
1369 { KSYM_comma, "XK_comma", "," },
1370 { KSYM_minus, "XK_minus", "-" },
1371 { KSYM_period, "XK_period", "." },
1372 { KSYM_slash, "XK_slash", "/" },
1373 { KSYM_colon, "XK_colon", ":" },
1374 { KSYM_semicolon, "XK_semicolon", ";" },
1375 { KSYM_less, "XK_less", "<" },
1376 { KSYM_equal, "XK_equal", "=" },
1377 { KSYM_greater, "XK_greater", ">" },
1378 { KSYM_question, "XK_question", "?" },
1379 { KSYM_at, "XK_at", "@" },
1381 /* more ASCII keys */
1382 { KSYM_bracketleft, "XK_bracketleft", "[" },
1383 { KSYM_backslash, "XK_backslash", "\\" },
1384 { KSYM_bracketright,"XK_bracketright", "]" },
1385 { KSYM_asciicircum, "XK_asciicircum", "^" },
1386 { KSYM_underscore, "XK_underscore", "_" },
1387 { KSYM_grave, "XK_grave", "grave" },
1388 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1389 { KSYM_braceleft, "XK_braceleft", "brace left" },
1390 { KSYM_bar, "XK_bar", "bar" },
1391 { KSYM_braceright, "XK_braceright", "brace right" },
1392 { KSYM_asciitilde, "XK_asciitilde", "~" },
1394 /* special (non-ASCII) keys */
1395 { KSYM_degree, "XK_degree", "°" },
1396 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1397 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1398 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1399 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1400 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1401 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1402 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1404 /* end-of-array identifier */
1410 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1412 static char name_buffer[30];
1415 if (key >= KSYM_A && key <= KSYM_Z)
1416 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1417 else if (key >= KSYM_a && key <= KSYM_z)
1418 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1419 else if (key >= KSYM_0 && key <= KSYM_9)
1420 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1421 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1422 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1423 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1424 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1425 else if (key == KSYM_UNDEFINED)
1426 strcpy(name_buffer, "(undefined)");
1433 if (key == translate_key[i].key)
1435 strcpy(name_buffer, translate_key[i].name);
1439 while (translate_key[++i].name);
1441 if (!translate_key[i].name)
1442 strcpy(name_buffer, "(unknown)");
1445 *name = name_buffer;
1447 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1449 static char name_buffer[30];
1452 if (key >= KSYM_A && key <= KSYM_Z)
1453 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1454 else if (key >= KSYM_a && key <= KSYM_z)
1455 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1456 else if (key >= KSYM_0 && key <= KSYM_9)
1457 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1458 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1459 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1460 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1461 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1462 else if (key == KSYM_UNDEFINED)
1463 strcpy(name_buffer, "[undefined]");
1470 if (key == translate_key[i].key)
1472 strcpy(name_buffer, translate_key[i].x11name);
1476 while (translate_key[++i].x11name);
1478 if (!translate_key[i].x11name)
1479 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1482 *x11name = name_buffer;
1484 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1486 Key key = KSYM_UNDEFINED;
1491 if (strEqual(translate_key[i].name, *name))
1493 key = translate_key[i].key;
1497 while (translate_key[++i].x11name);
1499 if (key == KSYM_UNDEFINED)
1500 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1504 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1506 Key key = KSYM_UNDEFINED;
1507 char *name_ptr = *x11name;
1509 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1511 char c = name_ptr[3];
1513 if (c >= 'A' && c <= 'Z')
1514 key = KSYM_A + (Key)(c - 'A');
1515 else if (c >= 'a' && c <= 'z')
1516 key = KSYM_a + (Key)(c - 'a');
1517 else if (c >= '0' && c <= '9')
1518 key = KSYM_0 + (Key)(c - '0');
1520 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1522 char c = name_ptr[6];
1524 if (c >= '0' && c <= '9')
1525 key = KSYM_KP_0 + (Key)(c - '0');
1527 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1529 char c1 = name_ptr[4];
1530 char c2 = name_ptr[5];
1533 if ((c1 >= '0' && c1 <= '9') &&
1534 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1535 d = atoi(&name_ptr[4]);
1537 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1538 key = KSYM_F1 + (Key)(d - 1);
1540 else if (strPrefix(name_ptr, "XK_"))
1546 if (strEqual(name_ptr, translate_key[i].x11name))
1548 key = translate_key[i].key;
1552 while (translate_key[++i].x11name);
1554 else if (strPrefix(name_ptr, "0x"))
1556 unsigned int value = 0;
1562 char c = *name_ptr++;
1565 if (c >= '0' && c <= '9')
1567 else if (c >= 'a' && c <= 'f')
1568 d = (int)(c - 'a' + 10);
1569 else if (c >= 'A' && c <= 'F')
1570 d = (int)(c - 'A' + 10);
1578 value = value * 16 + d;
1589 char *getKeyNameFromKey(Key key)
1593 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1597 char *getX11KeyNameFromKey(Key key)
1601 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1605 Key getKeyFromKeyName(char *name)
1609 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1613 Key getKeyFromX11KeyName(char *x11name)
1617 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1621 char getCharFromKey(Key key)
1623 char *keyname = getKeyNameFromKey(key);
1626 if (strlen(keyname) == 1)
1628 else if (strEqual(keyname, "space"))
1634 char getValidConfigValueChar(char c)
1636 if (c == '#' || /* used to mark comments */
1637 c == '\\') /* used to mark continued lines */
1644 /* ------------------------------------------------------------------------- */
1645 /* functions to translate string identifiers to integer or boolean value */
1646 /* ------------------------------------------------------------------------- */
1648 int get_integer_from_string(char *s)
1650 static char *number_text[][3] =
1652 { "0", "zero", "null", },
1653 { "1", "one", "first" },
1654 { "2", "two", "second" },
1655 { "3", "three", "third" },
1656 { "4", "four", "fourth" },
1657 { "5", "five", "fifth" },
1658 { "6", "six", "sixth" },
1659 { "7", "seven", "seventh" },
1660 { "8", "eight", "eighth" },
1661 { "9", "nine", "ninth" },
1662 { "10", "ten", "tenth" },
1663 { "11", "eleven", "eleventh" },
1664 { "12", "twelve", "twelfth" },
1666 { NULL, NULL, NULL },
1670 char *s_lower = getStringToLower(s);
1673 for (i = 0; number_text[i][0] != NULL; i++)
1674 for (j = 0; j < 3; j++)
1675 if (strEqual(s_lower, number_text[i][j]))
1680 if (strEqual(s_lower, "false") ||
1681 strEqual(s_lower, "no") ||
1682 strEqual(s_lower, "off"))
1684 else if (strEqual(s_lower, "true") ||
1685 strEqual(s_lower, "yes") ||
1686 strEqual(s_lower, "on"))
1697 boolean get_boolean_from_string(char *s)
1699 char *s_lower = getStringToLower(s);
1700 boolean result = FALSE;
1702 if (strEqual(s_lower, "true") ||
1703 strEqual(s_lower, "yes") ||
1704 strEqual(s_lower, "on") ||
1705 get_integer_from_string(s) == 1)
1713 int get_switch3_from_string(char *s)
1715 char *s_lower = getStringToLower(s);
1718 if (strEqual(s_lower, "true") ||
1719 strEqual(s_lower, "yes") ||
1720 strEqual(s_lower, "on") ||
1721 get_integer_from_string(s) == 1)
1723 else if (strEqual(s_lower, "auto"))
1732 /* ------------------------------------------------------------------------- */
1733 /* functions for generic lists */
1734 /* ------------------------------------------------------------------------- */
1736 ListNode *newListNode()
1738 return checked_calloc(sizeof(ListNode));
1741 void addNodeToList(ListNode **node_first, char *key, void *content)
1743 ListNode *node_new = newListNode();
1745 node_new->key = getStringCopy(key);
1746 node_new->content = content;
1747 node_new->next = *node_first;
1748 *node_first = node_new;
1751 void deleteNodeFromList(ListNode **node_first, char *key,
1752 void (*destructor_function)(void *))
1754 if (node_first == NULL || *node_first == NULL)
1757 if (strEqual((*node_first)->key, key))
1759 checked_free((*node_first)->key);
1760 if (destructor_function)
1761 destructor_function((*node_first)->content);
1762 *node_first = (*node_first)->next;
1765 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1768 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1770 if (node_first == NULL)
1773 if (strEqual(node_first->key, key))
1776 return getNodeFromKey(node_first->next, key);
1779 int getNumNodes(ListNode *node_first)
1781 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1784 void dumpList(ListNode *node_first)
1786 ListNode *node = node_first;
1790 printf("['%s' (%d)]\n", node->key,
1791 ((struct ListNodeInfo *)node->content)->num_references);
1795 printf("[%d nodes]\n", getNumNodes(node_first));
1799 /* ------------------------------------------------------------------------- */
1800 /* functions for checking files and filenames */
1801 /* ------------------------------------------------------------------------- */
1803 boolean fileExists(char *filename)
1805 if (filename == NULL)
1808 return (access(filename, F_OK) == 0);
1811 boolean fileHasPrefix(char *basename, char *prefix)
1813 static char *basename_lower = NULL;
1814 int basename_length, prefix_length;
1816 checked_free(basename_lower);
1818 if (basename == NULL || prefix == NULL)
1821 basename_lower = getStringToLower(basename);
1822 basename_length = strlen(basename_lower);
1823 prefix_length = strlen(prefix);
1825 if (basename_length > prefix_length + 1 &&
1826 basename_lower[prefix_length] == '.' &&
1827 strncmp(basename_lower, prefix, prefix_length) == 0)
1833 boolean fileHasSuffix(char *basename, char *suffix)
1835 static char *basename_lower = NULL;
1836 int basename_length, suffix_length;
1838 checked_free(basename_lower);
1840 if (basename == NULL || suffix == NULL)
1843 basename_lower = getStringToLower(basename);
1844 basename_length = strlen(basename_lower);
1845 suffix_length = strlen(suffix);
1847 if (basename_length > suffix_length + 1 &&
1848 basename_lower[basename_length - suffix_length - 1] == '.' &&
1849 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1855 boolean FileIsGraphic(char *filename)
1857 char *basename = getBaseNamePtr(filename);
1859 return fileHasSuffix(basename, "pcx");
1862 boolean FileIsSound(char *filename)
1864 char *basename = getBaseNamePtr(filename);
1866 return fileHasSuffix(basename, "wav");
1869 boolean FileIsMusic(char *filename)
1871 char *basename = getBaseNamePtr(filename);
1873 if (FileIsSound(basename))
1876 #if defined(TARGET_SDL)
1877 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
1878 fileHasSuffix(basename, "mod") ||
1879 fileHasSuffix(basename, "s3m") ||
1880 fileHasSuffix(basename, "it") ||
1881 fileHasSuffix(basename, "xm") ||
1882 fileHasSuffix(basename, "midi") ||
1883 fileHasSuffix(basename, "mid") ||
1884 fileHasSuffix(basename, "mp3") ||
1885 fileHasSuffix(basename, "ogg"))
1892 boolean FileIsArtworkType(char *basename, int type)
1894 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1895 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1896 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1902 /* ------------------------------------------------------------------------- */
1903 /* functions for loading artwork configuration information */
1904 /* ------------------------------------------------------------------------- */
1906 char *get_mapped_token(char *token)
1908 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1909 static char *map_token_prefix[][2] =
1911 { "char_procent", "char_percent" },
1916 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1918 int len_token_prefix = strlen(map_token_prefix[i][0]);
1920 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1921 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1927 /* This function checks if a string <s> of the format "string1, string2, ..."
1928 exactly contains a string <s_contained>. */
1930 static boolean string_has_parameter(char *s, char *s_contained)
1934 if (s == NULL || s_contained == NULL)
1937 if (strlen(s_contained) > strlen(s))
1940 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1942 char next_char = s[strlen(s_contained)];
1944 /* check if next character is delimiter or whitespace */
1945 return (next_char == ',' || next_char == '\0' ||
1946 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1949 /* check if string contains another parameter string after a comma */
1950 substring = strchr(s, ',');
1951 if (substring == NULL) /* string does not contain a comma */
1954 /* advance string pointer to next character after the comma */
1957 /* skip potential whitespaces after the comma */
1958 while (*substring == ' ' || *substring == '\t')
1961 return string_has_parameter(substring, s_contained);
1964 int get_parameter_value(char *value_raw, char *suffix, int type)
1966 char *value = getStringToLower(value_raw);
1967 int result = 0; /* probably a save default value */
1969 if (strEqual(suffix, ".direction"))
1971 result = (strEqual(value, "left") ? MV_LEFT :
1972 strEqual(value, "right") ? MV_RIGHT :
1973 strEqual(value, "up") ? MV_UP :
1974 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1976 else if (strEqual(suffix, ".align"))
1978 result = (strEqual(value, "left") ? ALIGN_LEFT :
1979 strEqual(value, "right") ? ALIGN_RIGHT :
1980 strEqual(value, "center") ? ALIGN_CENTER :
1981 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1983 else if (strEqual(suffix, ".valign"))
1985 result = (strEqual(value, "top") ? VALIGN_TOP :
1986 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1987 strEqual(value, "middle") ? VALIGN_MIDDLE :
1988 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1990 else if (strEqual(suffix, ".anim_mode"))
1992 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1993 string_has_parameter(value, "loop") ? ANIM_LOOP :
1994 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1995 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1996 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1997 string_has_parameter(value, "random") ? ANIM_RANDOM :
1998 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1999 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2000 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2001 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2002 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2003 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2006 if (string_has_parameter(value, "reverse"))
2007 result |= ANIM_REVERSE;
2009 if (string_has_parameter(value, "opaque_player"))
2010 result |= ANIM_OPAQUE_PLAYER;
2012 if (string_has_parameter(value, "static_panel"))
2013 result |= ANIM_STATIC_PANEL;
2015 else if (strEqual(suffix, ".class"))
2017 result = get_hash_from_key(value);
2019 else if (strEqual(suffix, ".style"))
2021 result = STYLE_DEFAULT;
2023 if (string_has_parameter(value, "accurate_borders"))
2024 result |= STYLE_ACCURATE_BORDERS;
2026 if (string_has_parameter(value, "inner_corners"))
2027 result |= STYLE_INNER_CORNERS;
2029 else if (strEqual(suffix, ".fade_mode"))
2031 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2032 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2033 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2034 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2038 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2040 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2043 result = gfx.get_font_from_token_function(value);
2045 else /* generic parameter of type integer or boolean */
2047 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2048 type == TYPE_INTEGER ? get_integer_from_string(value) :
2049 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2050 ARG_UNDEFINED_VALUE);
2058 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2060 static struct ScreenModeInfo screen_mode;
2061 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2062 char *screen_mode_string_copy;
2063 char *screen_mode_string_pos_w;
2064 char *screen_mode_string_pos_h;
2066 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2069 screen_mode_string_copy = getStringCopy(screen_mode_string);
2071 screen_mode_string_pos_w = screen_mode_string_copy;
2072 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2073 *screen_mode_string_pos_h++ = '\0';
2075 screen_mode.width = atoi(screen_mode_string_pos_w);
2076 screen_mode.height = atoi(screen_mode_string_pos_h);
2078 return &screen_mode;
2081 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2084 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2085 float aspect_ratio_new;
2090 *x = i * aspect_ratio + 0.000001;
2093 aspect_ratio_new = (float)*x / (float)*y;
2097 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2100 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2101 struct ListNodeInfo ***, int *);
2103 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2104 struct ConfigTypeInfo *suffix_list,
2105 char **ignore_tokens,
2106 int num_file_list_entries)
2108 struct FileInfo *file_list;
2109 int num_file_list_entries_found = 0;
2110 int num_suffix_list_entries = 0;
2114 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2116 for (i = 0; suffix_list[i].token != NULL; i++)
2117 num_suffix_list_entries++;
2119 /* always start with reliable default values */
2120 for (i = 0; i < num_file_list_entries; i++)
2122 file_list[i].token = NULL;
2124 file_list[i].default_filename = NULL;
2125 file_list[i].filename = NULL;
2127 if (num_suffix_list_entries > 0)
2129 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2131 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2132 file_list[i].parameter = checked_calloc(parameter_array_size);
2134 for (j = 0; j < num_suffix_list_entries; j++)
2136 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2137 setString(&file_list[i].parameter[j], suffix_list[j].value);
2140 file_list[i].redefined = FALSE;
2141 file_list[i].fallback_to_default = FALSE;
2142 file_list[i].default_is_cloned = FALSE;
2147 for (i = 0; config_list[i].token != NULL; i++)
2149 int len_config_token = strlen(config_list[i].token);
2150 int len_config_value = strlen(config_list[i].value);
2151 boolean is_file_entry = TRUE;
2153 for (j = 0; suffix_list[j].token != NULL; j++)
2155 int len_suffix = strlen(suffix_list[j].token);
2157 if (len_suffix < len_config_token &&
2158 strEqual(&config_list[i].token[len_config_token - len_suffix],
2159 suffix_list[j].token))
2161 setString(&file_list[list_pos].default_parameter[j],
2162 config_list[i].value);
2164 is_file_entry = FALSE;
2169 /* the following tokens are no file definitions, but other config tokens */
2170 for (j = 0; ignore_tokens[j] != NULL; j++)
2171 if (strEqual(config_list[i].token, ignore_tokens[j]))
2172 is_file_entry = FALSE;
2179 if (list_pos >= num_file_list_entries)
2182 /* simple sanity check if this is really a file definition */
2183 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2184 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2185 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2187 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2188 config_list[i].token, config_list[i].value);
2189 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2192 file_list[list_pos].token = config_list[i].token;
2193 file_list[list_pos].default_filename = config_list[i].value;
2196 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2200 if (strSuffix(config_list[i].token, ".clone_from"))
2201 file_list[list_pos].default_is_cloned = TRUE;
2204 num_file_list_entries_found = list_pos + 1;
2205 if (num_file_list_entries_found != num_file_list_entries)
2207 Error(ERR_INFO_LINE, "-");
2208 Error(ERR_INFO, "inconsistant config list information:");
2209 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2210 num_file_list_entries);
2211 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2212 num_file_list_entries_found);
2213 Error(ERR_EXIT, "please fix");
2217 printf("::: ---------- DONE ----------\n");
2223 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2225 int len_token = strlen(token);
2226 int len_suffix = strlen(suffix);
2228 if (start_pos < 0) /* compare suffix from end of string */
2229 start_pos += len_token;
2231 if (start_pos < 0 || start_pos + len_suffix > len_token)
2234 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2237 if (token[start_pos + len_suffix] == '\0')
2240 if (token[start_pos + len_suffix] == '.')
2246 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2248 static void read_token_parameters(SetupFileHash *setup_file_hash,
2249 struct ConfigTypeInfo *suffix_list,
2250 struct FileInfo *file_list_entry)
2252 /* check for config token that is the base token without any suffixes */
2253 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2254 char *known_token_value = KNOWN_TOKEN_VALUE;
2257 if (filename != NULL)
2259 setString(&file_list_entry->filename, filename);
2261 /* when file definition found, set all parameters to default values */
2262 for (i = 0; suffix_list[i].token != NULL; i++)
2263 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2265 file_list_entry->redefined = TRUE;
2267 /* mark config file token as well known from default config */
2268 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2271 /* check for config tokens that can be build by base token and suffixes */
2272 for (i = 0; suffix_list[i].token != NULL; i++)
2274 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2275 char *value = getHashEntry(setup_file_hash, token);
2279 setString(&file_list_entry->parameter[i], value);
2281 /* mark config file token as well known from default config */
2282 setHashEntry(setup_file_hash, token, known_token_value);
2289 static void add_dynamic_file_list_entry(struct FileInfo **list,
2290 int *num_list_entries,
2291 SetupFileHash *extra_file_hash,
2292 struct ConfigTypeInfo *suffix_list,
2293 int num_suffix_list_entries,
2296 struct FileInfo *new_list_entry;
2297 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2299 (*num_list_entries)++;
2300 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2301 new_list_entry = &(*list)[*num_list_entries - 1];
2303 new_list_entry->token = getStringCopy(token);
2304 new_list_entry->default_filename = NULL;
2305 new_list_entry->filename = NULL;
2306 new_list_entry->parameter = checked_calloc(parameter_array_size);
2308 new_list_entry->redefined = FALSE;
2309 new_list_entry->fallback_to_default = FALSE;
2310 new_list_entry->default_is_cloned = FALSE;
2312 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2315 static void add_property_mapping(struct PropertyMapping **list,
2316 int *num_list_entries,
2317 int base_index, int ext1_index,
2318 int ext2_index, int ext3_index,
2321 struct PropertyMapping *new_list_entry;
2323 (*num_list_entries)++;
2324 *list = checked_realloc(*list,
2325 *num_list_entries * sizeof(struct PropertyMapping));
2326 new_list_entry = &(*list)[*num_list_entries - 1];
2328 new_list_entry->base_index = base_index;
2329 new_list_entry->ext1_index = ext1_index;
2330 new_list_entry->ext2_index = ext2_index;
2331 new_list_entry->ext3_index = ext3_index;
2333 new_list_entry->artwork_index = artwork_index;
2336 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2339 struct FileInfo *file_list = artwork_info->file_list;
2340 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2341 char **base_prefixes = artwork_info->base_prefixes;
2342 char **ext1_suffixes = artwork_info->ext1_suffixes;
2343 char **ext2_suffixes = artwork_info->ext2_suffixes;
2344 char **ext3_suffixes = artwork_info->ext3_suffixes;
2345 char **ignore_tokens = artwork_info->ignore_tokens;
2346 int num_file_list_entries = artwork_info->num_file_list_entries;
2347 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2348 int num_base_prefixes = artwork_info->num_base_prefixes;
2349 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2350 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2351 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2352 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2353 SetupFileHash *setup_file_hash, *valid_file_hash;
2354 SetupFileHash *extra_file_hash, *empty_file_hash;
2355 char *known_token_value = KNOWN_TOKEN_VALUE;
2358 if (filename == NULL)
2362 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2365 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2368 /* separate valid (defined) from empty (undefined) config token values */
2369 valid_file_hash = newSetupFileHash();
2370 empty_file_hash = newSetupFileHash();
2371 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2373 char *value = HASH_ITERATION_VALUE(itr);
2375 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2376 HASH_ITERATION_TOKEN(itr), value);
2378 END_HASH_ITERATION(setup_file_hash, itr)
2380 /* at this point, we do not need the setup file hash anymore -- free it */
2381 freeSetupFileHash(setup_file_hash);
2383 /* map deprecated to current tokens (using prefix match and replace) */
2384 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2386 char *token = HASH_ITERATION_TOKEN(itr);
2387 char *mapped_token = get_mapped_token(token);
2389 if (mapped_token != NULL)
2391 char *value = HASH_ITERATION_VALUE(itr);
2393 /* add mapped token */
2394 setHashEntry(valid_file_hash, mapped_token, value);
2396 /* ignore old token (by setting it to "known" keyword) */
2397 setHashEntry(valid_file_hash, token, known_token_value);
2402 END_HASH_ITERATION(valid_file_hash, itr)
2404 /* read parameters for all known config file tokens */
2405 for (i = 0; i < num_file_list_entries; i++)
2406 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2408 /* set all tokens that can be ignored here to "known" keyword */
2409 for (i = 0; i < num_ignore_tokens; i++)
2410 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2412 /* copy all unknown config file tokens to extra config hash */
2413 extra_file_hash = newSetupFileHash();
2414 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2416 char *value = HASH_ITERATION_VALUE(itr);
2418 if (!strEqual(value, known_token_value))
2419 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2421 END_HASH_ITERATION(valid_file_hash, itr)
2423 /* at this point, we do not need the valid file hash anymore -- free it */
2424 freeSetupFileHash(valid_file_hash);
2426 /* now try to determine valid, dynamically defined config tokens */
2428 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2430 struct FileInfo **dynamic_file_list =
2431 &artwork_info->dynamic_file_list;
2432 int *num_dynamic_file_list_entries =
2433 &artwork_info->num_dynamic_file_list_entries;
2434 struct PropertyMapping **property_mapping =
2435 &artwork_info->property_mapping;
2436 int *num_property_mapping_entries =
2437 &artwork_info->num_property_mapping_entries;
2438 int current_summarized_file_list_entry =
2439 artwork_info->num_file_list_entries +
2440 artwork_info->num_dynamic_file_list_entries;
2441 char *token = HASH_ITERATION_TOKEN(itr);
2442 int len_token = strlen(token);
2444 boolean base_prefix_found = FALSE;
2445 boolean parameter_suffix_found = FALSE;
2448 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2451 /* skip all parameter definitions (handled by read_token_parameters()) */
2452 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2454 int len_suffix = strlen(suffix_list[i].token);
2456 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2457 parameter_suffix_found = TRUE;
2460 if (parameter_suffix_found)
2463 /* ---------- step 0: search for matching base prefix ---------- */
2466 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2468 char *base_prefix = base_prefixes[i];
2469 int len_base_prefix = strlen(base_prefix);
2470 boolean ext1_suffix_found = FALSE;
2471 boolean ext2_suffix_found = FALSE;
2472 boolean ext3_suffix_found = FALSE;
2473 boolean exact_match = FALSE;
2474 int base_index = -1;
2475 int ext1_index = -1;
2476 int ext2_index = -1;
2477 int ext3_index = -1;
2479 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2481 if (!base_prefix_found)
2487 if (IS_PARENT_PROCESS())
2488 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2491 if (start_pos + len_base_prefix == len_token) /* exact match */
2496 if (IS_PARENT_PROCESS())
2497 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2500 add_dynamic_file_list_entry(dynamic_file_list,
2501 num_dynamic_file_list_entries,
2504 num_suffix_list_entries,
2506 add_property_mapping(property_mapping,
2507 num_property_mapping_entries,
2508 base_index, -1, -1, -1,
2509 current_summarized_file_list_entry);
2514 if (IS_PARENT_PROCESS())
2515 printf("---> examining token '%s': search 1st suffix ...\n", token);
2518 /* ---------- step 1: search for matching first suffix ---------- */
2520 start_pos += len_base_prefix;
2521 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2523 char *ext1_suffix = ext1_suffixes[j];
2524 int len_ext1_suffix = strlen(ext1_suffix);
2526 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2528 if (!ext1_suffix_found)
2534 if (IS_PARENT_PROCESS())
2535 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2538 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2543 if (IS_PARENT_PROCESS())
2544 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2547 add_dynamic_file_list_entry(dynamic_file_list,
2548 num_dynamic_file_list_entries,
2551 num_suffix_list_entries,
2553 add_property_mapping(property_mapping,
2554 num_property_mapping_entries,
2555 base_index, ext1_index, -1, -1,
2556 current_summarized_file_list_entry);
2560 start_pos += len_ext1_suffix;
2567 if (IS_PARENT_PROCESS())
2568 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2571 /* ---------- step 2: search for matching second suffix ---------- */
2573 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2575 char *ext2_suffix = ext2_suffixes[k];
2576 int len_ext2_suffix = strlen(ext2_suffix);
2578 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2580 if (!ext2_suffix_found)
2586 if (IS_PARENT_PROCESS())
2587 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2590 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2595 if (IS_PARENT_PROCESS())
2596 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2599 add_dynamic_file_list_entry(dynamic_file_list,
2600 num_dynamic_file_list_entries,
2603 num_suffix_list_entries,
2605 add_property_mapping(property_mapping,
2606 num_property_mapping_entries,
2607 base_index, ext1_index, ext2_index, -1,
2608 current_summarized_file_list_entry);
2612 start_pos += len_ext2_suffix;
2619 if (IS_PARENT_PROCESS())
2620 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2623 /* ---------- step 3: search for matching third suffix ---------- */
2625 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2627 char *ext3_suffix = ext3_suffixes[l];
2628 int len_ext3_suffix = strlen(ext3_suffix);
2630 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2632 if (!ext3_suffix_found)
2638 if (IS_PARENT_PROCESS())
2639 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2642 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2647 if (IS_PARENT_PROCESS())
2648 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2651 add_dynamic_file_list_entry(dynamic_file_list,
2652 num_dynamic_file_list_entries,
2655 num_suffix_list_entries,
2657 add_property_mapping(property_mapping,
2658 num_property_mapping_entries,
2659 base_index, ext1_index, ext2_index, ext3_index,
2660 current_summarized_file_list_entry);
2666 END_HASH_ITERATION(extra_file_hash, itr)
2668 if (artwork_info->num_dynamic_file_list_entries > 0)
2670 artwork_info->dynamic_artwork_list =
2671 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2672 artwork_info->sizeof_artwork_list_entry);
2675 if (options.verbose && IS_PARENT_PROCESS())
2677 SetupFileList *setup_file_list, *list;
2678 boolean dynamic_tokens_found = FALSE;
2679 boolean unknown_tokens_found = FALSE;
2680 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2682 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2683 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2685 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2687 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2688 dynamic_tokens_found = TRUE;
2690 unknown_tokens_found = TRUE;
2692 END_HASH_ITERATION(extra_file_hash, itr)
2694 if (options.debug && dynamic_tokens_found)
2696 Error(ERR_INFO_LINE, "-");
2697 Error(ERR_INFO, "dynamic token(s) found in config file:");
2698 Error(ERR_INFO, "- config file: '%s'", filename);
2700 for (list = setup_file_list; list != NULL; list = list->next)
2702 char *value = getHashEntry(extra_file_hash, list->token);
2704 if (value != NULL && strEqual(value, known_token_value))
2705 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2708 Error(ERR_INFO_LINE, "-");
2711 if (unknown_tokens_found)
2713 Error(ERR_INFO_LINE, "-");
2714 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2715 Error(ERR_INFO, "- config file: '%s'", filename);
2717 for (list = setup_file_list; list != NULL; list = list->next)
2719 char *value = getHashEntry(extra_file_hash, list->token);
2721 if (value != NULL && !strEqual(value, known_token_value))
2722 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2725 Error(ERR_INFO_LINE, "-");
2728 if (undefined_values_found)
2730 Error(ERR_INFO_LINE, "-");
2731 Error(ERR_INFO, "warning: undefined values found in config file:");
2732 Error(ERR_INFO, "- config file: '%s'", filename);
2734 for (list = setup_file_list; list != NULL; list = list->next)
2736 char *value = getHashEntry(empty_file_hash, list->token);
2739 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2742 Error(ERR_INFO_LINE, "-");
2745 freeSetupFileList(setup_file_list);
2748 freeSetupFileHash(extra_file_hash);
2749 freeSetupFileHash(empty_file_hash);
2752 for (i = 0; i < num_file_list_entries; i++)
2754 printf("'%s' ", file_list[i].token);
2755 if (file_list[i].filename)
2756 printf("-> '%s'\n", file_list[i].filename);
2758 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2763 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2765 struct FileInfo *file_list = artwork_info->file_list;
2766 int num_file_list_entries = artwork_info->num_file_list_entries;
2767 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2768 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2771 DrawInitText("Loading artwork config", 120, FC_GREEN);
2772 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2774 /* always start with reliable default values */
2775 for (i = 0; i < num_file_list_entries; i++)
2777 setString(&file_list[i].filename, file_list[i].default_filename);
2779 for (j = 0; j < num_suffix_list_entries; j++)
2780 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2782 file_list[i].redefined = FALSE;
2783 file_list[i].fallback_to_default = FALSE;
2786 /* free previous dynamic artwork file array */
2787 if (artwork_info->dynamic_file_list != NULL)
2789 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2791 free(artwork_info->dynamic_file_list[i].token);
2792 free(artwork_info->dynamic_file_list[i].filename);
2793 free(artwork_info->dynamic_file_list[i].parameter);
2796 free(artwork_info->dynamic_file_list);
2797 artwork_info->dynamic_file_list = NULL;
2799 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2800 &artwork_info->num_dynamic_file_list_entries);
2803 /* free previous property mapping */
2804 if (artwork_info->property_mapping != NULL)
2806 free(artwork_info->property_mapping);
2808 artwork_info->property_mapping = NULL;
2809 artwork_info->num_property_mapping_entries = 0;
2813 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2815 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2818 /* first look for special artwork configured in level series config */
2819 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2822 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2823 leveldir_current->graphics_set,
2824 leveldir_current->graphics_path);
2827 if (fileExists(filename_base))
2828 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2831 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2833 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2834 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2837 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2838 struct ListNodeInfo **listnode)
2842 char *filename = (*listnode)->source_filename;
2844 if (--(*listnode)->num_references <= 0)
2845 deleteNodeFromList(&artwork_info->content_list, filename,
2846 artwork_info->free_artwork);
2852 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2853 struct ListNodeInfo **listnode,
2854 struct FileInfo *file_list_entry)
2864 char *basename = file_list_entry->filename;
2865 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2867 if (filename == NULL)
2869 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2871 basename = file_list_entry->default_filename;
2873 /* fail for cloned default artwork that has no default filename defined */
2874 if (file_list_entry->default_is_cloned &&
2875 strEqual(basename, UNDEFINED_FILENAME))
2877 int error_mode = ERR_WARN;
2879 /* we can get away without sounds and music, but not without graphics */
2880 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2881 error_mode = ERR_EXIT;
2883 Error(error_mode, "token '%s' was cloned and has no default filename",
2884 file_list_entry->token);
2889 /* dynamic artwork has no default filename / skip empty default artwork */
2890 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2893 file_list_entry->fallback_to_default = TRUE;
2895 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2897 filename = getCustomArtworkFilename(basename, artwork_info->type);
2899 if (filename == NULL)
2901 int error_mode = ERR_WARN;
2903 /* we can get away without sounds and music, but not without graphics */
2904 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2905 error_mode = ERR_EXIT;
2907 Error(error_mode, "cannot find default artwork file '%s'", basename);
2913 /* check if the old and the new artwork file are the same */
2914 if (*listnode && strEqual((*listnode)->source_filename, filename))
2916 /* The old and new artwork are the same (have the same filename and path).
2917 This usually means that this artwork does not exist in this artwork set
2918 and a fallback to the existing artwork is done. */
2921 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2927 /* delete existing artwork file entry */
2928 deleteArtworkListEntry(artwork_info, listnode);
2930 /* check if the new artwork file already exists in the list of artworks */
2931 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2934 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2937 *listnode = (struct ListNodeInfo *)node->content;
2938 (*listnode)->num_references++;
2943 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2944 DrawInitText(basename, 150, FC_YELLOW);
2946 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2949 printf("[adding new artwork '%s']\n", filename);
2952 (*listnode)->num_references = 1;
2953 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2958 int error_mode = ERR_WARN;
2960 /* we can get away without sounds and music, but not without graphics */
2961 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2962 error_mode = ERR_EXIT;
2964 Error(error_mode, "cannot load artwork file '%s'", basename);
2970 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2971 struct ListNodeInfo **listnode,
2972 struct FileInfo *file_list_entry)
2975 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2978 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2980 deleteArtworkListEntry(artwork_info, listnode);
2984 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2987 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2989 struct FileInfo *file_list = artwork_info->file_list;
2990 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2991 int num_file_list_entries = artwork_info->num_file_list_entries;
2992 int num_dynamic_file_list_entries =
2993 artwork_info->num_dynamic_file_list_entries;
2996 for (i = 0; i < num_file_list_entries; i++)
2997 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3000 for (i = 0; i < num_dynamic_file_list_entries; i++)
3001 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3002 &dynamic_file_list[i]);
3005 dumpList(artwork_info->content_list);
3009 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3010 struct ListNodeInfo ***list,
3011 int *num_list_entries)
3018 for (i = 0; i < *num_list_entries; i++)
3019 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3023 *num_list_entries = 0;
3026 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3028 if (artwork_info == NULL)
3031 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3032 &artwork_info->num_file_list_entries);
3034 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3035 &artwork_info->num_dynamic_file_list_entries);
3039 /* ------------------------------------------------------------------------- */
3040 /* functions only needed for non-Unix (non-command-line) systems */
3041 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3042 /* (now also added for Windows, to create files in user data directory) */
3043 /* ------------------------------------------------------------------------- */
3045 char *getErrorFilename(char *basename)
3047 return getPath2(getUserGameDataDir(), basename);
3050 void openErrorFile()
3052 InitUserDataDirectory();
3054 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3055 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
3056 program.error_filename);
3059 void closeErrorFile()
3061 if (program.error_file != stderr) /* do not close stream 'stderr' */
3062 fclose(program.error_file);
3065 void dumpErrorFile()
3067 FILE *error_file = fopen(program.error_filename, MODE_READ);
3069 if (error_file != NULL)
3071 while (!feof(error_file))
3072 fputc(fgetc(error_file), stderr);
3078 void NotifyUserAboutErrorFile()
3080 #if defined(PLATFORM_WIN32)
3081 char *title_text = getStringCat2(program.program_title, " Error Message");
3082 char *error_text = getStringCat2("The program was aborted due to an error; "
3083 "for details, see the following error file:"
3084 STRING_NEWLINE, program.error_filename);
3086 MessageBox(NULL, error_text, title_text, MB_OK);
3091 /* ------------------------------------------------------------------------- */
3092 /* the following is only for debugging purpose and normally not used */
3093 /* ------------------------------------------------------------------------- */
3097 #define DEBUG_NUM_TIMESTAMPS 5
3098 #define DEBUG_TIME_IN_MICROSECONDS 0
3100 #if DEBUG_TIME_IN_MICROSECONDS
3101 static double Counter_Microseconds()
3103 static struct timeval base_time = { 0, 0 };
3104 struct timeval current_time;
3107 gettimeofday(¤t_time, NULL);
3109 /* reset base time in case of wrap-around */
3110 if (current_time.tv_sec < base_time.tv_sec)
3111 base_time = current_time;
3114 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3115 ((double)(current_time.tv_usec - base_time.tv_usec));
3117 return counter; /* return microseconds since last init */
3121 char *debug_print_timestamp_get_padding(int padding_size)
3123 static char *padding = NULL;
3124 int max_padding_size = 100;
3126 if (padding == NULL)
3128 padding = checked_calloc(max_padding_size + 1);
3129 memset(padding, ' ', max_padding_size);
3132 return &padding[MAX(0, max_padding_size - padding_size)];
3135 void debug_print_timestamp(int counter_nr, char *message)
3137 int indent_size = 8;
3138 int padding_size = 40;
3139 float timestamp_interval;
3142 Error(ERR_EXIT, "debugging: invalid negative counter");
3143 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3144 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3146 #if DEBUG_TIME_IN_MICROSECONDS
3147 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3150 counter[counter_nr][0] = Counter_Microseconds();
3152 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3155 counter[counter_nr][0] = Counter();
3158 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3159 counter[counter_nr][1] = counter[counter_nr][0];
3162 printf("%s%s%s %.3f %s\n",
3163 debug_print_timestamp_get_padding(counter_nr * indent_size),
3165 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3166 timestamp_interval / 1000,
3170 void debug_print_parent_only(char *format, ...)
3172 if (!IS_PARENT_PROCESS())
3179 va_start(ap, format);
3180 vprintf(format, ap);