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>
26 #if !defined(PLATFORM_WIN32)
28 #include <sys/param.h>
38 /* ========================================================================= */
39 /* some generic helper functions */
40 /* ========================================================================= */
42 /* ------------------------------------------------------------------------- */
43 /* platform independent wrappers for printf() et al. (newline aware) */
44 /* ------------------------------------------------------------------------- */
46 #if defined(PLATFORM_ANDROID)
47 static int android_log_prio = ANDROID_LOG_INFO;
51 static void vfPrintLog(FILE *stream, char *format, va_list ap)
55 static void vfPrintLog(FILE *stream, char *format, va_list ap)
59 static void fPrintLog(FILE *stream, char *format, va_list ap)
63 static void fPrintLog(FILE *stream, char *format, va_list ap)
68 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
70 #if defined(PLATFORM_ANDROID)
71 __android_log_vprint(android_log_prio, program.program_title, format, ap);
73 char *newline = STRING_NEWLINE;
75 vfprintf(stream, format, ap);
76 fprintf(stream, "%s", newline);
80 static void fprintf_newline(FILE *stream, char *format, ...)
85 vfprintf_newline(stream, format, ap);
89 void fprintf_line(FILE *stream, char *line_chars, int line_length)
93 for (i = 0; i < line_length; i++)
94 fprintf(stream, "%s", line_chars);
96 fprintf_newline(stream, "");
99 void printf_line(char *line_chars, int line_length)
101 fprintf_line(stdout, line_chars, line_length);
104 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
106 fprintf(stdout, "%s", prefix);
107 fprintf_line(stdout, line_chars, line_length);
111 /* ------------------------------------------------------------------------- */
112 /* string functions */
113 /* ------------------------------------------------------------------------- */
115 /* int2str() returns a number converted to a string;
116 the used memory is static, but will be overwritten by later calls,
117 so if you want to save the result, copy it to a private string buffer;
118 there can be 10 local calls of int2str() without buffering the result --
119 the 11th call will then destroy the result from the first call and so on.
122 char *int2str(int number, int size)
124 static char shift_array[10][40];
125 static int shift_counter = 0;
126 char *s = shift_array[shift_counter];
128 shift_counter = (shift_counter + 1) % 10;
135 sprintf(s, " %09d", number);
136 return &s[strlen(s) - size];
140 sprintf(s, "%d", number);
146 /* something similar to "int2str()" above, but allocates its own memory
147 and has a different interface; we cannot use "itoa()", because this
148 seems to be already defined when cross-compiling to the win32 target */
150 char *i_to_a(unsigned int i)
152 static char *a = NULL;
156 if (i > 2147483647) /* yes, this is a kludge */
159 a = checked_malloc(10 + 1);
167 /* calculate base-2 logarithm of argument (rounded down to integer;
168 this function returns the number of the highest bit set in argument) */
170 int log_2(unsigned int x)
176 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
183 boolean getTokenValueFromString(char *string, char **token, char **value)
185 return getTokenValueFromSetupLine(string, token, value);
189 /* ------------------------------------------------------------------------- */
190 /* counter functions */
191 /* ------------------------------------------------------------------------- */
193 #if defined(PLATFORM_MSDOS)
194 volatile unsigned int counter = 0;
196 void increment_counter()
201 END_OF_FUNCTION(increment_counter);
205 /* maximal allowed length of a command line option */
206 #define MAX_OPTION_LEN 256
210 #if defined(TARGET_SDL)
211 static unsigned int getCurrentMS()
213 return SDL_GetTicks();
216 #else /* !TARGET_SDL */
218 #if defined(PLATFORM_UNIX)
219 static unsigned int getCurrentMS()
221 struct timeval current_time;
223 gettimeofday(¤t_time, NULL);
225 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
227 #endif /* PLATFORM_UNIX */
228 #endif /* !TARGET_SDL */
230 static unsigned int mainCounter(int mode)
232 static unsigned int base_ms = 0;
233 unsigned int current_ms;
235 /* get current system milliseconds */
236 current_ms = getCurrentMS();
238 /* reset base timestamp in case of counter reset or wrap-around */
239 if (mode == INIT_COUNTER || current_ms < base_ms)
240 base_ms = current_ms;
242 /* return milliseconds since last counter reset */
243 return current_ms - base_ms;
248 #if defined(TARGET_SDL)
249 static unsigned int mainCounter(int mode)
251 static unsigned int base_ms = 0;
252 unsigned int current_ms;
253 unsigned int counter_ms;
255 current_ms = SDL_GetTicks();
257 /* reset base time in case of counter initializing or wrap-around */
258 if (mode == INIT_COUNTER || current_ms < base_ms)
259 base_ms = current_ms;
261 counter_ms = current_ms - base_ms;
263 return counter_ms; /* return milliseconds since last init */
266 #else /* !TARGET_SDL */
268 #if defined(PLATFORM_UNIX)
269 static unsigned int mainCounter(int mode)
271 static struct timeval base_time = { 0, 0 };
272 struct timeval current_time;
273 unsigned int counter_ms;
275 gettimeofday(¤t_time, NULL);
277 /* reset base time in case of counter initializing or wrap-around */
278 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
279 base_time = current_time;
281 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
282 + (current_time.tv_usec - base_time.tv_usec) / 1000;
284 return counter_ms; /* return milliseconds since last init */
286 #endif /* PLATFORM_UNIX */
287 #endif /* !TARGET_SDL */
291 void InitCounter() /* set counter back to zero */
293 #if !defined(PLATFORM_MSDOS)
294 mainCounter(INIT_COUNTER);
296 LOCK_VARIABLE(counter);
297 LOCK_FUNCTION(increment_counter);
298 install_int_ex(increment_counter, BPS_TO_TIMER(100));
302 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
304 #if !defined(PLATFORM_MSDOS)
305 return mainCounter(READ_COUNTER);
307 return (counter * 10);
311 static void sleep_milliseconds(unsigned int milliseconds_delay)
313 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
317 /* we want to wait only a few ms -- if we assume that we have a
318 kernel timer resolution of 10 ms, we would wait far to long;
319 therefore it's better to do a short interval of busy waiting
320 to get our sleeping time more accurate */
322 unsigned int base_counter = Counter(), actual_counter = Counter();
324 while (actual_counter < base_counter + milliseconds_delay &&
325 actual_counter >= base_counter)
326 actual_counter = Counter();
330 #if defined(TARGET_SDL)
331 SDL_Delay(milliseconds_delay);
332 #elif defined(TARGET_ALLEGRO)
333 rest(milliseconds_delay);
335 struct timeval delay;
337 delay.tv_sec = milliseconds_delay / 1000;
338 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
340 if (select(0, NULL, NULL, NULL, &delay) != 0)
341 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
346 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
348 sleep_milliseconds(delay);
351 boolean FrameReached(unsigned int *frame_counter_var,
352 unsigned int frame_delay)
354 unsigned int actual_frame_counter = FrameCounter;
356 if (actual_frame_counter >= *frame_counter_var &&
357 actual_frame_counter < *frame_counter_var + frame_delay)
360 *frame_counter_var = actual_frame_counter;
365 boolean DelayReached(unsigned int *counter_var,
368 unsigned int actual_counter = Counter();
370 if (actual_counter >= *counter_var &&
371 actual_counter < *counter_var + delay)
374 *counter_var = actual_counter;
379 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
381 unsigned int actual_counter;
385 actual_counter = Counter();
387 if (actual_counter >= *counter_var &&
388 actual_counter < *counter_var + delay)
389 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
394 *counter_var = actual_counter;
398 /* ------------------------------------------------------------------------- */
399 /* random generator functions */
400 /* ------------------------------------------------------------------------- */
402 unsigned int init_random_number(int nr, int seed)
404 if (seed == NEW_RANDOMIZE)
406 /* default random seed */
407 seed = (int)time(NULL); // seconds since the epoch
409 #if !defined(PLATFORM_WIN32)
410 /* add some more randomness */
411 struct timeval current_time;
413 gettimeofday(¤t_time, NULL);
415 seed += (int)current_time.tv_usec; // microseconds since the epoch
418 #if defined(TARGET_SDL)
419 /* add some more randomness */
420 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
424 /* add some more randomness */
425 seed += GetSimpleRandom(1000000);
429 srandom_linux_libc(nr, (unsigned int) seed);
431 return (unsigned int) seed;
434 unsigned int get_random_number(int nr, int max)
436 return (max > 0 ? random_linux_libc(nr) % max : 0);
440 /* ------------------------------------------------------------------------- */
441 /* system info functions */
442 /* ------------------------------------------------------------------------- */
444 #if !defined(PLATFORM_MSDOS) && !defined(PLATFORM_ANDROID)
445 static char *get_corrected_real_name(char *real_name)
447 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
448 char *from_ptr = real_name;
449 char *to_ptr = real_name_new;
451 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
452 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
454 /* the name field read from "passwd" file may also contain additional
455 user information, separated by commas, which will be removed here */
456 if (*from_ptr == ',')
459 /* the user's real name may contain 'ß' characters (german sharp s),
460 which have no equivalent in upper case letters (used by our fonts) */
461 if (*from_ptr == 'ß')
468 *to_ptr++ = *from_ptr++;
473 return real_name_new;
479 static char *login_name = NULL;
481 #if defined(PLATFORM_WIN32)
482 if (login_name == NULL)
484 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
485 login_name = checked_malloc(buffer_size);
487 if (GetUserName(login_name, &buffer_size) == 0)
488 strcpy(login_name, ANONYMOUS_NAME);
491 if (login_name == NULL)
495 if ((pwd = getpwuid(getuid())) == NULL)
496 login_name = ANONYMOUS_NAME;
498 login_name = getStringCopy(pwd->pw_name);
507 static char *real_name = NULL;
509 #if defined(PLATFORM_WIN32)
510 if (real_name == NULL)
512 static char buffer[MAX_USERNAME_LEN + 1];
513 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
515 if (GetUserName(buffer, &buffer_size) != 0)
516 real_name = get_corrected_real_name(buffer);
518 real_name = ANONYMOUS_NAME;
520 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
521 if (real_name == NULL)
525 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
526 real_name = get_corrected_real_name(pwd->pw_gecos);
528 real_name = ANONYMOUS_NAME;
531 real_name = ANONYMOUS_NAME;
537 time_t getFileTimestampEpochSeconds(char *filename)
539 struct stat file_status;
541 if (stat(filename, &file_status) != 0) /* cannot stat file */
544 return file_status.st_mtime;
548 /* ------------------------------------------------------------------------- */
549 /* path manipulation functions */
550 /* ------------------------------------------------------------------------- */
552 static char *getLastPathSeparatorPtr(char *filename)
554 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
556 if (last_separator == NULL) /* also try DOS/Windows variant */
557 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
559 return last_separator;
562 char *getBaseNamePtr(char *filename)
564 char *last_separator = getLastPathSeparatorPtr(filename);
566 if (last_separator != NULL)
567 return last_separator + 1; /* separator found: strip base path */
569 return filename; /* no separator found: filename has no path */
572 char *getBaseName(char *filename)
574 return getStringCopy(getBaseNamePtr(filename));
577 char *getBasePath(char *filename)
579 char *basepath = getStringCopy(filename);
580 char *last_separator = getLastPathSeparatorPtr(basepath);
582 if (last_separator != NULL)
583 *last_separator = '\0'; /* separator found: strip basename */
585 basepath = "."; /* no separator found: use current path */
590 static char *getProgramMainDataPath()
592 char *main_data_path = getStringCopy(program.command_basepath);
594 #if defined(PLATFORM_MACOSX)
595 static char *main_data_binary_subdir = NULL;
597 if (main_data_binary_subdir == NULL)
599 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
601 strlen(MAC_APP_BINARY_SUBDIR) + 1);
603 sprintf(main_data_binary_subdir, "%s.app/%s",
604 program.program_title, MAC_APP_BINARY_SUBDIR);
607 // cut relative path to Mac OS X application binary directory from path
608 if (strSuffix(main_data_path, main_data_binary_subdir))
609 main_data_path[strlen(main_data_path) -
610 strlen(main_data_binary_subdir)] = '\0';
612 // cut trailing path separator from path (but not if path is root directory)
613 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
614 main_data_path[strlen(main_data_path) - 1] = '\0';
617 return main_data_path;
621 /* ------------------------------------------------------------------------- */
622 /* various string functions */
623 /* ------------------------------------------------------------------------- */
625 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
627 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
630 sprintf(complete_string, "%s%s%s", s1, sep, s2);
632 return complete_string;
635 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
637 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
638 strlen(s2) + strlen(sep) +
641 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
643 return complete_string;
646 char *getStringCat2(char *s1, char *s2)
648 return getStringCat2WithSeparator(s1, s2, "");
651 char *getStringCat3(char *s1, char *s2, char *s3)
653 return getStringCat3WithSeparator(s1, s2, s3, "");
656 char *getPath2(char *path1, char *path2)
658 #if defined(PLATFORM_ANDROID)
659 // workaround for reading from APK assets directory -- skip leading "./"
660 if (strEqual(path1, "."))
661 return getStringCopy(path2);
664 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
667 char *getPath3(char *path1, char *path2, char *path3)
669 #if defined(PLATFORM_ANDROID)
670 // workaround for reading from APK assets directory -- skip leading "./"
671 if (strEqual(path1, "."))
672 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
675 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
678 char *getStringCopy(char *s)
685 s_copy = checked_malloc(strlen(s) + 1);
691 char *getStringCopyN(char *s, int n)
694 int s_len = MAX(0, n);
699 s_copy = checked_malloc(s_len + 1);
700 strncpy(s_copy, s, s_len);
701 s_copy[s_len] = '\0';
706 char *getStringToLower(char *s)
708 char *s_copy = checked_malloc(strlen(s) + 1);
709 char *s_ptr = s_copy;
712 *s_ptr++ = tolower(*s++);
718 void setString(char **old_value, char *new_value)
720 checked_free(*old_value);
722 *old_value = getStringCopy(new_value);
725 boolean strEqual(char *s1, char *s2)
727 return (s1 == NULL && s2 == NULL ? TRUE :
728 s1 == NULL && s2 != NULL ? FALSE :
729 s1 != NULL && s2 == NULL ? FALSE :
730 strcmp(s1, s2) == 0);
733 boolean strEqualN(char *s1, char *s2, int n)
735 return (s1 == NULL && s2 == NULL ? TRUE :
736 s1 == NULL && s2 != NULL ? FALSE :
737 s1 != NULL && s2 == NULL ? FALSE :
738 strncmp(s1, s2, n) == 0);
741 boolean strPrefix(char *s, char *prefix)
743 return (s == NULL && prefix == NULL ? TRUE :
744 s == NULL && prefix != NULL ? FALSE :
745 s != NULL && prefix == NULL ? FALSE :
746 strncmp(s, prefix, strlen(prefix)) == 0);
749 boolean strSuffix(char *s, char *suffix)
751 return (s == NULL && suffix == NULL ? TRUE :
752 s == NULL && suffix != NULL ? FALSE :
753 s != NULL && suffix == NULL ? FALSE :
754 strlen(s) < strlen(suffix) ? FALSE :
755 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
758 boolean strPrefixLower(char *s, char *prefix)
760 char *s_lower = getStringToLower(s);
761 boolean match = strPrefix(s_lower, prefix);
768 boolean strSuffixLower(char *s, char *suffix)
770 char *s_lower = getStringToLower(s);
771 boolean match = strSuffix(s_lower, suffix);
779 /* ------------------------------------------------------------------------- */
780 /* command line option handling functions */
781 /* ------------------------------------------------------------------------- */
783 void GetOptions(char *argv[], void (*print_usage_function)(void))
785 char *ro_base_path = RO_BASE_PATH;
786 char *rw_base_path = RW_BASE_PATH;
787 char **options_left = &argv[1];
790 /* if the program is configured to start from current directory (default),
791 determine program package directory from program binary (some versions
792 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
793 set the current working directory to the program package directory) */
795 if (strEqual(ro_base_path, "."))
796 ro_base_path = getProgramMainDataPath();
797 if (strEqual(rw_base_path, "."))
798 rw_base_path = getProgramMainDataPath();
801 #if !defined(PLATFORM_MACOSX)
802 /* if the program is configured to start from current directory (default),
803 determine program package directory (KDE/Konqueror does not do this by
804 itself and fails otherwise); on Mac OS X, the program binary is stored
805 in an application package directory -- do not try to use this directory
806 as the program data directory (Mac OS X handles this correctly anyway) */
808 if (strEqual(ro_base_path, "."))
809 ro_base_path = program.command_basepath;
810 if (strEqual(rw_base_path, "."))
811 rw_base_path = program.command_basepath;
816 /* initialize global program options */
817 options.display_name = NULL;
818 options.server_host = NULL;
819 options.server_port = 0;
821 options.ro_base_directory = ro_base_path;
822 options.rw_base_directory = rw_base_path;
823 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
824 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
825 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
826 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
827 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
829 options.execute_command = NULL;
830 options.special_flags = NULL;
832 options.serveronly = FALSE;
833 options.network = FALSE;
834 options.verbose = FALSE;
835 options.debug = FALSE;
836 options.debug_x11_sync = FALSE;
839 options.verbose = TRUE;
841 #if !defined(PLATFORM_UNIX)
842 if (*options_left == NULL) /* no options given -- enable verbose mode */
843 options.verbose = TRUE;
847 while (*options_left)
849 char option_str[MAX_OPTION_LEN];
850 char *option = options_left[0];
851 char *next_option = options_left[1];
852 char *option_arg = NULL;
853 int option_len = strlen(option);
855 if (option_len >= MAX_OPTION_LEN)
856 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
858 strcpy(option_str, option); /* copy argument into buffer */
861 if (strEqual(option, "--")) /* stop scanning arguments */
864 if (strPrefix(option, "--")) /* treat '--' like '-' */
867 option_arg = strchr(option, '=');
868 if (option_arg == NULL) /* no '=' in option */
869 option_arg = next_option;
872 *option_arg++ = '\0'; /* cut argument from option */
873 if (*option_arg == '\0') /* no argument after '=' */
874 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
877 option_len = strlen(option);
879 if (strEqual(option, "-"))
880 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
881 else if (strncmp(option, "-help", option_len) == 0)
883 print_usage_function();
887 else if (strncmp(option, "-display", option_len) == 0)
889 if (option_arg == NULL)
890 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
892 options.display_name = option_arg;
893 if (option_arg == next_option)
896 else if (strncmp(option, "-basepath", option_len) == 0)
898 if (option_arg == NULL)
899 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
901 /* this should be extended to separate options for ro and rw data */
902 options.ro_base_directory = ro_base_path = option_arg;
903 options.rw_base_directory = rw_base_path = option_arg;
904 if (option_arg == next_option)
907 /* adjust paths for sub-directories in base directory accordingly */
908 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
909 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
910 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
911 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
912 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
914 else if (strncmp(option, "-levels", option_len) == 0)
916 if (option_arg == NULL)
917 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
919 options.level_directory = option_arg;
920 if (option_arg == next_option)
923 else if (strncmp(option, "-graphics", option_len) == 0)
925 if (option_arg == NULL)
926 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
928 options.graphics_directory = option_arg;
929 if (option_arg == next_option)
932 else if (strncmp(option, "-sounds", option_len) == 0)
934 if (option_arg == NULL)
935 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
937 options.sounds_directory = option_arg;
938 if (option_arg == next_option)
941 else if (strncmp(option, "-music", option_len) == 0)
943 if (option_arg == NULL)
944 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
946 options.music_directory = option_arg;
947 if (option_arg == next_option)
950 else if (strncmp(option, "-network", option_len) == 0)
952 options.network = TRUE;
954 else if (strncmp(option, "-serveronly", option_len) == 0)
956 options.serveronly = TRUE;
958 else if (strncmp(option, "-verbose", option_len) == 0)
960 options.verbose = TRUE;
962 else if (strncmp(option, "-debug", option_len) == 0)
964 options.debug = TRUE;
966 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
968 options.debug_x11_sync = TRUE;
970 else if (strPrefix(option, "-D"))
973 options.special_flags = getStringCopy(&option[2]);
975 char *flags_string = &option[2];
976 unsigned int flags_value;
978 if (*flags_string == '\0')
979 Error(ERR_EXIT_HELP, "empty flag ignored");
981 flags_value = get_special_flags_function(flags_string);
983 if (flags_value == 0)
984 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
986 options.special_flags |= flags_value;
989 else if (strncmp(option, "-execute", option_len) == 0)
991 if (option_arg == NULL)
992 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
994 options.execute_command = option_arg;
995 if (option_arg == next_option)
998 /* when doing batch processing, always enable verbose mode (warnings) */
999 options.verbose = TRUE;
1001 else if (*option == '-')
1003 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1005 else if (options.server_host == NULL)
1007 options.server_host = *options_left;
1009 else if (options.server_port == 0)
1011 options.server_port = atoi(*options_left);
1012 if (options.server_port < 1024)
1013 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1016 Error(ERR_EXIT_HELP, "too many arguments");
1023 /* ------------------------------------------------------------------------- */
1024 /* error handling functions */
1025 /* ------------------------------------------------------------------------- */
1027 /* used by SetError() and GetError() to store internal error messages */
1028 static char internal_error[1024]; /* this is bad */
1030 void SetError(char *format, ...)
1034 va_start(ap, format);
1035 vsprintf(internal_error, format, ap);
1041 return internal_error;
1044 void Error(int mode, char *format, ...)
1046 static boolean last_line_was_separator = FALSE;
1047 char *process_name = "";
1049 #if defined(PLATFORM_ANDROID)
1050 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1051 mode & ERR_INFO ? ANDROID_LOG_INFO :
1052 mode & ERR_WARN ? ANDROID_LOG_WARN :
1053 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1054 ANDROID_LOG_UNKNOWN);
1058 /* display warnings only when running in verbose mode */
1059 if (mode & ERR_WARN && !options.verbose)
1063 if (mode == ERR_INFO_LINE)
1065 if (!last_line_was_separator)
1066 fprintf_line(program.error_file, format, 79);
1068 last_line_was_separator = TRUE;
1073 last_line_was_separator = FALSE;
1075 if (mode & ERR_SOUND_SERVER)
1076 process_name = " sound server";
1077 else if (mode & ERR_NETWORK_SERVER)
1078 process_name = " network server";
1079 else if (mode & ERR_NETWORK_CLIENT)
1080 process_name = " network client **";
1086 fprintf(program.error_file, "%s%s: ", program.command_basename,
1089 if (mode & ERR_WARN)
1090 fprintf(program.error_file, "warning: ");
1092 va_start(ap, format);
1093 vfprintf_newline(program.error_file, format, ap);
1096 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1098 va_start(ap, format);
1099 program.exit_message_function(format, ap);
1104 if (mode & ERR_HELP)
1105 fprintf_newline(program.error_file,
1106 "%s: Try option '--help' for more information.",
1107 program.command_basename);
1109 if (mode & ERR_EXIT)
1110 fprintf_newline(program.error_file, "%s%s: aborting",
1111 program.command_basename, process_name);
1113 if (mode & ERR_EXIT)
1115 if (mode & ERR_FROM_SERVER)
1116 exit(1); /* child process: normal exit */
1118 program.exit_function(1); /* main process: clean up stuff */
1123 /* ------------------------------------------------------------------------- */
1124 /* checked memory allocation and freeing functions */
1125 /* ------------------------------------------------------------------------- */
1127 void *checked_malloc(unsigned int size)
1134 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1139 void *checked_calloc(unsigned int size)
1143 ptr = calloc(1, size);
1146 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1151 void *checked_realloc(void *ptr, unsigned int size)
1153 ptr = realloc(ptr, size);
1156 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1161 void checked_free(void *ptr)
1163 if (ptr != NULL) /* this check should be done by free() anyway */
1167 void clear_mem(void *ptr, unsigned int size)
1169 #if defined(PLATFORM_WIN32)
1170 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1171 char *cptr = (char *)ptr;
1176 memset(ptr, 0, size);
1181 /* ------------------------------------------------------------------------- */
1182 /* various helper functions */
1183 /* ------------------------------------------------------------------------- */
1185 inline void swap_numbers(int *i1, int *i2)
1193 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1205 /* the "put" variants of the following file access functions check for the file
1206 pointer being != NULL and return the number of bytes they have or would have
1207 written; this allows for chunk writing functions to first determine the size
1208 of the (not yet written) chunk, write the correct chunk size and finally
1209 write the chunk itself */
1213 int getFile8BitInteger(File *file)
1215 return getByteFromFile(file);
1220 int getFile8BitInteger(FILE *file)
1227 int putFile8BitInteger(FILE *file, int value)
1237 int getFile16BitInteger(File *file, int byte_order)
1239 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1240 return ((getByteFromFile(file) << 8) |
1241 (getByteFromFile(file) << 0));
1242 else /* BYTE_ORDER_LITTLE_ENDIAN */
1243 return ((getByteFromFile(file) << 0) |
1244 (getByteFromFile(file) << 8));
1249 int getFile16BitInteger(FILE *file, int byte_order)
1251 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1252 return ((fgetc(file) << 8) |
1253 (fgetc(file) << 0));
1254 else /* BYTE_ORDER_LITTLE_ENDIAN */
1255 return ((fgetc(file) << 0) |
1256 (fgetc(file) << 8));
1261 int putFile16BitInteger(FILE *file, int value, int byte_order)
1265 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1267 fputc((value >> 8) & 0xff, file);
1268 fputc((value >> 0) & 0xff, file);
1270 else /* BYTE_ORDER_LITTLE_ENDIAN */
1272 fputc((value >> 0) & 0xff, file);
1273 fputc((value >> 8) & 0xff, file);
1282 int getFile32BitInteger(File *file, int byte_order)
1284 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1285 return ((getByteFromFile(file) << 24) |
1286 (getByteFromFile(file) << 16) |
1287 (getByteFromFile(file) << 8) |
1288 (getByteFromFile(file) << 0));
1289 else /* BYTE_ORDER_LITTLE_ENDIAN */
1290 return ((getByteFromFile(file) << 0) |
1291 (getByteFromFile(file) << 8) |
1292 (getByteFromFile(file) << 16) |
1293 (getByteFromFile(file) << 24));
1298 int getFile32BitInteger(FILE *file, int byte_order)
1300 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1301 return ((fgetc(file) << 24) |
1302 (fgetc(file) << 16) |
1303 (fgetc(file) << 8) |
1304 (fgetc(file) << 0));
1305 else /* BYTE_ORDER_LITTLE_ENDIAN */
1306 return ((fgetc(file) << 0) |
1307 (fgetc(file) << 8) |
1308 (fgetc(file) << 16) |
1309 (fgetc(file) << 24));
1314 int putFile32BitInteger(FILE *file, int value, int byte_order)
1318 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1320 fputc((value >> 24) & 0xff, file);
1321 fputc((value >> 16) & 0xff, file);
1322 fputc((value >> 8) & 0xff, file);
1323 fputc((value >> 0) & 0xff, file);
1325 else /* BYTE_ORDER_LITTLE_ENDIAN */
1327 fputc((value >> 0) & 0xff, file);
1328 fputc((value >> 8) & 0xff, file);
1329 fputc((value >> 16) & 0xff, file);
1330 fputc((value >> 24) & 0xff, file);
1339 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1342 const int chunk_name_length = 4;
1344 /* read chunk name */
1345 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1348 if (chunk_size != NULL)
1350 /* read chunk size */
1351 *chunk_size = getFile32BitInteger(file, byte_order);
1354 return (checkEndOfFile(file) ? FALSE : TRUE);
1359 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1362 const int chunk_name_length = 4;
1364 /* read chunk name */
1365 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1368 if (chunk_size != NULL)
1370 /* read chunk size */
1371 *chunk_size = getFile32BitInteger(file, byte_order);
1374 return (feof(file) || ferror(file) ? FALSE : TRUE);
1379 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1384 /* write chunk name */
1386 fputs(chunk_name, file);
1388 num_bytes += strlen(chunk_name);
1390 if (chunk_size >= 0)
1392 /* write chunk size */
1394 putFile32BitInteger(file, chunk_size, byte_order);
1404 int getFileVersion(File *file)
1406 int version_major = getByteFromFile(file);
1407 int version_minor = getByteFromFile(file);
1408 int version_patch = getByteFromFile(file);
1409 int version_build = getByteFromFile(file);
1411 return VERSION_IDENT(version_major, version_minor, version_patch,
1417 int getFileVersion(FILE *file)
1419 int version_major = fgetc(file);
1420 int version_minor = fgetc(file);
1421 int version_patch = fgetc(file);
1422 int version_build = fgetc(file);
1424 return VERSION_IDENT(version_major, version_minor, version_patch,
1430 int putFileVersion(FILE *file, int version)
1434 int version_major = VERSION_MAJOR(version);
1435 int version_minor = VERSION_MINOR(version);
1436 int version_patch = VERSION_PATCH(version);
1437 int version_build = VERSION_BUILD(version);
1439 fputc(version_major, file);
1440 fputc(version_minor, file);
1441 fputc(version_patch, file);
1442 fputc(version_build, file);
1450 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1454 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1455 buffer[i] = getByteFromFile(file);
1460 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1464 for(i = 0; i < bytes && !feof(file); i++)
1465 buffer[i] = fgetc(file);
1470 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1474 for(i = 0; i < bytes; i++)
1475 fputc(buffer[i], file);
1480 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1482 while (bytes-- && !checkEndOfFile(file))
1483 getByteFromFile(file);
1488 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1490 while (bytes-- && !feof(file))
1496 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1503 /* ------------------------------------------------------------------------- */
1504 /* functions to translate key identifiers between different format */
1505 /* ------------------------------------------------------------------------- */
1507 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1508 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1509 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1510 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1512 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1521 /* normal cursor keys */
1522 { KSYM_Left, "XK_Left", "cursor left" },
1523 { KSYM_Right, "XK_Right", "cursor right" },
1524 { KSYM_Up, "XK_Up", "cursor up" },
1525 { KSYM_Down, "XK_Down", "cursor down" },
1527 /* keypad cursor keys */
1529 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1530 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1531 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1532 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1535 /* other keypad keys */
1536 #ifdef KSYM_KP_Enter
1537 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1538 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1539 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1540 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1541 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1542 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1546 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1547 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1548 { KSYM_Control_L, "XK_Control_L", "left control" },
1549 { KSYM_Control_R, "XK_Control_R", "right control" },
1550 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1551 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1552 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1553 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1554 #if !defined(TARGET_SDL2)
1555 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1556 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1558 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1559 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1561 /* some special keys */
1562 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1563 { KSYM_Delete, "XK_Delete", "delete" },
1564 { KSYM_Insert, "XK_Insert", "insert" },
1565 { KSYM_Tab, "XK_Tab", "tab" },
1566 { KSYM_Home, "XK_Home", "home" },
1567 { KSYM_End, "XK_End", "end" },
1568 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1569 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1571 #if defined(TARGET_SDL2)
1572 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1573 { KSYM_Back, "XK_Back", "back" }, /* back key */
1576 /* ASCII 0x20 to 0x40 keys (except numbers) */
1577 { KSYM_space, "XK_space", "space" },
1578 { KSYM_exclam, "XK_exclam", "!" },
1579 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1580 { KSYM_numbersign, "XK_numbersign", "#" },
1581 { KSYM_dollar, "XK_dollar", "$" },
1582 { KSYM_percent, "XK_percent", "%" },
1583 { KSYM_ampersand, "XK_ampersand", "&" },
1584 { KSYM_apostrophe, "XK_apostrophe", "'" },
1585 { KSYM_parenleft, "XK_parenleft", "(" },
1586 { KSYM_parenright, "XK_parenright", ")" },
1587 { KSYM_asterisk, "XK_asterisk", "*" },
1588 { KSYM_plus, "XK_plus", "+" },
1589 { KSYM_comma, "XK_comma", "," },
1590 { KSYM_minus, "XK_minus", "-" },
1591 { KSYM_period, "XK_period", "." },
1592 { KSYM_slash, "XK_slash", "/" },
1593 { KSYM_colon, "XK_colon", ":" },
1594 { KSYM_semicolon, "XK_semicolon", ";" },
1595 { KSYM_less, "XK_less", "<" },
1596 { KSYM_equal, "XK_equal", "=" },
1597 { KSYM_greater, "XK_greater", ">" },
1598 { KSYM_question, "XK_question", "?" },
1599 { KSYM_at, "XK_at", "@" },
1601 /* more ASCII keys */
1602 { KSYM_bracketleft, "XK_bracketleft", "[" },
1603 { KSYM_backslash, "XK_backslash", "\\" },
1604 { KSYM_bracketright,"XK_bracketright", "]" },
1605 { KSYM_asciicircum, "XK_asciicircum", "^" },
1606 { KSYM_underscore, "XK_underscore", "_" },
1607 { KSYM_grave, "XK_grave", "grave" },
1608 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1609 { KSYM_braceleft, "XK_braceleft", "brace left" },
1610 { KSYM_bar, "XK_bar", "bar" },
1611 { KSYM_braceright, "XK_braceright", "brace right" },
1612 { KSYM_asciitilde, "XK_asciitilde", "~" },
1614 #if !defined(TARGET_SDL2)
1615 /* special (non-ASCII) keys */
1616 { KSYM_degree, "XK_degree", "°" },
1617 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1618 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1619 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1620 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1621 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1622 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1623 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1626 /* end-of-array identifier */
1632 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1634 static char name_buffer[30];
1637 if (key >= KSYM_A && key <= KSYM_Z)
1638 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1639 else if (key >= KSYM_a && key <= KSYM_z)
1640 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1641 else if (key >= KSYM_0 && key <= KSYM_9)
1642 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1643 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1644 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1645 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1646 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1647 else if (key == KSYM_UNDEFINED)
1648 strcpy(name_buffer, "(undefined)");
1655 if (key == translate_key[i].key)
1657 strcpy(name_buffer, translate_key[i].name);
1661 while (translate_key[++i].name);
1663 if (!translate_key[i].name)
1664 strcpy(name_buffer, "(unknown)");
1667 *name = name_buffer;
1669 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1671 static char name_buffer[30];
1674 if (key >= KSYM_A && key <= KSYM_Z)
1675 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1676 else if (key >= KSYM_a && key <= KSYM_z)
1677 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1678 else if (key >= KSYM_0 && key <= KSYM_9)
1679 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1680 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1681 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1682 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1683 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1684 else if (key == KSYM_UNDEFINED)
1685 strcpy(name_buffer, "[undefined]");
1692 if (key == translate_key[i].key)
1694 strcpy(name_buffer, translate_key[i].x11name);
1698 while (translate_key[++i].x11name);
1700 if (!translate_key[i].x11name)
1701 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1704 *x11name = name_buffer;
1706 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1708 Key key = KSYM_UNDEFINED;
1713 if (strEqual(translate_key[i].name, *name))
1715 key = translate_key[i].key;
1719 while (translate_key[++i].x11name);
1721 if (key == KSYM_UNDEFINED)
1722 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1726 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1728 Key key = KSYM_UNDEFINED;
1729 char *name_ptr = *x11name;
1731 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1733 char c = name_ptr[3];
1735 if (c >= 'A' && c <= 'Z')
1736 key = KSYM_A + (Key)(c - 'A');
1737 else if (c >= 'a' && c <= 'z')
1738 key = KSYM_a + (Key)(c - 'a');
1739 else if (c >= '0' && c <= '9')
1740 key = KSYM_0 + (Key)(c - '0');
1742 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1744 char c = name_ptr[6];
1746 if (c >= '0' && c <= '9')
1747 key = KSYM_KP_0 + (Key)(c - '0');
1749 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1751 char c1 = name_ptr[4];
1752 char c2 = name_ptr[5];
1755 if ((c1 >= '0' && c1 <= '9') &&
1756 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1757 d = atoi(&name_ptr[4]);
1759 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1760 key = KSYM_F1 + (Key)(d - 1);
1762 else if (strPrefix(name_ptr, "XK_"))
1768 if (strEqual(name_ptr, translate_key[i].x11name))
1770 key = translate_key[i].key;
1774 while (translate_key[++i].x11name);
1776 else if (strPrefix(name_ptr, "0x"))
1778 unsigned int value = 0;
1784 char c = *name_ptr++;
1787 if (c >= '0' && c <= '9')
1789 else if (c >= 'a' && c <= 'f')
1790 d = (int)(c - 'a' + 10);
1791 else if (c >= 'A' && c <= 'F')
1792 d = (int)(c - 'A' + 10);
1800 value = value * 16 + d;
1811 char *getKeyNameFromKey(Key key)
1815 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1819 char *getX11KeyNameFromKey(Key key)
1823 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1827 Key getKeyFromKeyName(char *name)
1831 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1835 Key getKeyFromX11KeyName(char *x11name)
1839 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1843 char getCharFromKey(Key key)
1845 char *keyname = getKeyNameFromKey(key);
1848 if (strlen(keyname) == 1)
1850 else if (strEqual(keyname, "space"))
1856 char getValidConfigValueChar(char c)
1858 if (c == '#' || /* used to mark comments */
1859 c == '\\') /* used to mark continued lines */
1866 /* ------------------------------------------------------------------------- */
1867 /* functions to translate string identifiers to integer or boolean value */
1868 /* ------------------------------------------------------------------------- */
1870 int get_integer_from_string(char *s)
1872 static char *number_text[][3] =
1874 { "0", "zero", "null", },
1875 { "1", "one", "first" },
1876 { "2", "two", "second" },
1877 { "3", "three", "third" },
1878 { "4", "four", "fourth" },
1879 { "5", "five", "fifth" },
1880 { "6", "six", "sixth" },
1881 { "7", "seven", "seventh" },
1882 { "8", "eight", "eighth" },
1883 { "9", "nine", "ninth" },
1884 { "10", "ten", "tenth" },
1885 { "11", "eleven", "eleventh" },
1886 { "12", "twelve", "twelfth" },
1888 { NULL, NULL, NULL },
1892 char *s_lower = getStringToLower(s);
1895 for (i = 0; number_text[i][0] != NULL; i++)
1896 for (j = 0; j < 3; j++)
1897 if (strEqual(s_lower, number_text[i][j]))
1902 if (strEqual(s_lower, "false") ||
1903 strEqual(s_lower, "no") ||
1904 strEqual(s_lower, "off"))
1906 else if (strEqual(s_lower, "true") ||
1907 strEqual(s_lower, "yes") ||
1908 strEqual(s_lower, "on"))
1919 boolean get_boolean_from_string(char *s)
1921 char *s_lower = getStringToLower(s);
1922 boolean result = FALSE;
1924 if (strEqual(s_lower, "true") ||
1925 strEqual(s_lower, "yes") ||
1926 strEqual(s_lower, "on") ||
1927 get_integer_from_string(s) == 1)
1935 int get_switch3_from_string(char *s)
1937 char *s_lower = getStringToLower(s);
1940 if (strEqual(s_lower, "true") ||
1941 strEqual(s_lower, "yes") ||
1942 strEqual(s_lower, "on") ||
1943 get_integer_from_string(s) == 1)
1945 else if (strEqual(s_lower, "auto"))
1954 /* ------------------------------------------------------------------------- */
1955 /* functions for generic lists */
1956 /* ------------------------------------------------------------------------- */
1958 ListNode *newListNode()
1960 return checked_calloc(sizeof(ListNode));
1963 void addNodeToList(ListNode **node_first, char *key, void *content)
1965 ListNode *node_new = newListNode();
1967 node_new->key = getStringCopy(key);
1968 node_new->content = content;
1969 node_new->next = *node_first;
1970 *node_first = node_new;
1973 void deleteNodeFromList(ListNode **node_first, char *key,
1974 void (*destructor_function)(void *))
1976 if (node_first == NULL || *node_first == NULL)
1979 if (strEqual((*node_first)->key, key))
1981 checked_free((*node_first)->key);
1982 if (destructor_function)
1983 destructor_function((*node_first)->content);
1984 *node_first = (*node_first)->next;
1987 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1990 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1992 if (node_first == NULL)
1995 if (strEqual(node_first->key, key))
1998 return getNodeFromKey(node_first->next, key);
2001 int getNumNodes(ListNode *node_first)
2003 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2006 void dumpList(ListNode *node_first)
2008 ListNode *node = node_first;
2012 printf("['%s' (%d)]\n", node->key,
2013 ((struct ListNodeInfo *)node->content)->num_references);
2017 printf("[%d nodes]\n", getNumNodes(node_first));
2021 /* ------------------------------------------------------------------------- */
2022 /* functions for file handling */
2023 /* ------------------------------------------------------------------------- */
2025 File *openFile(char *filename, char *mode)
2027 File *file = checked_calloc(sizeof(File));
2029 file->file = fopen(filename, mode);
2031 if (file->file != NULL)
2033 file->filename = getStringCopy(filename);
2038 #if defined(PLATFORM_ANDROID)
2039 file->asset_file = SDL_RWFromFile(filename, mode);
2041 if (file->asset_file != NULL)
2043 file->file_is_asset = TRUE;
2044 file->filename = getStringCopy(filename);
2055 int closeFile(File *file)
2062 #if defined(PLATFORM_ANDROID)
2063 if (file->asset_file)
2064 result = SDL_RWclose(file->asset_file);
2068 result = fclose(file->file);
2070 checked_free(file->filename);
2076 int checkEndOfFile(File *file)
2078 #if defined(PLATFORM_ANDROID)
2079 if (file->file_is_asset)
2080 return file->end_of_file;
2083 return feof(file->file);
2086 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2088 #if defined(PLATFORM_ANDROID)
2089 if (file->file_is_asset)
2091 if (file->end_of_file)
2094 size_t num_items_read =
2095 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2097 if (num_items_read < num_items)
2098 file->end_of_file = TRUE;
2100 return num_items_read;
2104 return fread(buffer, item_size, num_items, file->file);
2107 int seekFile(File *file, long offset, int whence)
2109 #if defined(PLATFORM_ANDROID)
2110 if (file->file_is_asset)
2112 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2113 whence == SEEK_CUR ? RW_SEEK_CUR :
2114 whence == SEEK_END ? RW_SEEK_END : 0);
2116 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2120 return fseek(file->file, offset, whence);
2123 int getByteFromFile(File *file)
2125 #if defined(PLATFORM_ANDROID)
2126 if (file->file_is_asset)
2128 if (file->end_of_file)
2132 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2134 if (num_bytes_read < 1)
2135 file->end_of_file = TRUE;
2137 return (file->end_of_file ? EOF : (int)c);
2141 return fgetc(file->file);
2144 char *getStringFromFile(File *file, char *line, int size)
2146 #if defined(PLATFORM_ANDROID)
2147 if (file->file_is_asset)
2149 if (file->end_of_file)
2152 char *line_ptr = line;
2153 int num_bytes_read = 0;
2155 while (num_bytes_read < size - 1 &&
2156 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2157 *line_ptr++ != '\n')
2162 if (strlen(line) == 0)
2164 file->end_of_file = TRUE;
2173 return fgets(line, size, file->file);
2177 /* ------------------------------------------------------------------------- */
2178 /* functions for directory handling */
2179 /* ------------------------------------------------------------------------- */
2181 Directory *openDirectory(char *dir_name)
2183 Directory *dir = checked_calloc(sizeof(Directory));
2185 dir->dir = opendir(dir_name);
2187 if (dir->dir != NULL)
2189 dir->filename = getStringCopy(dir_name);
2194 #if defined(PLATFORM_ANDROID)
2195 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2197 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2199 checked_free(asset_toc_filename);
2201 if (dir->asset_toc_file != NULL)
2203 dir->directory_is_asset = TRUE;
2204 dir->filename = getStringCopy(dir_name);
2215 int closeDirectory(Directory *dir)
2222 #if defined(PLATFORM_ANDROID)
2223 if (dir->asset_toc_file)
2224 result = SDL_RWclose(dir->asset_toc_file);
2228 result = closedir(dir->dir);
2231 freeDirectoryEntry(dir->dir_entry);
2233 checked_free(dir->filename);
2239 DirectoryEntry *readDirectory(Directory *dir)
2242 freeDirectoryEntry(dir->dir_entry);
2244 dir->dir_entry = NULL;
2246 #if defined(PLATFORM_ANDROID)
2247 if (dir->directory_is_asset)
2249 char line[MAX_LINE_LEN];
2250 char *line_ptr = line;
2251 int num_bytes_read = 0;
2253 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2254 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2263 if (strlen(line) == 0)
2266 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2268 dir->dir_entry->is_directory = FALSE;
2269 if (line[strlen(line) - 1] == '/')
2271 dir->dir_entry->is_directory = TRUE;
2273 line[strlen(line) - 1] = '\0';
2276 dir->dir_entry->basename = getStringCopy(line);
2277 dir->dir_entry->filename = getPath2(dir->filename, line);
2279 return dir->dir_entry;
2283 struct dirent *dir_entry = readdir(dir->dir);
2285 if (dir_entry == NULL)
2288 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2290 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2291 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2293 struct stat file_status;
2295 dir->dir_entry->is_directory =
2296 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2297 (file_status.st_mode & S_IFMT) == S_IFDIR);
2300 Error(ERR_INFO, "::: '%s' is directory: %d",
2301 dir->dir_entry->basename,
2302 dir->dir_entry->is_directory);
2305 return dir->dir_entry;
2308 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2310 if (dir_entry == NULL)
2313 checked_free(dir_entry->basename);
2314 checked_free(dir_entry->filename);
2315 checked_free(dir_entry);
2319 /* ------------------------------------------------------------------------- */
2320 /* functions for checking files and filenames */
2321 /* ------------------------------------------------------------------------- */
2323 boolean directoryExists(char *dir_name)
2325 if (dir_name == NULL)
2328 boolean success = (access(dir_name, F_OK) == 0);
2330 #if defined(PLATFORM_ANDROID)
2333 // this might be an asset directory; check by trying to open toc file
2334 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2335 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2337 checked_free(asset_toc_filename);
2339 success = (file != NULL);
2349 boolean fileExists(char *filename)
2351 if (filename == NULL)
2354 boolean success = (access(filename, F_OK) == 0);
2356 #if defined(PLATFORM_ANDROID)
2359 // this might be an asset file; check by trying to open it
2360 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2362 success = (file != NULL);
2372 boolean fileHasPrefix(char *basename, char *prefix)
2374 static char *basename_lower = NULL;
2375 int basename_length, prefix_length;
2377 checked_free(basename_lower);
2379 if (basename == NULL || prefix == NULL)
2382 basename_lower = getStringToLower(basename);
2383 basename_length = strlen(basename_lower);
2384 prefix_length = strlen(prefix);
2386 if (basename_length > prefix_length + 1 &&
2387 basename_lower[prefix_length] == '.' &&
2388 strncmp(basename_lower, prefix, prefix_length) == 0)
2394 boolean fileHasSuffix(char *basename, char *suffix)
2396 static char *basename_lower = NULL;
2397 int basename_length, suffix_length;
2399 checked_free(basename_lower);
2401 if (basename == NULL || suffix == NULL)
2404 basename_lower = getStringToLower(basename);
2405 basename_length = strlen(basename_lower);
2406 suffix_length = strlen(suffix);
2408 if (basename_length > suffix_length + 1 &&
2409 basename_lower[basename_length - suffix_length - 1] == '.' &&
2410 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2416 boolean FileIsGraphic(char *filename)
2418 char *basename = getBaseNamePtr(filename);
2420 #if defined(TARGET_SDL)
2421 return (!fileHasSuffix(basename, "txt") &&
2422 !fileHasSuffix(basename, "conf"));
2424 return fileHasSuffix(basename, "pcx");
2428 boolean FileIsSound(char *filename)
2430 char *basename = getBaseNamePtr(filename);
2432 #if defined(TARGET_SDL)
2433 return (!fileHasSuffix(basename, "txt") &&
2434 !fileHasSuffix(basename, "conf"));
2436 return fileHasSuffix(basename, "wav");
2440 boolean FileIsMusic(char *filename)
2442 char *basename = getBaseNamePtr(filename);
2444 #if defined(TARGET_SDL)
2445 return (!fileHasSuffix(basename, "txt") &&
2446 !fileHasSuffix(basename, "conf"));
2448 if (FileIsSound(basename))
2452 #if defined(TARGET_SDL)
2453 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2454 fileHasSuffix(basename, "mod") ||
2455 fileHasSuffix(basename, "s3m") ||
2456 fileHasSuffix(basename, "it") ||
2457 fileHasSuffix(basename, "xm") ||
2458 fileHasSuffix(basename, "midi") ||
2459 fileHasSuffix(basename, "mid") ||
2460 fileHasSuffix(basename, "mp3") ||
2461 fileHasSuffix(basename, "ogg"))
2470 boolean FileIsArtworkType(char *basename, int type)
2472 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2473 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2474 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2480 /* ------------------------------------------------------------------------- */
2481 /* functions for loading artwork configuration information */
2482 /* ------------------------------------------------------------------------- */
2484 char *get_mapped_token(char *token)
2486 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2487 static char *map_token_prefix[][2] =
2489 { "char_procent", "char_percent" },
2494 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2496 int len_token_prefix = strlen(map_token_prefix[i][0]);
2498 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2499 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2505 /* This function checks if a string <s> of the format "string1, string2, ..."
2506 exactly contains a string <s_contained>. */
2508 static boolean string_has_parameter(char *s, char *s_contained)
2512 if (s == NULL || s_contained == NULL)
2515 if (strlen(s_contained) > strlen(s))
2518 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2520 char next_char = s[strlen(s_contained)];
2522 /* check if next character is delimiter or whitespace */
2523 return (next_char == ',' || next_char == '\0' ||
2524 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2527 /* check if string contains another parameter string after a comma */
2528 substring = strchr(s, ',');
2529 if (substring == NULL) /* string does not contain a comma */
2532 /* advance string pointer to next character after the comma */
2535 /* skip potential whitespaces after the comma */
2536 while (*substring == ' ' || *substring == '\t')
2539 return string_has_parameter(substring, s_contained);
2542 int get_parameter_value(char *value_raw, char *suffix, int type)
2544 char *value = getStringToLower(value_raw);
2545 int result = 0; /* probably a save default value */
2547 if (strEqual(suffix, ".direction"))
2549 result = (strEqual(value, "left") ? MV_LEFT :
2550 strEqual(value, "right") ? MV_RIGHT :
2551 strEqual(value, "up") ? MV_UP :
2552 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2554 else if (strEqual(suffix, ".align"))
2556 result = (strEqual(value, "left") ? ALIGN_LEFT :
2557 strEqual(value, "right") ? ALIGN_RIGHT :
2558 strEqual(value, "center") ? ALIGN_CENTER :
2559 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2561 else if (strEqual(suffix, ".valign"))
2563 result = (strEqual(value, "top") ? VALIGN_TOP :
2564 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2565 strEqual(value, "middle") ? VALIGN_MIDDLE :
2566 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2568 else if (strEqual(suffix, ".anim_mode"))
2570 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2571 string_has_parameter(value, "loop") ? ANIM_LOOP :
2572 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2573 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2574 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2575 string_has_parameter(value, "random") ? ANIM_RANDOM :
2576 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2577 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2578 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2579 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2580 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2581 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2584 if (string_has_parameter(value, "reverse"))
2585 result |= ANIM_REVERSE;
2587 if (string_has_parameter(value, "opaque_player"))
2588 result |= ANIM_OPAQUE_PLAYER;
2590 if (string_has_parameter(value, "static_panel"))
2591 result |= ANIM_STATIC_PANEL;
2593 else if (strEqual(suffix, ".class"))
2595 result = get_hash_from_key(value);
2597 else if (strEqual(suffix, ".style"))
2599 result = STYLE_DEFAULT;
2601 if (string_has_parameter(value, "accurate_borders"))
2602 result |= STYLE_ACCURATE_BORDERS;
2604 if (string_has_parameter(value, "inner_corners"))
2605 result |= STYLE_INNER_CORNERS;
2607 else if (strEqual(suffix, ".fade_mode"))
2609 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2610 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2611 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2612 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2616 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2618 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2621 result = gfx.get_font_from_token_function(value);
2623 else /* generic parameter of type integer or boolean */
2625 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2626 type == TYPE_INTEGER ? get_integer_from_string(value) :
2627 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2628 ARG_UNDEFINED_VALUE);
2636 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2638 static struct ScreenModeInfo screen_mode;
2639 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2640 char *screen_mode_string_copy;
2641 char *screen_mode_string_pos_w;
2642 char *screen_mode_string_pos_h;
2644 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2647 screen_mode_string_copy = getStringCopy(screen_mode_string);
2649 screen_mode_string_pos_w = screen_mode_string_copy;
2650 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2651 *screen_mode_string_pos_h++ = '\0';
2653 screen_mode.width = atoi(screen_mode_string_pos_w);
2654 screen_mode.height = atoi(screen_mode_string_pos_h);
2656 return &screen_mode;
2659 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2662 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2663 float aspect_ratio_new;
2668 *x = i * aspect_ratio + 0.000001;
2671 aspect_ratio_new = (float)*x / (float)*y;
2675 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2678 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2679 struct ListNodeInfo ***, int *);
2681 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2682 struct ConfigTypeInfo *suffix_list,
2683 char **ignore_tokens,
2684 int num_file_list_entries)
2686 struct FileInfo *file_list;
2687 int num_file_list_entries_found = 0;
2688 int num_suffix_list_entries = 0;
2692 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2694 for (i = 0; suffix_list[i].token != NULL; i++)
2695 num_suffix_list_entries++;
2697 /* always start with reliable default values */
2698 for (i = 0; i < num_file_list_entries; i++)
2700 file_list[i].token = NULL;
2702 file_list[i].default_filename = NULL;
2703 file_list[i].filename = NULL;
2705 if (num_suffix_list_entries > 0)
2707 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2709 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2710 file_list[i].parameter = checked_calloc(parameter_array_size);
2712 for (j = 0; j < num_suffix_list_entries; j++)
2714 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2715 setString(&file_list[i].parameter[j], suffix_list[j].value);
2718 file_list[i].redefined = FALSE;
2719 file_list[i].fallback_to_default = FALSE;
2720 file_list[i].default_is_cloned = FALSE;
2726 for (i = 0; config_list[i].token != NULL; i++)
2728 int len_config_token = strlen(config_list[i].token);
2730 int len_config_value = strlen(config_list[i].value);
2732 boolean is_file_entry = TRUE;
2734 for (j = 0; suffix_list[j].token != NULL; j++)
2736 int len_suffix = strlen(suffix_list[j].token);
2738 if (len_suffix < len_config_token &&
2739 strEqual(&config_list[i].token[len_config_token - len_suffix],
2740 suffix_list[j].token))
2742 setString(&file_list[list_pos].default_parameter[j],
2743 config_list[i].value);
2745 is_file_entry = FALSE;
2751 /* the following tokens are no file definitions, but other config tokens */
2752 for (j = 0; ignore_tokens[j] != NULL; j++)
2753 if (strEqual(config_list[i].token, ignore_tokens[j]))
2754 is_file_entry = FALSE;
2761 if (list_pos >= num_file_list_entries)
2765 /* simple sanity check if this is really a file definition */
2766 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2767 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2768 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2770 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2771 config_list[i].token, config_list[i].value);
2772 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2776 file_list[list_pos].token = config_list[i].token;
2777 file_list[list_pos].default_filename = config_list[i].value;
2780 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2784 if (strSuffix(config_list[i].token, ".clone_from"))
2785 file_list[list_pos].default_is_cloned = TRUE;
2788 num_file_list_entries_found = list_pos + 1;
2789 if (num_file_list_entries_found != num_file_list_entries)
2791 Error(ERR_INFO_LINE, "-");
2792 Error(ERR_INFO, "inconsistant config list information:");
2793 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2794 num_file_list_entries);
2795 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2796 num_file_list_entries_found);
2797 Error(ERR_EXIT, "please fix");
2801 printf("::: ---------- DONE ----------\n");
2807 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2809 int len_token = strlen(token);
2810 int len_suffix = strlen(suffix);
2812 if (start_pos < 0) /* compare suffix from end of string */
2813 start_pos += len_token;
2815 if (start_pos < 0 || start_pos + len_suffix > len_token)
2818 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2821 if (token[start_pos + len_suffix] == '\0')
2824 if (token[start_pos + len_suffix] == '.')
2830 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2832 static void read_token_parameters(SetupFileHash *setup_file_hash,
2833 struct ConfigTypeInfo *suffix_list,
2834 struct FileInfo *file_list_entry)
2836 /* check for config token that is the base token without any suffixes */
2837 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2838 char *known_token_value = KNOWN_TOKEN_VALUE;
2841 if (filename != NULL)
2843 setString(&file_list_entry->filename, filename);
2845 /* when file definition found, set all parameters to default values */
2846 for (i = 0; suffix_list[i].token != NULL; i++)
2847 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2849 file_list_entry->redefined = TRUE;
2851 /* mark config file token as well known from default config */
2852 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2855 /* check for config tokens that can be build by base token and suffixes */
2856 for (i = 0; suffix_list[i].token != NULL; i++)
2858 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2859 char *value = getHashEntry(setup_file_hash, token);
2863 setString(&file_list_entry->parameter[i], value);
2865 /* mark config file token as well known from default config */
2866 setHashEntry(setup_file_hash, token, known_token_value);
2873 static void add_dynamic_file_list_entry(struct FileInfo **list,
2874 int *num_list_entries,
2875 SetupFileHash *extra_file_hash,
2876 struct ConfigTypeInfo *suffix_list,
2877 int num_suffix_list_entries,
2880 struct FileInfo *new_list_entry;
2881 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2883 (*num_list_entries)++;
2884 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2885 new_list_entry = &(*list)[*num_list_entries - 1];
2887 new_list_entry->token = getStringCopy(token);
2888 new_list_entry->default_filename = NULL;
2889 new_list_entry->filename = NULL;
2890 new_list_entry->parameter = checked_calloc(parameter_array_size);
2892 new_list_entry->redefined = FALSE;
2893 new_list_entry->fallback_to_default = FALSE;
2894 new_list_entry->default_is_cloned = FALSE;
2896 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2899 static void add_property_mapping(struct PropertyMapping **list,
2900 int *num_list_entries,
2901 int base_index, int ext1_index,
2902 int ext2_index, int ext3_index,
2905 struct PropertyMapping *new_list_entry;
2907 (*num_list_entries)++;
2908 *list = checked_realloc(*list,
2909 *num_list_entries * sizeof(struct PropertyMapping));
2910 new_list_entry = &(*list)[*num_list_entries - 1];
2912 new_list_entry->base_index = base_index;
2913 new_list_entry->ext1_index = ext1_index;
2914 new_list_entry->ext2_index = ext2_index;
2915 new_list_entry->ext3_index = ext3_index;
2917 new_list_entry->artwork_index = artwork_index;
2920 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2923 struct FileInfo *file_list = artwork_info->file_list;
2924 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2925 char **base_prefixes = artwork_info->base_prefixes;
2926 char **ext1_suffixes = artwork_info->ext1_suffixes;
2927 char **ext2_suffixes = artwork_info->ext2_suffixes;
2928 char **ext3_suffixes = artwork_info->ext3_suffixes;
2929 char **ignore_tokens = artwork_info->ignore_tokens;
2930 int num_file_list_entries = artwork_info->num_file_list_entries;
2931 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2932 int num_base_prefixes = artwork_info->num_base_prefixes;
2933 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2934 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2935 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2936 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2937 SetupFileHash *setup_file_hash, *valid_file_hash;
2938 SetupFileHash *extra_file_hash, *empty_file_hash;
2939 char *known_token_value = KNOWN_TOKEN_VALUE;
2942 if (filename == NULL)
2946 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2949 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2952 /* separate valid (defined) from empty (undefined) config token values */
2953 valid_file_hash = newSetupFileHash();
2954 empty_file_hash = newSetupFileHash();
2955 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2957 char *value = HASH_ITERATION_VALUE(itr);
2959 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2960 HASH_ITERATION_TOKEN(itr), value);
2962 END_HASH_ITERATION(setup_file_hash, itr)
2964 /* at this point, we do not need the setup file hash anymore -- free it */
2965 freeSetupFileHash(setup_file_hash);
2967 /* map deprecated to current tokens (using prefix match and replace) */
2968 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2970 char *token = HASH_ITERATION_TOKEN(itr);
2971 char *mapped_token = get_mapped_token(token);
2973 if (mapped_token != NULL)
2975 char *value = HASH_ITERATION_VALUE(itr);
2977 /* add mapped token */
2978 setHashEntry(valid_file_hash, mapped_token, value);
2980 /* ignore old token (by setting it to "known" keyword) */
2981 setHashEntry(valid_file_hash, token, known_token_value);
2986 END_HASH_ITERATION(valid_file_hash, itr)
2988 /* read parameters for all known config file tokens */
2989 for (i = 0; i < num_file_list_entries; i++)
2990 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2992 /* set all tokens that can be ignored here to "known" keyword */
2993 for (i = 0; i < num_ignore_tokens; i++)
2994 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2996 /* copy all unknown config file tokens to extra config hash */
2997 extra_file_hash = newSetupFileHash();
2998 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3000 char *value = HASH_ITERATION_VALUE(itr);
3002 if (!strEqual(value, known_token_value))
3003 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3005 END_HASH_ITERATION(valid_file_hash, itr)
3007 /* at this point, we do not need the valid file hash anymore -- free it */
3008 freeSetupFileHash(valid_file_hash);
3010 /* now try to determine valid, dynamically defined config tokens */
3012 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3014 struct FileInfo **dynamic_file_list =
3015 &artwork_info->dynamic_file_list;
3016 int *num_dynamic_file_list_entries =
3017 &artwork_info->num_dynamic_file_list_entries;
3018 struct PropertyMapping **property_mapping =
3019 &artwork_info->property_mapping;
3020 int *num_property_mapping_entries =
3021 &artwork_info->num_property_mapping_entries;
3022 int current_summarized_file_list_entry =
3023 artwork_info->num_file_list_entries +
3024 artwork_info->num_dynamic_file_list_entries;
3025 char *token = HASH_ITERATION_TOKEN(itr);
3026 int len_token = strlen(token);
3028 boolean base_prefix_found = FALSE;
3029 boolean parameter_suffix_found = FALSE;
3032 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3035 /* skip all parameter definitions (handled by read_token_parameters()) */
3036 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3038 int len_suffix = strlen(suffix_list[i].token);
3040 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3041 parameter_suffix_found = TRUE;
3044 if (parameter_suffix_found)
3047 /* ---------- step 0: search for matching base prefix ---------- */
3050 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3052 char *base_prefix = base_prefixes[i];
3053 int len_base_prefix = strlen(base_prefix);
3054 boolean ext1_suffix_found = FALSE;
3055 boolean ext2_suffix_found = FALSE;
3056 boolean ext3_suffix_found = FALSE;
3057 boolean exact_match = FALSE;
3058 int base_index = -1;
3059 int ext1_index = -1;
3060 int ext2_index = -1;
3061 int ext3_index = -1;
3063 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3065 if (!base_prefix_found)
3071 if (IS_PARENT_PROCESS())
3072 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3075 if (start_pos + len_base_prefix == len_token) /* exact match */
3080 if (IS_PARENT_PROCESS())
3081 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3084 add_dynamic_file_list_entry(dynamic_file_list,
3085 num_dynamic_file_list_entries,
3088 num_suffix_list_entries,
3090 add_property_mapping(property_mapping,
3091 num_property_mapping_entries,
3092 base_index, -1, -1, -1,
3093 current_summarized_file_list_entry);
3098 if (IS_PARENT_PROCESS())
3099 printf("---> examining token '%s': search 1st suffix ...\n", token);
3102 /* ---------- step 1: search for matching first suffix ---------- */
3104 start_pos += len_base_prefix;
3105 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3107 char *ext1_suffix = ext1_suffixes[j];
3108 int len_ext1_suffix = strlen(ext1_suffix);
3110 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3112 if (!ext1_suffix_found)
3118 if (IS_PARENT_PROCESS())
3119 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3122 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3127 if (IS_PARENT_PROCESS())
3128 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3131 add_dynamic_file_list_entry(dynamic_file_list,
3132 num_dynamic_file_list_entries,
3135 num_suffix_list_entries,
3137 add_property_mapping(property_mapping,
3138 num_property_mapping_entries,
3139 base_index, ext1_index, -1, -1,
3140 current_summarized_file_list_entry);
3144 start_pos += len_ext1_suffix;
3151 if (IS_PARENT_PROCESS())
3152 printf("---> examining token '%s': search 2nd suffix ...\n", token);
3155 /* ---------- step 2: search for matching second suffix ---------- */
3157 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3159 char *ext2_suffix = ext2_suffixes[k];
3160 int len_ext2_suffix = strlen(ext2_suffix);
3162 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3164 if (!ext2_suffix_found)
3170 if (IS_PARENT_PROCESS())
3171 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3174 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3179 if (IS_PARENT_PROCESS())
3180 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3183 add_dynamic_file_list_entry(dynamic_file_list,
3184 num_dynamic_file_list_entries,
3187 num_suffix_list_entries,
3189 add_property_mapping(property_mapping,
3190 num_property_mapping_entries,
3191 base_index, ext1_index, ext2_index, -1,
3192 current_summarized_file_list_entry);
3196 start_pos += len_ext2_suffix;
3203 if (IS_PARENT_PROCESS())
3204 printf("---> examining token '%s': search 3rd suffix ...\n",token);
3207 /* ---------- step 3: search for matching third suffix ---------- */
3209 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3211 char *ext3_suffix = ext3_suffixes[l];
3212 int len_ext3_suffix = strlen(ext3_suffix);
3214 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3216 if (!ext3_suffix_found)
3222 if (IS_PARENT_PROCESS())
3223 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3226 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3231 if (IS_PARENT_PROCESS())
3232 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3235 add_dynamic_file_list_entry(dynamic_file_list,
3236 num_dynamic_file_list_entries,
3239 num_suffix_list_entries,
3241 add_property_mapping(property_mapping,
3242 num_property_mapping_entries,
3243 base_index, ext1_index, ext2_index, ext3_index,
3244 current_summarized_file_list_entry);
3250 END_HASH_ITERATION(extra_file_hash, itr)
3252 if (artwork_info->num_dynamic_file_list_entries > 0)
3254 artwork_info->dynamic_artwork_list =
3255 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3256 artwork_info->sizeof_artwork_list_entry);
3259 if (options.verbose && IS_PARENT_PROCESS())
3261 SetupFileList *setup_file_list, *list;
3262 boolean dynamic_tokens_found = FALSE;
3263 boolean unknown_tokens_found = FALSE;
3264 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3266 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3267 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3269 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3271 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3272 dynamic_tokens_found = TRUE;
3274 unknown_tokens_found = TRUE;
3276 END_HASH_ITERATION(extra_file_hash, itr)
3278 if (options.debug && dynamic_tokens_found)
3280 Error(ERR_INFO_LINE, "-");
3281 Error(ERR_INFO, "dynamic token(s) found in config file:");
3282 Error(ERR_INFO, "- config file: '%s'", filename);
3284 for (list = setup_file_list; list != NULL; list = list->next)
3286 char *value = getHashEntry(extra_file_hash, list->token);
3288 if (value != NULL && strEqual(value, known_token_value))
3289 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3292 Error(ERR_INFO_LINE, "-");
3295 if (unknown_tokens_found)
3297 Error(ERR_INFO_LINE, "-");
3298 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3299 Error(ERR_INFO, "- config file: '%s'", filename);
3301 for (list = setup_file_list; list != NULL; list = list->next)
3303 char *value = getHashEntry(extra_file_hash, list->token);
3305 if (value != NULL && !strEqual(value, known_token_value))
3306 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3309 Error(ERR_INFO_LINE, "-");
3312 if (undefined_values_found)
3314 Error(ERR_INFO_LINE, "-");
3315 Error(ERR_INFO, "warning: undefined values found in config file:");
3316 Error(ERR_INFO, "- config file: '%s'", filename);
3318 for (list = setup_file_list; list != NULL; list = list->next)
3320 char *value = getHashEntry(empty_file_hash, list->token);
3323 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3326 Error(ERR_INFO_LINE, "-");
3329 freeSetupFileList(setup_file_list);
3332 freeSetupFileHash(extra_file_hash);
3333 freeSetupFileHash(empty_file_hash);
3336 for (i = 0; i < num_file_list_entries; i++)
3338 printf("'%s' ", file_list[i].token);
3339 if (file_list[i].filename)
3340 printf("-> '%s'\n", file_list[i].filename);
3342 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3347 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3349 struct FileInfo *file_list = artwork_info->file_list;
3350 int num_file_list_entries = artwork_info->num_file_list_entries;
3351 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3352 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3355 DrawInitText("Loading artwork config", 120, FC_GREEN);
3356 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3358 /* always start with reliable default values */
3359 for (i = 0; i < num_file_list_entries; i++)
3361 setString(&file_list[i].filename, file_list[i].default_filename);
3363 for (j = 0; j < num_suffix_list_entries; j++)
3364 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3366 file_list[i].redefined = FALSE;
3367 file_list[i].fallback_to_default = FALSE;
3370 /* free previous dynamic artwork file array */
3371 if (artwork_info->dynamic_file_list != NULL)
3373 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3375 free(artwork_info->dynamic_file_list[i].token);
3376 free(artwork_info->dynamic_file_list[i].filename);
3377 free(artwork_info->dynamic_file_list[i].parameter);
3380 free(artwork_info->dynamic_file_list);
3381 artwork_info->dynamic_file_list = NULL;
3383 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3384 &artwork_info->num_dynamic_file_list_entries);
3387 /* free previous property mapping */
3388 if (artwork_info->property_mapping != NULL)
3390 free(artwork_info->property_mapping);
3392 artwork_info->property_mapping = NULL;
3393 artwork_info->num_property_mapping_entries = 0;
3397 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3399 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3402 /* first look for special artwork configured in level series config */
3403 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3406 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3407 leveldir_current->graphics_set,
3408 leveldir_current->graphics_path);
3411 if (fileExists(filename_base))
3412 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3415 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3417 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3418 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3421 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3422 struct ListNodeInfo **listnode)
3426 char *filename = (*listnode)->source_filename;
3428 if (--(*listnode)->num_references <= 0)
3429 deleteNodeFromList(&artwork_info->content_list, filename,
3430 artwork_info->free_artwork);
3436 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3437 struct ListNodeInfo **listnode,
3438 struct FileInfo *file_list_entry)
3448 char *basename = file_list_entry->filename;
3449 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3451 if (filename == NULL)
3453 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3455 basename = file_list_entry->default_filename;
3457 /* fail for cloned default artwork that has no default filename defined */
3458 if (file_list_entry->default_is_cloned &&
3459 strEqual(basename, UNDEFINED_FILENAME))
3461 int error_mode = ERR_WARN;
3463 /* we can get away without sounds and music, but not without graphics */
3464 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3465 error_mode = ERR_EXIT;
3467 Error(error_mode, "token '%s' was cloned and has no default filename",
3468 file_list_entry->token);
3473 /* dynamic artwork has no default filename / skip empty default artwork */
3474 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3477 file_list_entry->fallback_to_default = TRUE;
3479 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3481 filename = getCustomArtworkFilename(basename, artwork_info->type);
3483 if (filename == NULL)
3485 int error_mode = ERR_WARN;
3487 /* we can get away without sounds and music, but not without graphics */
3488 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3489 error_mode = ERR_EXIT;
3491 Error(error_mode, "cannot find default artwork file '%s'", basename);
3497 /* check if the old and the new artwork file are the same */
3498 if (*listnode && strEqual((*listnode)->source_filename, filename))
3500 /* The old and new artwork are the same (have the same filename and path).
3501 This usually means that this artwork does not exist in this artwork set
3502 and a fallback to the existing artwork is done. */
3505 printf("[artwork '%s' already exists (same list entry)]\n", filename);
3511 /* delete existing artwork file entry */
3512 deleteArtworkListEntry(artwork_info, listnode);
3514 /* check if the new artwork file already exists in the list of artworks */
3515 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3518 printf("[artwork '%s' already exists (other list entry)]\n", filename);
3521 *listnode = (struct ListNodeInfo *)node->content;
3522 (*listnode)->num_references++;
3527 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3528 DrawInitText(basename, 150, FC_YELLOW);
3530 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3533 printf("[adding new artwork '%s']\n", filename);
3536 (*listnode)->num_references = 1;
3537 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3542 int error_mode = ERR_WARN;
3544 /* we can get away without sounds and music, but not without graphics */
3545 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3546 error_mode = ERR_EXIT;
3548 Error(error_mode, "cannot load artwork file '%s'", basename);
3554 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3555 struct ListNodeInfo **listnode,
3556 struct FileInfo *file_list_entry)
3559 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3562 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3564 deleteArtworkListEntry(artwork_info, listnode);
3569 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3572 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3574 struct FileInfo *file_list = artwork_info->file_list;
3575 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3576 int num_file_list_entries = artwork_info->num_file_list_entries;
3577 int num_dynamic_file_list_entries =
3578 artwork_info->num_dynamic_file_list_entries;
3581 print_timestamp_init("ReloadCustomArtworkList");
3583 for (i = 0; i < num_file_list_entries; i++)
3584 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3587 for (i = 0; i < num_dynamic_file_list_entries; i++)
3588 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3589 &dynamic_file_list[i]);
3591 print_timestamp_done("ReloadCustomArtworkList");
3594 dumpList(artwork_info->content_list);
3598 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3599 struct ListNodeInfo ***list,
3600 int *num_list_entries)
3607 for (i = 0; i < *num_list_entries; i++)
3608 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3612 *num_list_entries = 0;
3615 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3617 if (artwork_info == NULL)
3620 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3621 &artwork_info->num_file_list_entries);
3623 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3624 &artwork_info->num_dynamic_file_list_entries);
3628 /* ------------------------------------------------------------------------- */
3629 /* functions only needed for non-Unix (non-command-line) systems */
3630 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3631 /* (now also added for Windows, to create files in user data directory) */
3632 /* ------------------------------------------------------------------------- */
3634 char *getErrorFilename(char *basename)
3636 return getPath2(getUserGameDataDir(), basename);
3639 void openErrorFile()
3641 InitUserDataDirectory();
3643 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3645 program.error_file = stderr;
3647 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3648 program.error_filename, strerror(errno));
3652 void closeErrorFile()
3654 if (program.error_file != stderr) /* do not close stream 'stderr' */
3655 fclose(program.error_file);
3658 void dumpErrorFile()
3660 FILE *error_file = fopen(program.error_filename, MODE_READ);
3662 if (error_file != NULL)
3664 while (!feof(error_file))
3665 fputc(fgetc(error_file), stderr);
3671 void NotifyUserAboutErrorFile()
3673 #if defined(PLATFORM_WIN32)
3674 char *title_text = getStringCat2(program.program_title, " Error Message");
3675 char *error_text = getStringCat2("The program was aborted due to an error; "
3676 "for details, see the following error file:"
3677 STRING_NEWLINE, program.error_filename);
3679 MessageBox(NULL, error_text, title_text, MB_OK);
3684 /* ------------------------------------------------------------------------- */
3685 /* the following is only for debugging purpose and normally not used */
3686 /* ------------------------------------------------------------------------- */
3690 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
3691 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3693 #define DEBUG_NUM_TIMESTAMPS 10
3694 #define DEBUG_TIME_IN_MICROSECONDS 0
3696 #if DEBUG_TIME_IN_MICROSECONDS
3697 static double Counter_Microseconds()
3699 static struct timeval base_time = { 0, 0 };
3700 struct timeval current_time;
3703 gettimeofday(¤t_time, NULL);
3705 /* reset base time in case of wrap-around */
3706 if (current_time.tv_sec < base_time.tv_sec)
3707 base_time = current_time;
3710 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3711 ((double)(current_time.tv_usec - base_time.tv_usec));
3713 return counter; /* return microseconds since last init */
3717 char *debug_print_timestamp_get_padding(int padding_size)
3719 static char *padding = NULL;
3720 int max_padding_size = 100;
3722 if (padding == NULL)
3724 padding = checked_calloc(max_padding_size + 1);
3725 memset(padding, ' ', max_padding_size);
3728 return &padding[MAX(0, max_padding_size - padding_size)];
3731 void debug_print_timestamp(int counter_nr, char *message)
3733 int indent_size = 8;
3734 int padding_size = 40;
3735 float timestamp_interval;
3738 Error(ERR_EXIT, "debugging: invalid negative counter");
3739 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3740 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3742 #if DEBUG_TIME_IN_MICROSECONDS
3743 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3746 counter[counter_nr][0] = Counter_Microseconds();
3748 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3751 counter[counter_nr][0] = Counter();
3754 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3755 counter[counter_nr][1] = counter[counter_nr][0];
3759 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3761 printf("%s%s%s %.3f %s\n",
3763 debug_print_timestamp_get_padding(counter_nr * indent_size),
3765 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3766 timestamp_interval / 1000,
3770 void debug_print_parent_only(char *format, ...)
3772 if (!IS_PARENT_PROCESS())
3779 va_start(ap, format);
3780 vprintf(format, ap);
3789 void print_timestamp_ext(char *message, char *mode)
3791 #if DEBUG_PRINT_INIT_TIMESTAMPS
3792 static char *debug_message = NULL;
3793 static char *last_message = NULL;
3794 static int counter_nr = 0;
3795 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3797 checked_free(debug_message);
3798 debug_message = getStringCat3(mode, " ", message);
3800 if (strEqual(mode, "INIT"))
3802 debug_print_timestamp(counter_nr, NULL);
3804 if (counter_nr + 1 < max_depth)
3805 debug_print_timestamp(counter_nr, debug_message);
3809 debug_print_timestamp(counter_nr, NULL);
3811 else if (strEqual(mode, "DONE"))
3815 if (counter_nr + 1 < max_depth ||
3816 (counter_nr == 0 && max_depth == 1))
3818 last_message = message;
3820 if (counter_nr == 0 && max_depth == 1)
3822 checked_free(debug_message);
3823 debug_message = getStringCat3("TIME", " ", message);
3826 debug_print_timestamp(counter_nr, debug_message);
3829 else if (!strEqual(mode, "TIME") ||
3830 !strEqual(message, last_message))
3832 if (counter_nr < max_depth)
3833 debug_print_timestamp(counter_nr, debug_message);
3838 void print_timestamp_init(char *message)
3840 print_timestamp_ext(message, "INIT");
3843 void print_timestamp_time(char *message)
3845 print_timestamp_ext(message, "TIME");
3848 void print_timestamp_done(char *message)
3850 print_timestamp_ext(message, "DONE");