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 *getStringCopy(const char *s)
616 s_copy = checked_malloc(strlen(s) + 1);
622 char *getStringCopyN(const char *s, int n)
625 int s_len = MAX(0, n);
630 s_copy = checked_malloc(s_len + 1);
631 strncpy(s_copy, s, s_len);
632 s_copy[s_len] = '\0';
637 char *getStringCopyNStatic(const char *s, int n)
639 static char *s_copy = NULL;
641 checked_free(s_copy);
643 s_copy = getStringCopyN(s, n);
648 char *getStringToLower(const char *s)
650 char *s_copy = checked_malloc(strlen(s) + 1);
651 char *s_ptr = s_copy;
654 *s_ptr++ = tolower(*s++);
660 void setString(char **old_value, char *new_value)
662 checked_free(*old_value);
664 *old_value = getStringCopy(new_value);
667 boolean strEqual(char *s1, char *s2)
669 return (s1 == NULL && s2 == NULL ? TRUE :
670 s1 == NULL && s2 != NULL ? FALSE :
671 s1 != NULL && s2 == NULL ? FALSE :
672 strcmp(s1, s2) == 0);
675 boolean strEqualN(char *s1, char *s2, int n)
677 return (s1 == NULL && s2 == NULL ? TRUE :
678 s1 == NULL && s2 != NULL ? FALSE :
679 s1 != NULL && s2 == NULL ? FALSE :
680 strncmp(s1, s2, n) == 0);
683 boolean strPrefix(char *s, char *prefix)
685 return (s == NULL && prefix == NULL ? TRUE :
686 s == NULL && prefix != NULL ? FALSE :
687 s != NULL && prefix == NULL ? FALSE :
688 strncmp(s, prefix, strlen(prefix)) == 0);
691 boolean strSuffix(char *s, char *suffix)
693 return (s == NULL && suffix == NULL ? TRUE :
694 s == NULL && suffix != NULL ? FALSE :
695 s != NULL && suffix == NULL ? FALSE :
696 strlen(s) < strlen(suffix) ? FALSE :
697 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
700 boolean strPrefixLower(char *s, char *prefix)
702 char *s_lower = getStringToLower(s);
703 boolean match = strPrefix(s_lower, prefix);
710 boolean strSuffixLower(char *s, char *suffix)
712 char *s_lower = getStringToLower(s);
713 boolean match = strSuffix(s_lower, suffix);
721 /* ------------------------------------------------------------------------- */
722 /* command line option handling functions */
723 /* ------------------------------------------------------------------------- */
725 void GetOptions(char *argv[],
726 void (*print_usage_function)(void),
727 void (*print_version_function)(void))
729 char *ro_base_path = RO_BASE_PATH;
730 char *rw_base_path = RW_BASE_PATH;
731 char **options_left = &argv[1];
733 /* if the program is configured to start from current directory (default),
734 determine program package directory from program binary (some versions
735 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
736 set the current working directory to the program package directory) */
738 if (strEqual(ro_base_path, "."))
739 ro_base_path = getProgramMainDataPath();
740 if (strEqual(rw_base_path, "."))
741 rw_base_path = getProgramMainDataPath();
743 /* initialize global program options */
744 options.display_name = NULL;
745 options.server_host = NULL;
746 options.server_port = 0;
748 options.ro_base_directory = ro_base_path;
749 options.rw_base_directory = rw_base_path;
750 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
751 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
752 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
753 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
754 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
756 options.execute_command = NULL;
757 options.special_flags = NULL;
759 options.serveronly = FALSE;
760 options.network = FALSE;
761 options.verbose = FALSE;
762 options.debug = FALSE;
763 options.debug_x11_sync = FALSE;
766 options.verbose = TRUE;
768 #if !defined(PLATFORM_UNIX)
769 if (*options_left == NULL) /* no options given -- enable verbose mode */
770 options.verbose = TRUE;
774 while (*options_left)
776 char option_str[MAX_OPTION_LEN];
777 char *option = options_left[0];
778 char *next_option = options_left[1];
779 char *option_arg = NULL;
780 int option_len = strlen(option);
782 if (option_len >= MAX_OPTION_LEN)
783 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
785 strcpy(option_str, option); /* copy argument into buffer */
788 if (strEqual(option, "--")) /* stop scanning arguments */
791 if (strPrefix(option, "--")) /* treat '--' like '-' */
794 option_arg = strchr(option, '=');
795 if (option_arg == NULL) /* no '=' in option */
796 option_arg = next_option;
799 *option_arg++ = '\0'; /* cut argument from option */
800 if (*option_arg == '\0') /* no argument after '=' */
801 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
804 option_len = strlen(option);
806 if (strEqual(option, "-"))
808 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
810 else if (strncmp(option, "-help", option_len) == 0)
812 print_usage_function();
816 else if (strncmp(option, "-display", option_len) == 0)
818 if (option_arg == NULL)
819 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
821 options.display_name = option_arg;
822 if (option_arg == next_option)
825 else if (strncmp(option, "-basepath", option_len) == 0)
827 if (option_arg == NULL)
828 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
830 /* this should be extended to separate options for ro and rw data */
831 options.ro_base_directory = ro_base_path = option_arg;
832 options.rw_base_directory = rw_base_path = option_arg;
833 if (option_arg == next_option)
836 /* adjust paths for sub-directories in base directory accordingly */
837 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
838 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
839 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
840 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
841 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
843 else if (strncmp(option, "-levels", option_len) == 0)
845 if (option_arg == NULL)
846 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
848 options.level_directory = option_arg;
849 if (option_arg == next_option)
852 else if (strncmp(option, "-graphics", option_len) == 0)
854 if (option_arg == NULL)
855 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
857 options.graphics_directory = option_arg;
858 if (option_arg == next_option)
861 else if (strncmp(option, "-sounds", option_len) == 0)
863 if (option_arg == NULL)
864 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
866 options.sounds_directory = option_arg;
867 if (option_arg == next_option)
870 else if (strncmp(option, "-music", option_len) == 0)
872 if (option_arg == NULL)
873 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
875 options.music_directory = option_arg;
876 if (option_arg == next_option)
879 else if (strncmp(option, "-network", option_len) == 0)
881 options.network = TRUE;
883 else if (strncmp(option, "-serveronly", option_len) == 0)
885 options.serveronly = TRUE;
887 else if (strncmp(option, "-debug", option_len) == 0)
889 options.debug = TRUE;
891 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
893 options.debug_x11_sync = TRUE;
895 else if (strncmp(option, "-verbose", option_len) == 0)
897 options.verbose = TRUE;
899 else if (strncmp(option, "-version", option_len) == 0 ||
900 strncmp(option, "-V", option_len) == 0)
902 print_version_function();
906 else if (strPrefix(option, "-D"))
908 options.special_flags = getStringCopy(&option[2]);
910 else if (strncmp(option, "-execute", option_len) == 0)
912 if (option_arg == NULL)
913 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
915 options.execute_command = option_arg;
916 if (option_arg == next_option)
919 /* when doing batch processing, always enable verbose mode (warnings) */
920 options.verbose = TRUE;
922 else if (*option == '-')
924 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
926 else if (options.server_host == NULL)
928 options.server_host = *options_left;
930 else if (options.server_port == 0)
932 options.server_port = atoi(*options_left);
933 if (options.server_port < 1024)
934 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
937 Error(ERR_EXIT_HELP, "too many arguments");
944 /* ------------------------------------------------------------------------- */
945 /* error handling functions */
946 /* ------------------------------------------------------------------------- */
948 #define MAX_INTERNAL_ERROR_SIZE 1024
950 /* used by SetError() and GetError() to store internal error messages */
951 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
953 void SetError(char *format, ...)
957 va_start(ap, format);
958 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
964 return internal_error;
967 void Error(int mode, char *format, ...)
969 static boolean last_line_was_separator = FALSE;
970 char *process_name = "";
972 #if defined(PLATFORM_ANDROID)
973 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
974 mode & ERR_INFO ? ANDROID_LOG_INFO :
975 mode & ERR_WARN ? ANDROID_LOG_WARN :
976 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
977 ANDROID_LOG_UNKNOWN);
980 /* display warnings only when running in verbose mode */
981 if (mode & ERR_WARN && !options.verbose)
984 if (mode == ERR_INFO_LINE)
986 if (!last_line_was_separator)
987 fprintf_line(program.error_file, format, 79);
989 last_line_was_separator = TRUE;
994 last_line_was_separator = FALSE;
996 if (mode & ERR_SOUND_SERVER)
997 process_name = " sound server";
998 else if (mode & ERR_NETWORK_SERVER)
999 process_name = " network server";
1000 else if (mode & ERR_NETWORK_CLIENT)
1001 process_name = " network client **";
1007 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1010 if (mode & ERR_WARN)
1011 fprintf_nonewline(program.error_file, "warning: ");
1013 va_start(ap, format);
1014 vfprintf_newline(program.error_file, format, ap);
1017 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1019 va_start(ap, format);
1020 program.exit_message_function(format, ap);
1025 if (mode & ERR_HELP)
1026 fprintf_newline(program.error_file,
1027 "%s: Try option '--help' for more information.",
1028 program.command_basename);
1030 if (mode & ERR_EXIT)
1031 fprintf_newline(program.error_file, "%s%s: aborting",
1032 program.command_basename, process_name);
1034 if (mode & ERR_EXIT)
1036 if (mode & ERR_FROM_SERVER)
1037 exit(1); /* child process: normal exit */
1039 program.exit_function(1); /* main process: clean up stuff */
1044 /* ------------------------------------------------------------------------- */
1045 /* checked memory allocation and freeing functions */
1046 /* ------------------------------------------------------------------------- */
1048 void *checked_malloc(unsigned int size)
1055 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1060 void *checked_calloc(unsigned int size)
1064 ptr = calloc(1, size);
1067 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1072 void *checked_realloc(void *ptr, unsigned int size)
1074 ptr = realloc(ptr, size);
1077 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1082 void checked_free(void *ptr)
1084 if (ptr != NULL) /* this check should be done by free() anyway */
1088 void clear_mem(void *ptr, unsigned int size)
1090 #if defined(PLATFORM_WIN32)
1091 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1092 char *cptr = (char *)ptr;
1097 memset(ptr, 0, size);
1102 /* ------------------------------------------------------------------------- */
1103 /* various helper functions */
1104 /* ------------------------------------------------------------------------- */
1106 inline void swap_numbers(int *i1, int *i2)
1114 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1126 /* the "put" variants of the following file access functions check for the file
1127 pointer being != NULL and return the number of bytes they have or would have
1128 written; this allows for chunk writing functions to first determine the size
1129 of the (not yet written) chunk, write the correct chunk size and finally
1130 write the chunk itself */
1132 int getFile8BitInteger(File *file)
1134 return getByteFromFile(file);
1137 int putFile8BitInteger(FILE *file, int value)
1145 int getFile16BitInteger(File *file, int byte_order)
1147 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1148 return ((getByteFromFile(file) << 8) |
1149 (getByteFromFile(file) << 0));
1150 else /* BYTE_ORDER_LITTLE_ENDIAN */
1151 return ((getByteFromFile(file) << 0) |
1152 (getByteFromFile(file) << 8));
1155 int putFile16BitInteger(FILE *file, int value, int byte_order)
1159 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1161 fputc((value >> 8) & 0xff, file);
1162 fputc((value >> 0) & 0xff, file);
1164 else /* BYTE_ORDER_LITTLE_ENDIAN */
1166 fputc((value >> 0) & 0xff, file);
1167 fputc((value >> 8) & 0xff, file);
1174 int getFile32BitInteger(File *file, int byte_order)
1176 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1177 return ((getByteFromFile(file) << 24) |
1178 (getByteFromFile(file) << 16) |
1179 (getByteFromFile(file) << 8) |
1180 (getByteFromFile(file) << 0));
1181 else /* BYTE_ORDER_LITTLE_ENDIAN */
1182 return ((getByteFromFile(file) << 0) |
1183 (getByteFromFile(file) << 8) |
1184 (getByteFromFile(file) << 16) |
1185 (getByteFromFile(file) << 24));
1188 int putFile32BitInteger(FILE *file, int value, int byte_order)
1192 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1194 fputc((value >> 24) & 0xff, file);
1195 fputc((value >> 16) & 0xff, file);
1196 fputc((value >> 8) & 0xff, file);
1197 fputc((value >> 0) & 0xff, file);
1199 else /* BYTE_ORDER_LITTLE_ENDIAN */
1201 fputc((value >> 0) & 0xff, file);
1202 fputc((value >> 8) & 0xff, file);
1203 fputc((value >> 16) & 0xff, file);
1204 fputc((value >> 24) & 0xff, file);
1211 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1214 const int chunk_name_length = 4;
1216 /* read chunk name */
1217 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1220 if (chunk_size != NULL)
1222 /* read chunk size */
1223 *chunk_size = getFile32BitInteger(file, byte_order);
1226 return (checkEndOfFile(file) ? FALSE : TRUE);
1229 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1234 /* write chunk name */
1236 fputs(chunk_name, file);
1238 num_bytes += strlen(chunk_name);
1240 if (chunk_size >= 0)
1242 /* write chunk size */
1244 putFile32BitInteger(file, chunk_size, byte_order);
1252 int getFileVersion(File *file)
1254 int version_major = getByteFromFile(file);
1255 int version_minor = getByteFromFile(file);
1256 int version_patch = getByteFromFile(file);
1257 int version_build = getByteFromFile(file);
1259 return VERSION_IDENT(version_major, version_minor, version_patch,
1263 int putFileVersion(FILE *file, int version)
1267 int version_major = VERSION_MAJOR(version);
1268 int version_minor = VERSION_MINOR(version);
1269 int version_patch = VERSION_PATCH(version);
1270 int version_build = VERSION_BUILD(version);
1272 fputc(version_major, file);
1273 fputc(version_minor, file);
1274 fputc(version_patch, file);
1275 fputc(version_build, file);
1281 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1285 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1286 buffer[i] = getByteFromFile(file);
1289 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1293 for(i = 0; i < bytes; i++)
1294 fputc(buffer[i], file);
1297 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1299 while (bytes-- && !checkEndOfFile(file))
1300 getByteFromFile(file);
1303 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1310 /* ------------------------------------------------------------------------- */
1311 /* functions to translate key identifiers between different format */
1312 /* ------------------------------------------------------------------------- */
1314 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1315 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1316 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1317 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1319 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1328 /* normal cursor keys */
1329 { KSYM_Left, "XK_Left", "cursor left" },
1330 { KSYM_Right, "XK_Right", "cursor right" },
1331 { KSYM_Up, "XK_Up", "cursor up" },
1332 { KSYM_Down, "XK_Down", "cursor down" },
1334 /* keypad cursor keys */
1336 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1337 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1338 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1339 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1342 /* other keypad keys */
1343 #ifdef KSYM_KP_Enter
1344 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1345 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1346 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1347 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1348 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1349 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1353 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1354 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1355 { KSYM_Control_L, "XK_Control_L", "left control" },
1356 { KSYM_Control_R, "XK_Control_R", "right control" },
1357 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1358 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1359 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1360 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1361 #if !defined(TARGET_SDL2)
1362 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1363 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1365 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1366 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1368 /* some special keys */
1369 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1370 { KSYM_Delete, "XK_Delete", "delete" },
1371 { KSYM_Insert, "XK_Insert", "insert" },
1372 { KSYM_Tab, "XK_Tab", "tab" },
1373 { KSYM_Home, "XK_Home", "home" },
1374 { KSYM_End, "XK_End", "end" },
1375 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1376 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1378 #if defined(TARGET_SDL2)
1379 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1380 { KSYM_Back, "XK_Back", "back" }, /* back key */
1383 /* ASCII 0x20 to 0x40 keys (except numbers) */
1384 { KSYM_space, "XK_space", "space" },
1385 { KSYM_exclam, "XK_exclam", "!" },
1386 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1387 { KSYM_numbersign, "XK_numbersign", "#" },
1388 { KSYM_dollar, "XK_dollar", "$" },
1389 { KSYM_percent, "XK_percent", "%" },
1390 { KSYM_ampersand, "XK_ampersand", "&" },
1391 { KSYM_apostrophe, "XK_apostrophe", "'" },
1392 { KSYM_parenleft, "XK_parenleft", "(" },
1393 { KSYM_parenright, "XK_parenright", ")" },
1394 { KSYM_asterisk, "XK_asterisk", "*" },
1395 { KSYM_plus, "XK_plus", "+" },
1396 { KSYM_comma, "XK_comma", "," },
1397 { KSYM_minus, "XK_minus", "-" },
1398 { KSYM_period, "XK_period", "." },
1399 { KSYM_slash, "XK_slash", "/" },
1400 { KSYM_colon, "XK_colon", ":" },
1401 { KSYM_semicolon, "XK_semicolon", ";" },
1402 { KSYM_less, "XK_less", "<" },
1403 { KSYM_equal, "XK_equal", "=" },
1404 { KSYM_greater, "XK_greater", ">" },
1405 { KSYM_question, "XK_question", "?" },
1406 { KSYM_at, "XK_at", "@" },
1408 /* more ASCII keys */
1409 { KSYM_bracketleft, "XK_bracketleft", "[" },
1410 { KSYM_backslash, "XK_backslash", "\\" },
1411 { KSYM_bracketright,"XK_bracketright", "]" },
1412 { KSYM_asciicircum, "XK_asciicircum", "^" },
1413 { KSYM_underscore, "XK_underscore", "_" },
1414 { KSYM_grave, "XK_grave", "grave" },
1415 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1416 { KSYM_braceleft, "XK_braceleft", "brace left" },
1417 { KSYM_bar, "XK_bar", "bar" },
1418 { KSYM_braceright, "XK_braceright", "brace right" },
1419 { KSYM_asciitilde, "XK_asciitilde", "~" },
1421 /* special (non-ASCII) keys */
1422 { KSYM_degree, "XK_degree", "degree" },
1423 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1424 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1425 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1426 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1427 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1428 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1429 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1431 #if defined(TARGET_SDL2)
1432 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1433 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1434 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1435 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1436 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1437 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1438 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1439 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1440 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1442 /* other keys (for reverse mapping only) */
1443 { KSYM_space, "XK_space", " " },
1446 #if defined(TARGET_SDL2)
1447 /* keypad keys are not in numerical order in SDL2 */
1448 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1449 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1450 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1451 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1452 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1453 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1454 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1455 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1456 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1457 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1460 /* end-of-array identifier */
1466 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1468 static char name_buffer[30];
1471 if (key >= KSYM_A && key <= KSYM_Z)
1472 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1473 else if (key >= KSYM_a && key <= KSYM_z)
1474 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1475 else if (key >= KSYM_0 && key <= KSYM_9)
1476 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1477 #if !defined(TARGET_SDL2)
1478 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1479 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1481 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1482 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1483 else if (key == KSYM_UNDEFINED)
1484 strcpy(name_buffer, "(undefined)");
1491 if (key == translate_key[i].key)
1493 strcpy(name_buffer, translate_key[i].name);
1497 while (translate_key[++i].name);
1499 if (!translate_key[i].name)
1500 strcpy(name_buffer, "(unknown)");
1503 *name = name_buffer;
1505 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1507 static char name_buffer[30];
1510 if (key >= KSYM_A && key <= KSYM_Z)
1511 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1512 else if (key >= KSYM_a && key <= KSYM_z)
1513 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1514 else if (key >= KSYM_0 && key <= KSYM_9)
1515 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1516 #if !defined(TARGET_SDL2)
1517 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1518 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1520 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1521 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1522 else if (key == KSYM_UNDEFINED)
1523 strcpy(name_buffer, "[undefined]");
1530 if (key == translate_key[i].key)
1532 strcpy(name_buffer, translate_key[i].x11name);
1536 while (translate_key[++i].x11name);
1538 if (!translate_key[i].x11name)
1539 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1542 *x11name = name_buffer;
1544 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1546 Key key = KSYM_UNDEFINED;
1547 char *name_ptr = *name;
1549 if (strlen(*name) == 1)
1551 char c = name_ptr[0];
1553 if (c >= 'A' && c <= 'Z')
1554 key = KSYM_A + (Key)(c - 'A');
1555 else if (c >= 'a' && c <= 'z')
1556 key = KSYM_a + (Key)(c - 'a');
1557 else if (c >= '0' && c <= '9')
1558 key = KSYM_0 + (Key)(c - '0');
1561 if (key == KSYM_UNDEFINED)
1567 if (strEqual(translate_key[i].name, *name))
1569 key = translate_key[i].key;
1573 while (translate_key[++i].x11name);
1576 if (key == KSYM_UNDEFINED)
1577 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1581 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1583 Key key = KSYM_UNDEFINED;
1584 char *name_ptr = *x11name;
1586 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1588 char c = name_ptr[3];
1590 if (c >= 'A' && c <= 'Z')
1591 key = KSYM_A + (Key)(c - 'A');
1592 else if (c >= 'a' && c <= 'z')
1593 key = KSYM_a + (Key)(c - 'a');
1594 else if (c >= '0' && c <= '9')
1595 key = KSYM_0 + (Key)(c - '0');
1597 #if !defined(TARGET_SDL2)
1598 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1600 char c = name_ptr[6];
1602 if (c >= '0' && c <= '9')
1603 key = KSYM_KP_0 + (Key)(c - '0');
1606 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1608 char c1 = name_ptr[4];
1609 char c2 = name_ptr[5];
1612 if ((c1 >= '0' && c1 <= '9') &&
1613 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1614 d = atoi(&name_ptr[4]);
1616 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1617 key = KSYM_F1 + (Key)(d - 1);
1619 else if (strPrefix(name_ptr, "XK_"))
1625 if (strEqual(name_ptr, translate_key[i].x11name))
1627 key = translate_key[i].key;
1631 while (translate_key[++i].x11name);
1633 else if (strPrefix(name_ptr, "0x"))
1635 unsigned int value = 0;
1641 char c = *name_ptr++;
1644 if (c >= '0' && c <= '9')
1646 else if (c >= 'a' && c <= 'f')
1647 d = (int)(c - 'a' + 10);
1648 else if (c >= 'A' && c <= 'F')
1649 d = (int)(c - 'A' + 10);
1657 value = value * 16 + d;
1668 char *getKeyNameFromKey(Key key)
1672 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1676 char *getX11KeyNameFromKey(Key key)
1680 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1684 Key getKeyFromKeyName(char *name)
1688 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1692 Key getKeyFromX11KeyName(char *x11name)
1696 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1700 char getCharFromKey(Key key)
1706 } translate_key_char[] =
1708 /* special (non-ASCII) keys (ISO-8859-1) */
1709 { KSYM_degree, CHAR_BYTE_DEGREE },
1710 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1711 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1712 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1713 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1714 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1715 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1716 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1718 /* end-of-array identifier */
1722 char *keyname = getKeyNameFromKey(key);
1725 if (strlen(keyname) == 1)
1727 else if (strEqual(keyname, "space"))
1735 if (key == translate_key_char[i].key)
1737 c = translate_key_char[i].key_char;
1742 while (translate_key_char[++i].key_char);
1748 char getValidConfigValueChar(char c)
1750 if (c == '#' || /* used to mark comments */
1751 c == '\\') /* used to mark continued lines */
1758 /* ------------------------------------------------------------------------- */
1759 /* functions to translate string identifiers to integer or boolean value */
1760 /* ------------------------------------------------------------------------- */
1762 int get_integer_from_string(char *s)
1764 static char *number_text[][3] =
1766 { "0", "zero", "null", },
1767 { "1", "one", "first" },
1768 { "2", "two", "second" },
1769 { "3", "three", "third" },
1770 { "4", "four", "fourth" },
1771 { "5", "five", "fifth" },
1772 { "6", "six", "sixth" },
1773 { "7", "seven", "seventh" },
1774 { "8", "eight", "eighth" },
1775 { "9", "nine", "ninth" },
1776 { "10", "ten", "tenth" },
1777 { "11", "eleven", "eleventh" },
1778 { "12", "twelve", "twelfth" },
1780 { NULL, NULL, NULL },
1784 char *s_lower = getStringToLower(s);
1787 for (i = 0; number_text[i][0] != NULL; i++)
1788 for (j = 0; j < 3; j++)
1789 if (strEqual(s_lower, number_text[i][j]))
1794 if (strEqual(s_lower, "false") ||
1795 strEqual(s_lower, "no") ||
1796 strEqual(s_lower, "off"))
1798 else if (strEqual(s_lower, "true") ||
1799 strEqual(s_lower, "yes") ||
1800 strEqual(s_lower, "on"))
1811 boolean get_boolean_from_string(char *s)
1813 char *s_lower = getStringToLower(s);
1814 boolean result = FALSE;
1816 if (strEqual(s_lower, "true") ||
1817 strEqual(s_lower, "yes") ||
1818 strEqual(s_lower, "on") ||
1819 get_integer_from_string(s) == 1)
1827 int get_switch3_from_string(char *s)
1829 char *s_lower = getStringToLower(s);
1832 if (strEqual(s_lower, "true") ||
1833 strEqual(s_lower, "yes") ||
1834 strEqual(s_lower, "on") ||
1835 get_integer_from_string(s) == 1)
1837 else if (strEqual(s_lower, "auto"))
1846 /* ------------------------------------------------------------------------- */
1847 /* functions for generic lists */
1848 /* ------------------------------------------------------------------------- */
1850 ListNode *newListNode()
1852 return checked_calloc(sizeof(ListNode));
1855 void addNodeToList(ListNode **node_first, char *key, void *content)
1857 ListNode *node_new = newListNode();
1859 node_new->key = getStringCopy(key);
1860 node_new->content = content;
1861 node_new->next = *node_first;
1862 *node_first = node_new;
1865 void deleteNodeFromList(ListNode **node_first, char *key,
1866 void (*destructor_function)(void *))
1868 if (node_first == NULL || *node_first == NULL)
1871 if (strEqual((*node_first)->key, key))
1873 checked_free((*node_first)->key);
1874 if (destructor_function)
1875 destructor_function((*node_first)->content);
1876 *node_first = (*node_first)->next;
1879 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1882 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1884 if (node_first == NULL)
1887 if (strEqual(node_first->key, key))
1890 return getNodeFromKey(node_first->next, key);
1893 int getNumNodes(ListNode *node_first)
1895 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1898 void dumpList(ListNode *node_first)
1900 ListNode *node = node_first;
1904 printf("['%s' (%d)]\n", node->key,
1905 ((struct ListNodeInfo *)node->content)->num_references);
1909 printf("[%d nodes]\n", getNumNodes(node_first));
1913 /* ------------------------------------------------------------------------- */
1914 /* functions for file handling */
1915 /* ------------------------------------------------------------------------- */
1917 File *openFile(char *filename, char *mode)
1919 File *file = checked_calloc(sizeof(File));
1921 file->file = fopen(filename, mode);
1923 if (file->file != NULL)
1925 file->filename = getStringCopy(filename);
1930 #if defined(PLATFORM_ANDROID)
1931 file->asset_file = SDL_RWFromFile(filename, mode);
1933 if (file->asset_file != NULL)
1935 file->file_is_asset = TRUE;
1936 file->filename = getStringCopy(filename);
1947 int closeFile(File *file)
1954 #if defined(PLATFORM_ANDROID)
1955 if (file->asset_file)
1956 result = SDL_RWclose(file->asset_file);
1960 result = fclose(file->file);
1962 checked_free(file->filename);
1968 int checkEndOfFile(File *file)
1970 #if defined(PLATFORM_ANDROID)
1971 if (file->file_is_asset)
1972 return file->end_of_file;
1975 return feof(file->file);
1978 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
1980 #if defined(PLATFORM_ANDROID)
1981 if (file->file_is_asset)
1983 if (file->end_of_file)
1986 size_t num_items_read =
1987 SDL_RWread(file->asset_file, buffer, item_size, num_items);
1989 if (num_items_read < num_items)
1990 file->end_of_file = TRUE;
1992 return num_items_read;
1996 return fread(buffer, item_size, num_items, file->file);
1999 int seekFile(File *file, long offset, int whence)
2001 #if defined(PLATFORM_ANDROID)
2002 if (file->file_is_asset)
2004 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2005 whence == SEEK_CUR ? RW_SEEK_CUR :
2006 whence == SEEK_END ? RW_SEEK_END : 0);
2008 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2012 return fseek(file->file, offset, whence);
2015 int getByteFromFile(File *file)
2017 #if defined(PLATFORM_ANDROID)
2018 if (file->file_is_asset)
2020 if (file->end_of_file)
2024 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2026 if (num_bytes_read < 1)
2027 file->end_of_file = TRUE;
2029 return (file->end_of_file ? EOF : (int)c);
2033 return fgetc(file->file);
2036 char *getStringFromFile(File *file, char *line, int size)
2038 #if defined(PLATFORM_ANDROID)
2039 if (file->file_is_asset)
2041 if (file->end_of_file)
2044 char *line_ptr = line;
2045 int num_bytes_read = 0;
2047 while (num_bytes_read < size - 1 &&
2048 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2049 *line_ptr++ != '\n')
2054 if (strlen(line) == 0)
2056 file->end_of_file = TRUE;
2065 return fgets(line, size, file->file);
2069 /* ------------------------------------------------------------------------- */
2070 /* functions for directory handling */
2071 /* ------------------------------------------------------------------------- */
2073 Directory *openDirectory(char *dir_name)
2075 Directory *dir = checked_calloc(sizeof(Directory));
2077 dir->dir = opendir(dir_name);
2079 if (dir->dir != NULL)
2081 dir->filename = getStringCopy(dir_name);
2086 #if defined(PLATFORM_ANDROID)
2087 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2089 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2091 checked_free(asset_toc_filename);
2093 if (dir->asset_toc_file != NULL)
2095 dir->directory_is_asset = TRUE;
2096 dir->filename = getStringCopy(dir_name);
2107 int closeDirectory(Directory *dir)
2114 #if defined(PLATFORM_ANDROID)
2115 if (dir->asset_toc_file)
2116 result = SDL_RWclose(dir->asset_toc_file);
2120 result = closedir(dir->dir);
2123 freeDirectoryEntry(dir->dir_entry);
2125 checked_free(dir->filename);
2131 DirectoryEntry *readDirectory(Directory *dir)
2134 freeDirectoryEntry(dir->dir_entry);
2136 dir->dir_entry = NULL;
2138 #if defined(PLATFORM_ANDROID)
2139 if (dir->directory_is_asset)
2141 char line[MAX_LINE_LEN];
2142 char *line_ptr = line;
2143 int num_bytes_read = 0;
2145 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2146 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2155 if (strlen(line) == 0)
2158 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2160 dir->dir_entry->is_directory = FALSE;
2161 if (line[strlen(line) - 1] == '/')
2163 dir->dir_entry->is_directory = TRUE;
2165 line[strlen(line) - 1] = '\0';
2168 dir->dir_entry->basename = getStringCopy(line);
2169 dir->dir_entry->filename = getPath2(dir->filename, line);
2171 return dir->dir_entry;
2175 struct dirent *dir_entry = readdir(dir->dir);
2177 if (dir_entry == NULL)
2180 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2182 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2183 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2185 struct stat file_status;
2187 dir->dir_entry->is_directory =
2188 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2189 (file_status.st_mode & S_IFMT) == S_IFDIR);
2191 return dir->dir_entry;
2194 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2196 if (dir_entry == NULL)
2199 checked_free(dir_entry->basename);
2200 checked_free(dir_entry->filename);
2201 checked_free(dir_entry);
2205 /* ------------------------------------------------------------------------- */
2206 /* functions for checking files and filenames */
2207 /* ------------------------------------------------------------------------- */
2209 boolean directoryExists(char *dir_name)
2211 if (dir_name == NULL)
2214 boolean success = (access(dir_name, F_OK) == 0);
2216 #if defined(PLATFORM_ANDROID)
2219 // this might be an asset directory; check by trying to open toc file
2220 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2221 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2223 checked_free(asset_toc_filename);
2225 success = (file != NULL);
2235 boolean fileExists(char *filename)
2237 if (filename == NULL)
2240 boolean success = (access(filename, F_OK) == 0);
2242 #if defined(PLATFORM_ANDROID)
2245 // this might be an asset file; check by trying to open it
2246 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2248 success = (file != NULL);
2258 boolean fileHasPrefix(char *basename, char *prefix)
2260 static char *basename_lower = NULL;
2261 int basename_length, prefix_length;
2263 checked_free(basename_lower);
2265 if (basename == NULL || prefix == NULL)
2268 basename_lower = getStringToLower(basename);
2269 basename_length = strlen(basename_lower);
2270 prefix_length = strlen(prefix);
2272 if (basename_length > prefix_length + 1 &&
2273 basename_lower[prefix_length] == '.' &&
2274 strncmp(basename_lower, prefix, prefix_length) == 0)
2280 boolean fileHasSuffix(char *basename, char *suffix)
2282 static char *basename_lower = NULL;
2283 int basename_length, suffix_length;
2285 checked_free(basename_lower);
2287 if (basename == NULL || suffix == NULL)
2290 basename_lower = getStringToLower(basename);
2291 basename_length = strlen(basename_lower);
2292 suffix_length = strlen(suffix);
2294 if (basename_length > suffix_length + 1 &&
2295 basename_lower[basename_length - suffix_length - 1] == '.' &&
2296 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2302 static boolean FileCouldBeArtwork(char *basename)
2304 return (!strEqual(basename, ".") &&
2305 !strEqual(basename, "..") &&
2306 !fileHasSuffix(basename, "txt") &&
2307 !fileHasSuffix(basename, "conf"));
2310 boolean FileIsGraphic(char *filename)
2312 char *basename = getBaseNamePtr(filename);
2314 return FileCouldBeArtwork(basename);
2317 boolean FileIsSound(char *filename)
2319 char *basename = getBaseNamePtr(filename);
2321 return FileCouldBeArtwork(basename);
2324 boolean FileIsMusic(char *filename)
2326 char *basename = getBaseNamePtr(filename);
2328 return FileCouldBeArtwork(basename);
2331 boolean FileIsArtworkType(char *basename, int type)
2333 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2334 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2335 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2341 /* ------------------------------------------------------------------------- */
2342 /* functions for loading artwork configuration information */
2343 /* ------------------------------------------------------------------------- */
2345 char *get_mapped_token(char *token)
2347 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2348 static char *map_token_prefix[][2] =
2350 { "char_procent", "char_percent" },
2355 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2357 int len_token_prefix = strlen(map_token_prefix[i][0]);
2359 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2360 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2366 /* This function checks if a string <s> of the format "string1, string2, ..."
2367 exactly contains a string <s_contained>. */
2369 static boolean string_has_parameter(char *s, char *s_contained)
2373 if (s == NULL || s_contained == NULL)
2376 if (strlen(s_contained) > strlen(s))
2379 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2381 char next_char = s[strlen(s_contained)];
2383 /* check if next character is delimiter or whitespace */
2384 return (next_char == ',' || next_char == '\0' ||
2385 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2388 /* check if string contains another parameter string after a comma */
2389 substring = strchr(s, ',');
2390 if (substring == NULL) /* string does not contain a comma */
2393 /* advance string pointer to next character after the comma */
2396 /* skip potential whitespaces after the comma */
2397 while (*substring == ' ' || *substring == '\t')
2400 return string_has_parameter(substring, s_contained);
2403 int get_parameter_value(char *value_raw, char *suffix, int type)
2405 char *value = getStringToLower(value_raw);
2406 int result = 0; /* probably a save default value */
2408 if (strEqual(suffix, ".direction"))
2410 result = (strEqual(value, "left") ? MV_LEFT :
2411 strEqual(value, "right") ? MV_RIGHT :
2412 strEqual(value, "up") ? MV_UP :
2413 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2415 else if (strEqual(suffix, ".align"))
2417 result = (strEqual(value, "left") ? ALIGN_LEFT :
2418 strEqual(value, "right") ? ALIGN_RIGHT :
2419 strEqual(value, "center") ? ALIGN_CENTER :
2420 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2422 else if (strEqual(suffix, ".valign"))
2424 result = (strEqual(value, "top") ? VALIGN_TOP :
2425 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2426 strEqual(value, "middle") ? VALIGN_MIDDLE :
2427 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2429 else if (strEqual(suffix, ".anim_mode"))
2431 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2432 string_has_parameter(value, "loop") ? ANIM_LOOP :
2433 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2434 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2435 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2436 string_has_parameter(value, "random") ? ANIM_RANDOM :
2437 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2438 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2439 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2440 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2441 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2442 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2445 if (string_has_parameter(value, "reverse"))
2446 result |= ANIM_REVERSE;
2448 if (string_has_parameter(value, "opaque_player"))
2449 result |= ANIM_OPAQUE_PLAYER;
2451 if (string_has_parameter(value, "static_panel"))
2452 result |= ANIM_STATIC_PANEL;
2454 else if (strEqual(suffix, ".class"))
2456 result = get_hash_from_key(value);
2458 else if (strEqual(suffix, ".style"))
2460 result = STYLE_DEFAULT;
2462 if (string_has_parameter(value, "accurate_borders"))
2463 result |= STYLE_ACCURATE_BORDERS;
2465 if (string_has_parameter(value, "inner_corners"))
2466 result |= STYLE_INNER_CORNERS;
2468 else if (strEqual(suffix, ".fade_mode"))
2470 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2471 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2472 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2473 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2476 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2478 result = gfx.get_font_from_token_function(value);
2480 else /* generic parameter of type integer or boolean */
2482 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2483 type == TYPE_INTEGER ? get_integer_from_string(value) :
2484 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2485 ARG_UNDEFINED_VALUE);
2493 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2495 static struct ScreenModeInfo screen_mode;
2496 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2497 char *screen_mode_string_copy;
2498 char *screen_mode_string_pos_w;
2499 char *screen_mode_string_pos_h;
2501 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2504 screen_mode_string_copy = getStringCopy(screen_mode_string);
2506 screen_mode_string_pos_w = screen_mode_string_copy;
2507 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2508 *screen_mode_string_pos_h++ = '\0';
2510 screen_mode.width = atoi(screen_mode_string_pos_w);
2511 screen_mode.height = atoi(screen_mode_string_pos_h);
2513 return &screen_mode;
2516 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2519 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2520 float aspect_ratio_new;
2525 *x = i * aspect_ratio + 0.000001;
2528 aspect_ratio_new = (float)*x / (float)*y;
2532 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2535 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2536 struct ListNodeInfo ***, int *);
2538 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2539 struct ConfigTypeInfo *suffix_list,
2540 char **ignore_tokens,
2541 int num_file_list_entries)
2543 struct FileInfo *file_list;
2544 int num_file_list_entries_found = 0;
2545 int num_suffix_list_entries = 0;
2549 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2551 for (i = 0; suffix_list[i].token != NULL; i++)
2552 num_suffix_list_entries++;
2554 /* always start with reliable default values */
2555 for (i = 0; i < num_file_list_entries; i++)
2557 file_list[i].token = NULL;
2559 file_list[i].default_filename = NULL;
2560 file_list[i].filename = NULL;
2562 if (num_suffix_list_entries > 0)
2564 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2566 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2567 file_list[i].parameter = checked_calloc(parameter_array_size);
2569 for (j = 0; j < num_suffix_list_entries; j++)
2571 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2572 setString(&file_list[i].parameter[j], suffix_list[j].value);
2575 file_list[i].redefined = FALSE;
2576 file_list[i].fallback_to_default = FALSE;
2577 file_list[i].default_is_cloned = FALSE;
2583 for (i = 0; config_list[i].token != NULL; i++)
2585 int len_config_token = strlen(config_list[i].token);
2586 boolean is_file_entry = TRUE;
2588 for (j = 0; suffix_list[j].token != NULL; j++)
2590 int len_suffix = strlen(suffix_list[j].token);
2592 if (len_suffix < len_config_token &&
2593 strEqual(&config_list[i].token[len_config_token - len_suffix],
2594 suffix_list[j].token))
2596 setString(&file_list[list_pos].default_parameter[j],
2597 config_list[i].value);
2599 is_file_entry = FALSE;
2605 /* the following tokens are no file definitions, but other config tokens */
2606 for (j = 0; ignore_tokens[j] != NULL; j++)
2607 if (strEqual(config_list[i].token, ignore_tokens[j]))
2608 is_file_entry = FALSE;
2615 if (list_pos >= num_file_list_entries)
2618 file_list[list_pos].token = config_list[i].token;
2619 file_list[list_pos].default_filename = config_list[i].value;
2622 if (strSuffix(config_list[i].token, ".clone_from"))
2623 file_list[list_pos].default_is_cloned = TRUE;
2626 num_file_list_entries_found = list_pos + 1;
2627 if (num_file_list_entries_found != num_file_list_entries)
2629 Error(ERR_INFO_LINE, "-");
2630 Error(ERR_INFO, "inconsistant config list information:");
2631 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2632 num_file_list_entries);
2633 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2634 num_file_list_entries_found);
2635 Error(ERR_EXIT, "please fix");
2641 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2643 int len_token = strlen(token);
2644 int len_suffix = strlen(suffix);
2646 if (start_pos < 0) /* compare suffix from end of string */
2647 start_pos += len_token;
2649 if (start_pos < 0 || start_pos + len_suffix > len_token)
2652 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2655 if (token[start_pos + len_suffix] == '\0')
2658 if (token[start_pos + len_suffix] == '.')
2664 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2666 static void read_token_parameters(SetupFileHash *setup_file_hash,
2667 struct ConfigTypeInfo *suffix_list,
2668 struct FileInfo *file_list_entry)
2670 /* check for config token that is the base token without any suffixes */
2671 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2672 char *known_token_value = KNOWN_TOKEN_VALUE;
2675 if (filename != NULL)
2677 setString(&file_list_entry->filename, filename);
2679 /* when file definition found, set all parameters to default values */
2680 for (i = 0; suffix_list[i].token != NULL; i++)
2681 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2683 file_list_entry->redefined = TRUE;
2685 /* mark config file token as well known from default config */
2686 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2689 /* check for config tokens that can be build by base token and suffixes */
2690 for (i = 0; suffix_list[i].token != NULL; i++)
2692 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2693 char *value = getHashEntry(setup_file_hash, token);
2697 setString(&file_list_entry->parameter[i], value);
2699 /* mark config file token as well known from default config */
2700 setHashEntry(setup_file_hash, token, known_token_value);
2707 static void add_dynamic_file_list_entry(struct FileInfo **list,
2708 int *num_list_entries,
2709 SetupFileHash *extra_file_hash,
2710 struct ConfigTypeInfo *suffix_list,
2711 int num_suffix_list_entries,
2714 struct FileInfo *new_list_entry;
2715 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2717 (*num_list_entries)++;
2718 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2719 new_list_entry = &(*list)[*num_list_entries - 1];
2721 new_list_entry->token = getStringCopy(token);
2722 new_list_entry->default_filename = NULL;
2723 new_list_entry->filename = NULL;
2724 new_list_entry->parameter = checked_calloc(parameter_array_size);
2726 new_list_entry->redefined = FALSE;
2727 new_list_entry->fallback_to_default = FALSE;
2728 new_list_entry->default_is_cloned = FALSE;
2730 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2733 static void add_property_mapping(struct PropertyMapping **list,
2734 int *num_list_entries,
2735 int base_index, int ext1_index,
2736 int ext2_index, int ext3_index,
2739 struct PropertyMapping *new_list_entry;
2741 (*num_list_entries)++;
2742 *list = checked_realloc(*list,
2743 *num_list_entries * sizeof(struct PropertyMapping));
2744 new_list_entry = &(*list)[*num_list_entries - 1];
2746 new_list_entry->base_index = base_index;
2747 new_list_entry->ext1_index = ext1_index;
2748 new_list_entry->ext2_index = ext2_index;
2749 new_list_entry->ext3_index = ext3_index;
2751 new_list_entry->artwork_index = artwork_index;
2754 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2757 struct FileInfo *file_list = artwork_info->file_list;
2758 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2759 char **base_prefixes = artwork_info->base_prefixes;
2760 char **ext1_suffixes = artwork_info->ext1_suffixes;
2761 char **ext2_suffixes = artwork_info->ext2_suffixes;
2762 char **ext3_suffixes = artwork_info->ext3_suffixes;
2763 char **ignore_tokens = artwork_info->ignore_tokens;
2764 int num_file_list_entries = artwork_info->num_file_list_entries;
2765 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2766 int num_base_prefixes = artwork_info->num_base_prefixes;
2767 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2768 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2769 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2770 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2771 SetupFileHash *setup_file_hash, *valid_file_hash;
2772 SetupFileHash *extra_file_hash, *empty_file_hash;
2773 char *known_token_value = KNOWN_TOKEN_VALUE;
2776 if (filename == NULL)
2779 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2782 /* separate valid (defined) from empty (undefined) config token values */
2783 valid_file_hash = newSetupFileHash();
2784 empty_file_hash = newSetupFileHash();
2785 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2787 char *value = HASH_ITERATION_VALUE(itr);
2789 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2790 HASH_ITERATION_TOKEN(itr), value);
2792 END_HASH_ITERATION(setup_file_hash, itr)
2794 /* at this point, we do not need the setup file hash anymore -- free it */
2795 freeSetupFileHash(setup_file_hash);
2797 /* map deprecated to current tokens (using prefix match and replace) */
2798 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2800 char *token = HASH_ITERATION_TOKEN(itr);
2801 char *mapped_token = get_mapped_token(token);
2803 if (mapped_token != NULL)
2805 char *value = HASH_ITERATION_VALUE(itr);
2807 /* add mapped token */
2808 setHashEntry(valid_file_hash, mapped_token, value);
2810 /* ignore old token (by setting it to "known" keyword) */
2811 setHashEntry(valid_file_hash, token, known_token_value);
2816 END_HASH_ITERATION(valid_file_hash, itr)
2818 /* read parameters for all known config file tokens */
2819 for (i = 0; i < num_file_list_entries; i++)
2820 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2822 /* set all tokens that can be ignored here to "known" keyword */
2823 for (i = 0; i < num_ignore_tokens; i++)
2824 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2826 /* copy all unknown config file tokens to extra config hash */
2827 extra_file_hash = newSetupFileHash();
2828 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2830 char *value = HASH_ITERATION_VALUE(itr);
2832 if (!strEqual(value, known_token_value))
2833 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2835 END_HASH_ITERATION(valid_file_hash, itr)
2837 /* at this point, we do not need the valid file hash anymore -- free it */
2838 freeSetupFileHash(valid_file_hash);
2840 /* now try to determine valid, dynamically defined config tokens */
2842 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2844 struct FileInfo **dynamic_file_list =
2845 &artwork_info->dynamic_file_list;
2846 int *num_dynamic_file_list_entries =
2847 &artwork_info->num_dynamic_file_list_entries;
2848 struct PropertyMapping **property_mapping =
2849 &artwork_info->property_mapping;
2850 int *num_property_mapping_entries =
2851 &artwork_info->num_property_mapping_entries;
2852 int current_summarized_file_list_entry =
2853 artwork_info->num_file_list_entries +
2854 artwork_info->num_dynamic_file_list_entries;
2855 char *token = HASH_ITERATION_TOKEN(itr);
2856 int len_token = strlen(token);
2858 boolean base_prefix_found = FALSE;
2859 boolean parameter_suffix_found = FALSE;
2861 /* skip all parameter definitions (handled by read_token_parameters()) */
2862 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2864 int len_suffix = strlen(suffix_list[i].token);
2866 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2867 parameter_suffix_found = TRUE;
2870 if (parameter_suffix_found)
2873 /* ---------- step 0: search for matching base prefix ---------- */
2876 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2878 char *base_prefix = base_prefixes[i];
2879 int len_base_prefix = strlen(base_prefix);
2880 boolean ext1_suffix_found = FALSE;
2881 boolean ext2_suffix_found = FALSE;
2882 boolean ext3_suffix_found = FALSE;
2883 boolean exact_match = FALSE;
2884 int base_index = -1;
2885 int ext1_index = -1;
2886 int ext2_index = -1;
2887 int ext3_index = -1;
2889 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2891 if (!base_prefix_found)
2896 if (start_pos + len_base_prefix == len_token) /* exact match */
2900 add_dynamic_file_list_entry(dynamic_file_list,
2901 num_dynamic_file_list_entries,
2904 num_suffix_list_entries,
2906 add_property_mapping(property_mapping,
2907 num_property_mapping_entries,
2908 base_index, -1, -1, -1,
2909 current_summarized_file_list_entry);
2913 /* ---------- step 1: search for matching first suffix ---------- */
2915 start_pos += len_base_prefix;
2916 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2918 char *ext1_suffix = ext1_suffixes[j];
2919 int len_ext1_suffix = strlen(ext1_suffix);
2921 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2923 if (!ext1_suffix_found)
2928 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2932 add_dynamic_file_list_entry(dynamic_file_list,
2933 num_dynamic_file_list_entries,
2936 num_suffix_list_entries,
2938 add_property_mapping(property_mapping,
2939 num_property_mapping_entries,
2940 base_index, ext1_index, -1, -1,
2941 current_summarized_file_list_entry);
2945 start_pos += len_ext1_suffix;
2951 /* ---------- step 2: search for matching second suffix ---------- */
2953 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2955 char *ext2_suffix = ext2_suffixes[k];
2956 int len_ext2_suffix = strlen(ext2_suffix);
2958 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2960 if (!ext2_suffix_found)
2965 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2969 add_dynamic_file_list_entry(dynamic_file_list,
2970 num_dynamic_file_list_entries,
2973 num_suffix_list_entries,
2975 add_property_mapping(property_mapping,
2976 num_property_mapping_entries,
2977 base_index, ext1_index, ext2_index, -1,
2978 current_summarized_file_list_entry);
2982 start_pos += len_ext2_suffix;
2988 /* ---------- step 3: search for matching third suffix ---------- */
2990 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2992 char *ext3_suffix = ext3_suffixes[l];
2993 int len_ext3_suffix = strlen(ext3_suffix);
2995 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2997 if (!ext3_suffix_found)
3002 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3006 add_dynamic_file_list_entry(dynamic_file_list,
3007 num_dynamic_file_list_entries,
3010 num_suffix_list_entries,
3012 add_property_mapping(property_mapping,
3013 num_property_mapping_entries,
3014 base_index, ext1_index, ext2_index, ext3_index,
3015 current_summarized_file_list_entry);
3021 END_HASH_ITERATION(extra_file_hash, itr)
3023 if (artwork_info->num_dynamic_file_list_entries > 0)
3025 artwork_info->dynamic_artwork_list =
3026 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3027 artwork_info->sizeof_artwork_list_entry);
3030 if (options.verbose && IS_PARENT_PROCESS())
3032 SetupFileList *setup_file_list, *list;
3033 boolean dynamic_tokens_found = FALSE;
3034 boolean unknown_tokens_found = FALSE;
3035 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3037 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3038 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3040 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3042 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3043 dynamic_tokens_found = TRUE;
3045 unknown_tokens_found = TRUE;
3047 END_HASH_ITERATION(extra_file_hash, itr)
3049 if (options.debug && dynamic_tokens_found)
3051 Error(ERR_INFO_LINE, "-");
3052 Error(ERR_INFO, "dynamic token(s) found in config file:");
3053 Error(ERR_INFO, "- config file: '%s'", filename);
3055 for (list = setup_file_list; list != NULL; list = list->next)
3057 char *value = getHashEntry(extra_file_hash, list->token);
3059 if (value != NULL && strEqual(value, known_token_value))
3060 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3063 Error(ERR_INFO_LINE, "-");
3066 if (unknown_tokens_found)
3068 Error(ERR_INFO_LINE, "-");
3069 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3070 Error(ERR_INFO, "- config file: '%s'", filename);
3072 for (list = setup_file_list; list != NULL; list = list->next)
3074 char *value = getHashEntry(extra_file_hash, list->token);
3076 if (value != NULL && !strEqual(value, known_token_value))
3077 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3080 Error(ERR_INFO_LINE, "-");
3083 if (undefined_values_found)
3085 Error(ERR_INFO_LINE, "-");
3086 Error(ERR_INFO, "warning: undefined values found in config file:");
3087 Error(ERR_INFO, "- config file: '%s'", filename);
3089 for (list = setup_file_list; list != NULL; list = list->next)
3091 char *value = getHashEntry(empty_file_hash, list->token);
3094 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3097 Error(ERR_INFO_LINE, "-");
3100 freeSetupFileList(setup_file_list);
3103 freeSetupFileHash(extra_file_hash);
3104 freeSetupFileHash(empty_file_hash);
3107 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3109 struct FileInfo *file_list = artwork_info->file_list;
3110 int num_file_list_entries = artwork_info->num_file_list_entries;
3111 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3112 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3115 DrawInitText("Loading artwork config", 120, FC_GREEN);
3116 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3118 /* always start with reliable default values */
3119 for (i = 0; i < num_file_list_entries; i++)
3121 setString(&file_list[i].filename, file_list[i].default_filename);
3123 for (j = 0; j < num_suffix_list_entries; j++)
3124 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3126 file_list[i].redefined = FALSE;
3127 file_list[i].fallback_to_default = FALSE;
3130 /* free previous dynamic artwork file array */
3131 if (artwork_info->dynamic_file_list != NULL)
3133 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3135 free(artwork_info->dynamic_file_list[i].token);
3136 free(artwork_info->dynamic_file_list[i].filename);
3137 free(artwork_info->dynamic_file_list[i].parameter);
3140 free(artwork_info->dynamic_file_list);
3141 artwork_info->dynamic_file_list = NULL;
3143 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3144 &artwork_info->num_dynamic_file_list_entries);
3147 /* free previous property mapping */
3148 if (artwork_info->property_mapping != NULL)
3150 free(artwork_info->property_mapping);
3152 artwork_info->property_mapping = NULL;
3153 artwork_info->num_property_mapping_entries = 0;
3156 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3158 /* first look for special artwork configured in level series config */
3159 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3161 if (fileExists(filename_base))
3162 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3165 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3167 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3168 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3171 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3172 struct ListNodeInfo **listnode)
3176 char *filename = (*listnode)->source_filename;
3178 if (--(*listnode)->num_references <= 0)
3179 deleteNodeFromList(&artwork_info->content_list, filename,
3180 artwork_info->free_artwork);
3186 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3187 struct ListNodeInfo **listnode,
3188 struct FileInfo *file_list_entry)
3198 char *basename = file_list_entry->filename;
3199 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3201 if (filename == NULL)
3203 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3205 basename = file_list_entry->default_filename;
3207 /* fail for cloned default artwork that has no default filename defined */
3208 if (file_list_entry->default_is_cloned &&
3209 strEqual(basename, UNDEFINED_FILENAME))
3211 int error_mode = ERR_WARN;
3213 /* we can get away without sounds and music, but not without graphics */
3214 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3215 error_mode = ERR_EXIT;
3217 Error(error_mode, "token '%s' was cloned and has no default filename",
3218 file_list_entry->token);
3223 /* dynamic artwork has no default filename / skip empty default artwork */
3224 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3227 file_list_entry->fallback_to_default = TRUE;
3229 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3231 filename = getCustomArtworkFilename(basename, artwork_info->type);
3233 if (filename == NULL)
3235 int error_mode = ERR_WARN;
3237 /* we can get away without sounds and music, but not without graphics */
3238 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3239 error_mode = ERR_EXIT;
3241 Error(error_mode, "cannot find default artwork file '%s'", basename);
3247 /* check if the old and the new artwork file are the same */
3248 if (*listnode && strEqual((*listnode)->source_filename, filename))
3250 /* The old and new artwork are the same (have the same filename and path).
3251 This usually means that this artwork does not exist in this artwork set
3252 and a fallback to the existing artwork is done. */
3257 /* delete existing artwork file entry */
3258 deleteArtworkListEntry(artwork_info, listnode);
3260 /* check if the new artwork file already exists in the list of artwork */
3261 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3263 *listnode = (struct ListNodeInfo *)node->content;
3264 (*listnode)->num_references++;
3269 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3270 DrawInitText(basename, 150, FC_YELLOW);
3272 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3274 /* add new artwork file entry to the list of artwork files */
3275 (*listnode)->num_references = 1;
3276 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3281 int error_mode = ERR_WARN;
3283 /* we can get away without sounds and music, but not without graphics */
3284 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3285 error_mode = ERR_EXIT;
3287 Error(error_mode, "cannot load artwork file '%s'", basename);
3293 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3294 struct ListNodeInfo **listnode,
3295 struct FileInfo *file_list_entry)
3297 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3299 deleteArtworkListEntry(artwork_info, listnode);
3304 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3307 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3309 struct FileInfo *file_list = artwork_info->file_list;
3310 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3311 int num_file_list_entries = artwork_info->num_file_list_entries;
3312 int num_dynamic_file_list_entries =
3313 artwork_info->num_dynamic_file_list_entries;
3316 print_timestamp_init("ReloadCustomArtworkList");
3318 for (i = 0; i < num_file_list_entries; i++)
3319 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3322 for (i = 0; i < num_dynamic_file_list_entries; i++)
3323 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3324 &dynamic_file_list[i]);
3326 print_timestamp_done("ReloadCustomArtworkList");
3329 dumpList(artwork_info->content_list);
3333 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3334 struct ListNodeInfo ***list,
3335 int *num_list_entries)
3342 for (i = 0; i < *num_list_entries; i++)
3343 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3347 *num_list_entries = 0;
3350 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3352 if (artwork_info == NULL)
3355 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3356 &artwork_info->num_file_list_entries);
3358 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3359 &artwork_info->num_dynamic_file_list_entries);
3363 /* ------------------------------------------------------------------------- */
3364 /* functions only needed for non-Unix (non-command-line) systems */
3365 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3366 /* (now also added for Windows, to create files in user data directory) */
3367 /* ------------------------------------------------------------------------- */
3369 char *getErrorFilename(char *basename)
3371 return getPath2(getUserGameDataDir(), basename);
3374 void openErrorFile()
3376 InitUserDataDirectory();
3378 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3380 program.error_file = stderr;
3382 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3383 program.error_filename, strerror(errno));
3386 /* error output should be unbuffered so it is not truncated in a crash */
3387 setbuf(program.error_file, NULL);
3390 void closeErrorFile()
3392 if (program.error_file != stderr) /* do not close stream 'stderr' */
3393 fclose(program.error_file);
3396 void dumpErrorFile()
3398 FILE *error_file = fopen(program.error_filename, MODE_READ);
3400 if (error_file != NULL)
3402 while (!feof(error_file))
3403 fputc(fgetc(error_file), stderr);
3409 void NotifyUserAboutErrorFile()
3411 #if defined(PLATFORM_WIN32)
3412 char *title_text = getStringCat2(program.program_title, " Error Message");
3413 char *error_text = getStringCat2("The program was aborted due to an error; "
3414 "for details, see the following error file:"
3415 STRING_NEWLINE, program.error_filename);
3417 MessageBox(NULL, error_text, title_text, MB_OK);
3422 /* ------------------------------------------------------------------------- */
3423 /* the following is only for debugging purpose and normally not used */
3424 /* ------------------------------------------------------------------------- */
3428 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3429 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3431 #define DEBUG_NUM_TIMESTAMPS 10
3432 #define DEBUG_TIME_IN_MICROSECONDS 0
3434 #if DEBUG_TIME_IN_MICROSECONDS
3435 static double Counter_Microseconds()
3437 static struct timeval base_time = { 0, 0 };
3438 struct timeval current_time;
3441 gettimeofday(¤t_time, NULL);
3443 /* reset base time in case of wrap-around */
3444 if (current_time.tv_sec < base_time.tv_sec)
3445 base_time = current_time;
3448 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3449 ((double)(current_time.tv_usec - base_time.tv_usec));
3451 return counter; /* return microseconds since last init */
3455 char *debug_print_timestamp_get_padding(int padding_size)
3457 static char *padding = NULL;
3458 int max_padding_size = 100;
3460 if (padding == NULL)
3462 padding = checked_calloc(max_padding_size + 1);
3463 memset(padding, ' ', max_padding_size);
3466 return &padding[MAX(0, max_padding_size - padding_size)];
3469 void debug_print_timestamp(int counter_nr, char *message)
3471 int indent_size = 8;
3472 int padding_size = 40;
3473 float timestamp_interval;
3476 Error(ERR_EXIT, "debugging: invalid negative counter");
3477 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3478 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3480 #if DEBUG_TIME_IN_MICROSECONDS
3481 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3484 counter[counter_nr][0] = Counter_Microseconds();
3486 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3489 counter[counter_nr][0] = Counter();
3492 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3493 counter[counter_nr][1] = counter[counter_nr][0];
3496 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3497 debug_print_timestamp_get_padding(counter_nr * indent_size),
3499 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3500 timestamp_interval / 1000,
3504 void debug_print_parent_only(char *format, ...)
3506 if (!IS_PARENT_PROCESS())
3513 va_start(ap, format);
3514 vprintf(format, ap);
3523 void print_timestamp_ext(char *message, char *mode)
3525 #if DEBUG_PRINT_INIT_TIMESTAMPS
3526 static char *debug_message = NULL;
3527 static char *last_message = NULL;
3528 static int counter_nr = 0;
3529 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3531 checked_free(debug_message);
3532 debug_message = getStringCat3(mode, " ", message);
3534 if (strEqual(mode, "INIT"))
3536 debug_print_timestamp(counter_nr, NULL);
3538 if (counter_nr + 1 < max_depth)
3539 debug_print_timestamp(counter_nr, debug_message);
3543 debug_print_timestamp(counter_nr, NULL);
3545 else if (strEqual(mode, "DONE"))
3549 if (counter_nr + 1 < max_depth ||
3550 (counter_nr == 0 && max_depth == 1))
3552 last_message = message;
3554 if (counter_nr == 0 && max_depth == 1)
3556 checked_free(debug_message);
3557 debug_message = getStringCat3("TIME", " ", message);
3560 debug_print_timestamp(counter_nr, debug_message);
3563 else if (!strEqual(mode, "TIME") ||
3564 !strEqual(message, last_message))
3566 if (counter_nr < max_depth)
3567 debug_print_timestamp(counter_nr, debug_message);
3572 void print_timestamp_init(char *message)
3574 print_timestamp_ext(message, "INIT");
3577 void print_timestamp_time(char *message)
3579 print_timestamp_ext(message, "TIME");
3582 void print_timestamp_done(char *message)
3584 print_timestamp_ext(message, "DONE");