1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://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 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOG_OUT_TO_STDOUT TRUE
45 #define DUPLICATE_LOG_ERR_TO_STDERR TRUE
48 #if defined(PLATFORM_ANDROID)
49 static int android_log_prio = ANDROID_LOG_INFO;
50 static char *android_log_buffer = NULL;
52 static void append_to_android_log_buffer(char *format, va_list ap)
54 char text_new[MAX_OUTPUT_LINESIZE];
56 // print text to temporary string
57 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
59 if (android_log_buffer == NULL)
61 android_log_buffer = getStringCopy(text_new);
65 char *android_log_buffer_old = android_log_buffer;
67 // append new text to existing text
68 android_log_buffer = getStringCat2(android_log_buffer, text_new);
70 checked_free(android_log_buffer_old);
74 static void vprintf_log_nonewline(char *format, va_list ap)
76 // add log output to buffer until text with newline is printed
77 append_to_android_log_buffer(format, ap);
80 static void vprintf_log(char *format, va_list ap)
82 // add log output to buffer
83 append_to_android_log_buffer(format, ap);
85 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
86 __android_log_write(android_log_prio, program.program_title,
89 checked_free(android_log_buffer);
90 android_log_buffer = NULL;
95 static void vprintf_log_nonewline(char *format, va_list ap)
97 FILE *file = program.log_file[LOG_ERR_ID];
99 #if DUPLICATE_LOG_ERR_TO_STDERR
100 if (file != program.log_file_default[LOG_ERR_ID])
105 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
111 vfprintf(file, format, ap);
114 static void vprintf_log(char *format, va_list ap)
116 FILE *file = program.log_file[LOG_ERR_ID];
117 char *newline = STRING_NEWLINE;
119 #if DUPLICATE_LOG_ERR_TO_STDERR
120 if (file != program.log_file_default[LOG_ERR_ID])
125 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
126 fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline);
132 vfprintf(file, format, ap);
133 fprintf(file, "%s", newline);
137 static void printf_log_nonewline(char *format, ...)
141 va_start(ap, format);
142 vprintf_log_nonewline(format, ap);
146 static void printf_log(char *format, ...)
150 va_start(ap, format);
151 vprintf_log(format, ap);
155 static void printf_log_line(char *line_chars, int line_length)
159 for (i = 0; i < line_length; i++)
160 printf_log_nonewline("%s", line_chars);
166 // ----------------------------------------------------------------------------
167 // platform independent wrappers for printf() et al.
168 // ----------------------------------------------------------------------------
170 void fprintf_line(FILE *file, char *line_chars, int line_length)
174 for (i = 0; i < line_length; i++)
175 fprintf(file, "%s", line_chars);
180 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
183 fprintf(file, "%s", prefix);
184 fprintf_line(file, line_chars, line_length);
187 void printf_line(char *line_chars, int line_length)
189 fprintf_line(stdout, line_chars, line_length);
192 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
194 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
197 static void vPrint(char *format, va_list ap)
199 FILE *file = program.log_file[LOG_OUT_ID];
201 #if DUPLICATE_LOG_OUT_TO_STDOUT
202 if (file != program.log_file_default[LOG_OUT_ID])
207 vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2);
213 vfprintf(file, format, ap);
216 void Print(char *format, ...)
220 va_start(ap, format);
225 void PrintNoLog(char *format, ...)
227 FILE *file = program.log_file_default[LOG_OUT_ID];
230 va_start(ap, format);
231 vfprintf(file, format, ap);
237 void PrintLine(char *line_chars, int line_length)
241 for (i = 0; i < line_length; i++)
247 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
250 PrintLine(line_chars, line_length);
254 // ----------------------------------------------------------------------------
255 // generic logging and error handling functions
256 // ----------------------------------------------------------------------------
268 static char *log_tokens[] =
278 static void printf_log_prefix(int log_level, char *mode)
280 if (log_level < 0 || log_level > LOG_FATAL)
283 char *log_token = log_tokens[log_level];
285 if (log_level == LOG_DEBUG)
286 printf_log_nonewline("[%s] [%s] ", log_token, mode);
288 printf_log_nonewline("[%s] ", log_token);
291 static void vLog(int log_level, char *mode, char *format, va_list ap)
293 if (log_level < 0 || log_level > LOG_FATAL)
296 if (log_level == LOG_DEBUG)
298 // only show debug messages when in debug mode
302 // if optional debug mode specified, limit debug output accordingly
303 if (options.debug_mode != NULL &&
304 strstr(mode, options.debug_mode) == NULL)
307 else if (log_level == LOG_WARN)
309 // only show warning messages when in verbose mode
310 if (!options.verbose)
314 #if defined(PLATFORM_ANDROID)
315 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
316 log_level == LOG_INFO ? ANDROID_LOG_INFO :
317 log_level == LOG_WARN ? ANDROID_LOG_WARN :
318 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
319 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
320 ANDROID_LOG_UNKNOWN);
323 static boolean last_line_was_separator = FALSE;
324 char *log_token = log_tokens[log_level];
326 if (strEqual(format, "===") ||
327 strEqual(format, "---"))
329 static char *mode_last = NULL;
330 char line_char[2] = { format[0], '\0' };
331 int line_length = 80 - strlen(log_token) - 3;
333 if (log_level == LOG_DEBUG)
334 line_length -= strlen(mode) + 3;
336 if (last_line_was_separator && strEqual(mode, mode_last))
339 printf_log_prefix(log_level, mode);
340 printf_log_line(line_char, line_length);
342 if (!strEqual(mode, mode_last))
343 setString(&mode_last, mode);
345 last_line_was_separator = TRUE;
350 last_line_was_separator = FALSE;
352 printf_log_prefix(log_level, mode);
354 vprintf_log(format, ap);
357 static void Log(int log_level, char *mode, char *format, ...)
361 va_start(ap, format);
362 vLog(log_level, mode, format, ap);
366 void Debug(char *mode, char *format, ...)
370 va_start(ap, format);
371 vLog(LOG_DEBUG, mode, format, ap);
375 void Info(char *format, ...)
379 va_start(ap, format);
380 vLog(LOG_INFO, NULL, format, ap);
384 void Warn(char *format, ...)
388 va_start(ap, format);
389 vLog(LOG_WARN, NULL, format, ap);
393 void Error(char *format, ...)
397 va_start(ap, format);
398 vLog(LOG_ERROR, NULL, format, ap);
402 void Fail(char *format, ...)
406 va_start(ap, format);
407 vLog(LOG_FATAL, NULL, format, ap);
410 if (!network.is_server_thread)
412 va_start(ap, format);
413 program.exit_message_function(format, ap);
417 Log(LOG_FATAL, NULL, "aborting");
419 // network server thread: normal exit
420 if (network.is_server_thread)
423 // main process: clean up stuff
424 program.exit_function(1);
427 void FailWithHelp(char *format, ...)
431 va_start(ap, format);
432 vLog(LOG_FATAL, NULL, format, ap);
435 Log(LOG_FATAL, NULL, "try option '--help' for more information");
436 Log(LOG_FATAL, NULL, "aborting");
438 // main process: clean up stuff
439 program.exit_function(1);
443 // ----------------------------------------------------------------------------
445 // ----------------------------------------------------------------------------
447 /* int2str() returns a number converted to a string;
448 the used memory is static, but will be overwritten by later calls,
449 so if you want to save the result, copy it to a private string buffer;
450 there can be 10 local calls of int2str() without buffering the result --
451 the 11th call will then destroy the result from the first call and so on. */
453 char *int2str(int number, int size)
455 static char shift_array[10][40];
456 static int shift_counter = 0;
457 char *s = shift_array[shift_counter];
459 shift_counter = (shift_counter + 1) % 10;
466 sprintf(s, " %09d", number);
467 return &s[strlen(s) - size];
471 sprintf(s, "%d", number);
477 // something similar to "int2str()" above, but allocates its own memory
478 // and has a different interface; we cannot use "itoa()", because this
479 // seems to be already defined when cross-compiling to the win32 target
481 char *i_to_a(unsigned int i)
483 static char *a = NULL;
487 if (i > 2147483647) // yes, this is a kludge
490 a = checked_malloc(10 + 1);
498 // calculate base-2 logarithm of argument (rounded down to integer;
499 // this function returns the number of the highest bit set in argument)
501 int log_2(unsigned int x)
507 x -= (1 << e); // for rounding down (rounding up: remove this line)
514 boolean getTokenValueFromString(char *string, char **token, char **value)
516 return getTokenValueFromSetupLine(string, token, value);
520 // ----------------------------------------------------------------------------
522 // ----------------------------------------------------------------------------
524 // maximal allowed length of a command line option
525 #define MAX_OPTION_LEN 256
527 static unsigned int getCurrentMS(void)
529 return SDL_GetTicks();
532 static unsigned int mainCounter(int mode)
534 static unsigned int base_ms = 0;
535 unsigned int current_ms;
537 // get current system milliseconds
538 current_ms = getCurrentMS();
540 // reset base timestamp in case of counter reset or wrap-around
541 if (mode == INIT_COUNTER || current_ms < base_ms)
542 base_ms = current_ms;
544 // return milliseconds since last counter reset
545 return current_ms - base_ms;
548 void InitCounter() // set counter back to zero
550 mainCounter(INIT_COUNTER);
553 unsigned int Counter() // get milliseconds since last call of InitCounter()
555 return mainCounter(READ_COUNTER);
558 static void sleep_milliseconds(unsigned int milliseconds_delay)
560 SDL_Delay(milliseconds_delay);
563 void Delay(unsigned int delay) // Sleep specified number of milliseconds
565 sleep_milliseconds(delay);
568 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
569 unsigned int actual_counter)
571 if (actual_counter >= *counter_var &&
572 actual_counter < *counter_var + delay)
575 *counter_var = actual_counter;
580 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
582 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
585 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
587 return DelayReachedExt(counter_var, delay, Counter());
590 void ResetDelayCounterExt(unsigned int *counter_var,
591 unsigned int actual_counter)
593 DelayReachedExt(counter_var, 0, actual_counter);
596 void ResetFrameCounter(unsigned int *frame_counter_var)
598 FrameReached(frame_counter_var, 0);
601 void ResetDelayCounter(unsigned int *counter_var)
603 DelayReached(counter_var, 0);
606 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
608 unsigned int actual_counter;
613 actual_counter = Counter();
615 if (actual_counter >= *counter_var &&
616 actual_counter < *counter_var + delay)
617 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
622 if (*counter_var != 0 &&
624 actual_counter >= *counter_var + delay)
626 int lag = actual_counter - (*counter_var + delay);
627 int delay2 = (delay + 1) / 2;
630 skip_frames = (lag + delay2) / delay;
633 *counter_var = actual_counter;
638 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
639 int *loop_var, int last_loop_value)
641 int skip_frames = WaitUntilDelayReached(counter_var, delay);
646 Debug("internal:SkipUntilDelayReached",
647 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
649 skip_frames, skip_frames * delay);
651 Debug("internal:SkipUntilDelayReached",
657 if (skip_frames == 0)
660 // when skipping frames, make sure to never skip the last frame, as
661 // this may be needed for animations to reach a defined end state;
662 // furthermore, we assume that this function is called at the end
663 // of a "for" loop, which continues by incrementing the loop variable
664 // by one before checking the loop condition again; therefore we have
665 // to check against the last loop value minus one here
669 if (*loop_var < last_loop_value) // never skip the last frame
671 *loop_var += skip_frames;
673 if (*loop_var > last_loop_value) // never skip the last frame
674 *loop_var = last_loop_value;
679 // ----------------------------------------------------------------------------
680 // random generator functions
681 // ----------------------------------------------------------------------------
683 unsigned int init_random_number(int nr, int seed)
685 if (seed == NEW_RANDOMIZE)
687 // default random seed
688 seed = (int)time(NULL); // seconds since the epoch
690 #if !defined(PLATFORM_WIN32)
691 // add some more randomness
692 struct timeval current_time;
694 gettimeofday(¤t_time, NULL);
696 seed += (int)current_time.tv_usec; // microseconds since the epoch
699 // add some more randomness
700 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
702 // add some more randomness
703 seed += GetSimpleRandom(1000000);
706 srandom_linux_libc(nr, (unsigned int) seed);
708 return (unsigned int) seed;
711 unsigned int get_random_number(int nr, int max)
713 return (max > 0 ? random_linux_libc(nr) % max : 0);
717 // ----------------------------------------------------------------------------
718 // system info functions
719 // ----------------------------------------------------------------------------
721 #if !defined(PLATFORM_ANDROID)
722 static char *get_corrected_real_name(char *real_name)
724 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
725 char *from_ptr = real_name;
726 char *to_ptr = real_name_new;
728 // copy the name string, but not more than MAX_USERNAME_LEN characters
729 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
731 // the name field read from "passwd" file may also contain additional
732 // user information, separated by commas, which will be removed here
733 if (*from_ptr == ',')
736 // the user's real name may contain 'german sharp s' characters,
737 // which have no equivalent in upper case letters (used by our fonts)
738 if (*from_ptr == CHAR_BYTE_SHARP_S)
745 *to_ptr++ = *from_ptr++;
750 return real_name_new;
754 char *getLoginName(void)
756 static char *login_name = NULL;
758 #if defined(PLATFORM_WIN32)
759 if (login_name == NULL)
761 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
762 login_name = checked_malloc(buffer_size);
764 if (GetUserName(login_name, &buffer_size) == 0)
765 strcpy(login_name, ANONYMOUS_NAME);
767 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
768 if (login_name == NULL)
772 if ((pwd = getpwuid(getuid())) == NULL)
773 login_name = ANONYMOUS_NAME;
775 login_name = getStringCopy(pwd->pw_name);
778 login_name = ANONYMOUS_NAME;
784 char *getRealName(void)
786 static char *real_name = NULL;
788 #if defined(PLATFORM_WIN32)
789 if (real_name == NULL)
791 static char buffer[MAX_USERNAME_LEN + 1];
792 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
794 if (GetUserName(buffer, &buffer_size) != 0)
795 real_name = get_corrected_real_name(buffer);
797 real_name = ANONYMOUS_NAME;
799 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
800 if (real_name == NULL)
804 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
805 real_name = get_corrected_real_name(pwd->pw_gecos);
807 real_name = ANONYMOUS_NAME;
810 real_name = ANONYMOUS_NAME;
816 time_t getFileTimestampEpochSeconds(char *filename)
818 struct stat file_status;
820 if (stat(filename, &file_status) != 0) // cannot stat file
823 return file_status.st_mtime;
827 // ----------------------------------------------------------------------------
828 // path manipulation functions
829 // ----------------------------------------------------------------------------
831 static char *getLastPathSeparatorPtr(char *filename)
833 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
835 if (last_separator == NULL) // also try DOS/Windows variant
836 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
838 return last_separator;
841 char *getBaseNamePtr(char *filename)
843 char *last_separator = getLastPathSeparatorPtr(filename);
845 if (last_separator != NULL)
846 return last_separator + 1; // separator found: strip base path
848 return filename; // no separator found: filename has no path
851 char *getBaseName(char *filename)
853 return getStringCopy(getBaseNamePtr(filename));
856 char *getBaseNameNoSuffix(char *filename)
858 char *basename = getStringCopy(getBaseNamePtr(filename));
860 // remove trailing suffix (separated by dot or hyphen)
861 if (basename[0] != '.' && basename[0] != '-')
863 if (strchr(basename, '.') != NULL)
864 *strchr(basename, '.') = '\0';
866 if (strchr(basename, '-') != NULL)
867 *strchr(basename, '-') = '\0';
873 char *getBasePath(char *filename)
875 char *basepath = getStringCopy(filename);
876 char *last_separator = getLastPathSeparatorPtr(basepath);
878 // if no separator was found, use current directory
879 if (last_separator == NULL)
883 return getStringCopy(".");
886 // separator found: strip basename
887 *last_separator = '\0';
893 // ----------------------------------------------------------------------------
894 // various string functions
895 // ----------------------------------------------------------------------------
897 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
899 if (s1 == NULL || s2 == NULL || sep == NULL)
902 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
905 sprintf(complete_string, "%s%s%s", s1, sep, s2);
907 return complete_string;
910 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
912 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
915 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
916 strlen(s2) + strlen(sep) +
919 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
921 return complete_string;
924 char *getStringCat2(char *s1, char *s2)
926 return getStringCat2WithSeparator(s1, s2, "");
929 char *getStringCat3(char *s1, char *s2, char *s3)
931 return getStringCat3WithSeparator(s1, s2, s3, "");
934 char *getPath2(char *path1, char *path2)
936 #if defined(PLATFORM_ANDROID)
937 // workaround for reading from assets directory -- skip "." subdirs in path
938 if (strEqual(path1, "."))
939 return getStringCopy(path2);
940 else if (strEqual(path2, "."))
941 return getStringCopy(path1);
944 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
947 char *getPath3(char *path1, char *path2, char *path3)
949 #if defined(PLATFORM_ANDROID)
950 // workaround for reading from assets directory -- skip "." subdirs in path
951 if (strEqual(path1, "."))
952 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
953 else if (strEqual(path2, "."))
954 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
955 else if (strEqual(path3, "."))
956 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
959 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
962 static char *getPngOrPcxIfNotExists(char *filename)
964 // switch from PNG to PCX file and vice versa, if file does not exist
965 // (backwards compatibility with PCX files used in previous versions)
967 if (!fileExists(filename) && strSuffix(filename, ".png"))
968 strcpy(&filename[strlen(filename) - 3], "pcx");
969 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
970 strcpy(&filename[strlen(filename) - 3], "png");
975 char *getImg2(char *path1, char *path2)
977 return getPngOrPcxIfNotExists(getPath2(path1, path2));
980 char *getImg3(char *path1, char *path2, char *path3)
982 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
985 char *getStringCopy(const char *s)
992 s_copy = checked_malloc(strlen(s) + 1);
998 char *getStringCopyN(const char *s, int n)
1001 int s_len = MAX(0, n);
1006 s_copy = checked_malloc(s_len + 1);
1007 strncpy(s_copy, s, s_len);
1008 s_copy[s_len] = '\0';
1013 char *getStringCopyNStatic(const char *s, int n)
1015 static char *s_copy = NULL;
1017 checked_free(s_copy);
1019 s_copy = getStringCopyN(s, n);
1024 char *getStringToLower(const char *s)
1026 char *s_copy = checked_malloc(strlen(s) + 1);
1027 char *s_ptr = s_copy;
1030 *s_ptr++ = tolower(*s++);
1036 void setString(char **old_value, char *new_value)
1038 checked_free(*old_value);
1040 *old_value = getStringCopy(new_value);
1043 boolean strEqual(char *s1, char *s2)
1045 return (s1 == NULL && s2 == NULL ? TRUE :
1046 s1 == NULL && s2 != NULL ? FALSE :
1047 s1 != NULL && s2 == NULL ? FALSE :
1048 strcmp(s1, s2) == 0);
1051 boolean strEqualN(char *s1, char *s2, int n)
1053 return (s1 == NULL && s2 == NULL ? TRUE :
1054 s1 == NULL && s2 != NULL ? FALSE :
1055 s1 != NULL && s2 == NULL ? FALSE :
1056 strncmp(s1, s2, n) == 0);
1059 boolean strPrefix(char *s, char *prefix)
1061 return (s == NULL && prefix == NULL ? TRUE :
1062 s == NULL && prefix != NULL ? FALSE :
1063 s != NULL && prefix == NULL ? FALSE :
1064 strncmp(s, prefix, strlen(prefix)) == 0);
1067 boolean strSuffix(char *s, char *suffix)
1069 return (s == NULL && suffix == NULL ? TRUE :
1070 s == NULL && suffix != NULL ? FALSE :
1071 s != NULL && suffix == NULL ? FALSE :
1072 strlen(s) < strlen(suffix) ? FALSE :
1073 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1076 boolean strPrefixLower(char *s, char *prefix)
1078 char *s_lower = getStringToLower(s);
1079 boolean match = strPrefix(s_lower, prefix);
1086 boolean strSuffixLower(char *s, char *suffix)
1088 char *s_lower = getStringToLower(s);
1089 boolean match = strSuffix(s_lower, suffix);
1097 // ----------------------------------------------------------------------------
1098 // command line option handling functions
1099 // ----------------------------------------------------------------------------
1101 void GetOptions(int argc, char *argv[],
1102 void (*print_usage_function)(void),
1103 void (*print_version_function)(void))
1105 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1106 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1107 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1108 char **options_left = &argvplus[1];
1110 // replace original "argv" with null-terminated array of string pointers
1112 argvplus[argc] = argv[argc];
1114 // initialize global program options
1115 options.server_host = NULL;
1116 options.server_port = 0;
1118 options.ro_base_directory = ro_base_path;
1119 options.rw_base_directory = rw_base_path;
1120 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1121 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1122 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1123 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1124 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1125 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1127 options.execute_command = NULL;
1128 options.special_flags = NULL;
1129 options.debug_mode = NULL;
1131 options.mytapes = FALSE;
1132 options.serveronly = FALSE;
1133 options.network = FALSE;
1134 options.verbose = FALSE;
1135 options.debug = FALSE;
1138 options.verbose = TRUE;
1140 #if !defined(PLATFORM_UNIX)
1141 if (*options_left == NULL) // no options given -- enable verbose mode
1142 options.verbose = TRUE;
1147 #if defined(PLATFORM_ANDROID)
1148 options.debug = TRUE;
1152 while (*options_left)
1154 char option_str[MAX_OPTION_LEN];
1155 char *option = options_left[0];
1156 char *next_option = options_left[1];
1157 char *option_arg = NULL;
1158 int option_len = strlen(option);
1160 if (option_len >= MAX_OPTION_LEN)
1161 FailWithHelp("unrecognized option '%s'", option);
1163 strcpy(option_str, option); // copy argument into buffer
1164 option = option_str;
1166 if (strEqual(option, "--")) // stop scanning arguments
1169 if (strPrefix(option, "--")) // treat '--' like '-'
1172 option_arg = strchr(option, '=');
1173 if (option_arg == NULL) // no '=' in option
1174 option_arg = next_option;
1177 *option_arg++ = '\0'; // cut argument from option
1178 if (*option_arg == '\0') // no argument after '='
1179 FailWithHelp("option '%s' has invalid argument", option_str);
1182 option_len = strlen(option);
1184 if (strEqual(option, "-"))
1186 FailWithHelp("unrecognized option '%s'", option);
1188 else if (strncmp(option, "-help", option_len) == 0)
1190 print_usage_function();
1194 else if (strncmp(option, "-basepath", option_len) == 0)
1196 if (option_arg == NULL)
1197 FailWithHelp("option '%s' requires an argument", option_str);
1199 // this should be extended to separate options for ro and rw data
1200 options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1201 options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1202 if (option_arg == next_option)
1205 // adjust paths for sub-directories in base directory accordingly
1206 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1207 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1208 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1209 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1210 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1211 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1213 else if (strncmp(option, "-levels", option_len) == 0)
1215 if (option_arg == NULL)
1216 FailWithHelp("option '%s' requires an argument", option_str);
1218 options.level_directory = getStringCopy(option_arg);
1219 if (option_arg == next_option)
1222 else if (strncmp(option, "-graphics", option_len) == 0)
1224 if (option_arg == NULL)
1225 FailWithHelp("option '%s' requires an argument", option_str);
1227 options.graphics_directory = getStringCopy(option_arg);
1228 if (option_arg == next_option)
1231 else if (strncmp(option, "-sounds", option_len) == 0)
1233 if (option_arg == NULL)
1234 FailWithHelp("option '%s' requires an argument", option_str);
1236 options.sounds_directory = getStringCopy(option_arg);
1237 if (option_arg == next_option)
1240 else if (strncmp(option, "-music", option_len) == 0)
1242 if (option_arg == NULL)
1243 FailWithHelp("option '%s' requires an argument", option_str);
1245 options.music_directory = getStringCopy(option_arg);
1246 if (option_arg == next_option)
1249 else if (strncmp(option, "-mytapes", option_len) == 0)
1251 options.mytapes = TRUE;
1253 else if (strncmp(option, "-network", option_len) == 0)
1255 options.network = TRUE;
1257 else if (strncmp(option, "-serveronly", option_len) == 0)
1259 options.serveronly = TRUE;
1261 else if (strncmp(option, "-debug", option_len) == 0)
1263 options.debug = TRUE;
1265 // optionally, debug output can be limited to a specific debug mode
1266 if (option_arg != next_option)
1267 options.debug_mode = getStringCopy(option_arg);
1269 else if (strncmp(option, "-verbose", option_len) == 0)
1271 options.verbose = TRUE;
1273 else if (strncmp(option, "-version", option_len) == 0 ||
1274 strncmp(option, "-V", option_len) == 0)
1276 print_version_function();
1280 else if (strPrefix(option, "-D"))
1282 options.special_flags = getStringCopy(&option[2]);
1284 else if (strncmp(option, "-execute", option_len) == 0)
1286 if (option_arg == NULL)
1287 FailWithHelp("option '%s' requires an argument", option_str);
1289 options.execute_command = getStringCopy(option_arg);
1290 if (option_arg == next_option)
1293 // when doing batch processing, always enable verbose mode (warnings)
1294 options.verbose = TRUE;
1296 #if defined(PLATFORM_MACOSX)
1297 else if (strPrefix(option, "-psn"))
1299 // ignore process serial number when launched via GUI on Mac OS X
1302 else if (*option == '-')
1304 FailWithHelp("unrecognized option '%s'", option_str);
1306 else if (options.server_host == NULL)
1308 options.server_host = *options_left;
1310 else if (options.server_port == 0)
1312 options.server_port = atoi(*options_left);
1313 if (options.server_port < 1024)
1314 FailWithHelp("bad port number '%d'", options.server_port);
1317 FailWithHelp("too many arguments");
1324 // ----------------------------------------------------------------------------
1325 // checked memory allocation and freeing functions
1326 // ----------------------------------------------------------------------------
1328 void *checked_malloc(unsigned int size)
1335 Fail("cannot allocate %d bytes -- out of memory", size);
1340 void *checked_calloc(unsigned int size)
1344 ptr = calloc(1, size);
1347 Fail("cannot allocate %d bytes -- out of memory", size);
1352 void *checked_realloc(void *ptr, unsigned int size)
1354 ptr = realloc(ptr, size);
1357 Fail("cannot allocate %d bytes -- out of memory", size);
1362 void checked_free(void *ptr)
1364 if (ptr != NULL) // this check should be done by free() anyway
1368 void clear_mem(void *ptr, unsigned int size)
1370 #if defined(PLATFORM_WIN32)
1371 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1372 char *cptr = (char *)ptr;
1377 memset(ptr, 0, size);
1382 // ----------------------------------------------------------------------------
1383 // various helper functions
1384 // ----------------------------------------------------------------------------
1386 void swap_numbers(int *i1, int *i2)
1394 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1406 /* the "put" variants of the following file access functions check for the file
1407 pointer being != NULL and return the number of bytes they have or would have
1408 written; this allows for chunk writing functions to first determine the size
1409 of the (not yet written) chunk, write the correct chunk size and finally
1410 write the chunk itself */
1412 int getFile8BitInteger(File *file)
1414 return getByteFromFile(file);
1417 int putFile8BitInteger(FILE *file, int value)
1425 int getFile16BitInteger(File *file, int byte_order)
1427 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1428 return ((getByteFromFile(file) << 8) |
1429 (getByteFromFile(file) << 0));
1430 else // BYTE_ORDER_LITTLE_ENDIAN
1431 return ((getByteFromFile(file) << 0) |
1432 (getByteFromFile(file) << 8));
1435 int putFile16BitInteger(FILE *file, int value, int byte_order)
1439 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1441 fputc((value >> 8) & 0xff, file);
1442 fputc((value >> 0) & 0xff, file);
1444 else // BYTE_ORDER_LITTLE_ENDIAN
1446 fputc((value >> 0) & 0xff, file);
1447 fputc((value >> 8) & 0xff, file);
1454 int getFile32BitInteger(File *file, int byte_order)
1456 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1457 return ((getByteFromFile(file) << 24) |
1458 (getByteFromFile(file) << 16) |
1459 (getByteFromFile(file) << 8) |
1460 (getByteFromFile(file) << 0));
1461 else // BYTE_ORDER_LITTLE_ENDIAN
1462 return ((getByteFromFile(file) << 0) |
1463 (getByteFromFile(file) << 8) |
1464 (getByteFromFile(file) << 16) |
1465 (getByteFromFile(file) << 24));
1468 int putFile32BitInteger(FILE *file, int value, int byte_order)
1472 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1474 fputc((value >> 24) & 0xff, file);
1475 fputc((value >> 16) & 0xff, file);
1476 fputc((value >> 8) & 0xff, file);
1477 fputc((value >> 0) & 0xff, file);
1479 else // BYTE_ORDER_LITTLE_ENDIAN
1481 fputc((value >> 0) & 0xff, file);
1482 fputc((value >> 8) & 0xff, file);
1483 fputc((value >> 16) & 0xff, file);
1484 fputc((value >> 24) & 0xff, file);
1491 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1494 const int chunk_name_length = 4;
1497 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1500 if (chunk_size != NULL)
1503 *chunk_size = getFile32BitInteger(file, byte_order);
1506 return (checkEndOfFile(file) ? FALSE : TRUE);
1509 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1516 fputs(chunk_name, file);
1518 num_bytes += strlen(chunk_name);
1520 if (chunk_size >= 0)
1524 putFile32BitInteger(file, chunk_size, byte_order);
1532 int getFileVersion(File *file)
1534 int version_super = getByteFromFile(file);
1535 int version_major = getByteFromFile(file);
1536 int version_minor = getByteFromFile(file);
1537 int version_patch = getByteFromFile(file);
1539 return VERSION_IDENT(version_super, version_major, version_minor,
1543 int putFileVersion(FILE *file, int version)
1547 int version_super = VERSION_SUPER(version);
1548 int version_major = VERSION_MAJOR(version);
1549 int version_minor = VERSION_MINOR(version);
1550 int version_patch = VERSION_PATCH(version);
1552 fputc(version_super, file);
1553 fputc(version_major, file);
1554 fputc(version_minor, file);
1555 fputc(version_patch, file);
1561 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1565 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1566 buffer[i] = getByteFromFile(file);
1569 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1573 for (i = 0; i < bytes; i++)
1574 fputc(buffer[i], file);
1577 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1579 while (bytes-- && !checkEndOfFile(file))
1580 getByteFromFile(file);
1583 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1590 // ----------------------------------------------------------------------------
1591 // functions to translate key identifiers between different format
1592 // ----------------------------------------------------------------------------
1594 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1595 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1596 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1597 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1599 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1608 // return and escape keys
1609 { KSYM_Return, "XK_Return", "return" },
1610 { KSYM_Escape, "XK_Escape", "escape" },
1612 // normal cursor keys
1613 { KSYM_Left, "XK_Left", "cursor left" },
1614 { KSYM_Right, "XK_Right", "cursor right" },
1615 { KSYM_Up, "XK_Up", "cursor up" },
1616 { KSYM_Down, "XK_Down", "cursor down" },
1618 // keypad cursor keys
1620 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1621 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1622 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1623 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1626 // other keypad keys
1627 #ifdef KSYM_KP_Enter
1628 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1629 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1630 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1631 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1632 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1633 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1637 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1638 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1639 { KSYM_Control_L, "XK_Control_L", "left control" },
1640 { KSYM_Control_R, "XK_Control_R", "right control" },
1641 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1642 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1643 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1644 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1645 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1646 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1648 // some special keys
1649 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1650 { KSYM_Delete, "XK_Delete", "delete" },
1651 { KSYM_Insert, "XK_Insert", "insert" },
1652 { KSYM_Tab, "XK_Tab", "tab" },
1653 { KSYM_Home, "XK_Home", "home" },
1654 { KSYM_End, "XK_End", "end" },
1655 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1656 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1658 { KSYM_Select, "XK_Select", "select" },
1659 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1660 { KSYM_Back, "XK_Back", "back" }, // back key
1661 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1662 #if defined(PLATFORM_ANDROID)
1663 { KSYM_Rewind, "XK_Rewind", "rewind" },
1664 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1667 // ASCII 0x20 to 0x40 keys (except numbers)
1668 { KSYM_space, "XK_space", "space" },
1669 { KSYM_exclam, "XK_exclam", "!" },
1670 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1671 { KSYM_numbersign, "XK_numbersign", "#" },
1672 { KSYM_dollar, "XK_dollar", "$" },
1673 { KSYM_percent, "XK_percent", "%" },
1674 { KSYM_ampersand, "XK_ampersand", "&" },
1675 { KSYM_apostrophe, "XK_apostrophe", "'" },
1676 { KSYM_parenleft, "XK_parenleft", "(" },
1677 { KSYM_parenright, "XK_parenright", ")" },
1678 { KSYM_asterisk, "XK_asterisk", "*" },
1679 { KSYM_plus, "XK_plus", "+" },
1680 { KSYM_comma, "XK_comma", "," },
1681 { KSYM_minus, "XK_minus", "-" },
1682 { KSYM_period, "XK_period", "." },
1683 { KSYM_slash, "XK_slash", "/" },
1684 { KSYM_colon, "XK_colon", ":" },
1685 { KSYM_semicolon, "XK_semicolon", ";" },
1686 { KSYM_less, "XK_less", "<" },
1687 { KSYM_equal, "XK_equal", "=" },
1688 { KSYM_greater, "XK_greater", ">" },
1689 { KSYM_question, "XK_question", "?" },
1690 { KSYM_at, "XK_at", "@" },
1693 { KSYM_bracketleft, "XK_bracketleft", "[" },
1694 { KSYM_backslash, "XK_backslash", "\\" },
1695 { KSYM_bracketright,"XK_bracketright", "]" },
1696 { KSYM_asciicircum, "XK_asciicircum", "^" },
1697 { KSYM_underscore, "XK_underscore", "_" },
1698 { KSYM_grave, "XK_grave", "grave" },
1699 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1700 { KSYM_braceleft, "XK_braceleft", "brace left" },
1701 { KSYM_bar, "XK_bar", "bar" },
1702 { KSYM_braceright, "XK_braceright", "brace right" },
1703 { KSYM_asciitilde, "XK_asciitilde", "~" },
1705 // special (non-ASCII) keys
1706 { KSYM_degree, "XK_degree", "degree" },
1707 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1708 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1709 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1710 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1711 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1712 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1713 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1715 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1716 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1717 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1718 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1719 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1720 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1721 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1722 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1723 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1725 // other keys (for reverse mapping only)
1726 { KSYM_space, "XK_space", " " },
1728 // keypad keys are not in numerical order in SDL2
1729 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1730 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1731 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1732 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1733 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1734 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1735 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1736 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1737 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1738 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1740 // end-of-array identifier
1746 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1748 static char name_buffer[30];
1751 if (key >= KSYM_A && key <= KSYM_Z)
1752 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1753 else if (key >= KSYM_a && key <= KSYM_z)
1754 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1755 else if (key >= KSYM_0 && key <= KSYM_9)
1756 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1757 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1758 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1759 else if (key == KSYM_UNDEFINED)
1760 strcpy(name_buffer, "(undefined)");
1767 if (key == translate_key[i].key)
1769 strcpy(name_buffer, translate_key[i].name);
1773 while (translate_key[++i].name);
1775 if (!translate_key[i].name)
1776 strcpy(name_buffer, "(unknown)");
1779 *name = name_buffer;
1781 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1783 static char name_buffer[30];
1786 if (key >= KSYM_A && key <= KSYM_Z)
1787 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1788 else if (key >= KSYM_a && key <= KSYM_z)
1789 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1790 else if (key >= KSYM_0 && key <= KSYM_9)
1791 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1792 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1793 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1794 else if (key == KSYM_UNDEFINED)
1795 strcpy(name_buffer, "[undefined]");
1802 if (key == translate_key[i].key)
1804 strcpy(name_buffer, translate_key[i].x11name);
1808 while (translate_key[++i].x11name);
1810 if (!translate_key[i].x11name)
1811 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1814 *x11name = name_buffer;
1816 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1818 Key key = KSYM_UNDEFINED;
1819 char *name_ptr = *name;
1821 if (strlen(*name) == 1)
1823 char c = name_ptr[0];
1825 if (c >= 'A' && c <= 'Z')
1826 key = KSYM_A + (Key)(c - 'A');
1827 else if (c >= 'a' && c <= 'z')
1828 key = KSYM_a + (Key)(c - 'a');
1829 else if (c >= '0' && c <= '9')
1830 key = KSYM_0 + (Key)(c - '0');
1833 if (key == KSYM_UNDEFINED)
1839 if (strEqual(translate_key[i].name, *name))
1841 key = translate_key[i].key;
1845 while (translate_key[++i].x11name);
1848 if (key == KSYM_UNDEFINED)
1849 Warn("getKeyFromKeyName(): not completely implemented");
1853 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1855 Key key = KSYM_UNDEFINED;
1856 char *name_ptr = *x11name;
1858 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1860 char c = name_ptr[3];
1862 if (c >= 'A' && c <= 'Z')
1863 key = KSYM_A + (Key)(c - 'A');
1864 else if (c >= 'a' && c <= 'z')
1865 key = KSYM_a + (Key)(c - 'a');
1866 else if (c >= '0' && c <= '9')
1867 key = KSYM_0 + (Key)(c - '0');
1869 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1871 char c1 = name_ptr[4];
1872 char c2 = name_ptr[5];
1875 if ((c1 >= '0' && c1 <= '9') &&
1876 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1877 d = atoi(&name_ptr[4]);
1879 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1880 key = KSYM_F1 + (Key)(d - 1);
1882 else if (strPrefix(name_ptr, "XK_"))
1888 if (strEqual(name_ptr, translate_key[i].x11name))
1890 key = translate_key[i].key;
1894 while (translate_key[++i].x11name);
1896 else if (strPrefix(name_ptr, "0x"))
1898 unsigned int value = 0;
1904 char c = *name_ptr++;
1907 if (c >= '0' && c <= '9')
1909 else if (c >= 'a' && c <= 'f')
1910 d = (int)(c - 'a' + 10);
1911 else if (c >= 'A' && c <= 'F')
1912 d = (int)(c - 'A' + 10);
1920 value = value * 16 + d;
1931 char *getKeyNameFromKey(Key key)
1935 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1939 char *getX11KeyNameFromKey(Key key)
1943 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1947 Key getKeyFromKeyName(char *name)
1951 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1955 Key getKeyFromX11KeyName(char *x11name)
1959 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1963 char getCharFromKey(Key key)
1969 } translate_key_char[] =
1971 // special (non-ASCII) keys (ISO-8859-1)
1972 { KSYM_degree, CHAR_BYTE_DEGREE },
1973 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1974 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1975 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1976 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1977 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1978 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1979 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1981 // end-of-array identifier
1985 char *keyname = getKeyNameFromKey(key);
1988 if (strlen(keyname) == 1)
1990 else if (strEqual(keyname, "space"))
1998 if (key == translate_key_char[i].key)
2000 c = translate_key_char[i].key_char;
2005 while (translate_key_char[++i].key_char);
2011 char getValidConfigValueChar(char c)
2013 if (c == '#' || // used to mark comments
2014 c == '\\') // used to mark continued lines
2021 // ----------------------------------------------------------------------------
2022 // functions to translate string identifiers to integer or boolean value
2023 // ----------------------------------------------------------------------------
2025 int get_integer_from_string(char *s)
2027 static char *number_text[][3] =
2029 { "0", "zero", "null", },
2030 { "1", "one", "first" },
2031 { "2", "two", "second" },
2032 { "3", "three", "third" },
2033 { "4", "four", "fourth" },
2034 { "5", "five", "fifth" },
2035 { "6", "six", "sixth" },
2036 { "7", "seven", "seventh" },
2037 { "8", "eight", "eighth" },
2038 { "9", "nine", "ninth" },
2039 { "10", "ten", "tenth" },
2040 { "11", "eleven", "eleventh" },
2041 { "12", "twelve", "twelfth" },
2043 { NULL, NULL, NULL },
2047 char *s_lower = getStringToLower(s);
2050 for (i = 0; number_text[i][0] != NULL; i++)
2051 for (j = 0; j < 3; j++)
2052 if (strEqual(s_lower, number_text[i][j]))
2057 if (strEqual(s_lower, "false") ||
2058 strEqual(s_lower, "no") ||
2059 strEqual(s_lower, "off"))
2061 else if (strEqual(s_lower, "true") ||
2062 strEqual(s_lower, "yes") ||
2063 strEqual(s_lower, "on"))
2074 boolean get_boolean_from_string(char *s)
2076 char *s_lower = getStringToLower(s);
2077 boolean result = FALSE;
2079 if (strEqual(s_lower, "true") ||
2080 strEqual(s_lower, "yes") ||
2081 strEqual(s_lower, "on") ||
2082 get_integer_from_string(s) == 1)
2090 int get_switch3_from_string(char *s)
2092 char *s_lower = getStringToLower(s);
2095 if (strEqual(s_lower, "true") ||
2096 strEqual(s_lower, "yes") ||
2097 strEqual(s_lower, "on") ||
2098 get_integer_from_string(s) == 1)
2100 else if (strEqual(s_lower, "auto"))
2108 int get_player_nr_from_string(char *s)
2110 static char *player_text[] =
2120 char *s_lower = getStringToLower(s);
2124 for (i = 0; player_text[i] != NULL; i++)
2125 if (strEqual(s_lower, player_text[i]))
2134 // ----------------------------------------------------------------------------
2135 // functions for generic lists
2136 // ----------------------------------------------------------------------------
2138 ListNode *newListNode(void)
2140 return checked_calloc(sizeof(ListNode));
2143 void addNodeToList(ListNode **node_first, char *key, void *content)
2145 ListNode *node_new = newListNode();
2147 node_new->key = getStringCopy(key);
2148 node_new->content = content;
2149 node_new->next = *node_first;
2152 (*node_first)->prev = node_new;
2154 *node_first = node_new;
2157 void deleteNodeFromList(ListNode **node_first, char *key,
2158 void (*destructor_function)(void *))
2160 if (node_first == NULL || *node_first == NULL)
2163 if (strEqual((*node_first)->key, key))
2165 // after first recursion, (*node_first)->prev->next == *node_first,
2166 // so *node_first would be overwritten with (*node_first)->next
2167 // => use a copy of *node_first (and later of (*node_first)->next)
2168 ListNode *node = *node_first;
2169 ListNode *node_next = node->next;
2171 checked_free(node->key);
2173 if (destructor_function)
2174 destructor_function(node->content);
2177 node->prev->next = node->next;
2180 node->next->prev = node->prev;
2184 // after removing node, set list pointer to next valid list node
2185 // (this is important if the first node of the list was deleted)
2186 *node_first = node_next;
2190 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2194 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2196 if (node_first == NULL)
2199 if (strEqual(node_first->key, key))
2202 return getNodeFromKey(node_first->next, key);
2205 int getNumNodes(ListNode *node_first)
2207 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2211 static void dumpList(ListNode *node_first)
2213 ListNode *node = node_first;
2217 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2218 ((struct ListNodeInfo *)node->content)->num_references);
2222 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2227 // ----------------------------------------------------------------------------
2228 // functions for file handling
2229 // ----------------------------------------------------------------------------
2231 #define MAX_BUFFER_SIZE 4096
2233 File *openFile(char *filename, char *mode)
2235 File *file = checked_calloc(sizeof(File));
2237 file->file = fopen(filename, mode);
2239 if (file->file != NULL)
2241 file->filename = getStringCopy(filename);
2246 #if defined(PLATFORM_ANDROID)
2247 file->asset_file = SDL_RWFromFile(filename, mode);
2249 if (file->asset_file != NULL)
2251 file->file_is_asset = TRUE;
2252 file->filename = getStringCopy(filename);
2263 int closeFile(File *file)
2270 #if defined(PLATFORM_ANDROID)
2271 if (file->asset_file)
2272 result = SDL_RWclose(file->asset_file);
2276 result = fclose(file->file);
2278 checked_free(file->filename);
2284 int checkEndOfFile(File *file)
2286 #if defined(PLATFORM_ANDROID)
2287 if (file->file_is_asset)
2288 return file->end_of_file;
2291 return feof(file->file);
2294 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2296 #if defined(PLATFORM_ANDROID)
2297 if (file->file_is_asset)
2299 if (file->end_of_file)
2302 size_t num_items_read =
2303 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2305 if (num_items_read < num_items)
2306 file->end_of_file = TRUE;
2308 return num_items_read;
2312 return fread(buffer, item_size, num_items, file->file);
2315 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2317 return fwrite(buffer, item_size, num_items, file->file);
2320 int seekFile(File *file, long offset, int whence)
2322 #if defined(PLATFORM_ANDROID)
2323 if (file->file_is_asset)
2325 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2326 whence == SEEK_CUR ? RW_SEEK_CUR :
2327 whence == SEEK_END ? RW_SEEK_END : 0);
2329 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2333 return fseek(file->file, offset, whence);
2336 int getByteFromFile(File *file)
2338 #if defined(PLATFORM_ANDROID)
2339 if (file->file_is_asset)
2341 if (file->end_of_file)
2345 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2347 if (num_bytes_read < 1)
2348 file->end_of_file = TRUE;
2350 return (file->end_of_file ? EOF : (int)c);
2354 return fgetc(file->file);
2357 char *getStringFromFile(File *file, char *line, int size)
2359 #if defined(PLATFORM_ANDROID)
2360 if (file->file_is_asset)
2362 if (file->end_of_file)
2365 char *line_ptr = line;
2366 int num_bytes_read = 0;
2368 while (num_bytes_read < size - 1 &&
2369 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2370 *line_ptr++ != '\n')
2375 if (strlen(line) == 0)
2377 file->end_of_file = TRUE;
2386 return fgets(line, size, file->file);
2389 int copyFile(char *filename_from, char *filename_to)
2391 File *file_from, *file_to;
2393 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2398 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2400 closeFile(file_from);
2405 while (!checkEndOfFile(file_from))
2407 byte buffer[MAX_BUFFER_SIZE];
2408 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2410 writeFile(file_to, buffer, 1, bytes_read);
2413 closeFile(file_from);
2420 // ----------------------------------------------------------------------------
2421 // functions for directory handling
2422 // ----------------------------------------------------------------------------
2424 Directory *openDirectory(char *dir_name)
2426 Directory *dir = checked_calloc(sizeof(Directory));
2428 dir->dir = opendir(dir_name);
2430 if (dir->dir != NULL)
2432 dir->filename = getStringCopy(dir_name);
2437 #if defined(PLATFORM_ANDROID)
2438 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2440 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2442 checked_free(asset_toc_filename);
2444 if (dir->asset_toc_file != NULL)
2446 dir->directory_is_asset = TRUE;
2447 dir->filename = getStringCopy(dir_name);
2458 int closeDirectory(Directory *dir)
2465 #if defined(PLATFORM_ANDROID)
2466 if (dir->asset_toc_file)
2467 result = SDL_RWclose(dir->asset_toc_file);
2471 result = closedir(dir->dir);
2474 freeDirectoryEntry(dir->dir_entry);
2476 checked_free(dir->filename);
2482 DirectoryEntry *readDirectory(Directory *dir)
2485 freeDirectoryEntry(dir->dir_entry);
2487 dir->dir_entry = NULL;
2489 #if defined(PLATFORM_ANDROID)
2490 if (dir->directory_is_asset)
2492 char line[MAX_LINE_LEN];
2493 char *line_ptr = line;
2494 int num_bytes_read = 0;
2496 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2497 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2506 if (strlen(line) == 0)
2509 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2511 dir->dir_entry->is_directory = FALSE;
2512 if (line[strlen(line) - 1] == '/')
2514 dir->dir_entry->is_directory = TRUE;
2516 line[strlen(line) - 1] = '\0';
2519 dir->dir_entry->basename = getStringCopy(line);
2520 dir->dir_entry->filename = getPath2(dir->filename, line);
2522 return dir->dir_entry;
2526 struct dirent *dir_entry = readdir(dir->dir);
2528 if (dir_entry == NULL)
2531 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2533 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2534 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2536 struct stat file_status;
2538 dir->dir_entry->is_directory =
2539 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2540 S_ISDIR(file_status.st_mode));
2542 return dir->dir_entry;
2545 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2547 if (dir_entry == NULL)
2550 checked_free(dir_entry->basename);
2551 checked_free(dir_entry->filename);
2552 checked_free(dir_entry);
2556 // ----------------------------------------------------------------------------
2557 // functions for checking files and filenames
2558 // ----------------------------------------------------------------------------
2560 boolean directoryExists(char *dir_name)
2562 if (dir_name == NULL)
2565 struct stat file_status;
2566 boolean success = (stat(dir_name, &file_status) == 0 &&
2567 S_ISDIR(file_status.st_mode));
2569 #if defined(PLATFORM_ANDROID)
2572 // this might be an asset directory; check by trying to open toc file
2573 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2574 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2576 checked_free(asset_toc_filename);
2578 success = (file != NULL);
2588 boolean fileExists(char *filename)
2590 if (filename == NULL)
2593 boolean success = (access(filename, F_OK) == 0);
2595 #if defined(PLATFORM_ANDROID)
2598 // this might be an asset file; check by trying to open it
2599 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2601 success = (file != NULL);
2612 static boolean fileHasPrefix(char *basename, char *prefix)
2614 static char *basename_lower = NULL;
2615 int basename_length, prefix_length;
2617 checked_free(basename_lower);
2619 if (basename == NULL || prefix == NULL)
2622 basename_lower = getStringToLower(basename);
2623 basename_length = strlen(basename_lower);
2624 prefix_length = strlen(prefix);
2626 if (basename_length > prefix_length + 1 &&
2627 basename_lower[prefix_length] == '.' &&
2628 strncmp(basename_lower, prefix, prefix_length) == 0)
2635 static boolean fileHasSuffix(char *basename, char *suffix)
2637 static char *basename_lower = NULL;
2638 int basename_length, suffix_length;
2640 checked_free(basename_lower);
2642 if (basename == NULL || suffix == NULL)
2645 basename_lower = getStringToLower(basename);
2646 basename_length = strlen(basename_lower);
2647 suffix_length = strlen(suffix);
2649 if (basename_length > suffix_length + 1 &&
2650 basename_lower[basename_length - suffix_length - 1] == '.' &&
2651 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2657 static boolean FileCouldBeArtwork(char *filename)
2659 char *basename = getBaseNamePtr(filename);
2661 return (!strEqual(basename, ".") &&
2662 !strEqual(basename, "..") &&
2663 !fileHasSuffix(basename, "txt") &&
2664 !fileHasSuffix(basename, "conf") &&
2665 !directoryExists(filename));
2668 boolean FileIsGraphic(char *filename)
2670 return FileCouldBeArtwork(filename);
2673 boolean FileIsSound(char *filename)
2675 return FileCouldBeArtwork(filename);
2678 boolean FileIsMusic(char *filename)
2680 return FileCouldBeArtwork(filename);
2683 boolean FileIsArtworkType(char *filename, int type)
2685 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2686 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2687 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2693 // ----------------------------------------------------------------------------
2694 // functions for loading artwork configuration information
2695 // ----------------------------------------------------------------------------
2697 char *get_mapped_token(char *token)
2699 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2700 static char *map_token_prefix[][2] =
2702 { "char_procent", "char_percent" },
2703 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2704 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2705 { "bd_butterfly_left", "bd_butterfly.left" },
2706 { "bd_butterfly_right", "bd_butterfly.right" },
2707 { "bd_butterfly_up", "bd_butterfly.up" },
2708 { "bd_butterfly_down", "bd_butterfly.down" },
2709 { "bd_firefly_left", "bd_firefly.left" },
2710 { "bd_firefly_right", "bd_firefly.right" },
2711 { "bd_firefly_up", "bd_firefly.up" },
2712 { "bd_firefly_down", "bd_firefly.down" },
2718 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2720 int len_token_prefix = strlen(map_token_prefix[i][0]);
2722 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2723 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2726 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2727 char *gfx_substring = ".gfx";
2728 char *gfx_prefix = "gfx.";
2729 if (strstr(token, gfx_substring) != NULL)
2731 char *token_prefix = getStringCopy(token);
2732 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2733 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2736 // cut off token string at ".gfx" substring position
2737 *token_gfx_pos = '\0';
2739 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2740 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2744 return mapped_token;
2750 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2753 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2754 static struct ConfigTypeInfo prefix_list[] =
2756 { "global.anim_1" },
2757 { "global.anim_2" },
2758 { "global.anim_3" },
2759 { "global.anim_4" },
2760 { "global.anim_5" },
2761 { "global.anim_6" },
2762 { "global.anim_7" },
2763 { "global.anim_8" },
2764 { "global.anim_9" },
2765 { "global.anim_10" },
2766 { "global.anim_11" },
2767 { "global.anim_12" },
2768 { "global.anim_13" },
2769 { "global.anim_14" },
2770 { "global.anim_15" },
2771 { "global.anim_16" },
2772 { "global.anim_17" },
2773 { "global.anim_18" },
2774 { "global.anim_19" },
2775 { "global.anim_20" },
2776 { "global.anim_21" },
2777 { "global.anim_22" },
2778 { "global.anim_23" },
2779 { "global.anim_24" },
2780 { "global.anim_25" },
2781 { "global.anim_26" },
2782 { "global.anim_27" },
2783 { "global.anim_28" },
2784 { "global.anim_29" },
2785 { "global.anim_30" },
2786 { "global.anim_31" },
2787 { "global.anim_32" },
2791 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2792 boolean prefix_found = FALSE;
2796 // search for prefix to check if base token has to be created
2797 for (i = 0; prefix_list[i].token != NULL; i++)
2798 if (strPrefix(token, prefix_list[i].token))
2799 prefix_found = TRUE;
2804 // search for suffix (parameter) to determine base token length
2805 for (i = 0; suffix_list[i].token != NULL; i++)
2806 if (strSuffix(token, suffix_list[i].token))
2807 len_suffix = strlen(suffix_list[i].token);
2809 return getStringCopyN(token, strlen(token) - len_suffix);
2812 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2813 struct ListNodeInfo ***, int *);
2815 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2816 struct ConfigTypeInfo *suffix_list,
2817 char **ignore_tokens,
2818 int num_file_list_entries)
2820 SetupFileHash *ignore_tokens_hash;
2821 struct FileInfo *file_list;
2822 int num_file_list_entries_found = 0;
2823 int num_suffix_list_entries = 0;
2827 // create hash from list of tokens to be ignored (for quick access)
2828 ignore_tokens_hash = newSetupFileHash();
2829 for (i = 0; ignore_tokens[i] != NULL; i++)
2830 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2832 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2834 for (i = 0; suffix_list[i].token != NULL; i++)
2835 num_suffix_list_entries++;
2837 // always start with reliable default values
2838 for (i = 0; i < num_file_list_entries; i++)
2840 file_list[i].token = NULL;
2842 file_list[i].default_filename = NULL;
2843 file_list[i].filename = NULL;
2845 if (num_suffix_list_entries > 0)
2847 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2849 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2850 file_list[i].parameter = checked_calloc(parameter_array_size);
2852 for (j = 0; j < num_suffix_list_entries; j++)
2854 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2855 setString(&file_list[i].parameter[j], suffix_list[j].value);
2858 file_list[i].redefined = FALSE;
2859 file_list[i].fallback_to_default = FALSE;
2860 file_list[i].default_is_cloned = FALSE;
2866 for (i = 0; config_list[i].token != NULL; i++)
2868 int len_config_token = strlen(config_list[i].token);
2869 boolean is_file_entry = TRUE;
2871 for (j = 0; suffix_list[j].token != NULL; j++)
2873 int len_suffix = strlen(suffix_list[j].token);
2875 if (len_suffix < len_config_token &&
2876 strEqual(&config_list[i].token[len_config_token - len_suffix],
2877 suffix_list[j].token))
2879 setString(&file_list[list_pos].default_parameter[j],
2880 config_list[i].value);
2882 is_file_entry = FALSE;
2888 // the following tokens are no file definitions, but other config tokens
2889 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
2890 is_file_entry = FALSE;
2897 if (list_pos >= num_file_list_entries)
2900 file_list[list_pos].token = config_list[i].token;
2901 file_list[list_pos].default_filename = config_list[i].value;
2904 if (strSuffix(config_list[i].token, ".clone_from"))
2905 file_list[list_pos].default_is_cloned = TRUE;
2908 num_file_list_entries_found = list_pos + 1;
2909 if (num_file_list_entries_found != num_file_list_entries)
2912 Error("inconsistant config list information:");
2913 Error("- should be: %d (according to 'src/conf_xxx.h')",
2914 num_file_list_entries);
2915 Error("- found to be: %d (according to 'src/conf_xxx.c')",
2916 num_file_list_entries_found);
2921 freeSetupFileHash(ignore_tokens_hash);
2926 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2928 int len_token = strlen(token);
2929 int len_suffix = strlen(suffix);
2931 if (start_pos < 0) // compare suffix from end of string
2932 start_pos += len_token;
2934 if (start_pos < 0 || start_pos + len_suffix > len_token)
2937 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2940 if (token[start_pos + len_suffix] == '\0')
2943 if (token[start_pos + len_suffix] == '.')
2949 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2951 static void read_token_parameters(SetupFileHash *setup_file_hash,
2952 struct ConfigTypeInfo *suffix_list,
2953 struct FileInfo *file_list_entry)
2955 // check for config token that is the base token without any suffixes
2956 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2957 char *known_token_value = KNOWN_TOKEN_VALUE;
2960 if (filename != NULL)
2962 setString(&file_list_entry->filename, filename);
2964 // when file definition found, set all parameters to default values
2965 for (i = 0; suffix_list[i].token != NULL; i++)
2966 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2968 file_list_entry->redefined = TRUE;
2970 // mark config file token as well known from default config
2971 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2974 // check for config tokens that can be build by base token and suffixes
2975 for (i = 0; suffix_list[i].token != NULL; i++)
2977 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2978 char *value = getHashEntry(setup_file_hash, token);
2982 setString(&file_list_entry->parameter[i], value);
2984 // mark config file token as well known from default config
2985 setHashEntry(setup_file_hash, token, known_token_value);
2992 static void add_dynamic_file_list_entry(struct FileInfo **list,
2993 int *num_list_entries,
2994 SetupFileHash *extra_file_hash,
2995 struct ConfigTypeInfo *suffix_list,
2996 int num_suffix_list_entries,
2999 struct FileInfo *new_list_entry;
3000 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3002 (*num_list_entries)++;
3003 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3004 new_list_entry = &(*list)[*num_list_entries - 1];
3006 new_list_entry->token = getStringCopy(token);
3007 new_list_entry->default_filename = NULL;
3008 new_list_entry->filename = NULL;
3009 new_list_entry->parameter = checked_calloc(parameter_array_size);
3011 new_list_entry->redefined = FALSE;
3012 new_list_entry->fallback_to_default = FALSE;
3013 new_list_entry->default_is_cloned = FALSE;
3015 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3018 static void add_property_mapping(struct PropertyMapping **list,
3019 int *num_list_entries,
3020 int base_index, int ext1_index,
3021 int ext2_index, int ext3_index,
3024 struct PropertyMapping *new_list_entry;
3026 (*num_list_entries)++;
3027 *list = checked_realloc(*list,
3028 *num_list_entries * sizeof(struct PropertyMapping));
3029 new_list_entry = &(*list)[*num_list_entries - 1];
3031 new_list_entry->base_index = base_index;
3032 new_list_entry->ext1_index = ext1_index;
3033 new_list_entry->ext2_index = ext2_index;
3034 new_list_entry->ext3_index = ext3_index;
3036 new_list_entry->artwork_index = artwork_index;
3039 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3042 struct FileInfo *file_list = artwork_info->file_list;
3043 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3044 char **base_prefixes = artwork_info->base_prefixes;
3045 char **ext1_suffixes = artwork_info->ext1_suffixes;
3046 char **ext2_suffixes = artwork_info->ext2_suffixes;
3047 char **ext3_suffixes = artwork_info->ext3_suffixes;
3048 char **ignore_tokens = artwork_info->ignore_tokens;
3049 int num_file_list_entries = artwork_info->num_file_list_entries;
3050 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3051 int num_base_prefixes = artwork_info->num_base_prefixes;
3052 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3053 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3054 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3055 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3056 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3057 SetupFileHash *extra_file_hash, *empty_file_hash;
3058 char *known_token_value = KNOWN_TOKEN_VALUE;
3059 char *base_token_value = UNDEFINED_FILENAME;
3062 if (filename == NULL)
3065 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3068 // separate valid (defined) from empty (undefined) config token values
3069 valid_file_hash = newSetupFileHash();
3070 empty_file_hash = newSetupFileHash();
3071 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3073 char *value = HASH_ITERATION_VALUE(itr);
3075 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3076 HASH_ITERATION_TOKEN(itr), value);
3078 END_HASH_ITERATION(setup_file_hash, itr)
3080 // at this point, we do not need the setup file hash anymore -- free it
3081 freeSetupFileHash(setup_file_hash);
3083 // prevent changing hash while iterating over it by using a temporary copy
3084 valid_file_hash_tmp = newSetupFileHash();
3085 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3087 setHashEntry(valid_file_hash_tmp,
3088 HASH_ITERATION_TOKEN(itr),
3089 HASH_ITERATION_VALUE(itr));
3091 END_HASH_ITERATION(valid_file_hash, itr)
3093 // (iterate over same temporary hash, as modifications are independent)
3095 // map deprecated to current tokens (using prefix match and replace)
3096 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3098 char *token = HASH_ITERATION_TOKEN(itr);
3099 char *mapped_token = get_mapped_token(token);
3101 if (mapped_token != NULL)
3103 char *value = HASH_ITERATION_VALUE(itr);
3106 setHashEntry(valid_file_hash, mapped_token, value);
3108 // ignore old token (by setting it to "known" keyword)
3109 setHashEntry(valid_file_hash, token, known_token_value);
3114 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3116 // add special base tokens (using prefix match and replace)
3117 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3119 char *token = HASH_ITERATION_TOKEN(itr);
3120 char *base_token = get_special_base_token(artwork_info, token);
3122 if (base_token != NULL)
3124 // add base token only if it does not already exist
3125 if (getHashEntry(valid_file_hash, base_token) == NULL)
3126 setHashEntry(valid_file_hash, base_token, base_token_value);
3131 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3133 // free temporary hash used for iteration
3134 freeSetupFileHash(valid_file_hash_tmp);
3136 // read parameters for all known config file tokens
3137 for (i = 0; i < num_file_list_entries; i++)
3138 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3140 // set all tokens that can be ignored here to "known" keyword
3141 for (i = 0; i < num_ignore_tokens; i++)
3142 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3144 // copy all unknown config file tokens to extra config hash
3145 extra_file_hash = newSetupFileHash();
3146 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3148 char *value = HASH_ITERATION_VALUE(itr);
3150 if (!strEqual(value, known_token_value))
3151 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3153 END_HASH_ITERATION(valid_file_hash, itr)
3155 // at this point, we do not need the valid file hash anymore -- free it
3156 freeSetupFileHash(valid_file_hash);
3158 // now try to determine valid, dynamically defined config tokens
3160 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3162 struct FileInfo **dynamic_file_list =
3163 &artwork_info->dynamic_file_list;
3164 int *num_dynamic_file_list_entries =
3165 &artwork_info->num_dynamic_file_list_entries;
3166 struct PropertyMapping **property_mapping =
3167 &artwork_info->property_mapping;
3168 int *num_property_mapping_entries =
3169 &artwork_info->num_property_mapping_entries;
3170 int current_summarized_file_list_entry =
3171 artwork_info->num_file_list_entries +
3172 artwork_info->num_dynamic_file_list_entries;
3173 char *token = HASH_ITERATION_TOKEN(itr);
3174 int len_token = strlen(token);
3176 boolean base_prefix_found = FALSE;
3177 boolean parameter_suffix_found = FALSE;
3179 // skip all parameter definitions (handled by read_token_parameters())
3180 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3182 int len_suffix = strlen(suffix_list[i].token);
3184 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3185 parameter_suffix_found = TRUE;
3188 if (parameter_suffix_found)
3191 // ---------- step 0: search for matching base prefix ----------
3194 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3196 char *base_prefix = base_prefixes[i];
3197 int len_base_prefix = strlen(base_prefix);
3198 boolean ext1_suffix_found = FALSE;
3199 boolean ext2_suffix_found = FALSE;
3200 boolean ext3_suffix_found = FALSE;
3201 boolean exact_match = FALSE;
3202 int base_index = -1;
3203 int ext1_index = -1;
3204 int ext2_index = -1;
3205 int ext3_index = -1;
3207 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3209 if (!base_prefix_found)
3214 if (start_pos + len_base_prefix == len_token) // exact match
3218 add_dynamic_file_list_entry(dynamic_file_list,
3219 num_dynamic_file_list_entries,
3222 num_suffix_list_entries,
3224 add_property_mapping(property_mapping,
3225 num_property_mapping_entries,
3226 base_index, -1, -1, -1,
3227 current_summarized_file_list_entry);
3231 // ---------- step 1: search for matching first suffix ----------
3233 start_pos += len_base_prefix;
3234 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3236 char *ext1_suffix = ext1_suffixes[j];
3237 int len_ext1_suffix = strlen(ext1_suffix);
3239 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3241 if (!ext1_suffix_found)
3246 if (start_pos + len_ext1_suffix == len_token) // exact match
3250 add_dynamic_file_list_entry(dynamic_file_list,
3251 num_dynamic_file_list_entries,
3254 num_suffix_list_entries,
3256 add_property_mapping(property_mapping,
3257 num_property_mapping_entries,
3258 base_index, ext1_index, -1, -1,
3259 current_summarized_file_list_entry);
3263 start_pos += len_ext1_suffix;
3269 // ---------- step 2: search for matching second suffix ----------
3271 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3273 char *ext2_suffix = ext2_suffixes[k];
3274 int len_ext2_suffix = strlen(ext2_suffix);
3276 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3278 if (!ext2_suffix_found)
3283 if (start_pos + len_ext2_suffix == len_token) // exact match
3287 add_dynamic_file_list_entry(dynamic_file_list,
3288 num_dynamic_file_list_entries,
3291 num_suffix_list_entries,
3293 add_property_mapping(property_mapping,
3294 num_property_mapping_entries,
3295 base_index, ext1_index, ext2_index, -1,
3296 current_summarized_file_list_entry);
3300 start_pos += len_ext2_suffix;
3306 // ---------- step 3: search for matching third suffix ----------
3308 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3310 char *ext3_suffix = ext3_suffixes[l];
3311 int len_ext3_suffix = strlen(ext3_suffix);
3313 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3315 if (!ext3_suffix_found)
3320 if (start_pos + len_ext3_suffix == len_token) // exact match
3324 add_dynamic_file_list_entry(dynamic_file_list,
3325 num_dynamic_file_list_entries,
3328 num_suffix_list_entries,
3330 add_property_mapping(property_mapping,
3331 num_property_mapping_entries,
3332 base_index, ext1_index, ext2_index, ext3_index,
3333 current_summarized_file_list_entry);
3339 END_HASH_ITERATION(extra_file_hash, itr)
3341 if (artwork_info->num_dynamic_file_list_entries > 0)
3343 artwork_info->dynamic_artwork_list =
3344 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3345 artwork_info->sizeof_artwork_list_entry);
3348 if (options.verbose && IS_PARENT_PROCESS())
3350 SetupFileList *setup_file_list, *list;
3351 boolean dynamic_tokens_found = FALSE;
3352 boolean unknown_tokens_found = FALSE;
3353 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3355 // list may be NULL for empty artwork config files
3356 setup_file_list = loadSetupFileList(filename);
3358 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3360 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3361 dynamic_tokens_found = TRUE;
3363 unknown_tokens_found = TRUE;
3365 END_HASH_ITERATION(extra_file_hash, itr)
3367 if (options.debug && dynamic_tokens_found)
3369 Debug("config", "---");
3370 Debug("config", "dynamic token(s) found in config file:");
3371 Debug("config", "- config file: '%s'", filename);
3373 for (list = setup_file_list; list != NULL; list = list->next)
3375 char *value = getHashEntry(extra_file_hash, list->token);
3377 if (value != NULL && strEqual(value, known_token_value))
3378 Debug("config", "- dynamic token: '%s'", list->token);
3381 Debug("config", "---");
3384 if (unknown_tokens_found)
3387 Warn("unknown token(s) found in config file:");
3388 Warn("- config file: '%s'", filename);
3390 for (list = setup_file_list; list != NULL; list = list->next)
3392 char *value = getHashEntry(extra_file_hash, list->token);
3394 if (value != NULL && !strEqual(value, known_token_value))
3395 Warn("- dynamic token: '%s'", list->token);
3401 if (undefined_values_found)
3404 Warn("undefined values found in config file:");
3405 Warn("- config file: '%s'", filename);
3407 for (list = setup_file_list; list != NULL; list = list->next)
3409 char *value = getHashEntry(empty_file_hash, list->token);
3412 Warn("- undefined value for token: '%s'", list->token);
3418 freeSetupFileList(setup_file_list);
3421 freeSetupFileHash(extra_file_hash);
3422 freeSetupFileHash(empty_file_hash);
3425 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3427 struct FileInfo *file_list = artwork_info->file_list;
3428 int num_file_list_entries = artwork_info->num_file_list_entries;
3429 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3430 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3433 DrawInitText("Loading artwork config", 120, FC_GREEN);
3434 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3436 // always start with reliable default values
3437 for (i = 0; i < num_file_list_entries; i++)
3439 setString(&file_list[i].filename, file_list[i].default_filename);
3441 for (j = 0; j < num_suffix_list_entries; j++)
3442 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3444 file_list[i].redefined = FALSE;
3445 file_list[i].fallback_to_default = FALSE;
3448 // free previous dynamic artwork file array
3449 if (artwork_info->dynamic_file_list != NULL)
3451 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3453 free(artwork_info->dynamic_file_list[i].token);
3454 free(artwork_info->dynamic_file_list[i].filename);
3455 free(artwork_info->dynamic_file_list[i].parameter);
3458 free(artwork_info->dynamic_file_list);
3459 artwork_info->dynamic_file_list = NULL;
3461 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3462 &artwork_info->num_dynamic_file_list_entries);
3465 // free previous property mapping
3466 if (artwork_info->property_mapping != NULL)
3468 free(artwork_info->property_mapping);
3470 artwork_info->property_mapping = NULL;
3471 artwork_info->num_property_mapping_entries = 0;
3474 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3476 // first look for special artwork configured in level series config
3477 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3479 if (fileExists(filename_base))
3480 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3483 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3485 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3486 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3489 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3490 struct ListNodeInfo **listnode)
3494 char *filename = (*listnode)->source_filename;
3496 if (--(*listnode)->num_references <= 0)
3497 deleteNodeFromList(&artwork_info->content_list, filename,
3498 artwork_info->free_artwork);
3504 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3505 struct ListNodeInfo **listnode,
3506 struct FileInfo *file_list_entry)
3516 char *basename = file_list_entry->filename;
3517 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3519 if (filename == NULL)
3521 Warn("cannot find artwork file '%s'", basename);
3523 basename = file_list_entry->default_filename;
3525 // fail for cloned default artwork that has no default filename defined
3526 if (file_list_entry->default_is_cloned &&
3527 strEqual(basename, UNDEFINED_FILENAME))
3529 void (*error_func)(char *, ...) = Warn;
3531 // we can get away without sounds and music, but not without graphics
3532 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3535 error_func("token '%s' was cloned and has no default filename",
3536 file_list_entry->token);
3541 // dynamic artwork has no default filename / skip empty default artwork
3542 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3545 file_list_entry->fallback_to_default = TRUE;
3547 Warn("trying default artwork file '%s'", basename);
3549 filename = getCustomArtworkFilename(basename, artwork_info->type);
3551 if (filename == NULL)
3553 void (*error_func)(char *, ...) = Warn;
3555 // we can get away without sounds and music, but not without graphics
3556 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3559 error_func("cannot find default artwork file '%s'", basename);
3565 // check if the old and the new artwork file are the same
3566 if (*listnode && strEqual((*listnode)->source_filename, filename))
3568 // The old and new artwork are the same (have the same filename and path).
3569 // This usually means that this artwork does not exist in this artwork set
3570 // and a fallback to the existing artwork is done.
3575 // delete existing artwork file entry
3576 deleteArtworkListEntry(artwork_info, listnode);
3578 // check if the new artwork file already exists in the list of artwork
3579 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3581 *listnode = (struct ListNodeInfo *)node->content;
3582 (*listnode)->num_references++;
3587 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3588 DrawInitText(basename, 150, FC_YELLOW);
3590 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3592 // add new artwork file entry to the list of artwork files
3593 (*listnode)->num_references = 1;
3594 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3599 void (*error_func)(char *, ...) = Warn;
3601 // we can get away without sounds and music, but not without graphics
3602 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3605 error_func("cannot load artwork file '%s'", basename);
3611 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3612 struct ListNodeInfo **listnode,
3613 struct FileInfo *file_list_entry)
3615 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3617 deleteArtworkListEntry(artwork_info, listnode);
3622 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3625 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3627 struct FileInfo *file_list = artwork_info->file_list;
3628 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3629 int num_file_list_entries = artwork_info->num_file_list_entries;
3630 int num_dynamic_file_list_entries =
3631 artwork_info->num_dynamic_file_list_entries;
3634 print_timestamp_init("ReloadCustomArtworkList");
3636 for (i = 0; i < num_file_list_entries; i++)
3637 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3640 for (i = 0; i < num_dynamic_file_list_entries; i++)
3641 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3642 &dynamic_file_list[i]);
3644 print_timestamp_done("ReloadCustomArtworkList");
3647 dumpList(artwork_info->content_list);
3651 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3652 struct ListNodeInfo ***list,
3653 int *num_list_entries)
3660 for (i = 0; i < *num_list_entries; i++)
3661 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3665 *num_list_entries = 0;
3668 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3670 if (artwork_info == NULL)
3673 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3674 &artwork_info->num_file_list_entries);
3676 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3677 &artwork_info->num_dynamic_file_list_entries);
3681 // ----------------------------------------------------------------------------
3682 // functions only needed for non-Unix (non-command-line) systems
3683 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3684 // (now also added for Windows, to create files in user data directory)
3685 // ----------------------------------------------------------------------------
3687 char *getLogFilename(char *basename)
3689 return getPath2(getUserGameDataDir(), basename);
3692 void OpenLogFiles(void)
3696 InitUserDataDirectory();
3698 for (i = 0; i < NUM_LOGS; i++)
3700 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3703 program.log_file[i] = program.log_file_default[i]; // reset to default
3705 Warn("cannot open file '%s' for writing: %s",
3706 program.log_filename[i], strerror(errno));
3709 // output should be unbuffered so it is not truncated in a crash
3710 setbuf(program.log_file[i], NULL);
3714 void CloseLogFiles(void)
3718 for (i = 0; i < NUM_LOGS; i++)
3719 if (program.log_file[i] != program.log_file_default[i])
3720 fclose(program.log_file[i]);
3723 void DumpLogFile(int nr)
3725 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3727 if (log_file == NULL)
3730 while (!feof(log_file))
3731 fputc(fgetc(log_file), stdout);
3736 void NotifyUserAboutErrorFile(void)
3738 #if defined(PLATFORM_WIN32)
3739 char *title_text = getStringCat2(program.program_title, " Error Message");
3740 char *error_text = getStringCat2("The program was aborted due to an error; "
3741 "for details, see the following error file:"
3743 program.log_filename[LOG_ERR_ID]);
3745 MessageBox(NULL, error_text, title_text, MB_OK);
3750 // ----------------------------------------------------------------------------
3751 // the following is only for debugging purpose and normally not used
3752 // ----------------------------------------------------------------------------
3756 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3757 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3759 #define DEBUG_NUM_TIMESTAMPS 10
3760 #define DEBUG_TIME_IN_MICROSECONDS 0
3762 #if DEBUG_TIME_IN_MICROSECONDS
3763 static double Counter_Microseconds(void)
3765 static struct timeval base_time = { 0, 0 };
3766 struct timeval current_time;
3769 gettimeofday(¤t_time, NULL);
3771 // reset base time in case of wrap-around
3772 if (current_time.tv_sec < base_time.tv_sec)
3773 base_time = current_time;
3776 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3777 ((double)(current_time.tv_usec - base_time.tv_usec));
3779 return counter; // return microseconds since last init
3783 static char *debug_print_timestamp_get_padding(int padding_size)
3785 static char *padding = NULL;
3786 int max_padding_size = 100;
3788 if (padding == NULL)
3790 padding = checked_calloc(max_padding_size + 1);
3791 memset(padding, ' ', max_padding_size);
3794 return &padding[MAX(0, max_padding_size - padding_size)];
3797 void debug_print_timestamp(int counter_nr, char *message)
3799 int indent_size = 8;
3800 int padding_size = 40;
3801 float timestamp_interval;
3804 Fail("debugging: invalid negative counter");
3805 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3806 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3808 #if DEBUG_TIME_IN_MICROSECONDS
3809 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3812 counter[counter_nr][0] = Counter_Microseconds();
3814 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3817 counter[counter_nr][0] = Counter();
3820 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3821 counter[counter_nr][1] = counter[counter_nr][0];
3824 Debug("time", "%s%s%s %.3f %s",
3825 debug_print_timestamp_get_padding(counter_nr * indent_size),
3827 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3828 timestamp_interval / 1000,
3833 static void debug_print_parent_only(char *format, ...)
3835 if (!IS_PARENT_PROCESS())
3842 va_start(ap, format);
3843 vprintf(format, ap);
3853 static void print_timestamp_ext(char *message, char *mode)
3855 #if DEBUG_PRINT_INIT_TIMESTAMPS
3856 static char *debug_message = NULL;
3857 static char *last_message = NULL;
3858 static int counter_nr = 0;
3859 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3861 checked_free(debug_message);
3862 debug_message = getStringCat3(mode, " ", message);
3864 if (strEqual(mode, "INIT"))
3866 debug_print_timestamp(counter_nr, NULL);
3868 if (counter_nr + 1 < max_depth)
3869 debug_print_timestamp(counter_nr, debug_message);
3873 debug_print_timestamp(counter_nr, NULL);
3875 else if (strEqual(mode, "DONE"))
3879 if (counter_nr + 1 < max_depth ||
3880 (counter_nr == 0 && max_depth == 1))
3882 last_message = message;
3884 if (counter_nr == 0 && max_depth == 1)
3886 checked_free(debug_message);
3887 debug_message = getStringCat3("TIME", " ", message);
3890 debug_print_timestamp(counter_nr, debug_message);
3893 else if (!strEqual(mode, "TIME") ||
3894 !strEqual(message, last_message))
3896 if (counter_nr < max_depth)
3897 debug_print_timestamp(counter_nr, debug_message);
3902 void print_timestamp_init(char *message)
3904 print_timestamp_ext(message, "INIT");
3907 void print_timestamp_time(char *message)
3909 print_timestamp_ext(message, "TIME");
3912 void print_timestamp_done(char *message)
3914 print_timestamp_ext(message, "DONE");