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 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 Log(int log_level, char *mode, char *format, va_list ap)
293 if (log_level < 0 || log_level > LOG_FATAL)
296 #if defined(PLATFORM_ANDROID)
297 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
298 log_level == LOG_INFO ? ANDROID_LOG_INFO :
299 log_level == LOG_WARN ? ANDROID_LOG_WARN :
300 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
301 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
302 ANDROID_LOG_UNKNOWN);
305 static boolean last_line_was_separator = FALSE;
306 char *log_token = log_tokens[log_level];
308 if (strEqual(format, "===") ||
309 strEqual(format, "---"))
311 static char *mode_last = NULL;
312 char line_char[2] = { format[0], '\0' };
313 int line_length = 80 - strlen(log_token) - 3;
315 if (log_level == LOG_DEBUG)
316 line_length -= strlen(mode) + 3;
318 if (last_line_was_separator && strEqual(mode, mode_last))
321 printf_log_prefix(log_level, mode);
322 printf_log_line(line_char, line_length);
324 if (!strEqual(mode, mode_last))
325 setString(&mode_last, mode);
327 last_line_was_separator = TRUE;
332 last_line_was_separator = FALSE;
334 printf_log_prefix(log_level, mode);
336 vprintf_log(format, ap);
339 void Debug(char *mode, char *format, ...)
346 // if optional debug mode specified, limit debug output accordingly
347 if (options.debug_mode != NULL &&
348 !strEqual(options.debug_mode, mode))
351 va_start(ap, format);
352 Log(LOG_DEBUG, mode, format, ap);
356 void Info(char *format, ...)
360 va_start(ap, format);
361 Log(LOG_INFO, NULL, format, ap);
365 void Warn(char *format, ...)
369 va_start(ap, format);
370 Log(LOG_WARN, NULL, format, ap);
375 // ----------------------------------------------------------------------------
377 // ----------------------------------------------------------------------------
379 /* int2str() returns a number converted to a string;
380 the used memory is static, but will be overwritten by later calls,
381 so if you want to save the result, copy it to a private string buffer;
382 there can be 10 local calls of int2str() without buffering the result --
383 the 11th call will then destroy the result from the first call and so on. */
385 char *int2str(int number, int size)
387 static char shift_array[10][40];
388 static int shift_counter = 0;
389 char *s = shift_array[shift_counter];
391 shift_counter = (shift_counter + 1) % 10;
398 sprintf(s, " %09d", number);
399 return &s[strlen(s) - size];
403 sprintf(s, "%d", number);
409 // something similar to "int2str()" above, but allocates its own memory
410 // and has a different interface; we cannot use "itoa()", because this
411 // seems to be already defined when cross-compiling to the win32 target
413 char *i_to_a(unsigned int i)
415 static char *a = NULL;
419 if (i > 2147483647) // yes, this is a kludge
422 a = checked_malloc(10 + 1);
430 // calculate base-2 logarithm of argument (rounded down to integer;
431 // this function returns the number of the highest bit set in argument)
433 int log_2(unsigned int x)
439 x -= (1 << e); // for rounding down (rounding up: remove this line)
446 boolean getTokenValueFromString(char *string, char **token, char **value)
448 return getTokenValueFromSetupLine(string, token, value);
452 // ----------------------------------------------------------------------------
454 // ----------------------------------------------------------------------------
456 // maximal allowed length of a command line option
457 #define MAX_OPTION_LEN 256
459 static unsigned int getCurrentMS(void)
461 return SDL_GetTicks();
464 static unsigned int mainCounter(int mode)
466 static unsigned int base_ms = 0;
467 unsigned int current_ms;
469 // get current system milliseconds
470 current_ms = getCurrentMS();
472 // reset base timestamp in case of counter reset or wrap-around
473 if (mode == INIT_COUNTER || current_ms < base_ms)
474 base_ms = current_ms;
476 // return milliseconds since last counter reset
477 return current_ms - base_ms;
480 void InitCounter() // set counter back to zero
482 mainCounter(INIT_COUNTER);
485 unsigned int Counter() // get milliseconds since last call of InitCounter()
487 return mainCounter(READ_COUNTER);
490 static void sleep_milliseconds(unsigned int milliseconds_delay)
492 SDL_Delay(milliseconds_delay);
495 void Delay(unsigned int delay) // Sleep specified number of milliseconds
497 sleep_milliseconds(delay);
500 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
501 unsigned int actual_counter)
503 if (actual_counter >= *counter_var &&
504 actual_counter < *counter_var + delay)
507 *counter_var = actual_counter;
512 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
514 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
517 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
519 return DelayReachedExt(counter_var, delay, Counter());
522 void ResetDelayCounterExt(unsigned int *counter_var,
523 unsigned int actual_counter)
525 DelayReachedExt(counter_var, 0, actual_counter);
528 void ResetFrameCounter(unsigned int *frame_counter_var)
530 FrameReached(frame_counter_var, 0);
533 void ResetDelayCounter(unsigned int *counter_var)
535 DelayReached(counter_var, 0);
538 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
540 unsigned int actual_counter;
545 actual_counter = Counter();
547 if (actual_counter >= *counter_var &&
548 actual_counter < *counter_var + delay)
549 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
554 if (*counter_var != 0 &&
556 actual_counter >= *counter_var + delay)
558 int lag = actual_counter - (*counter_var + delay);
559 int delay2 = (delay + 1) / 2;
562 skip_frames = (lag + delay2) / delay;
565 *counter_var = actual_counter;
570 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
571 int *loop_var, int last_loop_value)
573 int skip_frames = WaitUntilDelayReached(counter_var, delay);
577 printf("::: %d: %d ms", *loop_var, delay);
579 printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
584 if (skip_frames == 0)
587 // when skipping frames, make sure to never skip the last frame, as
588 // this may be needed for animations to reach a defined end state;
589 // furthermore, we assume that this function is called at the end
590 // of a "for" loop, which continues by incrementing the loop variable
591 // by one before checking the loop condition again; therefore we have
592 // to check against the last loop value minus one here
596 if (*loop_var < last_loop_value) // never skip the last frame
598 *loop_var += skip_frames;
600 if (*loop_var > last_loop_value) // never skip the last frame
601 *loop_var = last_loop_value;
606 // ----------------------------------------------------------------------------
607 // random generator functions
608 // ----------------------------------------------------------------------------
610 unsigned int init_random_number(int nr, int seed)
612 if (seed == NEW_RANDOMIZE)
614 // default random seed
615 seed = (int)time(NULL); // seconds since the epoch
617 #if !defined(PLATFORM_WIN32)
618 // add some more randomness
619 struct timeval current_time;
621 gettimeofday(¤t_time, NULL);
623 seed += (int)current_time.tv_usec; // microseconds since the epoch
626 // add some more randomness
627 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
629 // add some more randomness
630 seed += GetSimpleRandom(1000000);
633 srandom_linux_libc(nr, (unsigned int) seed);
635 return (unsigned int) seed;
638 unsigned int get_random_number(int nr, int max)
640 return (max > 0 ? random_linux_libc(nr) % max : 0);
644 // ----------------------------------------------------------------------------
645 // system info functions
646 // ----------------------------------------------------------------------------
648 #if !defined(PLATFORM_ANDROID)
649 static char *get_corrected_real_name(char *real_name)
651 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
652 char *from_ptr = real_name;
653 char *to_ptr = real_name_new;
655 // copy the name string, but not more than MAX_USERNAME_LEN characters
656 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
658 // the name field read from "passwd" file may also contain additional
659 // user information, separated by commas, which will be removed here
660 if (*from_ptr == ',')
663 // the user's real name may contain 'german sharp s' characters,
664 // which have no equivalent in upper case letters (used by our fonts)
665 if (*from_ptr == CHAR_BYTE_SHARP_S)
672 *to_ptr++ = *from_ptr++;
677 return real_name_new;
681 char *getLoginName(void)
683 static char *login_name = NULL;
685 #if defined(PLATFORM_WIN32)
686 if (login_name == NULL)
688 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
689 login_name = checked_malloc(buffer_size);
691 if (GetUserName(login_name, &buffer_size) == 0)
692 strcpy(login_name, ANONYMOUS_NAME);
694 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
695 if (login_name == NULL)
699 if ((pwd = getpwuid(getuid())) == NULL)
700 login_name = ANONYMOUS_NAME;
702 login_name = getStringCopy(pwd->pw_name);
705 login_name = ANONYMOUS_NAME;
711 char *getRealName(void)
713 static char *real_name = NULL;
715 #if defined(PLATFORM_WIN32)
716 if (real_name == NULL)
718 static char buffer[MAX_USERNAME_LEN + 1];
719 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
721 if (GetUserName(buffer, &buffer_size) != 0)
722 real_name = get_corrected_real_name(buffer);
724 real_name = ANONYMOUS_NAME;
726 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
727 if (real_name == NULL)
731 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
732 real_name = get_corrected_real_name(pwd->pw_gecos);
734 real_name = ANONYMOUS_NAME;
737 real_name = ANONYMOUS_NAME;
743 time_t getFileTimestampEpochSeconds(char *filename)
745 struct stat file_status;
747 if (stat(filename, &file_status) != 0) // cannot stat file
750 return file_status.st_mtime;
754 // ----------------------------------------------------------------------------
755 // path manipulation functions
756 // ----------------------------------------------------------------------------
758 static char *getLastPathSeparatorPtr(char *filename)
760 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
762 if (last_separator == NULL) // also try DOS/Windows variant
763 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
765 return last_separator;
768 char *getBaseNamePtr(char *filename)
770 char *last_separator = getLastPathSeparatorPtr(filename);
772 if (last_separator != NULL)
773 return last_separator + 1; // separator found: strip base path
775 return filename; // no separator found: filename has no path
778 char *getBaseName(char *filename)
780 return getStringCopy(getBaseNamePtr(filename));
783 char *getBaseNameNoSuffix(char *filename)
785 char *basename = getStringCopy(getBaseNamePtr(filename));
787 // remove trailing suffix (separated by dot or hyphen)
788 if (basename[0] != '.' && basename[0] != '-')
790 if (strchr(basename, '.') != NULL)
791 *strchr(basename, '.') = '\0';
793 if (strchr(basename, '-') != NULL)
794 *strchr(basename, '-') = '\0';
800 char *getBasePath(char *filename)
802 char *basepath = getStringCopy(filename);
803 char *last_separator = getLastPathSeparatorPtr(basepath);
805 // if no separator was found, use current directory
806 if (last_separator == NULL)
810 return getStringCopy(".");
813 // separator found: strip basename
814 *last_separator = '\0';
820 // ----------------------------------------------------------------------------
821 // various string functions
822 // ----------------------------------------------------------------------------
824 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
826 if (s1 == NULL || s2 == NULL || sep == NULL)
829 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
832 sprintf(complete_string, "%s%s%s", s1, sep, s2);
834 return complete_string;
837 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
839 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
842 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
843 strlen(s2) + strlen(sep) +
846 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
848 return complete_string;
851 char *getStringCat2(char *s1, char *s2)
853 return getStringCat2WithSeparator(s1, s2, "");
856 char *getStringCat3(char *s1, char *s2, char *s3)
858 return getStringCat3WithSeparator(s1, s2, s3, "");
861 char *getPath2(char *path1, char *path2)
863 #if defined(PLATFORM_ANDROID)
864 // workaround for reading from assets directory -- skip "." subdirs in path
865 if (strEqual(path1, "."))
866 return getStringCopy(path2);
867 else if (strEqual(path2, "."))
868 return getStringCopy(path1);
871 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
874 char *getPath3(char *path1, char *path2, char *path3)
876 #if defined(PLATFORM_ANDROID)
877 // workaround for reading from assets directory -- skip "." subdirs in path
878 if (strEqual(path1, "."))
879 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
880 else if (strEqual(path2, "."))
881 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
882 else if (strEqual(path3, "."))
883 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
886 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
889 static char *getPngOrPcxIfNotExists(char *filename)
891 // switch from PNG to PCX file and vice versa, if file does not exist
892 // (backwards compatibility with PCX files used in previous versions)
894 if (!fileExists(filename) && strSuffix(filename, ".png"))
895 strcpy(&filename[strlen(filename) - 3], "pcx");
896 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
897 strcpy(&filename[strlen(filename) - 3], "png");
902 char *getImg2(char *path1, char *path2)
904 return getPngOrPcxIfNotExists(getPath2(path1, path2));
907 char *getImg3(char *path1, char *path2, char *path3)
909 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
912 char *getStringCopy(const char *s)
919 s_copy = checked_malloc(strlen(s) + 1);
925 char *getStringCopyN(const char *s, int n)
928 int s_len = MAX(0, n);
933 s_copy = checked_malloc(s_len + 1);
934 strncpy(s_copy, s, s_len);
935 s_copy[s_len] = '\0';
940 char *getStringCopyNStatic(const char *s, int n)
942 static char *s_copy = NULL;
944 checked_free(s_copy);
946 s_copy = getStringCopyN(s, n);
951 char *getStringToLower(const char *s)
953 char *s_copy = checked_malloc(strlen(s) + 1);
954 char *s_ptr = s_copy;
957 *s_ptr++ = tolower(*s++);
963 void setString(char **old_value, char *new_value)
965 checked_free(*old_value);
967 *old_value = getStringCopy(new_value);
970 boolean strEqual(char *s1, char *s2)
972 return (s1 == NULL && s2 == NULL ? TRUE :
973 s1 == NULL && s2 != NULL ? FALSE :
974 s1 != NULL && s2 == NULL ? FALSE :
975 strcmp(s1, s2) == 0);
978 boolean strEqualN(char *s1, char *s2, int n)
980 return (s1 == NULL && s2 == NULL ? TRUE :
981 s1 == NULL && s2 != NULL ? FALSE :
982 s1 != NULL && s2 == NULL ? FALSE :
983 strncmp(s1, s2, n) == 0);
986 boolean strPrefix(char *s, char *prefix)
988 return (s == NULL && prefix == NULL ? TRUE :
989 s == NULL && prefix != NULL ? FALSE :
990 s != NULL && prefix == NULL ? FALSE :
991 strncmp(s, prefix, strlen(prefix)) == 0);
994 boolean strSuffix(char *s, char *suffix)
996 return (s == NULL && suffix == NULL ? TRUE :
997 s == NULL && suffix != NULL ? FALSE :
998 s != NULL && suffix == NULL ? FALSE :
999 strlen(s) < strlen(suffix) ? FALSE :
1000 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1003 boolean strPrefixLower(char *s, char *prefix)
1005 char *s_lower = getStringToLower(s);
1006 boolean match = strPrefix(s_lower, prefix);
1013 boolean strSuffixLower(char *s, char *suffix)
1015 char *s_lower = getStringToLower(s);
1016 boolean match = strSuffix(s_lower, suffix);
1024 // ----------------------------------------------------------------------------
1025 // command line option handling functions
1026 // ----------------------------------------------------------------------------
1028 void GetOptions(int argc, char *argv[],
1029 void (*print_usage_function)(void),
1030 void (*print_version_function)(void))
1032 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1033 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1034 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1035 char **options_left = &argvplus[1];
1037 // replace original "argv" with null-terminated array of string pointers
1039 argvplus[argc] = argv[argc];
1041 // initialize global program options
1042 options.server_host = NULL;
1043 options.server_port = 0;
1045 options.ro_base_directory = ro_base_path;
1046 options.rw_base_directory = rw_base_path;
1047 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1048 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1049 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1050 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1051 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1052 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1054 options.execute_command = NULL;
1055 options.special_flags = NULL;
1056 options.debug_mode = NULL;
1058 options.mytapes = FALSE;
1059 options.serveronly = FALSE;
1060 options.network = FALSE;
1061 options.verbose = FALSE;
1062 options.debug = FALSE;
1065 options.verbose = TRUE;
1067 #if !defined(PLATFORM_UNIX)
1068 if (*options_left == NULL) // no options given -- enable verbose mode
1069 options.verbose = TRUE;
1074 #if defined(PLATFORM_ANDROID)
1075 options.debug = TRUE;
1079 while (*options_left)
1081 char option_str[MAX_OPTION_LEN];
1082 char *option = options_left[0];
1083 char *next_option = options_left[1];
1084 char *option_arg = NULL;
1085 int option_len = strlen(option);
1087 if (option_len >= MAX_OPTION_LEN)
1088 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1090 strcpy(option_str, option); // copy argument into buffer
1091 option = option_str;
1093 if (strEqual(option, "--")) // stop scanning arguments
1096 if (strPrefix(option, "--")) // treat '--' like '-'
1099 option_arg = strchr(option, '=');
1100 if (option_arg == NULL) // no '=' in option
1101 option_arg = next_option;
1104 *option_arg++ = '\0'; // cut argument from option
1105 if (*option_arg == '\0') // no argument after '='
1106 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1109 option_len = strlen(option);
1111 if (strEqual(option, "-"))
1113 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1115 else if (strncmp(option, "-help", option_len) == 0)
1117 print_usage_function();
1121 else if (strncmp(option, "-basepath", option_len) == 0)
1123 if (option_arg == NULL)
1124 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1126 // this should be extended to separate options for ro and rw data
1127 options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1128 options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1129 if (option_arg == next_option)
1132 // adjust paths for sub-directories in base directory accordingly
1133 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1134 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1135 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1136 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1137 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1138 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1140 else if (strncmp(option, "-levels", option_len) == 0)
1142 if (option_arg == NULL)
1143 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1145 options.level_directory = getStringCopy(option_arg);
1146 if (option_arg == next_option)
1149 else if (strncmp(option, "-graphics", option_len) == 0)
1151 if (option_arg == NULL)
1152 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1154 options.graphics_directory = getStringCopy(option_arg);
1155 if (option_arg == next_option)
1158 else if (strncmp(option, "-sounds", option_len) == 0)
1160 if (option_arg == NULL)
1161 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1163 options.sounds_directory = getStringCopy(option_arg);
1164 if (option_arg == next_option)
1167 else if (strncmp(option, "-music", option_len) == 0)
1169 if (option_arg == NULL)
1170 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1172 options.music_directory = getStringCopy(option_arg);
1173 if (option_arg == next_option)
1176 else if (strncmp(option, "-mytapes", option_len) == 0)
1178 options.mytapes = TRUE;
1180 else if (strncmp(option, "-network", option_len) == 0)
1182 options.network = TRUE;
1184 else if (strncmp(option, "-serveronly", option_len) == 0)
1186 options.serveronly = TRUE;
1188 else if (strncmp(option, "-debug", option_len) == 0)
1190 options.debug = TRUE;
1192 // optionally, debug output can be limited to a specific debug mode
1193 if (option_arg != next_option)
1194 options.debug_mode = getStringCopy(option_arg);
1196 else if (strncmp(option, "-verbose", option_len) == 0)
1198 options.verbose = TRUE;
1200 else if (strncmp(option, "-version", option_len) == 0 ||
1201 strncmp(option, "-V", option_len) == 0)
1203 print_version_function();
1207 else if (strPrefix(option, "-D"))
1209 options.special_flags = getStringCopy(&option[2]);
1211 else if (strncmp(option, "-execute", option_len) == 0)
1213 if (option_arg == NULL)
1214 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1216 options.execute_command = getStringCopy(option_arg);
1217 if (option_arg == next_option)
1220 // when doing batch processing, always enable verbose mode (warnings)
1221 options.verbose = TRUE;
1223 #if defined(PLATFORM_MACOSX)
1224 else if (strPrefix(option, "-psn"))
1226 // ignore process serial number when launched via GUI on Mac OS X
1229 else if (*option == '-')
1231 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1233 else if (options.server_host == NULL)
1235 options.server_host = *options_left;
1237 else if (options.server_port == 0)
1239 options.server_port = atoi(*options_left);
1240 if (options.server_port < 1024)
1241 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1244 Error(ERR_EXIT_HELP, "too many arguments");
1251 // ----------------------------------------------------------------------------
1252 // error handling functions
1253 // ----------------------------------------------------------------------------
1255 #define MAX_INTERNAL_ERROR_SIZE 1024
1257 // used by SetError() and GetError() to store internal error messages
1258 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1260 void SetError(char *format, ...)
1264 va_start(ap, format);
1265 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1269 char *GetError(void)
1271 return internal_error;
1274 void Error(int mode, char *format, ...)
1276 static boolean last_line_was_separator = FALSE;
1277 char *process_name = "";
1279 if (program.log_file[LOG_ERR_ID] == NULL)
1282 #if defined(PLATFORM_ANDROID)
1283 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1284 mode & ERR_INFO ? ANDROID_LOG_INFO :
1285 mode & ERR_WARN ? ANDROID_LOG_WARN :
1286 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1287 ANDROID_LOG_UNKNOWN);
1290 // display debug messages only when running in debug mode
1291 if (mode & ERR_DEBUG && !options.debug)
1294 // display warnings only when running in verbose mode
1295 if (mode & ERR_WARN && !options.verbose)
1298 if (mode == ERR_INFO_LINE)
1300 if (!last_line_was_separator)
1301 printf_log_line(format, 79);
1303 last_line_was_separator = TRUE;
1308 last_line_was_separator = FALSE;
1310 if (mode & ERR_SOUND_SERVER)
1311 process_name = " sound server";
1312 else if (mode & ERR_NETWORK_SERVER)
1313 process_name = " network server";
1314 else if (mode & ERR_NETWORK_CLIENT)
1315 process_name = " network client **";
1319 #if !defined(PLATFORM_ANDROID)
1320 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1323 if (mode & ERR_WARN)
1324 printf_log_nonewline("warning: ");
1326 if (mode & ERR_EXIT)
1327 printf_log_nonewline("fatal error: ");
1331 va_start(ap, format);
1332 vprintf_log(format, ap);
1335 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1337 va_start(ap, format);
1338 program.exit_message_function(format, ap);
1343 if (mode & ERR_HELP)
1344 printf_log("%s: Try option '--help' for more information.",
1345 program.command_basename);
1347 if (mode & ERR_EXIT)
1348 printf_log("%s%s: aborting", program.command_basename, process_name);
1350 if (mode & ERR_EXIT)
1352 if (mode & ERR_FROM_SERVER)
1353 exit(1); // child process: normal exit
1355 program.exit_function(1); // main process: clean up stuff
1360 // ----------------------------------------------------------------------------
1361 // checked memory allocation and freeing functions
1362 // ----------------------------------------------------------------------------
1364 void *checked_malloc(unsigned int size)
1371 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1376 void *checked_calloc(unsigned int size)
1380 ptr = calloc(1, size);
1383 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1388 void *checked_realloc(void *ptr, unsigned int size)
1390 ptr = realloc(ptr, size);
1393 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1398 void checked_free(void *ptr)
1400 if (ptr != NULL) // this check should be done by free() anyway
1404 void clear_mem(void *ptr, unsigned int size)
1406 #if defined(PLATFORM_WIN32)
1407 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1408 char *cptr = (char *)ptr;
1413 memset(ptr, 0, size);
1418 // ----------------------------------------------------------------------------
1419 // various helper functions
1420 // ----------------------------------------------------------------------------
1422 void swap_numbers(int *i1, int *i2)
1430 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1442 /* the "put" variants of the following file access functions check for the file
1443 pointer being != NULL and return the number of bytes they have or would have
1444 written; this allows for chunk writing functions to first determine the size
1445 of the (not yet written) chunk, write the correct chunk size and finally
1446 write the chunk itself */
1448 int getFile8BitInteger(File *file)
1450 return getByteFromFile(file);
1453 int putFile8BitInteger(FILE *file, int value)
1461 int getFile16BitInteger(File *file, int byte_order)
1463 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1464 return ((getByteFromFile(file) << 8) |
1465 (getByteFromFile(file) << 0));
1466 else // BYTE_ORDER_LITTLE_ENDIAN
1467 return ((getByteFromFile(file) << 0) |
1468 (getByteFromFile(file) << 8));
1471 int putFile16BitInteger(FILE *file, int value, int byte_order)
1475 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1477 fputc((value >> 8) & 0xff, file);
1478 fputc((value >> 0) & 0xff, file);
1480 else // BYTE_ORDER_LITTLE_ENDIAN
1482 fputc((value >> 0) & 0xff, file);
1483 fputc((value >> 8) & 0xff, file);
1490 int getFile32BitInteger(File *file, int byte_order)
1492 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1493 return ((getByteFromFile(file) << 24) |
1494 (getByteFromFile(file) << 16) |
1495 (getByteFromFile(file) << 8) |
1496 (getByteFromFile(file) << 0));
1497 else // BYTE_ORDER_LITTLE_ENDIAN
1498 return ((getByteFromFile(file) << 0) |
1499 (getByteFromFile(file) << 8) |
1500 (getByteFromFile(file) << 16) |
1501 (getByteFromFile(file) << 24));
1504 int putFile32BitInteger(FILE *file, int value, int byte_order)
1508 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1510 fputc((value >> 24) & 0xff, file);
1511 fputc((value >> 16) & 0xff, file);
1512 fputc((value >> 8) & 0xff, file);
1513 fputc((value >> 0) & 0xff, file);
1515 else // BYTE_ORDER_LITTLE_ENDIAN
1517 fputc((value >> 0) & 0xff, file);
1518 fputc((value >> 8) & 0xff, file);
1519 fputc((value >> 16) & 0xff, file);
1520 fputc((value >> 24) & 0xff, file);
1527 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1530 const int chunk_name_length = 4;
1533 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1536 if (chunk_size != NULL)
1539 *chunk_size = getFile32BitInteger(file, byte_order);
1542 return (checkEndOfFile(file) ? FALSE : TRUE);
1545 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1552 fputs(chunk_name, file);
1554 num_bytes += strlen(chunk_name);
1556 if (chunk_size >= 0)
1560 putFile32BitInteger(file, chunk_size, byte_order);
1568 int getFileVersion(File *file)
1570 int version_super = getByteFromFile(file);
1571 int version_major = getByteFromFile(file);
1572 int version_minor = getByteFromFile(file);
1573 int version_patch = getByteFromFile(file);
1575 return VERSION_IDENT(version_super, version_major, version_minor,
1579 int putFileVersion(FILE *file, int version)
1583 int version_super = VERSION_SUPER(version);
1584 int version_major = VERSION_MAJOR(version);
1585 int version_minor = VERSION_MINOR(version);
1586 int version_patch = VERSION_PATCH(version);
1588 fputc(version_super, file);
1589 fputc(version_major, file);
1590 fputc(version_minor, file);
1591 fputc(version_patch, file);
1597 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1601 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1602 buffer[i] = getByteFromFile(file);
1605 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1609 for (i = 0; i < bytes; i++)
1610 fputc(buffer[i], file);
1613 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1615 while (bytes-- && !checkEndOfFile(file))
1616 getByteFromFile(file);
1619 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1626 // ----------------------------------------------------------------------------
1627 // functions to translate key identifiers between different format
1628 // ----------------------------------------------------------------------------
1630 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1631 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1632 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1633 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1635 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1644 // return and escape keys
1645 { KSYM_Return, "XK_Return", "return" },
1646 { KSYM_Escape, "XK_Escape", "escape" },
1648 // normal cursor keys
1649 { KSYM_Left, "XK_Left", "cursor left" },
1650 { KSYM_Right, "XK_Right", "cursor right" },
1651 { KSYM_Up, "XK_Up", "cursor up" },
1652 { KSYM_Down, "XK_Down", "cursor down" },
1654 // keypad cursor keys
1656 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1657 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1658 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1659 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1662 // other keypad keys
1663 #ifdef KSYM_KP_Enter
1664 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1665 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1666 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1667 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1668 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1669 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1673 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1674 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1675 { KSYM_Control_L, "XK_Control_L", "left control" },
1676 { KSYM_Control_R, "XK_Control_R", "right control" },
1677 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1678 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1679 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1680 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1681 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1682 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1684 // some special keys
1685 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1686 { KSYM_Delete, "XK_Delete", "delete" },
1687 { KSYM_Insert, "XK_Insert", "insert" },
1688 { KSYM_Tab, "XK_Tab", "tab" },
1689 { KSYM_Home, "XK_Home", "home" },
1690 { KSYM_End, "XK_End", "end" },
1691 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1692 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1694 { KSYM_Select, "XK_Select", "select" },
1695 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1696 { KSYM_Back, "XK_Back", "back" }, // back key
1697 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1698 #if defined(PLATFORM_ANDROID)
1699 { KSYM_Rewind, "XK_Rewind", "rewind" },
1700 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1703 // ASCII 0x20 to 0x40 keys (except numbers)
1704 { KSYM_space, "XK_space", "space" },
1705 { KSYM_exclam, "XK_exclam", "!" },
1706 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1707 { KSYM_numbersign, "XK_numbersign", "#" },
1708 { KSYM_dollar, "XK_dollar", "$" },
1709 { KSYM_percent, "XK_percent", "%" },
1710 { KSYM_ampersand, "XK_ampersand", "&" },
1711 { KSYM_apostrophe, "XK_apostrophe", "'" },
1712 { KSYM_parenleft, "XK_parenleft", "(" },
1713 { KSYM_parenright, "XK_parenright", ")" },
1714 { KSYM_asterisk, "XK_asterisk", "*" },
1715 { KSYM_plus, "XK_plus", "+" },
1716 { KSYM_comma, "XK_comma", "," },
1717 { KSYM_minus, "XK_minus", "-" },
1718 { KSYM_period, "XK_period", "." },
1719 { KSYM_slash, "XK_slash", "/" },
1720 { KSYM_colon, "XK_colon", ":" },
1721 { KSYM_semicolon, "XK_semicolon", ";" },
1722 { KSYM_less, "XK_less", "<" },
1723 { KSYM_equal, "XK_equal", "=" },
1724 { KSYM_greater, "XK_greater", ">" },
1725 { KSYM_question, "XK_question", "?" },
1726 { KSYM_at, "XK_at", "@" },
1729 { KSYM_bracketleft, "XK_bracketleft", "[" },
1730 { KSYM_backslash, "XK_backslash", "\\" },
1731 { KSYM_bracketright,"XK_bracketright", "]" },
1732 { KSYM_asciicircum, "XK_asciicircum", "^" },
1733 { KSYM_underscore, "XK_underscore", "_" },
1734 { KSYM_grave, "XK_grave", "grave" },
1735 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1736 { KSYM_braceleft, "XK_braceleft", "brace left" },
1737 { KSYM_bar, "XK_bar", "bar" },
1738 { KSYM_braceright, "XK_braceright", "brace right" },
1739 { KSYM_asciitilde, "XK_asciitilde", "~" },
1741 // special (non-ASCII) keys
1742 { KSYM_degree, "XK_degree", "degree" },
1743 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1744 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1745 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1746 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1747 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1748 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1749 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1751 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1752 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1753 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1754 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1755 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1756 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1757 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1758 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1759 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1761 // other keys (for reverse mapping only)
1762 { KSYM_space, "XK_space", " " },
1764 // keypad keys are not in numerical order in SDL2
1765 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1766 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1767 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1768 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1769 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1770 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1771 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1772 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1773 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1774 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1776 // end-of-array identifier
1782 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1784 static char name_buffer[30];
1787 if (key >= KSYM_A && key <= KSYM_Z)
1788 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1789 else if (key >= KSYM_a && key <= KSYM_z)
1790 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1791 else if (key >= KSYM_0 && key <= KSYM_9)
1792 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1793 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1794 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1795 else if (key == KSYM_UNDEFINED)
1796 strcpy(name_buffer, "(undefined)");
1803 if (key == translate_key[i].key)
1805 strcpy(name_buffer, translate_key[i].name);
1809 while (translate_key[++i].name);
1811 if (!translate_key[i].name)
1812 strcpy(name_buffer, "(unknown)");
1815 *name = name_buffer;
1817 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1819 static char name_buffer[30];
1822 if (key >= KSYM_A && key <= KSYM_Z)
1823 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1824 else if (key >= KSYM_a && key <= KSYM_z)
1825 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1826 else if (key >= KSYM_0 && key <= KSYM_9)
1827 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1828 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1829 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1830 else if (key == KSYM_UNDEFINED)
1831 strcpy(name_buffer, "[undefined]");
1838 if (key == translate_key[i].key)
1840 strcpy(name_buffer, translate_key[i].x11name);
1844 while (translate_key[++i].x11name);
1846 if (!translate_key[i].x11name)
1847 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1850 *x11name = name_buffer;
1852 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1854 Key key = KSYM_UNDEFINED;
1855 char *name_ptr = *name;
1857 if (strlen(*name) == 1)
1859 char c = name_ptr[0];
1861 if (c >= 'A' && c <= 'Z')
1862 key = KSYM_A + (Key)(c - 'A');
1863 else if (c >= 'a' && c <= 'z')
1864 key = KSYM_a + (Key)(c - 'a');
1865 else if (c >= '0' && c <= '9')
1866 key = KSYM_0 + (Key)(c - '0');
1869 if (key == KSYM_UNDEFINED)
1875 if (strEqual(translate_key[i].name, *name))
1877 key = translate_key[i].key;
1881 while (translate_key[++i].x11name);
1884 if (key == KSYM_UNDEFINED)
1885 Warn("getKeyFromKeyName(): not completely implemented");
1889 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1891 Key key = KSYM_UNDEFINED;
1892 char *name_ptr = *x11name;
1894 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1896 char c = name_ptr[3];
1898 if (c >= 'A' && c <= 'Z')
1899 key = KSYM_A + (Key)(c - 'A');
1900 else if (c >= 'a' && c <= 'z')
1901 key = KSYM_a + (Key)(c - 'a');
1902 else if (c >= '0' && c <= '9')
1903 key = KSYM_0 + (Key)(c - '0');
1905 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1907 char c1 = name_ptr[4];
1908 char c2 = name_ptr[5];
1911 if ((c1 >= '0' && c1 <= '9') &&
1912 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1913 d = atoi(&name_ptr[4]);
1915 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1916 key = KSYM_F1 + (Key)(d - 1);
1918 else if (strPrefix(name_ptr, "XK_"))
1924 if (strEqual(name_ptr, translate_key[i].x11name))
1926 key = translate_key[i].key;
1930 while (translate_key[++i].x11name);
1932 else if (strPrefix(name_ptr, "0x"))
1934 unsigned int value = 0;
1940 char c = *name_ptr++;
1943 if (c >= '0' && c <= '9')
1945 else if (c >= 'a' && c <= 'f')
1946 d = (int)(c - 'a' + 10);
1947 else if (c >= 'A' && c <= 'F')
1948 d = (int)(c - 'A' + 10);
1956 value = value * 16 + d;
1967 char *getKeyNameFromKey(Key key)
1971 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1975 char *getX11KeyNameFromKey(Key key)
1979 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1983 Key getKeyFromKeyName(char *name)
1987 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1991 Key getKeyFromX11KeyName(char *x11name)
1995 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1999 char getCharFromKey(Key key)
2005 } translate_key_char[] =
2007 // special (non-ASCII) keys (ISO-8859-1)
2008 { KSYM_degree, CHAR_BYTE_DEGREE },
2009 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2010 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2011 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2012 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2013 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2014 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2015 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2017 // end-of-array identifier
2021 char *keyname = getKeyNameFromKey(key);
2024 if (strlen(keyname) == 1)
2026 else if (strEqual(keyname, "space"))
2034 if (key == translate_key_char[i].key)
2036 c = translate_key_char[i].key_char;
2041 while (translate_key_char[++i].key_char);
2047 char getValidConfigValueChar(char c)
2049 if (c == '#' || // used to mark comments
2050 c == '\\') // used to mark continued lines
2057 // ----------------------------------------------------------------------------
2058 // functions to translate string identifiers to integer or boolean value
2059 // ----------------------------------------------------------------------------
2061 int get_integer_from_string(char *s)
2063 static char *number_text[][3] =
2065 { "0", "zero", "null", },
2066 { "1", "one", "first" },
2067 { "2", "two", "second" },
2068 { "3", "three", "third" },
2069 { "4", "four", "fourth" },
2070 { "5", "five", "fifth" },
2071 { "6", "six", "sixth" },
2072 { "7", "seven", "seventh" },
2073 { "8", "eight", "eighth" },
2074 { "9", "nine", "ninth" },
2075 { "10", "ten", "tenth" },
2076 { "11", "eleven", "eleventh" },
2077 { "12", "twelve", "twelfth" },
2079 { NULL, NULL, NULL },
2083 char *s_lower = getStringToLower(s);
2086 for (i = 0; number_text[i][0] != NULL; i++)
2087 for (j = 0; j < 3; j++)
2088 if (strEqual(s_lower, number_text[i][j]))
2093 if (strEqual(s_lower, "false") ||
2094 strEqual(s_lower, "no") ||
2095 strEqual(s_lower, "off"))
2097 else if (strEqual(s_lower, "true") ||
2098 strEqual(s_lower, "yes") ||
2099 strEqual(s_lower, "on"))
2110 boolean get_boolean_from_string(char *s)
2112 char *s_lower = getStringToLower(s);
2113 boolean result = FALSE;
2115 if (strEqual(s_lower, "true") ||
2116 strEqual(s_lower, "yes") ||
2117 strEqual(s_lower, "on") ||
2118 get_integer_from_string(s) == 1)
2126 int get_switch3_from_string(char *s)
2128 char *s_lower = getStringToLower(s);
2131 if (strEqual(s_lower, "true") ||
2132 strEqual(s_lower, "yes") ||
2133 strEqual(s_lower, "on") ||
2134 get_integer_from_string(s) == 1)
2136 else if (strEqual(s_lower, "auto"))
2144 int get_player_nr_from_string(char *s)
2146 static char *player_text[] =
2156 char *s_lower = getStringToLower(s);
2160 for (i = 0; player_text[i] != NULL; i++)
2161 if (strEqual(s_lower, player_text[i]))
2170 // ----------------------------------------------------------------------------
2171 // functions for generic lists
2172 // ----------------------------------------------------------------------------
2174 ListNode *newListNode(void)
2176 return checked_calloc(sizeof(ListNode));
2179 void addNodeToList(ListNode **node_first, char *key, void *content)
2181 ListNode *node_new = newListNode();
2183 node_new->key = getStringCopy(key);
2184 node_new->content = content;
2185 node_new->next = *node_first;
2188 (*node_first)->prev = node_new;
2190 *node_first = node_new;
2193 void deleteNodeFromList(ListNode **node_first, char *key,
2194 void (*destructor_function)(void *))
2196 if (node_first == NULL || *node_first == NULL)
2199 if (strEqual((*node_first)->key, key))
2201 // after first recursion, (*node_first)->prev->next == *node_first,
2202 // so *node_first would be overwritten with (*node_first)->next
2203 // => use a copy of *node_first (and later of (*node_first)->next)
2204 ListNode *node = *node_first;
2205 ListNode *node_next = node->next;
2207 checked_free(node->key);
2209 if (destructor_function)
2210 destructor_function(node->content);
2213 node->prev->next = node->next;
2216 node->next->prev = node->prev;
2220 // after removing node, set list pointer to next valid list node
2221 // (this is important if the first node of the list was deleted)
2222 *node_first = node_next;
2226 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2230 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2232 if (node_first == NULL)
2235 if (strEqual(node_first->key, key))
2238 return getNodeFromKey(node_first->next, key);
2241 int getNumNodes(ListNode *node_first)
2243 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2247 static void dumpList(ListNode *node_first)
2249 ListNode *node = node_first;
2253 printf("['%s' (%d)]\n", node->key,
2254 ((struct ListNodeInfo *)node->content)->num_references);
2258 printf("[%d nodes]\n", getNumNodes(node_first));
2263 // ----------------------------------------------------------------------------
2264 // functions for file handling
2265 // ----------------------------------------------------------------------------
2267 #define MAX_BUFFER_SIZE 4096
2269 File *openFile(char *filename, char *mode)
2271 File *file = checked_calloc(sizeof(File));
2273 file->file = fopen(filename, mode);
2275 if (file->file != NULL)
2277 file->filename = getStringCopy(filename);
2282 #if defined(PLATFORM_ANDROID)
2283 file->asset_file = SDL_RWFromFile(filename, mode);
2285 if (file->asset_file != NULL)
2287 file->file_is_asset = TRUE;
2288 file->filename = getStringCopy(filename);
2299 int closeFile(File *file)
2306 #if defined(PLATFORM_ANDROID)
2307 if (file->asset_file)
2308 result = SDL_RWclose(file->asset_file);
2312 result = fclose(file->file);
2314 checked_free(file->filename);
2320 int checkEndOfFile(File *file)
2322 #if defined(PLATFORM_ANDROID)
2323 if (file->file_is_asset)
2324 return file->end_of_file;
2327 return feof(file->file);
2330 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2332 #if defined(PLATFORM_ANDROID)
2333 if (file->file_is_asset)
2335 if (file->end_of_file)
2338 size_t num_items_read =
2339 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2341 if (num_items_read < num_items)
2342 file->end_of_file = TRUE;
2344 return num_items_read;
2348 return fread(buffer, item_size, num_items, file->file);
2351 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2353 return fwrite(buffer, item_size, num_items, file->file);
2356 int seekFile(File *file, long offset, int whence)
2358 #if defined(PLATFORM_ANDROID)
2359 if (file->file_is_asset)
2361 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2362 whence == SEEK_CUR ? RW_SEEK_CUR :
2363 whence == SEEK_END ? RW_SEEK_END : 0);
2365 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2369 return fseek(file->file, offset, whence);
2372 int getByteFromFile(File *file)
2374 #if defined(PLATFORM_ANDROID)
2375 if (file->file_is_asset)
2377 if (file->end_of_file)
2381 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2383 if (num_bytes_read < 1)
2384 file->end_of_file = TRUE;
2386 return (file->end_of_file ? EOF : (int)c);
2390 return fgetc(file->file);
2393 char *getStringFromFile(File *file, char *line, int size)
2395 #if defined(PLATFORM_ANDROID)
2396 if (file->file_is_asset)
2398 if (file->end_of_file)
2401 char *line_ptr = line;
2402 int num_bytes_read = 0;
2404 while (num_bytes_read < size - 1 &&
2405 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2406 *line_ptr++ != '\n')
2411 if (strlen(line) == 0)
2413 file->end_of_file = TRUE;
2422 return fgets(line, size, file->file);
2425 int copyFile(char *filename_from, char *filename_to)
2427 File *file_from, *file_to;
2429 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2434 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2436 closeFile(file_from);
2441 while (!checkEndOfFile(file_from))
2443 byte buffer[MAX_BUFFER_SIZE];
2444 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2446 writeFile(file_to, buffer, 1, bytes_read);
2449 closeFile(file_from);
2456 // ----------------------------------------------------------------------------
2457 // functions for directory handling
2458 // ----------------------------------------------------------------------------
2460 Directory *openDirectory(char *dir_name)
2462 Directory *dir = checked_calloc(sizeof(Directory));
2464 dir->dir = opendir(dir_name);
2466 if (dir->dir != NULL)
2468 dir->filename = getStringCopy(dir_name);
2473 #if defined(PLATFORM_ANDROID)
2474 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2476 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2478 checked_free(asset_toc_filename);
2480 if (dir->asset_toc_file != NULL)
2482 dir->directory_is_asset = TRUE;
2483 dir->filename = getStringCopy(dir_name);
2494 int closeDirectory(Directory *dir)
2501 #if defined(PLATFORM_ANDROID)
2502 if (dir->asset_toc_file)
2503 result = SDL_RWclose(dir->asset_toc_file);
2507 result = closedir(dir->dir);
2510 freeDirectoryEntry(dir->dir_entry);
2512 checked_free(dir->filename);
2518 DirectoryEntry *readDirectory(Directory *dir)
2521 freeDirectoryEntry(dir->dir_entry);
2523 dir->dir_entry = NULL;
2525 #if defined(PLATFORM_ANDROID)
2526 if (dir->directory_is_asset)
2528 char line[MAX_LINE_LEN];
2529 char *line_ptr = line;
2530 int num_bytes_read = 0;
2532 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2533 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2542 if (strlen(line) == 0)
2545 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2547 dir->dir_entry->is_directory = FALSE;
2548 if (line[strlen(line) - 1] == '/')
2550 dir->dir_entry->is_directory = TRUE;
2552 line[strlen(line) - 1] = '\0';
2555 dir->dir_entry->basename = getStringCopy(line);
2556 dir->dir_entry->filename = getPath2(dir->filename, line);
2558 return dir->dir_entry;
2562 struct dirent *dir_entry = readdir(dir->dir);
2564 if (dir_entry == NULL)
2567 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2569 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2570 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2572 struct stat file_status;
2574 dir->dir_entry->is_directory =
2575 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2576 S_ISDIR(file_status.st_mode));
2578 return dir->dir_entry;
2581 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2583 if (dir_entry == NULL)
2586 checked_free(dir_entry->basename);
2587 checked_free(dir_entry->filename);
2588 checked_free(dir_entry);
2592 // ----------------------------------------------------------------------------
2593 // functions for checking files and filenames
2594 // ----------------------------------------------------------------------------
2596 boolean directoryExists(char *dir_name)
2598 if (dir_name == NULL)
2601 struct stat file_status;
2602 boolean success = (stat(dir_name, &file_status) == 0 &&
2603 S_ISDIR(file_status.st_mode));
2605 #if defined(PLATFORM_ANDROID)
2608 // this might be an asset directory; check by trying to open toc file
2609 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2610 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2612 checked_free(asset_toc_filename);
2614 success = (file != NULL);
2624 boolean fileExists(char *filename)
2626 if (filename == NULL)
2629 boolean success = (access(filename, F_OK) == 0);
2631 #if defined(PLATFORM_ANDROID)
2634 // this might be an asset file; check by trying to open it
2635 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2637 success = (file != NULL);
2648 static boolean fileHasPrefix(char *basename, char *prefix)
2650 static char *basename_lower = NULL;
2651 int basename_length, prefix_length;
2653 checked_free(basename_lower);
2655 if (basename == NULL || prefix == NULL)
2658 basename_lower = getStringToLower(basename);
2659 basename_length = strlen(basename_lower);
2660 prefix_length = strlen(prefix);
2662 if (basename_length > prefix_length + 1 &&
2663 basename_lower[prefix_length] == '.' &&
2664 strncmp(basename_lower, prefix, prefix_length) == 0)
2671 static boolean fileHasSuffix(char *basename, char *suffix)
2673 static char *basename_lower = NULL;
2674 int basename_length, suffix_length;
2676 checked_free(basename_lower);
2678 if (basename == NULL || suffix == NULL)
2681 basename_lower = getStringToLower(basename);
2682 basename_length = strlen(basename_lower);
2683 suffix_length = strlen(suffix);
2685 if (basename_length > suffix_length + 1 &&
2686 basename_lower[basename_length - suffix_length - 1] == '.' &&
2687 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2693 static boolean FileCouldBeArtwork(char *filename)
2695 char *basename = getBaseNamePtr(filename);
2697 return (!strEqual(basename, ".") &&
2698 !strEqual(basename, "..") &&
2699 !fileHasSuffix(basename, "txt") &&
2700 !fileHasSuffix(basename, "conf") &&
2701 !directoryExists(filename));
2704 boolean FileIsGraphic(char *filename)
2706 return FileCouldBeArtwork(filename);
2709 boolean FileIsSound(char *filename)
2711 return FileCouldBeArtwork(filename);
2714 boolean FileIsMusic(char *filename)
2716 return FileCouldBeArtwork(filename);
2719 boolean FileIsArtworkType(char *filename, int type)
2721 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2722 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2723 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2729 // ----------------------------------------------------------------------------
2730 // functions for loading artwork configuration information
2731 // ----------------------------------------------------------------------------
2733 char *get_mapped_token(char *token)
2735 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2736 static char *map_token_prefix[][2] =
2738 { "char_procent", "char_percent" },
2739 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2740 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2741 { "bd_butterfly_left", "bd_butterfly.left" },
2742 { "bd_butterfly_right", "bd_butterfly.right" },
2743 { "bd_butterfly_up", "bd_butterfly.up" },
2744 { "bd_butterfly_down", "bd_butterfly.down" },
2745 { "bd_firefly_left", "bd_firefly.left" },
2746 { "bd_firefly_right", "bd_firefly.right" },
2747 { "bd_firefly_up", "bd_firefly.up" },
2748 { "bd_firefly_down", "bd_firefly.down" },
2754 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2756 int len_token_prefix = strlen(map_token_prefix[i][0]);
2758 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2759 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2762 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2763 char *gfx_substring = ".gfx";
2764 char *gfx_prefix = "gfx.";
2765 if (strstr(token, gfx_substring) != NULL)
2767 char *token_prefix = getStringCopy(token);
2768 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2769 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2772 // cut off token string at ".gfx" substring position
2773 *token_gfx_pos = '\0';
2775 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2776 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2780 return mapped_token;
2786 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2789 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2790 static struct ConfigTypeInfo prefix_list[] =
2792 { "global.anim_1" },
2793 { "global.anim_2" },
2794 { "global.anim_3" },
2795 { "global.anim_4" },
2796 { "global.anim_5" },
2797 { "global.anim_6" },
2798 { "global.anim_7" },
2799 { "global.anim_8" },
2800 { "global.anim_9" },
2801 { "global.anim_10" },
2802 { "global.anim_11" },
2803 { "global.anim_12" },
2804 { "global.anim_13" },
2805 { "global.anim_14" },
2806 { "global.anim_15" },
2807 { "global.anim_16" },
2808 { "global.anim_17" },
2809 { "global.anim_18" },
2810 { "global.anim_19" },
2811 { "global.anim_20" },
2812 { "global.anim_21" },
2813 { "global.anim_22" },
2814 { "global.anim_23" },
2815 { "global.anim_24" },
2816 { "global.anim_25" },
2817 { "global.anim_26" },
2818 { "global.anim_27" },
2819 { "global.anim_28" },
2820 { "global.anim_29" },
2821 { "global.anim_30" },
2822 { "global.anim_31" },
2823 { "global.anim_32" },
2827 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2828 boolean prefix_found = FALSE;
2832 // search for prefix to check if base token has to be created
2833 for (i = 0; prefix_list[i].token != NULL; i++)
2834 if (strPrefix(token, prefix_list[i].token))
2835 prefix_found = TRUE;
2840 // search for suffix (parameter) to determine base token length
2841 for (i = 0; suffix_list[i].token != NULL; i++)
2842 if (strSuffix(token, suffix_list[i].token))
2843 len_suffix = strlen(suffix_list[i].token);
2845 return getStringCopyN(token, strlen(token) - len_suffix);
2848 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2849 struct ListNodeInfo ***, int *);
2851 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2852 struct ConfigTypeInfo *suffix_list,
2853 char **ignore_tokens,
2854 int num_file_list_entries)
2856 SetupFileHash *ignore_tokens_hash;
2857 struct FileInfo *file_list;
2858 int num_file_list_entries_found = 0;
2859 int num_suffix_list_entries = 0;
2863 // create hash from list of tokens to be ignored (for quick access)
2864 ignore_tokens_hash = newSetupFileHash();
2865 for (i = 0; ignore_tokens[i] != NULL; i++)
2866 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2868 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2870 for (i = 0; suffix_list[i].token != NULL; i++)
2871 num_suffix_list_entries++;
2873 // always start with reliable default values
2874 for (i = 0; i < num_file_list_entries; i++)
2876 file_list[i].token = NULL;
2878 file_list[i].default_filename = NULL;
2879 file_list[i].filename = NULL;
2881 if (num_suffix_list_entries > 0)
2883 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2885 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2886 file_list[i].parameter = checked_calloc(parameter_array_size);
2888 for (j = 0; j < num_suffix_list_entries; j++)
2890 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2891 setString(&file_list[i].parameter[j], suffix_list[j].value);
2894 file_list[i].redefined = FALSE;
2895 file_list[i].fallback_to_default = FALSE;
2896 file_list[i].default_is_cloned = FALSE;
2902 for (i = 0; config_list[i].token != NULL; i++)
2904 int len_config_token = strlen(config_list[i].token);
2905 boolean is_file_entry = TRUE;
2907 for (j = 0; suffix_list[j].token != NULL; j++)
2909 int len_suffix = strlen(suffix_list[j].token);
2911 if (len_suffix < len_config_token &&
2912 strEqual(&config_list[i].token[len_config_token - len_suffix],
2913 suffix_list[j].token))
2915 setString(&file_list[list_pos].default_parameter[j],
2916 config_list[i].value);
2918 is_file_entry = FALSE;
2924 // the following tokens are no file definitions, but other config tokens
2925 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
2926 is_file_entry = FALSE;
2933 if (list_pos >= num_file_list_entries)
2936 file_list[list_pos].token = config_list[i].token;
2937 file_list[list_pos].default_filename = config_list[i].value;
2940 if (strSuffix(config_list[i].token, ".clone_from"))
2941 file_list[list_pos].default_is_cloned = TRUE;
2944 num_file_list_entries_found = list_pos + 1;
2945 if (num_file_list_entries_found != num_file_list_entries)
2947 Error(ERR_INFO_LINE, "-");
2948 Error(ERR_INFO, "inconsistant config list information:");
2949 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2950 num_file_list_entries);
2951 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2952 num_file_list_entries_found);
2953 Error(ERR_EXIT, "please fix");
2956 freeSetupFileHash(ignore_tokens_hash);
2961 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2963 int len_token = strlen(token);
2964 int len_suffix = strlen(suffix);
2966 if (start_pos < 0) // compare suffix from end of string
2967 start_pos += len_token;
2969 if (start_pos < 0 || start_pos + len_suffix > len_token)
2972 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2975 if (token[start_pos + len_suffix] == '\0')
2978 if (token[start_pos + len_suffix] == '.')
2984 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2986 static void read_token_parameters(SetupFileHash *setup_file_hash,
2987 struct ConfigTypeInfo *suffix_list,
2988 struct FileInfo *file_list_entry)
2990 // check for config token that is the base token without any suffixes
2991 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2992 char *known_token_value = KNOWN_TOKEN_VALUE;
2995 if (filename != NULL)
2997 setString(&file_list_entry->filename, filename);
2999 // when file definition found, set all parameters to default values
3000 for (i = 0; suffix_list[i].token != NULL; i++)
3001 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3003 file_list_entry->redefined = TRUE;
3005 // mark config file token as well known from default config
3006 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3009 // check for config tokens that can be build by base token and suffixes
3010 for (i = 0; suffix_list[i].token != NULL; i++)
3012 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3013 char *value = getHashEntry(setup_file_hash, token);
3017 setString(&file_list_entry->parameter[i], value);
3019 // mark config file token as well known from default config
3020 setHashEntry(setup_file_hash, token, known_token_value);
3027 static void add_dynamic_file_list_entry(struct FileInfo **list,
3028 int *num_list_entries,
3029 SetupFileHash *extra_file_hash,
3030 struct ConfigTypeInfo *suffix_list,
3031 int num_suffix_list_entries,
3034 struct FileInfo *new_list_entry;
3035 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3037 (*num_list_entries)++;
3038 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3039 new_list_entry = &(*list)[*num_list_entries - 1];
3041 new_list_entry->token = getStringCopy(token);
3042 new_list_entry->default_filename = NULL;
3043 new_list_entry->filename = NULL;
3044 new_list_entry->parameter = checked_calloc(parameter_array_size);
3046 new_list_entry->redefined = FALSE;
3047 new_list_entry->fallback_to_default = FALSE;
3048 new_list_entry->default_is_cloned = FALSE;
3050 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3053 static void add_property_mapping(struct PropertyMapping **list,
3054 int *num_list_entries,
3055 int base_index, int ext1_index,
3056 int ext2_index, int ext3_index,
3059 struct PropertyMapping *new_list_entry;
3061 (*num_list_entries)++;
3062 *list = checked_realloc(*list,
3063 *num_list_entries * sizeof(struct PropertyMapping));
3064 new_list_entry = &(*list)[*num_list_entries - 1];
3066 new_list_entry->base_index = base_index;
3067 new_list_entry->ext1_index = ext1_index;
3068 new_list_entry->ext2_index = ext2_index;
3069 new_list_entry->ext3_index = ext3_index;
3071 new_list_entry->artwork_index = artwork_index;
3074 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3077 struct FileInfo *file_list = artwork_info->file_list;
3078 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3079 char **base_prefixes = artwork_info->base_prefixes;
3080 char **ext1_suffixes = artwork_info->ext1_suffixes;
3081 char **ext2_suffixes = artwork_info->ext2_suffixes;
3082 char **ext3_suffixes = artwork_info->ext3_suffixes;
3083 char **ignore_tokens = artwork_info->ignore_tokens;
3084 int num_file_list_entries = artwork_info->num_file_list_entries;
3085 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3086 int num_base_prefixes = artwork_info->num_base_prefixes;
3087 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3088 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3089 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3090 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3091 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3092 SetupFileHash *extra_file_hash, *empty_file_hash;
3093 char *known_token_value = KNOWN_TOKEN_VALUE;
3094 char *base_token_value = UNDEFINED_FILENAME;
3097 if (filename == NULL)
3100 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3103 // separate valid (defined) from empty (undefined) config token values
3104 valid_file_hash = newSetupFileHash();
3105 empty_file_hash = newSetupFileHash();
3106 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3108 char *value = HASH_ITERATION_VALUE(itr);
3110 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3111 HASH_ITERATION_TOKEN(itr), value);
3113 END_HASH_ITERATION(setup_file_hash, itr)
3115 // at this point, we do not need the setup file hash anymore -- free it
3116 freeSetupFileHash(setup_file_hash);
3118 // prevent changing hash while iterating over it by using a temporary copy
3119 valid_file_hash_tmp = newSetupFileHash();
3120 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3122 setHashEntry(valid_file_hash_tmp,
3123 HASH_ITERATION_TOKEN(itr),
3124 HASH_ITERATION_VALUE(itr));
3126 END_HASH_ITERATION(valid_file_hash, itr)
3128 // (iterate over same temporary hash, as modifications are independent)
3130 // map deprecated to current tokens (using prefix match and replace)
3131 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3133 char *token = HASH_ITERATION_TOKEN(itr);
3134 char *mapped_token = get_mapped_token(token);
3136 if (mapped_token != NULL)
3138 char *value = HASH_ITERATION_VALUE(itr);
3141 setHashEntry(valid_file_hash, mapped_token, value);
3143 // ignore old token (by setting it to "known" keyword)
3144 setHashEntry(valid_file_hash, token, known_token_value);
3149 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3151 // add special base tokens (using prefix match and replace)
3152 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3154 char *token = HASH_ITERATION_TOKEN(itr);
3155 char *base_token = get_special_base_token(artwork_info, token);
3157 if (base_token != NULL)
3159 // add base token only if it does not already exist
3160 if (getHashEntry(valid_file_hash, base_token) == NULL)
3161 setHashEntry(valid_file_hash, base_token, base_token_value);
3166 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3168 // free temporary hash used for iteration
3169 freeSetupFileHash(valid_file_hash_tmp);
3171 // read parameters for all known config file tokens
3172 for (i = 0; i < num_file_list_entries; i++)
3173 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3175 // set all tokens that can be ignored here to "known" keyword
3176 for (i = 0; i < num_ignore_tokens; i++)
3177 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3179 // copy all unknown config file tokens to extra config hash
3180 extra_file_hash = newSetupFileHash();
3181 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3183 char *value = HASH_ITERATION_VALUE(itr);
3185 if (!strEqual(value, known_token_value))
3186 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3188 END_HASH_ITERATION(valid_file_hash, itr)
3190 // at this point, we do not need the valid file hash anymore -- free it
3191 freeSetupFileHash(valid_file_hash);
3193 // now try to determine valid, dynamically defined config tokens
3195 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3197 struct FileInfo **dynamic_file_list =
3198 &artwork_info->dynamic_file_list;
3199 int *num_dynamic_file_list_entries =
3200 &artwork_info->num_dynamic_file_list_entries;
3201 struct PropertyMapping **property_mapping =
3202 &artwork_info->property_mapping;
3203 int *num_property_mapping_entries =
3204 &artwork_info->num_property_mapping_entries;
3205 int current_summarized_file_list_entry =
3206 artwork_info->num_file_list_entries +
3207 artwork_info->num_dynamic_file_list_entries;
3208 char *token = HASH_ITERATION_TOKEN(itr);
3209 int len_token = strlen(token);
3211 boolean base_prefix_found = FALSE;
3212 boolean parameter_suffix_found = FALSE;
3214 // skip all parameter definitions (handled by read_token_parameters())
3215 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3217 int len_suffix = strlen(suffix_list[i].token);
3219 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3220 parameter_suffix_found = TRUE;
3223 if (parameter_suffix_found)
3226 // ---------- step 0: search for matching base prefix ----------
3229 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3231 char *base_prefix = base_prefixes[i];
3232 int len_base_prefix = strlen(base_prefix);
3233 boolean ext1_suffix_found = FALSE;
3234 boolean ext2_suffix_found = FALSE;
3235 boolean ext3_suffix_found = FALSE;
3236 boolean exact_match = FALSE;
3237 int base_index = -1;
3238 int ext1_index = -1;
3239 int ext2_index = -1;
3240 int ext3_index = -1;
3242 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3244 if (!base_prefix_found)
3249 if (start_pos + len_base_prefix == len_token) // exact match
3253 add_dynamic_file_list_entry(dynamic_file_list,
3254 num_dynamic_file_list_entries,
3257 num_suffix_list_entries,
3259 add_property_mapping(property_mapping,
3260 num_property_mapping_entries,
3261 base_index, -1, -1, -1,
3262 current_summarized_file_list_entry);
3266 // ---------- step 1: search for matching first suffix ----------
3268 start_pos += len_base_prefix;
3269 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3271 char *ext1_suffix = ext1_suffixes[j];
3272 int len_ext1_suffix = strlen(ext1_suffix);
3274 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3276 if (!ext1_suffix_found)
3281 if (start_pos + len_ext1_suffix == len_token) // exact match
3285 add_dynamic_file_list_entry(dynamic_file_list,
3286 num_dynamic_file_list_entries,
3289 num_suffix_list_entries,
3291 add_property_mapping(property_mapping,
3292 num_property_mapping_entries,
3293 base_index, ext1_index, -1, -1,
3294 current_summarized_file_list_entry);
3298 start_pos += len_ext1_suffix;
3304 // ---------- step 2: search for matching second suffix ----------
3306 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3308 char *ext2_suffix = ext2_suffixes[k];
3309 int len_ext2_suffix = strlen(ext2_suffix);
3311 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3313 if (!ext2_suffix_found)
3318 if (start_pos + len_ext2_suffix == len_token) // exact match
3322 add_dynamic_file_list_entry(dynamic_file_list,
3323 num_dynamic_file_list_entries,
3326 num_suffix_list_entries,
3328 add_property_mapping(property_mapping,
3329 num_property_mapping_entries,
3330 base_index, ext1_index, ext2_index, -1,
3331 current_summarized_file_list_entry);
3335 start_pos += len_ext2_suffix;
3341 // ---------- step 3: search for matching third suffix ----------
3343 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3345 char *ext3_suffix = ext3_suffixes[l];
3346 int len_ext3_suffix = strlen(ext3_suffix);
3348 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3350 if (!ext3_suffix_found)
3355 if (start_pos + len_ext3_suffix == len_token) // exact match
3359 add_dynamic_file_list_entry(dynamic_file_list,
3360 num_dynamic_file_list_entries,
3363 num_suffix_list_entries,
3365 add_property_mapping(property_mapping,
3366 num_property_mapping_entries,
3367 base_index, ext1_index, ext2_index, ext3_index,
3368 current_summarized_file_list_entry);
3374 END_HASH_ITERATION(extra_file_hash, itr)
3376 if (artwork_info->num_dynamic_file_list_entries > 0)
3378 artwork_info->dynamic_artwork_list =
3379 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3380 artwork_info->sizeof_artwork_list_entry);
3383 if (options.verbose && IS_PARENT_PROCESS())
3385 SetupFileList *setup_file_list, *list;
3386 boolean dynamic_tokens_found = FALSE;
3387 boolean unknown_tokens_found = FALSE;
3388 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3390 // list may be NULL for empty artwork config files
3391 setup_file_list = loadSetupFileList(filename);
3393 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3395 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3396 dynamic_tokens_found = TRUE;
3398 unknown_tokens_found = TRUE;
3400 END_HASH_ITERATION(extra_file_hash, itr)
3402 if (options.debug && dynamic_tokens_found)
3404 Debug("config", "---");
3405 Debug("config", "dynamic token(s) found in config file:");
3406 Debug("config", "- config file: '%s'", filename);
3408 for (list = setup_file_list; list != NULL; list = list->next)
3410 char *value = getHashEntry(extra_file_hash, list->token);
3412 if (value != NULL && strEqual(value, known_token_value))
3413 Debug("config", "- dynamic token: '%s'", list->token);
3416 Debug("config", "---");
3419 if (unknown_tokens_found)
3422 Warn("unknown token(s) found in config file:");
3423 Warn("- config file: '%s'", filename);
3425 for (list = setup_file_list; list != NULL; list = list->next)
3427 char *value = getHashEntry(extra_file_hash, list->token);
3429 if (value != NULL && !strEqual(value, known_token_value))
3430 Warn("- dynamic token: '%s'", list->token);
3436 if (undefined_values_found)
3439 Warn("undefined values found in config file:");
3440 Warn("- config file: '%s'", filename);
3442 for (list = setup_file_list; list != NULL; list = list->next)
3444 char *value = getHashEntry(empty_file_hash, list->token);
3447 Warn("- undefined value for token: '%s'", list->token);
3453 freeSetupFileList(setup_file_list);
3456 freeSetupFileHash(extra_file_hash);
3457 freeSetupFileHash(empty_file_hash);
3460 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3462 struct FileInfo *file_list = artwork_info->file_list;
3463 int num_file_list_entries = artwork_info->num_file_list_entries;
3464 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3465 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3468 DrawInitText("Loading artwork config", 120, FC_GREEN);
3469 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3471 // always start with reliable default values
3472 for (i = 0; i < num_file_list_entries; i++)
3474 setString(&file_list[i].filename, file_list[i].default_filename);
3476 for (j = 0; j < num_suffix_list_entries; j++)
3477 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3479 file_list[i].redefined = FALSE;
3480 file_list[i].fallback_to_default = FALSE;
3483 // free previous dynamic artwork file array
3484 if (artwork_info->dynamic_file_list != NULL)
3486 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3488 free(artwork_info->dynamic_file_list[i].token);
3489 free(artwork_info->dynamic_file_list[i].filename);
3490 free(artwork_info->dynamic_file_list[i].parameter);
3493 free(artwork_info->dynamic_file_list);
3494 artwork_info->dynamic_file_list = NULL;
3496 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3497 &artwork_info->num_dynamic_file_list_entries);
3500 // free previous property mapping
3501 if (artwork_info->property_mapping != NULL)
3503 free(artwork_info->property_mapping);
3505 artwork_info->property_mapping = NULL;
3506 artwork_info->num_property_mapping_entries = 0;
3509 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3511 // first look for special artwork configured in level series config
3512 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3514 if (fileExists(filename_base))
3515 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3518 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3520 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3521 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3524 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3525 struct ListNodeInfo **listnode)
3529 char *filename = (*listnode)->source_filename;
3531 if (--(*listnode)->num_references <= 0)
3532 deleteNodeFromList(&artwork_info->content_list, filename,
3533 artwork_info->free_artwork);
3539 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3540 struct ListNodeInfo **listnode,
3541 struct FileInfo *file_list_entry)
3551 char *basename = file_list_entry->filename;
3552 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3554 if (filename == NULL)
3556 Warn("cannot find artwork file '%s'", basename);
3558 basename = file_list_entry->default_filename;
3560 // fail for cloned default artwork that has no default filename defined
3561 if (file_list_entry->default_is_cloned &&
3562 strEqual(basename, UNDEFINED_FILENAME))
3564 int error_mode = ERR_WARN;
3566 // we can get away without sounds and music, but not without graphics
3567 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3568 error_mode = ERR_EXIT;
3570 Error(error_mode, "token '%s' was cloned and has no default filename",
3571 file_list_entry->token);
3576 // dynamic artwork has no default filename / skip empty default artwork
3577 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3580 file_list_entry->fallback_to_default = TRUE;
3582 Warn("trying default artwork file '%s'", basename);
3584 filename = getCustomArtworkFilename(basename, artwork_info->type);
3586 if (filename == NULL)
3588 int error_mode = ERR_WARN;
3590 // we can get away without sounds and music, but not without graphics
3591 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3592 error_mode = ERR_EXIT;
3594 Error(error_mode, "cannot find default artwork file '%s'", basename);
3600 // check if the old and the new artwork file are the same
3601 if (*listnode && strEqual((*listnode)->source_filename, filename))
3603 // The old and new artwork are the same (have the same filename and path).
3604 // This usually means that this artwork does not exist in this artwork set
3605 // and a fallback to the existing artwork is done.
3610 // delete existing artwork file entry
3611 deleteArtworkListEntry(artwork_info, listnode);
3613 // check if the new artwork file already exists in the list of artwork
3614 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3616 *listnode = (struct ListNodeInfo *)node->content;
3617 (*listnode)->num_references++;
3622 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3623 DrawInitText(basename, 150, FC_YELLOW);
3625 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3627 // add new artwork file entry to the list of artwork files
3628 (*listnode)->num_references = 1;
3629 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3634 int error_mode = ERR_WARN;
3636 // we can get away without sounds and music, but not without graphics
3637 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3638 error_mode = ERR_EXIT;
3640 Error(error_mode, "cannot load artwork file '%s'", basename);
3646 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3647 struct ListNodeInfo **listnode,
3648 struct FileInfo *file_list_entry)
3650 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3652 deleteArtworkListEntry(artwork_info, listnode);
3657 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3660 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3662 struct FileInfo *file_list = artwork_info->file_list;
3663 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3664 int num_file_list_entries = artwork_info->num_file_list_entries;
3665 int num_dynamic_file_list_entries =
3666 artwork_info->num_dynamic_file_list_entries;
3669 print_timestamp_init("ReloadCustomArtworkList");
3671 for (i = 0; i < num_file_list_entries; i++)
3672 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3675 for (i = 0; i < num_dynamic_file_list_entries; i++)
3676 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3677 &dynamic_file_list[i]);
3679 print_timestamp_done("ReloadCustomArtworkList");
3682 dumpList(artwork_info->content_list);
3686 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3687 struct ListNodeInfo ***list,
3688 int *num_list_entries)
3695 for (i = 0; i < *num_list_entries; i++)
3696 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3700 *num_list_entries = 0;
3703 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3705 if (artwork_info == NULL)
3708 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3709 &artwork_info->num_file_list_entries);
3711 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3712 &artwork_info->num_dynamic_file_list_entries);
3716 // ----------------------------------------------------------------------------
3717 // functions only needed for non-Unix (non-command-line) systems
3718 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3719 // (now also added for Windows, to create files in user data directory)
3720 // ----------------------------------------------------------------------------
3722 char *getLogFilename(char *basename)
3724 return getPath2(getUserGameDataDir(), basename);
3727 void OpenLogFiles(void)
3731 InitUserDataDirectory();
3733 for (i = 0; i < NUM_LOGS; i++)
3735 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3738 program.log_file[i] = program.log_file_default[i]; // reset to default
3740 Warn("cannot open file '%s' for writing: %s",
3741 program.log_filename[i], strerror(errno));
3744 // output should be unbuffered so it is not truncated in a crash
3745 setbuf(program.log_file[i], NULL);
3749 void CloseLogFiles(void)
3753 for (i = 0; i < NUM_LOGS; i++)
3754 if (program.log_file[i] != program.log_file_default[i])
3755 fclose(program.log_file[i]);
3758 void DumpLogFile(int nr)
3760 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3762 if (log_file == NULL)
3765 while (!feof(log_file))
3766 fputc(fgetc(log_file), stdout);
3771 void NotifyUserAboutErrorFile(void)
3773 #if defined(PLATFORM_WIN32)
3774 char *title_text = getStringCat2(program.program_title, " Error Message");
3775 char *error_text = getStringCat2("The program was aborted due to an error; "
3776 "for details, see the following error file:"
3778 program.log_filename[LOG_ERR_ID]);
3780 MessageBox(NULL, error_text, title_text, MB_OK);
3785 // ----------------------------------------------------------------------------
3786 // the following is only for debugging purpose and normally not used
3787 // ----------------------------------------------------------------------------
3791 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3792 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3794 #define DEBUG_NUM_TIMESTAMPS 10
3795 #define DEBUG_TIME_IN_MICROSECONDS 0
3797 #if DEBUG_TIME_IN_MICROSECONDS
3798 static double Counter_Microseconds(void)
3800 static struct timeval base_time = { 0, 0 };
3801 struct timeval current_time;
3804 gettimeofday(¤t_time, NULL);
3806 // reset base time in case of wrap-around
3807 if (current_time.tv_sec < base_time.tv_sec)
3808 base_time = current_time;
3811 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3812 ((double)(current_time.tv_usec - base_time.tv_usec));
3814 return counter; // return microseconds since last init
3818 static char *debug_print_timestamp_get_padding(int padding_size)
3820 static char *padding = NULL;
3821 int max_padding_size = 100;
3823 if (padding == NULL)
3825 padding = checked_calloc(max_padding_size + 1);
3826 memset(padding, ' ', max_padding_size);
3829 return &padding[MAX(0, max_padding_size - padding_size)];
3832 void debug_print_timestamp(int counter_nr, char *message)
3834 int indent_size = 8;
3835 int padding_size = 40;
3836 float timestamp_interval;
3839 Error(ERR_EXIT, "debugging: invalid negative counter");
3840 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3841 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3843 #if DEBUG_TIME_IN_MICROSECONDS
3844 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3847 counter[counter_nr][0] = Counter_Microseconds();
3849 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3852 counter[counter_nr][0] = Counter();
3855 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3856 counter[counter_nr][1] = counter[counter_nr][0];
3859 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3860 debug_print_timestamp_get_padding(counter_nr * indent_size),
3862 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3863 timestamp_interval / 1000,
3868 static void debug_print_parent_only(char *format, ...)
3870 if (!IS_PARENT_PROCESS())
3877 va_start(ap, format);
3878 vprintf(format, ap);
3888 static void print_timestamp_ext(char *message, char *mode)
3890 #if DEBUG_PRINT_INIT_TIMESTAMPS
3891 static char *debug_message = NULL;
3892 static char *last_message = NULL;
3893 static int counter_nr = 0;
3894 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3896 checked_free(debug_message);
3897 debug_message = getStringCat3(mode, " ", message);
3899 if (strEqual(mode, "INIT"))
3901 debug_print_timestamp(counter_nr, NULL);
3903 if (counter_nr + 1 < max_depth)
3904 debug_print_timestamp(counter_nr, debug_message);
3908 debug_print_timestamp(counter_nr, NULL);
3910 else if (strEqual(mode, "DONE"))
3914 if (counter_nr + 1 < max_depth ||
3915 (counter_nr == 0 && max_depth == 1))
3917 last_message = message;
3919 if (counter_nr == 0 && max_depth == 1)
3921 checked_free(debug_message);
3922 debug_message = getStringCat3("TIME", " ", message);
3925 debug_print_timestamp(counter_nr, debug_message);
3928 else if (!strEqual(mode, "TIME") ||
3929 !strEqual(message, last_message))
3931 if (counter_nr < max_depth)
3932 debug_print_timestamp(counter_nr, debug_message);
3937 void print_timestamp_init(char *message)
3939 print_timestamp_ext(message, "INIT");
3942 void print_timestamp_time(char *message)
3944 print_timestamp_ext(message, "TIME");
3947 void print_timestamp_done(char *message)
3949 print_timestamp_ext(message, "DONE");