1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ========================================================================= */
37 /* some generic helper functions */
38 /* ========================================================================= */
40 /* ------------------------------------------------------------------------- */
41 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 #if defined(PLATFORM_ANDROID)
45 static int android_log_prio = ANDROID_LOG_INFO;
49 static void vfPrintLog(FILE *stream, char *format, va_list ap)
53 static void vfPrintLog(FILE *stream, char *format, va_list ap)
57 static void fPrintLog(FILE *stream, char *format, va_list ap)
61 static void fPrintLog(FILE *stream, char *format, va_list ap)
66 static void vfprintf_nonewline(FILE *stream, char *format, va_list ap)
68 #if defined(PLATFORM_ANDROID)
69 // (prefix text of logging output is currently skipped on Android)
70 //__android_log_vprint(android_log_prio, program.program_title, format, ap);
75 vfprintf(stream, format, ap);
76 vfprintf(stderr, format, ap2);
82 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
84 #if defined(PLATFORM_ANDROID)
85 __android_log_vprint(android_log_prio, program.program_title, format, ap);
87 char *newline = STRING_NEWLINE;
92 vfprintf(stream, format, ap);
93 fprintf(stream, "%s", newline);
95 vfprintf(stderr, format, ap2);
96 fprintf(stderr, "%s", newline);
102 static void fprintf_nonewline(FILE *stream, char *format, ...)
106 va_start(ap, format);
107 vfprintf_nonewline(stream, format, ap);
111 static void fprintf_newline(FILE *stream, char *format, ...)
115 va_start(ap, format);
116 vfprintf_newline(stream, format, ap);
120 void fprintf_line(FILE *stream, char *line_chars, int line_length)
124 for (i = 0; i < line_length; i++)
125 fprintf_nonewline(stream, "%s", line_chars);
127 fprintf_newline(stream, "");
130 void printf_line(char *line_chars, int line_length)
132 fprintf_line(stdout, line_chars, line_length);
135 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
137 fprintf(stdout, "%s", prefix);
138 fprintf_line(stdout, line_chars, line_length);
142 /* ------------------------------------------------------------------------- */
143 /* string functions */
144 /* ------------------------------------------------------------------------- */
146 /* int2str() returns a number converted to a string;
147 the used memory is static, but will be overwritten by later calls,
148 so if you want to save the result, copy it to a private string buffer;
149 there can be 10 local calls of int2str() without buffering the result --
150 the 11th call will then destroy the result from the first call and so on.
153 char *int2str(int number, int size)
155 static char shift_array[10][40];
156 static int shift_counter = 0;
157 char *s = shift_array[shift_counter];
159 shift_counter = (shift_counter + 1) % 10;
166 sprintf(s, " %09d", number);
167 return &s[strlen(s) - size];
171 sprintf(s, "%d", number);
177 /* something similar to "int2str()" above, but allocates its own memory
178 and has a different interface; we cannot use "itoa()", because this
179 seems to be already defined when cross-compiling to the win32 target */
181 char *i_to_a(unsigned int i)
183 static char *a = NULL;
187 if (i > 2147483647) /* yes, this is a kludge */
190 a = checked_malloc(10 + 1);
198 /* calculate base-2 logarithm of argument (rounded down to integer;
199 this function returns the number of the highest bit set in argument) */
201 int log_2(unsigned int x)
207 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
214 boolean getTokenValueFromString(char *string, char **token, char **value)
216 return getTokenValueFromSetupLine(string, token, value);
220 /* ------------------------------------------------------------------------- */
221 /* counter functions */
222 /* ------------------------------------------------------------------------- */
224 /* maximal allowed length of a command line option */
225 #define MAX_OPTION_LEN 256
227 static unsigned int getCurrentMS()
229 return SDL_GetTicks();
232 static unsigned int mainCounter(int mode)
234 static unsigned int base_ms = 0;
235 unsigned int current_ms;
237 /* get current system milliseconds */
238 current_ms = getCurrentMS();
240 /* reset base timestamp in case of counter reset or wrap-around */
241 if (mode == INIT_COUNTER || current_ms < base_ms)
242 base_ms = current_ms;
244 /* return milliseconds since last counter reset */
245 return current_ms - base_ms;
248 void InitCounter() /* set counter back to zero */
250 mainCounter(INIT_COUNTER);
253 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
255 return mainCounter(READ_COUNTER);
258 static void sleep_milliseconds(unsigned int milliseconds_delay)
260 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
264 /* we want to wait only a few ms -- if we assume that we have a
265 kernel timer resolution of 10 ms, we would wait far to long;
266 therefore it's better to do a short interval of busy waiting
267 to get our sleeping time more accurate */
269 unsigned int base_counter = Counter(), actual_counter = Counter();
271 while (actual_counter < base_counter + milliseconds_delay &&
272 actual_counter >= base_counter)
273 actual_counter = Counter();
277 SDL_Delay(milliseconds_delay);
281 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
283 sleep_milliseconds(delay);
286 boolean FrameReached(unsigned int *frame_counter_var,
287 unsigned int frame_delay)
289 unsigned int actual_frame_counter = FrameCounter;
291 if (actual_frame_counter >= *frame_counter_var &&
292 actual_frame_counter < *frame_counter_var + frame_delay)
295 *frame_counter_var = actual_frame_counter;
300 boolean DelayReached(unsigned int *counter_var,
303 unsigned int actual_counter = Counter();
305 if (actual_counter >= *counter_var &&
306 actual_counter < *counter_var + delay)
309 *counter_var = actual_counter;
314 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
316 unsigned int actual_counter;
320 actual_counter = Counter();
322 if (actual_counter >= *counter_var &&
323 actual_counter < *counter_var + delay)
324 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
329 *counter_var = actual_counter;
333 /* ------------------------------------------------------------------------- */
334 /* random generator functions */
335 /* ------------------------------------------------------------------------- */
337 unsigned int init_random_number(int nr, int seed)
339 if (seed == NEW_RANDOMIZE)
341 /* default random seed */
342 seed = (int)time(NULL); // seconds since the epoch
344 #if !defined(PLATFORM_WIN32)
345 /* add some more randomness */
346 struct timeval current_time;
348 gettimeofday(¤t_time, NULL);
350 seed += (int)current_time.tv_usec; // microseconds since the epoch
353 /* add some more randomness */
354 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
356 /* add some more randomness */
357 seed += GetSimpleRandom(1000000);
360 srandom_linux_libc(nr, (unsigned int) seed);
362 return (unsigned int) seed;
365 unsigned int get_random_number(int nr, int max)
367 return (max > 0 ? random_linux_libc(nr) % max : 0);
371 /* ------------------------------------------------------------------------- */
372 /* system info functions */
373 /* ------------------------------------------------------------------------- */
375 #if !defined(PLATFORM_ANDROID)
376 static char *get_corrected_real_name(char *real_name)
378 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
379 char *from_ptr = real_name;
380 char *to_ptr = real_name_new;
382 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
383 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
385 /* the name field read from "passwd" file may also contain additional
386 user information, separated by commas, which will be removed here */
387 if (*from_ptr == ',')
390 /* the user's real name may contain 'german sharp s' characters,
391 which have no equivalent in upper case letters (used by our fonts) */
392 if (*from_ptr == CHAR_BYTE_SHARP_S)
399 *to_ptr++ = *from_ptr++;
404 return real_name_new;
410 static char *login_name = NULL;
412 #if defined(PLATFORM_WIN32)
413 if (login_name == NULL)
415 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
416 login_name = checked_malloc(buffer_size);
418 if (GetUserName(login_name, &buffer_size) == 0)
419 strcpy(login_name, ANONYMOUS_NAME);
422 if (login_name == NULL)
426 if ((pwd = getpwuid(getuid())) == NULL)
427 login_name = ANONYMOUS_NAME;
429 login_name = getStringCopy(pwd->pw_name);
438 static char *real_name = NULL;
440 #if defined(PLATFORM_WIN32)
441 if (real_name == NULL)
443 static char buffer[MAX_USERNAME_LEN + 1];
444 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
446 if (GetUserName(buffer, &buffer_size) != 0)
447 real_name = get_corrected_real_name(buffer);
449 real_name = ANONYMOUS_NAME;
451 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
452 if (real_name == NULL)
456 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
457 real_name = get_corrected_real_name(pwd->pw_gecos);
459 real_name = ANONYMOUS_NAME;
462 real_name = ANONYMOUS_NAME;
468 time_t getFileTimestampEpochSeconds(char *filename)
470 struct stat file_status;
472 if (stat(filename, &file_status) != 0) /* cannot stat file */
475 return file_status.st_mtime;
479 /* ------------------------------------------------------------------------- */
480 /* path manipulation functions */
481 /* ------------------------------------------------------------------------- */
483 static char *getLastPathSeparatorPtr(char *filename)
485 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
487 if (last_separator == NULL) /* also try DOS/Windows variant */
488 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
490 return last_separator;
493 char *getBaseNamePtr(char *filename)
495 char *last_separator = getLastPathSeparatorPtr(filename);
497 if (last_separator != NULL)
498 return last_separator + 1; /* separator found: strip base path */
500 return filename; /* no separator found: filename has no path */
503 char *getBaseName(char *filename)
505 return getStringCopy(getBaseNamePtr(filename));
508 char *getBasePath(char *filename)
510 char *basepath = getStringCopy(filename);
511 char *last_separator = getLastPathSeparatorPtr(basepath);
513 if (last_separator != NULL)
514 *last_separator = '\0'; /* separator found: strip basename */
516 basepath = "."; /* no separator found: use current path */
521 static char *getProgramMainDataPath()
523 char *main_data_path = getStringCopy(program.command_basepath);
525 #if defined(PLATFORM_MACOSX)
526 static char *main_data_binary_subdir = NULL;
528 if (main_data_binary_subdir == NULL)
530 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
532 strlen(MAC_APP_BINARY_SUBDIR) + 1);
534 sprintf(main_data_binary_subdir, "%s.app/%s",
535 program.program_title, MAC_APP_BINARY_SUBDIR);
538 // cut relative path to Mac OS X application binary directory from path
539 if (strSuffix(main_data_path, main_data_binary_subdir))
540 main_data_path[strlen(main_data_path) -
541 strlen(main_data_binary_subdir)] = '\0';
543 // cut trailing path separator from path (but not if path is root directory)
544 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
545 main_data_path[strlen(main_data_path) - 1] = '\0';
548 return main_data_path;
552 /* ------------------------------------------------------------------------- */
553 /* various string functions */
554 /* ------------------------------------------------------------------------- */
556 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
558 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
561 sprintf(complete_string, "%s%s%s", s1, sep, s2);
563 return complete_string;
566 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
568 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
569 strlen(s2) + strlen(sep) +
572 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
574 return complete_string;
577 char *getStringCat2(char *s1, char *s2)
579 return getStringCat2WithSeparator(s1, s2, "");
582 char *getStringCat3(char *s1, char *s2, char *s3)
584 return getStringCat3WithSeparator(s1, s2, s3, "");
587 char *getPath2(char *path1, char *path2)
589 #if defined(PLATFORM_ANDROID)
590 // workaround for reading from APK assets directory -- skip leading "./"
591 if (strEqual(path1, "."))
592 return getStringCopy(path2);
595 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
598 char *getPath3(char *path1, char *path2, char *path3)
600 #if defined(PLATFORM_ANDROID)
601 // workaround for reading from APK assets directory -- skip leading "./"
602 if (strEqual(path1, "."))
603 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
606 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
609 char *getImg2(char *path1, char *path2)
611 char *filename = getPath2(path1, path2);
613 if (!fileExists(filename) && strSuffix(path2, ".png"))
615 // backward compatibility: if PNG file not found, check for PCX file
616 char *path2pcx = getStringCopy(path2);
618 strcpy(&path2pcx[strlen(path2pcx) - 3], "pcx");
622 filename = getPath2(path1, path2pcx);
630 char *getImg3(char *path1, char *path2, char *path3)
632 char *filename = getPath3(path1, path2, path3);
634 if (!fileExists(filename) && strSuffix(path3, ".png"))
636 // backward compatibility: if PNG file not found, check for PCX file
637 char *path3pcx = getStringCopy(path3);
639 strcpy(&path3pcx[strlen(path3pcx) - 3], "pcx");
643 filename = getPath3(path1, path2, path3pcx);
651 char *getStringCopy(const char *s)
658 s_copy = checked_malloc(strlen(s) + 1);
664 char *getStringCopyN(const char *s, int n)
667 int s_len = MAX(0, n);
672 s_copy = checked_malloc(s_len + 1);
673 strncpy(s_copy, s, s_len);
674 s_copy[s_len] = '\0';
679 char *getStringCopyNStatic(const char *s, int n)
681 static char *s_copy = NULL;
683 checked_free(s_copy);
685 s_copy = getStringCopyN(s, n);
690 char *getStringToLower(const char *s)
692 char *s_copy = checked_malloc(strlen(s) + 1);
693 char *s_ptr = s_copy;
696 *s_ptr++ = tolower(*s++);
702 void setString(char **old_value, char *new_value)
704 checked_free(*old_value);
706 *old_value = getStringCopy(new_value);
709 boolean strEqual(char *s1, char *s2)
711 return (s1 == NULL && s2 == NULL ? TRUE :
712 s1 == NULL && s2 != NULL ? FALSE :
713 s1 != NULL && s2 == NULL ? FALSE :
714 strcmp(s1, s2) == 0);
717 boolean strEqualN(char *s1, char *s2, int n)
719 return (s1 == NULL && s2 == NULL ? TRUE :
720 s1 == NULL && s2 != NULL ? FALSE :
721 s1 != NULL && s2 == NULL ? FALSE :
722 strncmp(s1, s2, n) == 0);
725 boolean strPrefix(char *s, char *prefix)
727 return (s == NULL && prefix == NULL ? TRUE :
728 s == NULL && prefix != NULL ? FALSE :
729 s != NULL && prefix == NULL ? FALSE :
730 strncmp(s, prefix, strlen(prefix)) == 0);
733 boolean strSuffix(char *s, char *suffix)
735 return (s == NULL && suffix == NULL ? TRUE :
736 s == NULL && suffix != NULL ? FALSE :
737 s != NULL && suffix == NULL ? FALSE :
738 strlen(s) < strlen(suffix) ? FALSE :
739 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
742 boolean strPrefixLower(char *s, char *prefix)
744 char *s_lower = getStringToLower(s);
745 boolean match = strPrefix(s_lower, prefix);
752 boolean strSuffixLower(char *s, char *suffix)
754 char *s_lower = getStringToLower(s);
755 boolean match = strSuffix(s_lower, suffix);
763 /* ------------------------------------------------------------------------- */
764 /* command line option handling functions */
765 /* ------------------------------------------------------------------------- */
767 void GetOptions(char *argv[],
768 void (*print_usage_function)(void),
769 void (*print_version_function)(void))
771 char *ro_base_path = RO_BASE_PATH;
772 char *rw_base_path = RW_BASE_PATH;
773 char **options_left = &argv[1];
775 /* if the program is configured to start from current directory (default),
776 determine program package directory from program binary (some versions
777 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
778 set the current working directory to the program package directory) */
780 if (strEqual(ro_base_path, "."))
781 ro_base_path = getProgramMainDataPath();
782 if (strEqual(rw_base_path, "."))
783 rw_base_path = getProgramMainDataPath();
785 /* initialize global program options */
786 options.display_name = NULL;
787 options.server_host = NULL;
788 options.server_port = 0;
790 options.ro_base_directory = ro_base_path;
791 options.rw_base_directory = rw_base_path;
792 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
793 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
794 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
795 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
796 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
798 options.execute_command = NULL;
799 options.special_flags = NULL;
801 options.serveronly = FALSE;
802 options.network = FALSE;
803 options.verbose = FALSE;
804 options.debug = FALSE;
807 options.verbose = TRUE;
809 #if !defined(PLATFORM_UNIX)
810 if (*options_left == NULL) /* no options given -- enable verbose mode */
811 options.verbose = TRUE;
815 while (*options_left)
817 char option_str[MAX_OPTION_LEN];
818 char *option = options_left[0];
819 char *next_option = options_left[1];
820 char *option_arg = NULL;
821 int option_len = strlen(option);
823 if (option_len >= MAX_OPTION_LEN)
824 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
826 strcpy(option_str, option); /* copy argument into buffer */
829 if (strEqual(option, "--")) /* stop scanning arguments */
832 if (strPrefix(option, "--")) /* treat '--' like '-' */
835 option_arg = strchr(option, '=');
836 if (option_arg == NULL) /* no '=' in option */
837 option_arg = next_option;
840 *option_arg++ = '\0'; /* cut argument from option */
841 if (*option_arg == '\0') /* no argument after '=' */
842 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
845 option_len = strlen(option);
847 if (strEqual(option, "-"))
849 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
851 else if (strncmp(option, "-help", option_len) == 0)
853 print_usage_function();
857 else if (strncmp(option, "-display", option_len) == 0)
859 if (option_arg == NULL)
860 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
862 options.display_name = option_arg;
863 if (option_arg == next_option)
866 else if (strncmp(option, "-basepath", option_len) == 0)
868 if (option_arg == NULL)
869 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
871 /* this should be extended to separate options for ro and rw data */
872 options.ro_base_directory = ro_base_path = option_arg;
873 options.rw_base_directory = rw_base_path = option_arg;
874 if (option_arg == next_option)
877 /* adjust paths for sub-directories in base directory accordingly */
878 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
879 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
880 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
881 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
882 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
884 else if (strncmp(option, "-levels", option_len) == 0)
886 if (option_arg == NULL)
887 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
889 options.level_directory = option_arg;
890 if (option_arg == next_option)
893 else if (strncmp(option, "-graphics", option_len) == 0)
895 if (option_arg == NULL)
896 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
898 options.graphics_directory = option_arg;
899 if (option_arg == next_option)
902 else if (strncmp(option, "-sounds", option_len) == 0)
904 if (option_arg == NULL)
905 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
907 options.sounds_directory = option_arg;
908 if (option_arg == next_option)
911 else if (strncmp(option, "-music", option_len) == 0)
913 if (option_arg == NULL)
914 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
916 options.music_directory = option_arg;
917 if (option_arg == next_option)
920 else if (strncmp(option, "-network", option_len) == 0)
922 options.network = TRUE;
924 else if (strncmp(option, "-serveronly", option_len) == 0)
926 options.serveronly = TRUE;
928 else if (strncmp(option, "-debug", option_len) == 0)
930 options.debug = TRUE;
932 else if (strncmp(option, "-verbose", option_len) == 0)
934 options.verbose = TRUE;
936 else if (strncmp(option, "-version", option_len) == 0 ||
937 strncmp(option, "-V", option_len) == 0)
939 print_version_function();
943 else if (strPrefix(option, "-D"))
945 options.special_flags = getStringCopy(&option[2]);
947 else if (strncmp(option, "-execute", option_len) == 0)
949 if (option_arg == NULL)
950 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
952 options.execute_command = option_arg;
953 if (option_arg == next_option)
956 /* when doing batch processing, always enable verbose mode (warnings) */
957 options.verbose = TRUE;
959 else if (*option == '-')
961 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
963 else if (options.server_host == NULL)
965 options.server_host = *options_left;
967 else if (options.server_port == 0)
969 options.server_port = atoi(*options_left);
970 if (options.server_port < 1024)
971 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
974 Error(ERR_EXIT_HELP, "too many arguments");
981 /* ------------------------------------------------------------------------- */
982 /* error handling functions */
983 /* ------------------------------------------------------------------------- */
985 #define MAX_INTERNAL_ERROR_SIZE 1024
987 /* used by SetError() and GetError() to store internal error messages */
988 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
990 void SetError(char *format, ...)
994 va_start(ap, format);
995 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1001 return internal_error;
1004 void Error(int mode, char *format, ...)
1006 static boolean last_line_was_separator = FALSE;
1007 char *process_name = "";
1009 #if defined(PLATFORM_ANDROID)
1010 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1011 mode & ERR_INFO ? ANDROID_LOG_INFO :
1012 mode & ERR_WARN ? ANDROID_LOG_WARN :
1013 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1014 ANDROID_LOG_UNKNOWN);
1017 /* display warnings only when running in verbose mode */
1018 if (mode & ERR_WARN && !options.verbose)
1021 if (mode == ERR_INFO_LINE)
1023 if (!last_line_was_separator)
1024 fprintf_line(program.error_file, format, 79);
1026 last_line_was_separator = TRUE;
1031 last_line_was_separator = FALSE;
1033 if (mode & ERR_SOUND_SERVER)
1034 process_name = " sound server";
1035 else if (mode & ERR_NETWORK_SERVER)
1036 process_name = " network server";
1037 else if (mode & ERR_NETWORK_CLIENT)
1038 process_name = " network client **";
1044 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1047 if (mode & ERR_WARN)
1048 fprintf_nonewline(program.error_file, "warning: ");
1050 if (mode & ERR_EXIT)
1051 fprintf_nonewline(program.error_file, "fatal error: ");
1053 va_start(ap, format);
1054 vfprintf_newline(program.error_file, format, ap);
1057 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1059 va_start(ap, format);
1060 program.exit_message_function(format, ap);
1065 if (mode & ERR_HELP)
1066 fprintf_newline(program.error_file,
1067 "%s: Try option '--help' for more information.",
1068 program.command_basename);
1070 if (mode & ERR_EXIT)
1071 fprintf_newline(program.error_file, "%s%s: aborting",
1072 program.command_basename, process_name);
1074 if (mode & ERR_EXIT)
1076 if (mode & ERR_FROM_SERVER)
1077 exit(1); /* child process: normal exit */
1079 program.exit_function(1); /* main process: clean up stuff */
1084 /* ------------------------------------------------------------------------- */
1085 /* checked memory allocation and freeing functions */
1086 /* ------------------------------------------------------------------------- */
1088 void *checked_malloc(unsigned int size)
1095 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1100 void *checked_calloc(unsigned int size)
1104 ptr = calloc(1, size);
1107 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1112 void *checked_realloc(void *ptr, unsigned int size)
1114 ptr = realloc(ptr, size);
1117 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1122 void checked_free(void *ptr)
1124 if (ptr != NULL) /* this check should be done by free() anyway */
1128 void clear_mem(void *ptr, unsigned int size)
1130 #if defined(PLATFORM_WIN32)
1131 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1132 char *cptr = (char *)ptr;
1137 memset(ptr, 0, size);
1142 /* ------------------------------------------------------------------------- */
1143 /* various helper functions */
1144 /* ------------------------------------------------------------------------- */
1146 inline void swap_numbers(int *i1, int *i2)
1154 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1166 /* the "put" variants of the following file access functions check for the file
1167 pointer being != NULL and return the number of bytes they have or would have
1168 written; this allows for chunk writing functions to first determine the size
1169 of the (not yet written) chunk, write the correct chunk size and finally
1170 write the chunk itself */
1172 int getFile8BitInteger(File *file)
1174 return getByteFromFile(file);
1177 int putFile8BitInteger(FILE *file, int value)
1185 int getFile16BitInteger(File *file, int byte_order)
1187 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1188 return ((getByteFromFile(file) << 8) |
1189 (getByteFromFile(file) << 0));
1190 else /* BYTE_ORDER_LITTLE_ENDIAN */
1191 return ((getByteFromFile(file) << 0) |
1192 (getByteFromFile(file) << 8));
1195 int putFile16BitInteger(FILE *file, int value, int byte_order)
1199 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1201 fputc((value >> 8) & 0xff, file);
1202 fputc((value >> 0) & 0xff, file);
1204 else /* BYTE_ORDER_LITTLE_ENDIAN */
1206 fputc((value >> 0) & 0xff, file);
1207 fputc((value >> 8) & 0xff, file);
1214 int getFile32BitInteger(File *file, int byte_order)
1216 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1217 return ((getByteFromFile(file) << 24) |
1218 (getByteFromFile(file) << 16) |
1219 (getByteFromFile(file) << 8) |
1220 (getByteFromFile(file) << 0));
1221 else /* BYTE_ORDER_LITTLE_ENDIAN */
1222 return ((getByteFromFile(file) << 0) |
1223 (getByteFromFile(file) << 8) |
1224 (getByteFromFile(file) << 16) |
1225 (getByteFromFile(file) << 24));
1228 int putFile32BitInteger(FILE *file, int value, int byte_order)
1232 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1234 fputc((value >> 24) & 0xff, file);
1235 fputc((value >> 16) & 0xff, file);
1236 fputc((value >> 8) & 0xff, file);
1237 fputc((value >> 0) & 0xff, file);
1239 else /* BYTE_ORDER_LITTLE_ENDIAN */
1241 fputc((value >> 0) & 0xff, file);
1242 fputc((value >> 8) & 0xff, file);
1243 fputc((value >> 16) & 0xff, file);
1244 fputc((value >> 24) & 0xff, file);
1251 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1254 const int chunk_name_length = 4;
1256 /* read chunk name */
1257 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1260 if (chunk_size != NULL)
1262 /* read chunk size */
1263 *chunk_size = getFile32BitInteger(file, byte_order);
1266 return (checkEndOfFile(file) ? FALSE : TRUE);
1269 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1274 /* write chunk name */
1276 fputs(chunk_name, file);
1278 num_bytes += strlen(chunk_name);
1280 if (chunk_size >= 0)
1282 /* write chunk size */
1284 putFile32BitInteger(file, chunk_size, byte_order);
1292 int getFileVersion(File *file)
1294 int version_major = getByteFromFile(file);
1295 int version_minor = getByteFromFile(file);
1296 int version_patch = getByteFromFile(file);
1297 int version_build = getByteFromFile(file);
1299 return VERSION_IDENT(version_major, version_minor, version_patch,
1303 int putFileVersion(FILE *file, int version)
1307 int version_major = VERSION_MAJOR(version);
1308 int version_minor = VERSION_MINOR(version);
1309 int version_patch = VERSION_PATCH(version);
1310 int version_build = VERSION_BUILD(version);
1312 fputc(version_major, file);
1313 fputc(version_minor, file);
1314 fputc(version_patch, file);
1315 fputc(version_build, file);
1321 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1325 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1326 buffer[i] = getByteFromFile(file);
1329 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1333 for(i = 0; i < bytes; i++)
1334 fputc(buffer[i], file);
1337 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1339 while (bytes-- && !checkEndOfFile(file))
1340 getByteFromFile(file);
1343 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1350 /* ------------------------------------------------------------------------- */
1351 /* functions to translate key identifiers between different format */
1352 /* ------------------------------------------------------------------------- */
1354 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1355 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1356 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1357 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1359 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1368 /* normal cursor keys */
1369 { KSYM_Left, "XK_Left", "cursor left" },
1370 { KSYM_Right, "XK_Right", "cursor right" },
1371 { KSYM_Up, "XK_Up", "cursor up" },
1372 { KSYM_Down, "XK_Down", "cursor down" },
1374 /* keypad cursor keys */
1376 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1377 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1378 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1379 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1382 /* other keypad keys */
1383 #ifdef KSYM_KP_Enter
1384 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1385 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1386 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1387 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1388 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1389 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1393 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1394 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1395 { KSYM_Control_L, "XK_Control_L", "left control" },
1396 { KSYM_Control_R, "XK_Control_R", "right control" },
1397 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1398 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1399 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1400 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1401 #if !defined(TARGET_SDL2)
1402 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1403 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1405 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1406 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1408 /* some special keys */
1409 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1410 { KSYM_Delete, "XK_Delete", "delete" },
1411 { KSYM_Insert, "XK_Insert", "insert" },
1412 { KSYM_Tab, "XK_Tab", "tab" },
1413 { KSYM_Home, "XK_Home", "home" },
1414 { KSYM_End, "XK_End", "end" },
1415 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1416 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1418 #if defined(TARGET_SDL2)
1419 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1420 { KSYM_Back, "XK_Back", "back" }, /* back key */
1423 /* ASCII 0x20 to 0x40 keys (except numbers) */
1424 { KSYM_space, "XK_space", "space" },
1425 { KSYM_exclam, "XK_exclam", "!" },
1426 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1427 { KSYM_numbersign, "XK_numbersign", "#" },
1428 { KSYM_dollar, "XK_dollar", "$" },
1429 { KSYM_percent, "XK_percent", "%" },
1430 { KSYM_ampersand, "XK_ampersand", "&" },
1431 { KSYM_apostrophe, "XK_apostrophe", "'" },
1432 { KSYM_parenleft, "XK_parenleft", "(" },
1433 { KSYM_parenright, "XK_parenright", ")" },
1434 { KSYM_asterisk, "XK_asterisk", "*" },
1435 { KSYM_plus, "XK_plus", "+" },
1436 { KSYM_comma, "XK_comma", "," },
1437 { KSYM_minus, "XK_minus", "-" },
1438 { KSYM_period, "XK_period", "." },
1439 { KSYM_slash, "XK_slash", "/" },
1440 { KSYM_colon, "XK_colon", ":" },
1441 { KSYM_semicolon, "XK_semicolon", ";" },
1442 { KSYM_less, "XK_less", "<" },
1443 { KSYM_equal, "XK_equal", "=" },
1444 { KSYM_greater, "XK_greater", ">" },
1445 { KSYM_question, "XK_question", "?" },
1446 { KSYM_at, "XK_at", "@" },
1448 /* more ASCII keys */
1449 { KSYM_bracketleft, "XK_bracketleft", "[" },
1450 { KSYM_backslash, "XK_backslash", "\\" },
1451 { KSYM_bracketright,"XK_bracketright", "]" },
1452 { KSYM_asciicircum, "XK_asciicircum", "^" },
1453 { KSYM_underscore, "XK_underscore", "_" },
1454 { KSYM_grave, "XK_grave", "grave" },
1455 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1456 { KSYM_braceleft, "XK_braceleft", "brace left" },
1457 { KSYM_bar, "XK_bar", "bar" },
1458 { KSYM_braceright, "XK_braceright", "brace right" },
1459 { KSYM_asciitilde, "XK_asciitilde", "~" },
1461 /* special (non-ASCII) keys */
1462 { KSYM_degree, "XK_degree", "degree" },
1463 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1464 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1465 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1466 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1467 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1468 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1469 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1471 #if defined(TARGET_SDL2)
1472 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1473 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1474 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1475 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1476 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1477 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1478 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1479 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1480 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1482 /* other keys (for reverse mapping only) */
1483 { KSYM_space, "XK_space", " " },
1486 #if defined(TARGET_SDL2)
1487 /* keypad keys are not in numerical order in SDL2 */
1488 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1489 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1490 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1491 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1492 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1493 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1494 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1495 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1496 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1497 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1500 /* end-of-array identifier */
1506 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1508 static char name_buffer[30];
1511 if (key >= KSYM_A && key <= KSYM_Z)
1512 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1513 else if (key >= KSYM_a && key <= KSYM_z)
1514 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1515 else if (key >= KSYM_0 && key <= KSYM_9)
1516 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1517 #if !defined(TARGET_SDL2)
1518 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1519 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1521 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1522 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1523 else if (key == KSYM_UNDEFINED)
1524 strcpy(name_buffer, "(undefined)");
1531 if (key == translate_key[i].key)
1533 strcpy(name_buffer, translate_key[i].name);
1537 while (translate_key[++i].name);
1539 if (!translate_key[i].name)
1540 strcpy(name_buffer, "(unknown)");
1543 *name = name_buffer;
1545 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1547 static char name_buffer[30];
1550 if (key >= KSYM_A && key <= KSYM_Z)
1551 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1552 else if (key >= KSYM_a && key <= KSYM_z)
1553 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1554 else if (key >= KSYM_0 && key <= KSYM_9)
1555 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1556 #if !defined(TARGET_SDL2)
1557 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1558 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1560 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1561 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1562 else if (key == KSYM_UNDEFINED)
1563 strcpy(name_buffer, "[undefined]");
1570 if (key == translate_key[i].key)
1572 strcpy(name_buffer, translate_key[i].x11name);
1576 while (translate_key[++i].x11name);
1578 if (!translate_key[i].x11name)
1579 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1582 *x11name = name_buffer;
1584 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1586 Key key = KSYM_UNDEFINED;
1587 char *name_ptr = *name;
1589 if (strlen(*name) == 1)
1591 char c = name_ptr[0];
1593 if (c >= 'A' && c <= 'Z')
1594 key = KSYM_A + (Key)(c - 'A');
1595 else if (c >= 'a' && c <= 'z')
1596 key = KSYM_a + (Key)(c - 'a');
1597 else if (c >= '0' && c <= '9')
1598 key = KSYM_0 + (Key)(c - '0');
1601 if (key == KSYM_UNDEFINED)
1607 if (strEqual(translate_key[i].name, *name))
1609 key = translate_key[i].key;
1613 while (translate_key[++i].x11name);
1616 if (key == KSYM_UNDEFINED)
1617 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1621 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1623 Key key = KSYM_UNDEFINED;
1624 char *name_ptr = *x11name;
1626 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1628 char c = name_ptr[3];
1630 if (c >= 'A' && c <= 'Z')
1631 key = KSYM_A + (Key)(c - 'A');
1632 else if (c >= 'a' && c <= 'z')
1633 key = KSYM_a + (Key)(c - 'a');
1634 else if (c >= '0' && c <= '9')
1635 key = KSYM_0 + (Key)(c - '0');
1637 #if !defined(TARGET_SDL2)
1638 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1640 char c = name_ptr[6];
1642 if (c >= '0' && c <= '9')
1643 key = KSYM_KP_0 + (Key)(c - '0');
1646 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1648 char c1 = name_ptr[4];
1649 char c2 = name_ptr[5];
1652 if ((c1 >= '0' && c1 <= '9') &&
1653 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1654 d = atoi(&name_ptr[4]);
1656 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1657 key = KSYM_F1 + (Key)(d - 1);
1659 else if (strPrefix(name_ptr, "XK_"))
1665 if (strEqual(name_ptr, translate_key[i].x11name))
1667 key = translate_key[i].key;
1671 while (translate_key[++i].x11name);
1673 else if (strPrefix(name_ptr, "0x"))
1675 unsigned int value = 0;
1681 char c = *name_ptr++;
1684 if (c >= '0' && c <= '9')
1686 else if (c >= 'a' && c <= 'f')
1687 d = (int)(c - 'a' + 10);
1688 else if (c >= 'A' && c <= 'F')
1689 d = (int)(c - 'A' + 10);
1697 value = value * 16 + d;
1708 char *getKeyNameFromKey(Key key)
1712 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1716 char *getX11KeyNameFromKey(Key key)
1720 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1724 Key getKeyFromKeyName(char *name)
1728 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1732 Key getKeyFromX11KeyName(char *x11name)
1736 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1740 char getCharFromKey(Key key)
1746 } translate_key_char[] =
1748 /* special (non-ASCII) keys (ISO-8859-1) */
1749 { KSYM_degree, CHAR_BYTE_DEGREE },
1750 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1751 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1752 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1753 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1754 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1755 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1756 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1758 /* end-of-array identifier */
1762 char *keyname = getKeyNameFromKey(key);
1765 if (strlen(keyname) == 1)
1767 else if (strEqual(keyname, "space"))
1775 if (key == translate_key_char[i].key)
1777 c = translate_key_char[i].key_char;
1782 while (translate_key_char[++i].key_char);
1788 char getValidConfigValueChar(char c)
1790 if (c == '#' || /* used to mark comments */
1791 c == '\\') /* used to mark continued lines */
1798 /* ------------------------------------------------------------------------- */
1799 /* functions to translate string identifiers to integer or boolean value */
1800 /* ------------------------------------------------------------------------- */
1802 int get_integer_from_string(char *s)
1804 static char *number_text[][3] =
1806 { "0", "zero", "null", },
1807 { "1", "one", "first" },
1808 { "2", "two", "second" },
1809 { "3", "three", "third" },
1810 { "4", "four", "fourth" },
1811 { "5", "five", "fifth" },
1812 { "6", "six", "sixth" },
1813 { "7", "seven", "seventh" },
1814 { "8", "eight", "eighth" },
1815 { "9", "nine", "ninth" },
1816 { "10", "ten", "tenth" },
1817 { "11", "eleven", "eleventh" },
1818 { "12", "twelve", "twelfth" },
1820 { NULL, NULL, NULL },
1824 char *s_lower = getStringToLower(s);
1827 for (i = 0; number_text[i][0] != NULL; i++)
1828 for (j = 0; j < 3; j++)
1829 if (strEqual(s_lower, number_text[i][j]))
1834 if (strEqual(s_lower, "false") ||
1835 strEqual(s_lower, "no") ||
1836 strEqual(s_lower, "off"))
1838 else if (strEqual(s_lower, "true") ||
1839 strEqual(s_lower, "yes") ||
1840 strEqual(s_lower, "on"))
1851 boolean get_boolean_from_string(char *s)
1853 char *s_lower = getStringToLower(s);
1854 boolean result = FALSE;
1856 if (strEqual(s_lower, "true") ||
1857 strEqual(s_lower, "yes") ||
1858 strEqual(s_lower, "on") ||
1859 get_integer_from_string(s) == 1)
1867 int get_switch3_from_string(char *s)
1869 char *s_lower = getStringToLower(s);
1872 if (strEqual(s_lower, "true") ||
1873 strEqual(s_lower, "yes") ||
1874 strEqual(s_lower, "on") ||
1875 get_integer_from_string(s) == 1)
1877 else if (strEqual(s_lower, "auto"))
1886 /* ------------------------------------------------------------------------- */
1887 /* functions for generic lists */
1888 /* ------------------------------------------------------------------------- */
1890 ListNode *newListNode()
1892 return checked_calloc(sizeof(ListNode));
1895 void addNodeToList(ListNode **node_first, char *key, void *content)
1897 ListNode *node_new = newListNode();
1899 node_new->key = getStringCopy(key);
1900 node_new->content = content;
1901 node_new->next = *node_first;
1902 *node_first = node_new;
1905 void deleteNodeFromList(ListNode **node_first, char *key,
1906 void (*destructor_function)(void *))
1908 if (node_first == NULL || *node_first == NULL)
1911 if (strEqual((*node_first)->key, key))
1913 checked_free((*node_first)->key);
1914 if (destructor_function)
1915 destructor_function((*node_first)->content);
1916 *node_first = (*node_first)->next;
1919 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1922 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1924 if (node_first == NULL)
1927 if (strEqual(node_first->key, key))
1930 return getNodeFromKey(node_first->next, key);
1933 int getNumNodes(ListNode *node_first)
1935 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1938 void dumpList(ListNode *node_first)
1940 ListNode *node = node_first;
1944 printf("['%s' (%d)]\n", node->key,
1945 ((struct ListNodeInfo *)node->content)->num_references);
1949 printf("[%d nodes]\n", getNumNodes(node_first));
1953 /* ------------------------------------------------------------------------- */
1954 /* functions for file handling */
1955 /* ------------------------------------------------------------------------- */
1957 File *openFile(char *filename, char *mode)
1959 File *file = checked_calloc(sizeof(File));
1961 file->file = fopen(filename, mode);
1963 if (file->file != NULL)
1965 file->filename = getStringCopy(filename);
1970 #if defined(PLATFORM_ANDROID)
1971 file->asset_file = SDL_RWFromFile(filename, mode);
1973 if (file->asset_file != NULL)
1975 file->file_is_asset = TRUE;
1976 file->filename = getStringCopy(filename);
1987 int closeFile(File *file)
1994 #if defined(PLATFORM_ANDROID)
1995 if (file->asset_file)
1996 result = SDL_RWclose(file->asset_file);
2000 result = fclose(file->file);
2002 checked_free(file->filename);
2008 int checkEndOfFile(File *file)
2010 #if defined(PLATFORM_ANDROID)
2011 if (file->file_is_asset)
2012 return file->end_of_file;
2015 return feof(file->file);
2018 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2020 #if defined(PLATFORM_ANDROID)
2021 if (file->file_is_asset)
2023 if (file->end_of_file)
2026 size_t num_items_read =
2027 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2029 if (num_items_read < num_items)
2030 file->end_of_file = TRUE;
2032 return num_items_read;
2036 return fread(buffer, item_size, num_items, file->file);
2039 int seekFile(File *file, long offset, int whence)
2041 #if defined(PLATFORM_ANDROID)
2042 if (file->file_is_asset)
2044 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2045 whence == SEEK_CUR ? RW_SEEK_CUR :
2046 whence == SEEK_END ? RW_SEEK_END : 0);
2048 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2052 return fseek(file->file, offset, whence);
2055 int getByteFromFile(File *file)
2057 #if defined(PLATFORM_ANDROID)
2058 if (file->file_is_asset)
2060 if (file->end_of_file)
2064 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2066 if (num_bytes_read < 1)
2067 file->end_of_file = TRUE;
2069 return (file->end_of_file ? EOF : (int)c);
2073 return fgetc(file->file);
2076 char *getStringFromFile(File *file, char *line, int size)
2078 #if defined(PLATFORM_ANDROID)
2079 if (file->file_is_asset)
2081 if (file->end_of_file)
2084 char *line_ptr = line;
2085 int num_bytes_read = 0;
2087 while (num_bytes_read < size - 1 &&
2088 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2089 *line_ptr++ != '\n')
2094 if (strlen(line) == 0)
2096 file->end_of_file = TRUE;
2105 return fgets(line, size, file->file);
2109 /* ------------------------------------------------------------------------- */
2110 /* functions for directory handling */
2111 /* ------------------------------------------------------------------------- */
2113 Directory *openDirectory(char *dir_name)
2115 Directory *dir = checked_calloc(sizeof(Directory));
2117 dir->dir = opendir(dir_name);
2119 if (dir->dir != NULL)
2121 dir->filename = getStringCopy(dir_name);
2126 #if defined(PLATFORM_ANDROID)
2127 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2129 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2131 checked_free(asset_toc_filename);
2133 if (dir->asset_toc_file != NULL)
2135 dir->directory_is_asset = TRUE;
2136 dir->filename = getStringCopy(dir_name);
2147 int closeDirectory(Directory *dir)
2154 #if defined(PLATFORM_ANDROID)
2155 if (dir->asset_toc_file)
2156 result = SDL_RWclose(dir->asset_toc_file);
2160 result = closedir(dir->dir);
2163 freeDirectoryEntry(dir->dir_entry);
2165 checked_free(dir->filename);
2171 DirectoryEntry *readDirectory(Directory *dir)
2174 freeDirectoryEntry(dir->dir_entry);
2176 dir->dir_entry = NULL;
2178 #if defined(PLATFORM_ANDROID)
2179 if (dir->directory_is_asset)
2181 char line[MAX_LINE_LEN];
2182 char *line_ptr = line;
2183 int num_bytes_read = 0;
2185 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2186 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2195 if (strlen(line) == 0)
2198 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2200 dir->dir_entry->is_directory = FALSE;
2201 if (line[strlen(line) - 1] == '/')
2203 dir->dir_entry->is_directory = TRUE;
2205 line[strlen(line) - 1] = '\0';
2208 dir->dir_entry->basename = getStringCopy(line);
2209 dir->dir_entry->filename = getPath2(dir->filename, line);
2211 return dir->dir_entry;
2215 struct dirent *dir_entry = readdir(dir->dir);
2217 if (dir_entry == NULL)
2220 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2222 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2223 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2225 struct stat file_status;
2227 dir->dir_entry->is_directory =
2228 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2229 (file_status.st_mode & S_IFMT) == S_IFDIR);
2231 return dir->dir_entry;
2234 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2236 if (dir_entry == NULL)
2239 checked_free(dir_entry->basename);
2240 checked_free(dir_entry->filename);
2241 checked_free(dir_entry);
2245 /* ------------------------------------------------------------------------- */
2246 /* functions for checking files and filenames */
2247 /* ------------------------------------------------------------------------- */
2249 boolean directoryExists(char *dir_name)
2251 if (dir_name == NULL)
2254 struct stat file_status;
2255 boolean success = (stat(dir_name, &file_status) == 0 &&
2256 (file_status.st_mode & S_IFMT) == S_IFDIR);
2258 #if defined(PLATFORM_ANDROID)
2261 // this might be an asset directory; check by trying to open toc file
2262 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2263 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2265 checked_free(asset_toc_filename);
2267 success = (file != NULL);
2277 boolean fileExists(char *filename)
2279 if (filename == NULL)
2282 boolean success = (access(filename, F_OK) == 0);
2284 #if defined(PLATFORM_ANDROID)
2287 // this might be an asset file; check by trying to open it
2288 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2290 success = (file != NULL);
2300 boolean fileHasPrefix(char *basename, char *prefix)
2302 static char *basename_lower = NULL;
2303 int basename_length, prefix_length;
2305 checked_free(basename_lower);
2307 if (basename == NULL || prefix == NULL)
2310 basename_lower = getStringToLower(basename);
2311 basename_length = strlen(basename_lower);
2312 prefix_length = strlen(prefix);
2314 if (basename_length > prefix_length + 1 &&
2315 basename_lower[prefix_length] == '.' &&
2316 strncmp(basename_lower, prefix, prefix_length) == 0)
2322 boolean fileHasSuffix(char *basename, char *suffix)
2324 static char *basename_lower = NULL;
2325 int basename_length, suffix_length;
2327 checked_free(basename_lower);
2329 if (basename == NULL || suffix == NULL)
2332 basename_lower = getStringToLower(basename);
2333 basename_length = strlen(basename_lower);
2334 suffix_length = strlen(suffix);
2336 if (basename_length > suffix_length + 1 &&
2337 basename_lower[basename_length - suffix_length - 1] == '.' &&
2338 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2344 static boolean FileCouldBeArtwork(char *filename)
2346 char *basename = getBaseNamePtr(filename);
2348 return (!strEqual(basename, ".") &&
2349 !strEqual(basename, "..") &&
2350 !fileHasSuffix(basename, "txt") &&
2351 !fileHasSuffix(basename, "conf") &&
2352 !directoryExists(filename));
2355 boolean FileIsGraphic(char *filename)
2357 return FileCouldBeArtwork(filename);
2360 boolean FileIsSound(char *filename)
2362 return FileCouldBeArtwork(filename);
2365 boolean FileIsMusic(char *filename)
2367 return FileCouldBeArtwork(filename);
2370 boolean FileIsArtworkType(char *filename, int type)
2372 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2373 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2374 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2380 /* ------------------------------------------------------------------------- */
2381 /* functions for loading artwork configuration information */
2382 /* ------------------------------------------------------------------------- */
2384 char *get_mapped_token(char *token)
2386 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2387 static char *map_token_prefix[][2] =
2389 { "char_procent", "char_percent" },
2394 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2396 int len_token_prefix = strlen(map_token_prefix[i][0]);
2398 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2399 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2405 /* This function checks if a string <s> of the format "string1, string2, ..."
2406 exactly contains a string <s_contained>. */
2408 static boolean string_has_parameter(char *s, char *s_contained)
2412 if (s == NULL || s_contained == NULL)
2415 if (strlen(s_contained) > strlen(s))
2418 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2420 char next_char = s[strlen(s_contained)];
2422 /* check if next character is delimiter or whitespace */
2423 return (next_char == ',' || next_char == '\0' ||
2424 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2427 /* check if string contains another parameter string after a comma */
2428 substring = strchr(s, ',');
2429 if (substring == NULL) /* string does not contain a comma */
2432 /* advance string pointer to next character after the comma */
2435 /* skip potential whitespaces after the comma */
2436 while (*substring == ' ' || *substring == '\t')
2439 return string_has_parameter(substring, s_contained);
2442 int get_parameter_value(char *value_raw, char *suffix, int type)
2444 char *value = getStringToLower(value_raw);
2445 int result = 0; /* probably a save default value */
2447 if (strEqual(suffix, ".direction"))
2449 result = (strEqual(value, "left") ? MV_LEFT :
2450 strEqual(value, "right") ? MV_RIGHT :
2451 strEqual(value, "up") ? MV_UP :
2452 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2454 else if (strEqual(suffix, ".align"))
2456 result = (strEqual(value, "left") ? ALIGN_LEFT :
2457 strEqual(value, "right") ? ALIGN_RIGHT :
2458 strEqual(value, "center") ? ALIGN_CENTER :
2459 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2461 else if (strEqual(suffix, ".valign"))
2463 result = (strEqual(value, "top") ? VALIGN_TOP :
2464 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2465 strEqual(value, "middle") ? VALIGN_MIDDLE :
2466 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2468 else if (strEqual(suffix, ".anim_mode"))
2470 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2471 string_has_parameter(value, "loop") ? ANIM_LOOP :
2472 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2473 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2474 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2475 string_has_parameter(value, "random") ? ANIM_RANDOM :
2476 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2477 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2478 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2479 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2480 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2481 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2484 if (string_has_parameter(value, "reverse"))
2485 result |= ANIM_REVERSE;
2487 if (string_has_parameter(value, "opaque_player"))
2488 result |= ANIM_OPAQUE_PLAYER;
2490 if (string_has_parameter(value, "static_panel"))
2491 result |= ANIM_STATIC_PANEL;
2493 else if (strEqual(suffix, ".class"))
2495 result = get_hash_from_key(value);
2497 else if (strEqual(suffix, ".style"))
2499 result = STYLE_DEFAULT;
2501 if (string_has_parameter(value, "accurate_borders"))
2502 result |= STYLE_ACCURATE_BORDERS;
2504 if (string_has_parameter(value, "inner_corners"))
2505 result |= STYLE_INNER_CORNERS;
2507 else if (strEqual(suffix, ".fade_mode"))
2509 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2510 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2511 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2512 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2515 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2517 result = gfx.get_font_from_token_function(value);
2519 else /* generic parameter of type integer or boolean */
2521 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2522 type == TYPE_INTEGER ? get_integer_from_string(value) :
2523 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2524 ARG_UNDEFINED_VALUE);
2532 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2534 static struct ScreenModeInfo screen_mode;
2535 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2536 char *screen_mode_string_copy;
2537 char *screen_mode_string_pos_w;
2538 char *screen_mode_string_pos_h;
2540 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2543 screen_mode_string_copy = getStringCopy(screen_mode_string);
2545 screen_mode_string_pos_w = screen_mode_string_copy;
2546 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2547 *screen_mode_string_pos_h++ = '\0';
2549 screen_mode.width = atoi(screen_mode_string_pos_w);
2550 screen_mode.height = atoi(screen_mode_string_pos_h);
2552 return &screen_mode;
2555 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2558 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2559 float aspect_ratio_new;
2564 *x = i * aspect_ratio + 0.000001;
2567 aspect_ratio_new = (float)*x / (float)*y;
2571 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2574 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2575 struct ListNodeInfo ***, int *);
2577 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2578 struct ConfigTypeInfo *suffix_list,
2579 char **ignore_tokens,
2580 int num_file_list_entries)
2582 struct FileInfo *file_list;
2583 int num_file_list_entries_found = 0;
2584 int num_suffix_list_entries = 0;
2588 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2590 for (i = 0; suffix_list[i].token != NULL; i++)
2591 num_suffix_list_entries++;
2593 /* always start with reliable default values */
2594 for (i = 0; i < num_file_list_entries; i++)
2596 file_list[i].token = NULL;
2598 file_list[i].default_filename = NULL;
2599 file_list[i].filename = NULL;
2601 if (num_suffix_list_entries > 0)
2603 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2605 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2606 file_list[i].parameter = checked_calloc(parameter_array_size);
2608 for (j = 0; j < num_suffix_list_entries; j++)
2610 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2611 setString(&file_list[i].parameter[j], suffix_list[j].value);
2614 file_list[i].redefined = FALSE;
2615 file_list[i].fallback_to_default = FALSE;
2616 file_list[i].default_is_cloned = FALSE;
2622 for (i = 0; config_list[i].token != NULL; i++)
2624 int len_config_token = strlen(config_list[i].token);
2625 boolean is_file_entry = TRUE;
2627 for (j = 0; suffix_list[j].token != NULL; j++)
2629 int len_suffix = strlen(suffix_list[j].token);
2631 if (len_suffix < len_config_token &&
2632 strEqual(&config_list[i].token[len_config_token - len_suffix],
2633 suffix_list[j].token))
2635 setString(&file_list[list_pos].default_parameter[j],
2636 config_list[i].value);
2638 is_file_entry = FALSE;
2644 /* the following tokens are no file definitions, but other config tokens */
2645 for (j = 0; ignore_tokens[j] != NULL; j++)
2646 if (strEqual(config_list[i].token, ignore_tokens[j]))
2647 is_file_entry = FALSE;
2654 if (list_pos >= num_file_list_entries)
2657 file_list[list_pos].token = config_list[i].token;
2658 file_list[list_pos].default_filename = config_list[i].value;
2661 if (strSuffix(config_list[i].token, ".clone_from"))
2662 file_list[list_pos].default_is_cloned = TRUE;
2665 num_file_list_entries_found = list_pos + 1;
2666 if (num_file_list_entries_found != num_file_list_entries)
2668 Error(ERR_INFO_LINE, "-");
2669 Error(ERR_INFO, "inconsistant config list information:");
2670 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2671 num_file_list_entries);
2672 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2673 num_file_list_entries_found);
2674 Error(ERR_EXIT, "please fix");
2680 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2682 int len_token = strlen(token);
2683 int len_suffix = strlen(suffix);
2685 if (start_pos < 0) /* compare suffix from end of string */
2686 start_pos += len_token;
2688 if (start_pos < 0 || start_pos + len_suffix > len_token)
2691 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2694 if (token[start_pos + len_suffix] == '\0')
2697 if (token[start_pos + len_suffix] == '.')
2703 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2705 static void read_token_parameters(SetupFileHash *setup_file_hash,
2706 struct ConfigTypeInfo *suffix_list,
2707 struct FileInfo *file_list_entry)
2709 /* check for config token that is the base token without any suffixes */
2710 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2711 char *known_token_value = KNOWN_TOKEN_VALUE;
2714 if (filename != NULL)
2716 setString(&file_list_entry->filename, filename);
2718 /* when file definition found, set all parameters to default values */
2719 for (i = 0; suffix_list[i].token != NULL; i++)
2720 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2722 file_list_entry->redefined = TRUE;
2724 /* mark config file token as well known from default config */
2725 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2728 /* check for config tokens that can be build by base token and suffixes */
2729 for (i = 0; suffix_list[i].token != NULL; i++)
2731 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2732 char *value = getHashEntry(setup_file_hash, token);
2736 setString(&file_list_entry->parameter[i], value);
2738 /* mark config file token as well known from default config */
2739 setHashEntry(setup_file_hash, token, known_token_value);
2746 static void add_dynamic_file_list_entry(struct FileInfo **list,
2747 int *num_list_entries,
2748 SetupFileHash *extra_file_hash,
2749 struct ConfigTypeInfo *suffix_list,
2750 int num_suffix_list_entries,
2753 struct FileInfo *new_list_entry;
2754 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2756 (*num_list_entries)++;
2757 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2758 new_list_entry = &(*list)[*num_list_entries - 1];
2760 new_list_entry->token = getStringCopy(token);
2761 new_list_entry->default_filename = NULL;
2762 new_list_entry->filename = NULL;
2763 new_list_entry->parameter = checked_calloc(parameter_array_size);
2765 new_list_entry->redefined = FALSE;
2766 new_list_entry->fallback_to_default = FALSE;
2767 new_list_entry->default_is_cloned = FALSE;
2769 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2772 static void add_property_mapping(struct PropertyMapping **list,
2773 int *num_list_entries,
2774 int base_index, int ext1_index,
2775 int ext2_index, int ext3_index,
2778 struct PropertyMapping *new_list_entry;
2780 (*num_list_entries)++;
2781 *list = checked_realloc(*list,
2782 *num_list_entries * sizeof(struct PropertyMapping));
2783 new_list_entry = &(*list)[*num_list_entries - 1];
2785 new_list_entry->base_index = base_index;
2786 new_list_entry->ext1_index = ext1_index;
2787 new_list_entry->ext2_index = ext2_index;
2788 new_list_entry->ext3_index = ext3_index;
2790 new_list_entry->artwork_index = artwork_index;
2793 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2796 struct FileInfo *file_list = artwork_info->file_list;
2797 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2798 char **base_prefixes = artwork_info->base_prefixes;
2799 char **ext1_suffixes = artwork_info->ext1_suffixes;
2800 char **ext2_suffixes = artwork_info->ext2_suffixes;
2801 char **ext3_suffixes = artwork_info->ext3_suffixes;
2802 char **ignore_tokens = artwork_info->ignore_tokens;
2803 int num_file_list_entries = artwork_info->num_file_list_entries;
2804 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2805 int num_base_prefixes = artwork_info->num_base_prefixes;
2806 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2807 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2808 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2809 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2810 SetupFileHash *setup_file_hash, *valid_file_hash;
2811 SetupFileHash *extra_file_hash, *empty_file_hash;
2812 char *known_token_value = KNOWN_TOKEN_VALUE;
2815 if (filename == NULL)
2818 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2821 /* separate valid (defined) from empty (undefined) config token values */
2822 valid_file_hash = newSetupFileHash();
2823 empty_file_hash = newSetupFileHash();
2824 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2826 char *value = HASH_ITERATION_VALUE(itr);
2828 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2829 HASH_ITERATION_TOKEN(itr), value);
2831 END_HASH_ITERATION(setup_file_hash, itr)
2833 /* at this point, we do not need the setup file hash anymore -- free it */
2834 freeSetupFileHash(setup_file_hash);
2836 /* map deprecated to current tokens (using prefix match and replace) */
2837 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2839 char *token = HASH_ITERATION_TOKEN(itr);
2840 char *mapped_token = get_mapped_token(token);
2842 if (mapped_token != NULL)
2844 char *value = HASH_ITERATION_VALUE(itr);
2846 /* add mapped token */
2847 setHashEntry(valid_file_hash, mapped_token, value);
2849 /* ignore old token (by setting it to "known" keyword) */
2850 setHashEntry(valid_file_hash, token, known_token_value);
2855 END_HASH_ITERATION(valid_file_hash, itr)
2857 /* read parameters for all known config file tokens */
2858 for (i = 0; i < num_file_list_entries; i++)
2859 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2861 /* set all tokens that can be ignored here to "known" keyword */
2862 for (i = 0; i < num_ignore_tokens; i++)
2863 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2865 /* copy all unknown config file tokens to extra config hash */
2866 extra_file_hash = newSetupFileHash();
2867 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2869 char *value = HASH_ITERATION_VALUE(itr);
2871 if (!strEqual(value, known_token_value))
2872 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2874 END_HASH_ITERATION(valid_file_hash, itr)
2876 /* at this point, we do not need the valid file hash anymore -- free it */
2877 freeSetupFileHash(valid_file_hash);
2879 /* now try to determine valid, dynamically defined config tokens */
2881 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2883 struct FileInfo **dynamic_file_list =
2884 &artwork_info->dynamic_file_list;
2885 int *num_dynamic_file_list_entries =
2886 &artwork_info->num_dynamic_file_list_entries;
2887 struct PropertyMapping **property_mapping =
2888 &artwork_info->property_mapping;
2889 int *num_property_mapping_entries =
2890 &artwork_info->num_property_mapping_entries;
2891 int current_summarized_file_list_entry =
2892 artwork_info->num_file_list_entries +
2893 artwork_info->num_dynamic_file_list_entries;
2894 char *token = HASH_ITERATION_TOKEN(itr);
2895 int len_token = strlen(token);
2897 boolean base_prefix_found = FALSE;
2898 boolean parameter_suffix_found = FALSE;
2900 /* skip all parameter definitions (handled by read_token_parameters()) */
2901 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2903 int len_suffix = strlen(suffix_list[i].token);
2905 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2906 parameter_suffix_found = TRUE;
2909 if (parameter_suffix_found)
2912 /* ---------- step 0: search for matching base prefix ---------- */
2915 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2917 char *base_prefix = base_prefixes[i];
2918 int len_base_prefix = strlen(base_prefix);
2919 boolean ext1_suffix_found = FALSE;
2920 boolean ext2_suffix_found = FALSE;
2921 boolean ext3_suffix_found = FALSE;
2922 boolean exact_match = FALSE;
2923 int base_index = -1;
2924 int ext1_index = -1;
2925 int ext2_index = -1;
2926 int ext3_index = -1;
2928 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2930 if (!base_prefix_found)
2935 if (start_pos + len_base_prefix == len_token) /* exact match */
2939 add_dynamic_file_list_entry(dynamic_file_list,
2940 num_dynamic_file_list_entries,
2943 num_suffix_list_entries,
2945 add_property_mapping(property_mapping,
2946 num_property_mapping_entries,
2947 base_index, -1, -1, -1,
2948 current_summarized_file_list_entry);
2952 /* ---------- step 1: search for matching first suffix ---------- */
2954 start_pos += len_base_prefix;
2955 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2957 char *ext1_suffix = ext1_suffixes[j];
2958 int len_ext1_suffix = strlen(ext1_suffix);
2960 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2962 if (!ext1_suffix_found)
2967 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2971 add_dynamic_file_list_entry(dynamic_file_list,
2972 num_dynamic_file_list_entries,
2975 num_suffix_list_entries,
2977 add_property_mapping(property_mapping,
2978 num_property_mapping_entries,
2979 base_index, ext1_index, -1, -1,
2980 current_summarized_file_list_entry);
2984 start_pos += len_ext1_suffix;
2990 /* ---------- step 2: search for matching second suffix ---------- */
2992 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2994 char *ext2_suffix = ext2_suffixes[k];
2995 int len_ext2_suffix = strlen(ext2_suffix);
2997 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2999 if (!ext2_suffix_found)
3004 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3008 add_dynamic_file_list_entry(dynamic_file_list,
3009 num_dynamic_file_list_entries,
3012 num_suffix_list_entries,
3014 add_property_mapping(property_mapping,
3015 num_property_mapping_entries,
3016 base_index, ext1_index, ext2_index, -1,
3017 current_summarized_file_list_entry);
3021 start_pos += len_ext2_suffix;
3027 /* ---------- step 3: search for matching third suffix ---------- */
3029 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3031 char *ext3_suffix = ext3_suffixes[l];
3032 int len_ext3_suffix = strlen(ext3_suffix);
3034 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3036 if (!ext3_suffix_found)
3041 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3045 add_dynamic_file_list_entry(dynamic_file_list,
3046 num_dynamic_file_list_entries,
3049 num_suffix_list_entries,
3051 add_property_mapping(property_mapping,
3052 num_property_mapping_entries,
3053 base_index, ext1_index, ext2_index, ext3_index,
3054 current_summarized_file_list_entry);
3060 END_HASH_ITERATION(extra_file_hash, itr)
3062 if (artwork_info->num_dynamic_file_list_entries > 0)
3064 artwork_info->dynamic_artwork_list =
3065 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3066 artwork_info->sizeof_artwork_list_entry);
3069 if (options.verbose && IS_PARENT_PROCESS())
3071 SetupFileList *setup_file_list, *list;
3072 boolean dynamic_tokens_found = FALSE;
3073 boolean unknown_tokens_found = FALSE;
3074 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3076 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3077 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3079 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3081 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3082 dynamic_tokens_found = TRUE;
3084 unknown_tokens_found = TRUE;
3086 END_HASH_ITERATION(extra_file_hash, itr)
3088 if (options.debug && dynamic_tokens_found)
3090 Error(ERR_INFO_LINE, "-");
3091 Error(ERR_INFO, "dynamic token(s) found in config file:");
3092 Error(ERR_INFO, "- config file: '%s'", filename);
3094 for (list = setup_file_list; list != NULL; list = list->next)
3096 char *value = getHashEntry(extra_file_hash, list->token);
3098 if (value != NULL && strEqual(value, known_token_value))
3099 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3102 Error(ERR_INFO_LINE, "-");
3105 if (unknown_tokens_found)
3107 Error(ERR_INFO_LINE, "-");
3108 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3109 Error(ERR_INFO, "- config file: '%s'", filename);
3111 for (list = setup_file_list; list != NULL; list = list->next)
3113 char *value = getHashEntry(extra_file_hash, list->token);
3115 if (value != NULL && !strEqual(value, known_token_value))
3116 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3119 Error(ERR_INFO_LINE, "-");
3122 if (undefined_values_found)
3124 Error(ERR_INFO_LINE, "-");
3125 Error(ERR_INFO, "warning: undefined values found in config file:");
3126 Error(ERR_INFO, "- config file: '%s'", filename);
3128 for (list = setup_file_list; list != NULL; list = list->next)
3130 char *value = getHashEntry(empty_file_hash, list->token);
3133 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3136 Error(ERR_INFO_LINE, "-");
3139 freeSetupFileList(setup_file_list);
3142 freeSetupFileHash(extra_file_hash);
3143 freeSetupFileHash(empty_file_hash);
3146 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3148 struct FileInfo *file_list = artwork_info->file_list;
3149 int num_file_list_entries = artwork_info->num_file_list_entries;
3150 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3151 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3154 DrawInitText("Loading artwork config", 120, FC_GREEN);
3155 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3157 /* always start with reliable default values */
3158 for (i = 0; i < num_file_list_entries; i++)
3160 setString(&file_list[i].filename, file_list[i].default_filename);
3162 for (j = 0; j < num_suffix_list_entries; j++)
3163 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3165 file_list[i].redefined = FALSE;
3166 file_list[i].fallback_to_default = FALSE;
3169 /* free previous dynamic artwork file array */
3170 if (artwork_info->dynamic_file_list != NULL)
3172 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3174 free(artwork_info->dynamic_file_list[i].token);
3175 free(artwork_info->dynamic_file_list[i].filename);
3176 free(artwork_info->dynamic_file_list[i].parameter);
3179 free(artwork_info->dynamic_file_list);
3180 artwork_info->dynamic_file_list = NULL;
3182 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3183 &artwork_info->num_dynamic_file_list_entries);
3186 /* free previous property mapping */
3187 if (artwork_info->property_mapping != NULL)
3189 free(artwork_info->property_mapping);
3191 artwork_info->property_mapping = NULL;
3192 artwork_info->num_property_mapping_entries = 0;
3195 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3197 /* first look for special artwork configured in level series config */
3198 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3200 if (fileExists(filename_base))
3201 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3204 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3206 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3207 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3210 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3211 struct ListNodeInfo **listnode)
3215 char *filename = (*listnode)->source_filename;
3217 if (--(*listnode)->num_references <= 0)
3218 deleteNodeFromList(&artwork_info->content_list, filename,
3219 artwork_info->free_artwork);
3225 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3226 struct ListNodeInfo **listnode,
3227 struct FileInfo *file_list_entry)
3237 char *basename = file_list_entry->filename;
3238 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3240 if (filename == NULL)
3242 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3244 basename = file_list_entry->default_filename;
3246 /* fail for cloned default artwork that has no default filename defined */
3247 if (file_list_entry->default_is_cloned &&
3248 strEqual(basename, UNDEFINED_FILENAME))
3250 int error_mode = ERR_WARN;
3252 /* we can get away without sounds and music, but not without graphics */
3253 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3254 error_mode = ERR_EXIT;
3256 Error(error_mode, "token '%s' was cloned and has no default filename",
3257 file_list_entry->token);
3262 /* dynamic artwork has no default filename / skip empty default artwork */
3263 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3266 file_list_entry->fallback_to_default = TRUE;
3268 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3270 filename = getCustomArtworkFilename(basename, artwork_info->type);
3272 if (filename == NULL)
3274 int error_mode = ERR_WARN;
3276 /* we can get away without sounds and music, but not without graphics */
3277 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3278 error_mode = ERR_EXIT;
3280 Error(error_mode, "cannot find default artwork file '%s'", basename);
3286 /* check if the old and the new artwork file are the same */
3287 if (*listnode && strEqual((*listnode)->source_filename, filename))
3289 /* The old and new artwork are the same (have the same filename and path).
3290 This usually means that this artwork does not exist in this artwork set
3291 and a fallback to the existing artwork is done. */
3296 /* delete existing artwork file entry */
3297 deleteArtworkListEntry(artwork_info, listnode);
3299 /* check if the new artwork file already exists in the list of artwork */
3300 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3302 *listnode = (struct ListNodeInfo *)node->content;
3303 (*listnode)->num_references++;
3308 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3309 DrawInitText(basename, 150, FC_YELLOW);
3311 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3313 /* add new artwork file entry to the list of artwork files */
3314 (*listnode)->num_references = 1;
3315 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3320 int error_mode = ERR_WARN;
3322 /* we can get away without sounds and music, but not without graphics */
3323 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3324 error_mode = ERR_EXIT;
3326 Error(error_mode, "cannot load artwork file '%s'", basename);
3332 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3333 struct ListNodeInfo **listnode,
3334 struct FileInfo *file_list_entry)
3336 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3338 deleteArtworkListEntry(artwork_info, listnode);
3343 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3346 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3348 struct FileInfo *file_list = artwork_info->file_list;
3349 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3350 int num_file_list_entries = artwork_info->num_file_list_entries;
3351 int num_dynamic_file_list_entries =
3352 artwork_info->num_dynamic_file_list_entries;
3355 print_timestamp_init("ReloadCustomArtworkList");
3357 for (i = 0; i < num_file_list_entries; i++)
3358 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3361 for (i = 0; i < num_dynamic_file_list_entries; i++)
3362 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3363 &dynamic_file_list[i]);
3365 print_timestamp_done("ReloadCustomArtworkList");
3368 dumpList(artwork_info->content_list);
3372 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3373 struct ListNodeInfo ***list,
3374 int *num_list_entries)
3381 for (i = 0; i < *num_list_entries; i++)
3382 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3386 *num_list_entries = 0;
3389 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3391 if (artwork_info == NULL)
3394 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3395 &artwork_info->num_file_list_entries);
3397 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3398 &artwork_info->num_dynamic_file_list_entries);
3402 /* ------------------------------------------------------------------------- */
3403 /* functions only needed for non-Unix (non-command-line) systems */
3404 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3405 /* (now also added for Windows, to create files in user data directory) */
3406 /* ------------------------------------------------------------------------- */
3408 char *getErrorFilename(char *basename)
3410 return getPath2(getUserGameDataDir(), basename);
3413 void openErrorFile()
3415 InitUserDataDirectory();
3417 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3419 program.error_file = stderr;
3421 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3422 program.error_filename, strerror(errno));
3425 /* error output should be unbuffered so it is not truncated in a crash */
3426 setbuf(program.error_file, NULL);
3429 void closeErrorFile()
3431 if (program.error_file != stderr) /* do not close stream 'stderr' */
3432 fclose(program.error_file);
3435 void dumpErrorFile()
3437 FILE *error_file = fopen(program.error_filename, MODE_READ);
3439 if (error_file != NULL)
3441 while (!feof(error_file))
3442 fputc(fgetc(error_file), stderr);
3448 void NotifyUserAboutErrorFile()
3450 #if defined(PLATFORM_WIN32)
3451 char *title_text = getStringCat2(program.program_title, " Error Message");
3452 char *error_text = getStringCat2("The program was aborted due to an error; "
3453 "for details, see the following error file:"
3454 STRING_NEWLINE, program.error_filename);
3456 MessageBox(NULL, error_text, title_text, MB_OK);
3461 /* ------------------------------------------------------------------------- */
3462 /* the following is only for debugging purpose and normally not used */
3463 /* ------------------------------------------------------------------------- */
3467 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3468 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3470 #define DEBUG_NUM_TIMESTAMPS 10
3471 #define DEBUG_TIME_IN_MICROSECONDS 0
3473 #if DEBUG_TIME_IN_MICROSECONDS
3474 static double Counter_Microseconds()
3476 static struct timeval base_time = { 0, 0 };
3477 struct timeval current_time;
3480 gettimeofday(¤t_time, NULL);
3482 /* reset base time in case of wrap-around */
3483 if (current_time.tv_sec < base_time.tv_sec)
3484 base_time = current_time;
3487 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3488 ((double)(current_time.tv_usec - base_time.tv_usec));
3490 return counter; /* return microseconds since last init */
3494 char *debug_print_timestamp_get_padding(int padding_size)
3496 static char *padding = NULL;
3497 int max_padding_size = 100;
3499 if (padding == NULL)
3501 padding = checked_calloc(max_padding_size + 1);
3502 memset(padding, ' ', max_padding_size);
3505 return &padding[MAX(0, max_padding_size - padding_size)];
3508 void debug_print_timestamp(int counter_nr, char *message)
3510 int indent_size = 8;
3511 int padding_size = 40;
3512 float timestamp_interval;
3515 Error(ERR_EXIT, "debugging: invalid negative counter");
3516 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3517 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3519 #if DEBUG_TIME_IN_MICROSECONDS
3520 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3523 counter[counter_nr][0] = Counter_Microseconds();
3525 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3528 counter[counter_nr][0] = Counter();
3531 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3532 counter[counter_nr][1] = counter[counter_nr][0];
3535 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3536 debug_print_timestamp_get_padding(counter_nr * indent_size),
3538 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3539 timestamp_interval / 1000,
3543 void debug_print_parent_only(char *format, ...)
3545 if (!IS_PARENT_PROCESS())
3552 va_start(ap, format);
3553 vprintf(format, ap);
3562 void print_timestamp_ext(char *message, char *mode)
3564 #if DEBUG_PRINT_INIT_TIMESTAMPS
3565 static char *debug_message = NULL;
3566 static char *last_message = NULL;
3567 static int counter_nr = 0;
3568 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3570 checked_free(debug_message);
3571 debug_message = getStringCat3(mode, " ", message);
3573 if (strEqual(mode, "INIT"))
3575 debug_print_timestamp(counter_nr, NULL);
3577 if (counter_nr + 1 < max_depth)
3578 debug_print_timestamp(counter_nr, debug_message);
3582 debug_print_timestamp(counter_nr, NULL);
3584 else if (strEqual(mode, "DONE"))
3588 if (counter_nr + 1 < max_depth ||
3589 (counter_nr == 0 && max_depth == 1))
3591 last_message = message;
3593 if (counter_nr == 0 && max_depth == 1)
3595 checked_free(debug_message);
3596 debug_message = getStringCat3("TIME", " ", message);
3599 debug_print_timestamp(counter_nr, debug_message);
3602 else if (!strEqual(mode, "TIME") ||
3603 !strEqual(message, last_message))
3605 if (counter_nr < max_depth)
3606 debug_print_timestamp(counter_nr, debug_message);
3611 void print_timestamp_init(char *message)
3613 print_timestamp_ext(message, "INIT");
3616 void print_timestamp_time(char *message)
3618 print_timestamp_ext(message, "TIME");
3621 void print_timestamp_done(char *message)
3623 print_timestamp_ext(message, "DONE");