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 static boolean last_line_was_separator = FALSE;
297 char *log_token = log_tokens[log_level];
299 if (strEqual(format, "===") ||
300 strEqual(format, "---"))
302 static char *mode_last = NULL;
303 char line_char[2] = { format[0], '\0' };
304 int line_length = 80 - strlen(log_token) - 3;
306 if (log_level == LOG_DEBUG)
307 line_length -= strlen(mode) + 3;
309 if (last_line_was_separator && strEqual(mode, mode_last))
312 printf_log_prefix(log_level, mode);
313 printf_log_line(line_char, line_length);
315 if (!strEqual(mode, mode_last))
316 setString(&mode_last, mode);
318 last_line_was_separator = TRUE;
323 last_line_was_separator = FALSE;
325 printf_log_prefix(log_level, mode);
327 vprintf_log(format, ap);
330 void Debug(char *mode, char *format, ...)
334 // if optional debug mode specified, limit debug output accordingly
335 if (options.debug_mode != NULL &&
336 !strEqual(options.debug_mode, mode))
339 va_start(ap, format);
340 Log(LOG_DEBUG, mode, format, ap);
344 void Info(char *format, ...)
348 va_start(ap, format);
349 Log(LOG_INFO, NULL, format, ap);
353 void Warn(char *format, ...)
357 va_start(ap, format);
358 Log(LOG_WARN, NULL, format, ap);
363 // ----------------------------------------------------------------------------
365 // ----------------------------------------------------------------------------
367 /* int2str() returns a number converted to a string;
368 the used memory is static, but will be overwritten by later calls,
369 so if you want to save the result, copy it to a private string buffer;
370 there can be 10 local calls of int2str() without buffering the result --
371 the 11th call will then destroy the result from the first call and so on. */
373 char *int2str(int number, int size)
375 static char shift_array[10][40];
376 static int shift_counter = 0;
377 char *s = shift_array[shift_counter];
379 shift_counter = (shift_counter + 1) % 10;
386 sprintf(s, " %09d", number);
387 return &s[strlen(s) - size];
391 sprintf(s, "%d", number);
397 // something similar to "int2str()" above, but allocates its own memory
398 // and has a different interface; we cannot use "itoa()", because this
399 // seems to be already defined when cross-compiling to the win32 target
401 char *i_to_a(unsigned int i)
403 static char *a = NULL;
407 if (i > 2147483647) // yes, this is a kludge
410 a = checked_malloc(10 + 1);
418 // calculate base-2 logarithm of argument (rounded down to integer;
419 // this function returns the number of the highest bit set in argument)
421 int log_2(unsigned int x)
427 x -= (1 << e); // for rounding down (rounding up: remove this line)
434 boolean getTokenValueFromString(char *string, char **token, char **value)
436 return getTokenValueFromSetupLine(string, token, value);
440 // ----------------------------------------------------------------------------
442 // ----------------------------------------------------------------------------
444 // maximal allowed length of a command line option
445 #define MAX_OPTION_LEN 256
447 static unsigned int getCurrentMS(void)
449 return SDL_GetTicks();
452 static unsigned int mainCounter(int mode)
454 static unsigned int base_ms = 0;
455 unsigned int current_ms;
457 // get current system milliseconds
458 current_ms = getCurrentMS();
460 // reset base timestamp in case of counter reset or wrap-around
461 if (mode == INIT_COUNTER || current_ms < base_ms)
462 base_ms = current_ms;
464 // return milliseconds since last counter reset
465 return current_ms - base_ms;
468 void InitCounter() // set counter back to zero
470 mainCounter(INIT_COUNTER);
473 unsigned int Counter() // get milliseconds since last call of InitCounter()
475 return mainCounter(READ_COUNTER);
478 static void sleep_milliseconds(unsigned int milliseconds_delay)
480 SDL_Delay(milliseconds_delay);
483 void Delay(unsigned int delay) // Sleep specified number of milliseconds
485 sleep_milliseconds(delay);
488 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
489 unsigned int actual_counter)
491 if (actual_counter >= *counter_var &&
492 actual_counter < *counter_var + delay)
495 *counter_var = actual_counter;
500 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
502 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
505 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
507 return DelayReachedExt(counter_var, delay, Counter());
510 void ResetDelayCounterExt(unsigned int *counter_var,
511 unsigned int actual_counter)
513 DelayReachedExt(counter_var, 0, actual_counter);
516 void ResetFrameCounter(unsigned int *frame_counter_var)
518 FrameReached(frame_counter_var, 0);
521 void ResetDelayCounter(unsigned int *counter_var)
523 DelayReached(counter_var, 0);
526 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
528 unsigned int actual_counter;
533 actual_counter = Counter();
535 if (actual_counter >= *counter_var &&
536 actual_counter < *counter_var + delay)
537 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
542 if (*counter_var != 0 &&
544 actual_counter >= *counter_var + delay)
546 int lag = actual_counter - (*counter_var + delay);
547 int delay2 = (delay + 1) / 2;
550 skip_frames = (lag + delay2) / delay;
553 *counter_var = actual_counter;
558 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
559 int *loop_var, int last_loop_value)
561 int skip_frames = WaitUntilDelayReached(counter_var, delay);
565 printf("::: %d: %d ms", *loop_var, delay);
567 printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
572 if (skip_frames == 0)
575 // when skipping frames, make sure to never skip the last frame, as
576 // this may be needed for animations to reach a defined end state;
577 // furthermore, we assume that this function is called at the end
578 // of a "for" loop, which continues by incrementing the loop variable
579 // by one before checking the loop condition again; therefore we have
580 // to check against the last loop value minus one here
584 if (*loop_var < last_loop_value) // never skip the last frame
586 *loop_var += skip_frames;
588 if (*loop_var > last_loop_value) // never skip the last frame
589 *loop_var = last_loop_value;
594 // ----------------------------------------------------------------------------
595 // random generator functions
596 // ----------------------------------------------------------------------------
598 unsigned int init_random_number(int nr, int seed)
600 if (seed == NEW_RANDOMIZE)
602 // default random seed
603 seed = (int)time(NULL); // seconds since the epoch
605 #if !defined(PLATFORM_WIN32)
606 // add some more randomness
607 struct timeval current_time;
609 gettimeofday(¤t_time, NULL);
611 seed += (int)current_time.tv_usec; // microseconds since the epoch
614 // add some more randomness
615 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
617 // add some more randomness
618 seed += GetSimpleRandom(1000000);
621 srandom_linux_libc(nr, (unsigned int) seed);
623 return (unsigned int) seed;
626 unsigned int get_random_number(int nr, int max)
628 return (max > 0 ? random_linux_libc(nr) % max : 0);
632 // ----------------------------------------------------------------------------
633 // system info functions
634 // ----------------------------------------------------------------------------
636 #if !defined(PLATFORM_ANDROID)
637 static char *get_corrected_real_name(char *real_name)
639 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
640 char *from_ptr = real_name;
641 char *to_ptr = real_name_new;
643 // copy the name string, but not more than MAX_USERNAME_LEN characters
644 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
646 // the name field read from "passwd" file may also contain additional
647 // user information, separated by commas, which will be removed here
648 if (*from_ptr == ',')
651 // the user's real name may contain 'german sharp s' characters,
652 // which have no equivalent in upper case letters (used by our fonts)
653 if (*from_ptr == CHAR_BYTE_SHARP_S)
660 *to_ptr++ = *from_ptr++;
665 return real_name_new;
669 char *getLoginName(void)
671 static char *login_name = NULL;
673 #if defined(PLATFORM_WIN32)
674 if (login_name == NULL)
676 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
677 login_name = checked_malloc(buffer_size);
679 if (GetUserName(login_name, &buffer_size) == 0)
680 strcpy(login_name, ANONYMOUS_NAME);
682 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
683 if (login_name == NULL)
687 if ((pwd = getpwuid(getuid())) == NULL)
688 login_name = ANONYMOUS_NAME;
690 login_name = getStringCopy(pwd->pw_name);
693 login_name = ANONYMOUS_NAME;
699 char *getRealName(void)
701 static char *real_name = NULL;
703 #if defined(PLATFORM_WIN32)
704 if (real_name == NULL)
706 static char buffer[MAX_USERNAME_LEN + 1];
707 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
709 if (GetUserName(buffer, &buffer_size) != 0)
710 real_name = get_corrected_real_name(buffer);
712 real_name = ANONYMOUS_NAME;
714 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
715 if (real_name == NULL)
719 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
720 real_name = get_corrected_real_name(pwd->pw_gecos);
722 real_name = ANONYMOUS_NAME;
725 real_name = ANONYMOUS_NAME;
731 time_t getFileTimestampEpochSeconds(char *filename)
733 struct stat file_status;
735 if (stat(filename, &file_status) != 0) // cannot stat file
738 return file_status.st_mtime;
742 // ----------------------------------------------------------------------------
743 // path manipulation functions
744 // ----------------------------------------------------------------------------
746 static char *getLastPathSeparatorPtr(char *filename)
748 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
750 if (last_separator == NULL) // also try DOS/Windows variant
751 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
753 return last_separator;
756 char *getBaseNamePtr(char *filename)
758 char *last_separator = getLastPathSeparatorPtr(filename);
760 if (last_separator != NULL)
761 return last_separator + 1; // separator found: strip base path
763 return filename; // no separator found: filename has no path
766 char *getBaseName(char *filename)
768 return getStringCopy(getBaseNamePtr(filename));
771 char *getBaseNameNoSuffix(char *filename)
773 char *basename = getStringCopy(getBaseNamePtr(filename));
775 // remove trailing suffix (separated by dot or hyphen)
776 if (basename[0] != '.' && basename[0] != '-')
778 if (strchr(basename, '.') != NULL)
779 *strchr(basename, '.') = '\0';
781 if (strchr(basename, '-') != NULL)
782 *strchr(basename, '-') = '\0';
788 char *getBasePath(char *filename)
790 char *basepath = getStringCopy(filename);
791 char *last_separator = getLastPathSeparatorPtr(basepath);
793 // if no separator was found, use current directory
794 if (last_separator == NULL)
798 return getStringCopy(".");
801 // separator found: strip basename
802 *last_separator = '\0';
808 // ----------------------------------------------------------------------------
809 // various string functions
810 // ----------------------------------------------------------------------------
812 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
814 if (s1 == NULL || s2 == NULL || sep == NULL)
817 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
820 sprintf(complete_string, "%s%s%s", s1, sep, s2);
822 return complete_string;
825 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
827 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
830 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
831 strlen(s2) + strlen(sep) +
834 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
836 return complete_string;
839 char *getStringCat2(char *s1, char *s2)
841 return getStringCat2WithSeparator(s1, s2, "");
844 char *getStringCat3(char *s1, char *s2, char *s3)
846 return getStringCat3WithSeparator(s1, s2, s3, "");
849 char *getPath2(char *path1, char *path2)
851 #if defined(PLATFORM_ANDROID)
852 // workaround for reading from assets directory -- skip "." subdirs in path
853 if (strEqual(path1, "."))
854 return getStringCopy(path2);
855 else if (strEqual(path2, "."))
856 return getStringCopy(path1);
859 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
862 char *getPath3(char *path1, char *path2, char *path3)
864 #if defined(PLATFORM_ANDROID)
865 // workaround for reading from assets directory -- skip "." subdirs in path
866 if (strEqual(path1, "."))
867 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
868 else if (strEqual(path2, "."))
869 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
870 else if (strEqual(path3, "."))
871 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
874 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
877 static char *getPngOrPcxIfNotExists(char *filename)
879 // switch from PNG to PCX file and vice versa, if file does not exist
880 // (backwards compatibility with PCX files used in previous versions)
882 if (!fileExists(filename) && strSuffix(filename, ".png"))
883 strcpy(&filename[strlen(filename) - 3], "pcx");
884 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
885 strcpy(&filename[strlen(filename) - 3], "png");
890 char *getImg2(char *path1, char *path2)
892 return getPngOrPcxIfNotExists(getPath2(path1, path2));
895 char *getImg3(char *path1, char *path2, char *path3)
897 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
900 char *getStringCopy(const char *s)
907 s_copy = checked_malloc(strlen(s) + 1);
913 char *getStringCopyN(const char *s, int n)
916 int s_len = MAX(0, n);
921 s_copy = checked_malloc(s_len + 1);
922 strncpy(s_copy, s, s_len);
923 s_copy[s_len] = '\0';
928 char *getStringCopyNStatic(const char *s, int n)
930 static char *s_copy = NULL;
932 checked_free(s_copy);
934 s_copy = getStringCopyN(s, n);
939 char *getStringToLower(const char *s)
941 char *s_copy = checked_malloc(strlen(s) + 1);
942 char *s_ptr = s_copy;
945 *s_ptr++ = tolower(*s++);
951 void setString(char **old_value, char *new_value)
953 checked_free(*old_value);
955 *old_value = getStringCopy(new_value);
958 boolean strEqual(char *s1, char *s2)
960 return (s1 == NULL && s2 == NULL ? TRUE :
961 s1 == NULL && s2 != NULL ? FALSE :
962 s1 != NULL && s2 == NULL ? FALSE :
963 strcmp(s1, s2) == 0);
966 boolean strEqualN(char *s1, char *s2, int n)
968 return (s1 == NULL && s2 == NULL ? TRUE :
969 s1 == NULL && s2 != NULL ? FALSE :
970 s1 != NULL && s2 == NULL ? FALSE :
971 strncmp(s1, s2, n) == 0);
974 boolean strPrefix(char *s, char *prefix)
976 return (s == NULL && prefix == NULL ? TRUE :
977 s == NULL && prefix != NULL ? FALSE :
978 s != NULL && prefix == NULL ? FALSE :
979 strncmp(s, prefix, strlen(prefix)) == 0);
982 boolean strSuffix(char *s, char *suffix)
984 return (s == NULL && suffix == NULL ? TRUE :
985 s == NULL && suffix != NULL ? FALSE :
986 s != NULL && suffix == NULL ? FALSE :
987 strlen(s) < strlen(suffix) ? FALSE :
988 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
991 boolean strPrefixLower(char *s, char *prefix)
993 char *s_lower = getStringToLower(s);
994 boolean match = strPrefix(s_lower, prefix);
1001 boolean strSuffixLower(char *s, char *suffix)
1003 char *s_lower = getStringToLower(s);
1004 boolean match = strSuffix(s_lower, suffix);
1012 // ----------------------------------------------------------------------------
1013 // command line option handling functions
1014 // ----------------------------------------------------------------------------
1016 void GetOptions(int argc, char *argv[],
1017 void (*print_usage_function)(void),
1018 void (*print_version_function)(void))
1020 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1021 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1022 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1023 char **options_left = &argvplus[1];
1025 // replace original "argv" with null-terminated array of string pointers
1027 argvplus[argc] = argv[argc];
1029 // initialize global program options
1030 options.server_host = NULL;
1031 options.server_port = 0;
1033 options.ro_base_directory = ro_base_path;
1034 options.rw_base_directory = rw_base_path;
1035 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1036 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1037 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1038 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1039 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1040 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1042 options.execute_command = NULL;
1043 options.special_flags = NULL;
1044 options.debug_mode = NULL;
1046 options.mytapes = FALSE;
1047 options.serveronly = FALSE;
1048 options.network = FALSE;
1049 options.verbose = FALSE;
1050 options.debug = FALSE;
1053 options.verbose = TRUE;
1055 #if !defined(PLATFORM_UNIX)
1056 if (*options_left == NULL) // no options given -- enable verbose mode
1057 options.verbose = TRUE;
1062 #if defined(PLATFORM_ANDROID)
1063 options.debug = TRUE;
1067 while (*options_left)
1069 char option_str[MAX_OPTION_LEN];
1070 char *option = options_left[0];
1071 char *next_option = options_left[1];
1072 char *option_arg = NULL;
1073 int option_len = strlen(option);
1075 if (option_len >= MAX_OPTION_LEN)
1076 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1078 strcpy(option_str, option); // copy argument into buffer
1079 option = option_str;
1081 if (strEqual(option, "--")) // stop scanning arguments
1084 if (strPrefix(option, "--")) // treat '--' like '-'
1087 option_arg = strchr(option, '=');
1088 if (option_arg == NULL) // no '=' in option
1089 option_arg = next_option;
1092 *option_arg++ = '\0'; // cut argument from option
1093 if (*option_arg == '\0') // no argument after '='
1094 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1097 option_len = strlen(option);
1099 if (strEqual(option, "-"))
1101 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1103 else if (strncmp(option, "-help", option_len) == 0)
1105 print_usage_function();
1109 else if (strncmp(option, "-basepath", option_len) == 0)
1111 if (option_arg == NULL)
1112 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1114 // this should be extended to separate options for ro and rw data
1115 options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1116 options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1117 if (option_arg == next_option)
1120 // adjust paths for sub-directories in base directory accordingly
1121 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1122 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1123 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1124 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1125 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1126 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1128 else if (strncmp(option, "-levels", option_len) == 0)
1130 if (option_arg == NULL)
1131 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1133 options.level_directory = getStringCopy(option_arg);
1134 if (option_arg == next_option)
1137 else if (strncmp(option, "-graphics", option_len) == 0)
1139 if (option_arg == NULL)
1140 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1142 options.graphics_directory = getStringCopy(option_arg);
1143 if (option_arg == next_option)
1146 else if (strncmp(option, "-sounds", option_len) == 0)
1148 if (option_arg == NULL)
1149 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1151 options.sounds_directory = getStringCopy(option_arg);
1152 if (option_arg == next_option)
1155 else if (strncmp(option, "-music", option_len) == 0)
1157 if (option_arg == NULL)
1158 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1160 options.music_directory = getStringCopy(option_arg);
1161 if (option_arg == next_option)
1164 else if (strncmp(option, "-mytapes", option_len) == 0)
1166 options.mytapes = TRUE;
1168 else if (strncmp(option, "-network", option_len) == 0)
1170 options.network = TRUE;
1172 else if (strncmp(option, "-serveronly", option_len) == 0)
1174 options.serveronly = TRUE;
1176 else if (strncmp(option, "-debug", option_len) == 0)
1178 options.debug = TRUE;
1180 // optionally, debug output can be limited to a specific debug mode
1181 if (option_arg != next_option)
1182 options.debug_mode = getStringCopy(option_arg);
1184 else if (strncmp(option, "-verbose", option_len) == 0)
1186 options.verbose = TRUE;
1188 else if (strncmp(option, "-version", option_len) == 0 ||
1189 strncmp(option, "-V", option_len) == 0)
1191 print_version_function();
1195 else if (strPrefix(option, "-D"))
1197 options.special_flags = getStringCopy(&option[2]);
1199 else if (strncmp(option, "-execute", option_len) == 0)
1201 if (option_arg == NULL)
1202 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1204 options.execute_command = getStringCopy(option_arg);
1205 if (option_arg == next_option)
1208 // when doing batch processing, always enable verbose mode (warnings)
1209 options.verbose = TRUE;
1211 #if defined(PLATFORM_MACOSX)
1212 else if (strPrefix(option, "-psn"))
1214 // ignore process serial number when launched via GUI on Mac OS X
1217 else if (*option == '-')
1219 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1221 else if (options.server_host == NULL)
1223 options.server_host = *options_left;
1225 else if (options.server_port == 0)
1227 options.server_port = atoi(*options_left);
1228 if (options.server_port < 1024)
1229 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1232 Error(ERR_EXIT_HELP, "too many arguments");
1239 // ----------------------------------------------------------------------------
1240 // error handling functions
1241 // ----------------------------------------------------------------------------
1243 #define MAX_INTERNAL_ERROR_SIZE 1024
1245 // used by SetError() and GetError() to store internal error messages
1246 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1248 void SetError(char *format, ...)
1252 va_start(ap, format);
1253 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1257 char *GetError(void)
1259 return internal_error;
1262 void Error(int mode, char *format, ...)
1264 static boolean last_line_was_separator = FALSE;
1265 char *process_name = "";
1267 if (program.log_file[LOG_ERR_ID] == NULL)
1270 #if defined(PLATFORM_ANDROID)
1271 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1272 mode & ERR_INFO ? ANDROID_LOG_INFO :
1273 mode & ERR_WARN ? ANDROID_LOG_WARN :
1274 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1275 ANDROID_LOG_UNKNOWN);
1278 // display debug messages only when running in debug mode
1279 if (mode & ERR_DEBUG && !options.debug)
1282 // display warnings only when running in verbose mode
1283 if (mode & ERR_WARN && !options.verbose)
1286 if (mode == ERR_INFO_LINE)
1288 if (!last_line_was_separator)
1289 printf_log_line(format, 79);
1291 last_line_was_separator = TRUE;
1296 last_line_was_separator = FALSE;
1298 if (mode & ERR_SOUND_SERVER)
1299 process_name = " sound server";
1300 else if (mode & ERR_NETWORK_SERVER)
1301 process_name = " network server";
1302 else if (mode & ERR_NETWORK_CLIENT)
1303 process_name = " network client **";
1307 #if !defined(PLATFORM_ANDROID)
1308 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1311 if (mode & ERR_WARN)
1312 printf_log_nonewline("warning: ");
1314 if (mode & ERR_EXIT)
1315 printf_log_nonewline("fatal error: ");
1319 va_start(ap, format);
1320 vprintf_log(format, ap);
1323 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1325 va_start(ap, format);
1326 program.exit_message_function(format, ap);
1331 if (mode & ERR_HELP)
1332 printf_log("%s: Try option '--help' for more information.",
1333 program.command_basename);
1335 if (mode & ERR_EXIT)
1336 printf_log("%s%s: aborting", program.command_basename, process_name);
1338 if (mode & ERR_EXIT)
1340 if (mode & ERR_FROM_SERVER)
1341 exit(1); // child process: normal exit
1343 program.exit_function(1); // main process: clean up stuff
1348 // ----------------------------------------------------------------------------
1349 // checked memory allocation and freeing functions
1350 // ----------------------------------------------------------------------------
1352 void *checked_malloc(unsigned int size)
1359 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1364 void *checked_calloc(unsigned int size)
1368 ptr = calloc(1, size);
1371 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1376 void *checked_realloc(void *ptr, unsigned int size)
1378 ptr = realloc(ptr, size);
1381 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1386 void checked_free(void *ptr)
1388 if (ptr != NULL) // this check should be done by free() anyway
1392 void clear_mem(void *ptr, unsigned int size)
1394 #if defined(PLATFORM_WIN32)
1395 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1396 char *cptr = (char *)ptr;
1401 memset(ptr, 0, size);
1406 // ----------------------------------------------------------------------------
1407 // various helper functions
1408 // ----------------------------------------------------------------------------
1410 void swap_numbers(int *i1, int *i2)
1418 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1430 /* the "put" variants of the following file access functions check for the file
1431 pointer being != NULL and return the number of bytes they have or would have
1432 written; this allows for chunk writing functions to first determine the size
1433 of the (not yet written) chunk, write the correct chunk size and finally
1434 write the chunk itself */
1436 int getFile8BitInteger(File *file)
1438 return getByteFromFile(file);
1441 int putFile8BitInteger(FILE *file, int value)
1449 int getFile16BitInteger(File *file, int byte_order)
1451 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1452 return ((getByteFromFile(file) << 8) |
1453 (getByteFromFile(file) << 0));
1454 else // BYTE_ORDER_LITTLE_ENDIAN
1455 return ((getByteFromFile(file) << 0) |
1456 (getByteFromFile(file) << 8));
1459 int putFile16BitInteger(FILE *file, int value, int byte_order)
1463 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1465 fputc((value >> 8) & 0xff, file);
1466 fputc((value >> 0) & 0xff, file);
1468 else // BYTE_ORDER_LITTLE_ENDIAN
1470 fputc((value >> 0) & 0xff, file);
1471 fputc((value >> 8) & 0xff, file);
1478 int getFile32BitInteger(File *file, int byte_order)
1480 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1481 return ((getByteFromFile(file) << 24) |
1482 (getByteFromFile(file) << 16) |
1483 (getByteFromFile(file) << 8) |
1484 (getByteFromFile(file) << 0));
1485 else // BYTE_ORDER_LITTLE_ENDIAN
1486 return ((getByteFromFile(file) << 0) |
1487 (getByteFromFile(file) << 8) |
1488 (getByteFromFile(file) << 16) |
1489 (getByteFromFile(file) << 24));
1492 int putFile32BitInteger(FILE *file, int value, int byte_order)
1496 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1498 fputc((value >> 24) & 0xff, file);
1499 fputc((value >> 16) & 0xff, file);
1500 fputc((value >> 8) & 0xff, file);
1501 fputc((value >> 0) & 0xff, file);
1503 else // BYTE_ORDER_LITTLE_ENDIAN
1505 fputc((value >> 0) & 0xff, file);
1506 fputc((value >> 8) & 0xff, file);
1507 fputc((value >> 16) & 0xff, file);
1508 fputc((value >> 24) & 0xff, file);
1515 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1518 const int chunk_name_length = 4;
1521 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1524 if (chunk_size != NULL)
1527 *chunk_size = getFile32BitInteger(file, byte_order);
1530 return (checkEndOfFile(file) ? FALSE : TRUE);
1533 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1540 fputs(chunk_name, file);
1542 num_bytes += strlen(chunk_name);
1544 if (chunk_size >= 0)
1548 putFile32BitInteger(file, chunk_size, byte_order);
1556 int getFileVersion(File *file)
1558 int version_super = getByteFromFile(file);
1559 int version_major = getByteFromFile(file);
1560 int version_minor = getByteFromFile(file);
1561 int version_patch = getByteFromFile(file);
1563 return VERSION_IDENT(version_super, version_major, version_minor,
1567 int putFileVersion(FILE *file, int version)
1571 int version_super = VERSION_SUPER(version);
1572 int version_major = VERSION_MAJOR(version);
1573 int version_minor = VERSION_MINOR(version);
1574 int version_patch = VERSION_PATCH(version);
1576 fputc(version_super, file);
1577 fputc(version_major, file);
1578 fputc(version_minor, file);
1579 fputc(version_patch, file);
1585 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1589 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1590 buffer[i] = getByteFromFile(file);
1593 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1597 for (i = 0; i < bytes; i++)
1598 fputc(buffer[i], file);
1601 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1603 while (bytes-- && !checkEndOfFile(file))
1604 getByteFromFile(file);
1607 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1614 // ----------------------------------------------------------------------------
1615 // functions to translate key identifiers between different format
1616 // ----------------------------------------------------------------------------
1618 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1619 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1620 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1621 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1623 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1632 // return and escape keys
1633 { KSYM_Return, "XK_Return", "return" },
1634 { KSYM_Escape, "XK_Escape", "escape" },
1636 // normal cursor keys
1637 { KSYM_Left, "XK_Left", "cursor left" },
1638 { KSYM_Right, "XK_Right", "cursor right" },
1639 { KSYM_Up, "XK_Up", "cursor up" },
1640 { KSYM_Down, "XK_Down", "cursor down" },
1642 // keypad cursor keys
1644 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1645 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1646 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1647 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1650 // other keypad keys
1651 #ifdef KSYM_KP_Enter
1652 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1653 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1654 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1655 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1656 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1657 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1661 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1662 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1663 { KSYM_Control_L, "XK_Control_L", "left control" },
1664 { KSYM_Control_R, "XK_Control_R", "right control" },
1665 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1666 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1667 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1668 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1669 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1670 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1672 // some special keys
1673 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1674 { KSYM_Delete, "XK_Delete", "delete" },
1675 { KSYM_Insert, "XK_Insert", "insert" },
1676 { KSYM_Tab, "XK_Tab", "tab" },
1677 { KSYM_Home, "XK_Home", "home" },
1678 { KSYM_End, "XK_End", "end" },
1679 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1680 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1682 { KSYM_Select, "XK_Select", "select" },
1683 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1684 { KSYM_Back, "XK_Back", "back" }, // back key
1685 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1686 #if defined(PLATFORM_ANDROID)
1687 { KSYM_Rewind, "XK_Rewind", "rewind" },
1688 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1691 // ASCII 0x20 to 0x40 keys (except numbers)
1692 { KSYM_space, "XK_space", "space" },
1693 { KSYM_exclam, "XK_exclam", "!" },
1694 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1695 { KSYM_numbersign, "XK_numbersign", "#" },
1696 { KSYM_dollar, "XK_dollar", "$" },
1697 { KSYM_percent, "XK_percent", "%" },
1698 { KSYM_ampersand, "XK_ampersand", "&" },
1699 { KSYM_apostrophe, "XK_apostrophe", "'" },
1700 { KSYM_parenleft, "XK_parenleft", "(" },
1701 { KSYM_parenright, "XK_parenright", ")" },
1702 { KSYM_asterisk, "XK_asterisk", "*" },
1703 { KSYM_plus, "XK_plus", "+" },
1704 { KSYM_comma, "XK_comma", "," },
1705 { KSYM_minus, "XK_minus", "-" },
1706 { KSYM_period, "XK_period", "." },
1707 { KSYM_slash, "XK_slash", "/" },
1708 { KSYM_colon, "XK_colon", ":" },
1709 { KSYM_semicolon, "XK_semicolon", ";" },
1710 { KSYM_less, "XK_less", "<" },
1711 { KSYM_equal, "XK_equal", "=" },
1712 { KSYM_greater, "XK_greater", ">" },
1713 { KSYM_question, "XK_question", "?" },
1714 { KSYM_at, "XK_at", "@" },
1717 { KSYM_bracketleft, "XK_bracketleft", "[" },
1718 { KSYM_backslash, "XK_backslash", "\\" },
1719 { KSYM_bracketright,"XK_bracketright", "]" },
1720 { KSYM_asciicircum, "XK_asciicircum", "^" },
1721 { KSYM_underscore, "XK_underscore", "_" },
1722 { KSYM_grave, "XK_grave", "grave" },
1723 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1724 { KSYM_braceleft, "XK_braceleft", "brace left" },
1725 { KSYM_bar, "XK_bar", "bar" },
1726 { KSYM_braceright, "XK_braceright", "brace right" },
1727 { KSYM_asciitilde, "XK_asciitilde", "~" },
1729 // special (non-ASCII) keys
1730 { KSYM_degree, "XK_degree", "degree" },
1731 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1732 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1733 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1734 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1735 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1736 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1737 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1739 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1740 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1741 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1742 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1743 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1744 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1745 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1746 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1747 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1749 // other keys (for reverse mapping only)
1750 { KSYM_space, "XK_space", " " },
1752 // keypad keys are not in numerical order in SDL2
1753 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1754 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1755 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1756 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1757 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1758 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1759 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1760 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1761 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1762 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1764 // end-of-array identifier
1770 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1772 static char name_buffer[30];
1775 if (key >= KSYM_A && key <= KSYM_Z)
1776 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1777 else if (key >= KSYM_a && key <= KSYM_z)
1778 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1779 else if (key >= KSYM_0 && key <= KSYM_9)
1780 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1781 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1782 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1783 else if (key == KSYM_UNDEFINED)
1784 strcpy(name_buffer, "(undefined)");
1791 if (key == translate_key[i].key)
1793 strcpy(name_buffer, translate_key[i].name);
1797 while (translate_key[++i].name);
1799 if (!translate_key[i].name)
1800 strcpy(name_buffer, "(unknown)");
1803 *name = name_buffer;
1805 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1807 static char name_buffer[30];
1810 if (key >= KSYM_A && key <= KSYM_Z)
1811 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1812 else if (key >= KSYM_a && key <= KSYM_z)
1813 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1814 else if (key >= KSYM_0 && key <= KSYM_9)
1815 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1816 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1817 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1818 else if (key == KSYM_UNDEFINED)
1819 strcpy(name_buffer, "[undefined]");
1826 if (key == translate_key[i].key)
1828 strcpy(name_buffer, translate_key[i].x11name);
1832 while (translate_key[++i].x11name);
1834 if (!translate_key[i].x11name)
1835 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1838 *x11name = name_buffer;
1840 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1842 Key key = KSYM_UNDEFINED;
1843 char *name_ptr = *name;
1845 if (strlen(*name) == 1)
1847 char c = name_ptr[0];
1849 if (c >= 'A' && c <= 'Z')
1850 key = KSYM_A + (Key)(c - 'A');
1851 else if (c >= 'a' && c <= 'z')
1852 key = KSYM_a + (Key)(c - 'a');
1853 else if (c >= '0' && c <= '9')
1854 key = KSYM_0 + (Key)(c - '0');
1857 if (key == KSYM_UNDEFINED)
1863 if (strEqual(translate_key[i].name, *name))
1865 key = translate_key[i].key;
1869 while (translate_key[++i].x11name);
1872 if (key == KSYM_UNDEFINED)
1873 Warn("getKeyFromKeyName(): not completely implemented");
1877 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1879 Key key = KSYM_UNDEFINED;
1880 char *name_ptr = *x11name;
1882 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1884 char c = name_ptr[3];
1886 if (c >= 'A' && c <= 'Z')
1887 key = KSYM_A + (Key)(c - 'A');
1888 else if (c >= 'a' && c <= 'z')
1889 key = KSYM_a + (Key)(c - 'a');
1890 else if (c >= '0' && c <= '9')
1891 key = KSYM_0 + (Key)(c - '0');
1893 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1895 char c1 = name_ptr[4];
1896 char c2 = name_ptr[5];
1899 if ((c1 >= '0' && c1 <= '9') &&
1900 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1901 d = atoi(&name_ptr[4]);
1903 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1904 key = KSYM_F1 + (Key)(d - 1);
1906 else if (strPrefix(name_ptr, "XK_"))
1912 if (strEqual(name_ptr, translate_key[i].x11name))
1914 key = translate_key[i].key;
1918 while (translate_key[++i].x11name);
1920 else if (strPrefix(name_ptr, "0x"))
1922 unsigned int value = 0;
1928 char c = *name_ptr++;
1931 if (c >= '0' && c <= '9')
1933 else if (c >= 'a' && c <= 'f')
1934 d = (int)(c - 'a' + 10);
1935 else if (c >= 'A' && c <= 'F')
1936 d = (int)(c - 'A' + 10);
1944 value = value * 16 + d;
1955 char *getKeyNameFromKey(Key key)
1959 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1963 char *getX11KeyNameFromKey(Key key)
1967 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1971 Key getKeyFromKeyName(char *name)
1975 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1979 Key getKeyFromX11KeyName(char *x11name)
1983 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1987 char getCharFromKey(Key key)
1993 } translate_key_char[] =
1995 // special (non-ASCII) keys (ISO-8859-1)
1996 { KSYM_degree, CHAR_BYTE_DEGREE },
1997 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1998 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1999 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2000 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2001 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2002 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2003 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2005 // end-of-array identifier
2009 char *keyname = getKeyNameFromKey(key);
2012 if (strlen(keyname) == 1)
2014 else if (strEqual(keyname, "space"))
2022 if (key == translate_key_char[i].key)
2024 c = translate_key_char[i].key_char;
2029 while (translate_key_char[++i].key_char);
2035 char getValidConfigValueChar(char c)
2037 if (c == '#' || // used to mark comments
2038 c == '\\') // used to mark continued lines
2045 // ----------------------------------------------------------------------------
2046 // functions to translate string identifiers to integer or boolean value
2047 // ----------------------------------------------------------------------------
2049 int get_integer_from_string(char *s)
2051 static char *number_text[][3] =
2053 { "0", "zero", "null", },
2054 { "1", "one", "first" },
2055 { "2", "two", "second" },
2056 { "3", "three", "third" },
2057 { "4", "four", "fourth" },
2058 { "5", "five", "fifth" },
2059 { "6", "six", "sixth" },
2060 { "7", "seven", "seventh" },
2061 { "8", "eight", "eighth" },
2062 { "9", "nine", "ninth" },
2063 { "10", "ten", "tenth" },
2064 { "11", "eleven", "eleventh" },
2065 { "12", "twelve", "twelfth" },
2067 { NULL, NULL, NULL },
2071 char *s_lower = getStringToLower(s);
2074 for (i = 0; number_text[i][0] != NULL; i++)
2075 for (j = 0; j < 3; j++)
2076 if (strEqual(s_lower, number_text[i][j]))
2081 if (strEqual(s_lower, "false") ||
2082 strEqual(s_lower, "no") ||
2083 strEqual(s_lower, "off"))
2085 else if (strEqual(s_lower, "true") ||
2086 strEqual(s_lower, "yes") ||
2087 strEqual(s_lower, "on"))
2098 boolean get_boolean_from_string(char *s)
2100 char *s_lower = getStringToLower(s);
2101 boolean result = FALSE;
2103 if (strEqual(s_lower, "true") ||
2104 strEqual(s_lower, "yes") ||
2105 strEqual(s_lower, "on") ||
2106 get_integer_from_string(s) == 1)
2114 int get_switch3_from_string(char *s)
2116 char *s_lower = getStringToLower(s);
2119 if (strEqual(s_lower, "true") ||
2120 strEqual(s_lower, "yes") ||
2121 strEqual(s_lower, "on") ||
2122 get_integer_from_string(s) == 1)
2124 else if (strEqual(s_lower, "auto"))
2132 int get_player_nr_from_string(char *s)
2134 static char *player_text[] =
2144 char *s_lower = getStringToLower(s);
2148 for (i = 0; player_text[i] != NULL; i++)
2149 if (strEqual(s_lower, player_text[i]))
2158 // ----------------------------------------------------------------------------
2159 // functions for generic lists
2160 // ----------------------------------------------------------------------------
2162 ListNode *newListNode(void)
2164 return checked_calloc(sizeof(ListNode));
2167 void addNodeToList(ListNode **node_first, char *key, void *content)
2169 ListNode *node_new = newListNode();
2171 node_new->key = getStringCopy(key);
2172 node_new->content = content;
2173 node_new->next = *node_first;
2176 (*node_first)->prev = node_new;
2178 *node_first = node_new;
2181 void deleteNodeFromList(ListNode **node_first, char *key,
2182 void (*destructor_function)(void *))
2184 if (node_first == NULL || *node_first == NULL)
2187 if (strEqual((*node_first)->key, key))
2189 // after first recursion, (*node_first)->prev->next == *node_first,
2190 // so *node_first would be overwritten with (*node_first)->next
2191 // => use a copy of *node_first (and later of (*node_first)->next)
2192 ListNode *node = *node_first;
2193 ListNode *node_next = node->next;
2195 checked_free(node->key);
2197 if (destructor_function)
2198 destructor_function(node->content);
2201 node->prev->next = node->next;
2204 node->next->prev = node->prev;
2208 // after removing node, set list pointer to next valid list node
2209 // (this is important if the first node of the list was deleted)
2210 *node_first = node_next;
2214 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2218 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2220 if (node_first == NULL)
2223 if (strEqual(node_first->key, key))
2226 return getNodeFromKey(node_first->next, key);
2229 int getNumNodes(ListNode *node_first)
2231 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2235 static void dumpList(ListNode *node_first)
2237 ListNode *node = node_first;
2241 printf("['%s' (%d)]\n", node->key,
2242 ((struct ListNodeInfo *)node->content)->num_references);
2246 printf("[%d nodes]\n", getNumNodes(node_first));
2251 // ----------------------------------------------------------------------------
2252 // functions for file handling
2253 // ----------------------------------------------------------------------------
2255 #define MAX_BUFFER_SIZE 4096
2257 File *openFile(char *filename, char *mode)
2259 File *file = checked_calloc(sizeof(File));
2261 file->file = fopen(filename, mode);
2263 if (file->file != NULL)
2265 file->filename = getStringCopy(filename);
2270 #if defined(PLATFORM_ANDROID)
2271 file->asset_file = SDL_RWFromFile(filename, mode);
2273 if (file->asset_file != NULL)
2275 file->file_is_asset = TRUE;
2276 file->filename = getStringCopy(filename);
2287 int closeFile(File *file)
2294 #if defined(PLATFORM_ANDROID)
2295 if (file->asset_file)
2296 result = SDL_RWclose(file->asset_file);
2300 result = fclose(file->file);
2302 checked_free(file->filename);
2308 int checkEndOfFile(File *file)
2310 #if defined(PLATFORM_ANDROID)
2311 if (file->file_is_asset)
2312 return file->end_of_file;
2315 return feof(file->file);
2318 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2320 #if defined(PLATFORM_ANDROID)
2321 if (file->file_is_asset)
2323 if (file->end_of_file)
2326 size_t num_items_read =
2327 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2329 if (num_items_read < num_items)
2330 file->end_of_file = TRUE;
2332 return num_items_read;
2336 return fread(buffer, item_size, num_items, file->file);
2339 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2341 return fwrite(buffer, item_size, num_items, file->file);
2344 int seekFile(File *file, long offset, int whence)
2346 #if defined(PLATFORM_ANDROID)
2347 if (file->file_is_asset)
2349 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2350 whence == SEEK_CUR ? RW_SEEK_CUR :
2351 whence == SEEK_END ? RW_SEEK_END : 0);
2353 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2357 return fseek(file->file, offset, whence);
2360 int getByteFromFile(File *file)
2362 #if defined(PLATFORM_ANDROID)
2363 if (file->file_is_asset)
2365 if (file->end_of_file)
2369 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2371 if (num_bytes_read < 1)
2372 file->end_of_file = TRUE;
2374 return (file->end_of_file ? EOF : (int)c);
2378 return fgetc(file->file);
2381 char *getStringFromFile(File *file, char *line, int size)
2383 #if defined(PLATFORM_ANDROID)
2384 if (file->file_is_asset)
2386 if (file->end_of_file)
2389 char *line_ptr = line;
2390 int num_bytes_read = 0;
2392 while (num_bytes_read < size - 1 &&
2393 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2394 *line_ptr++ != '\n')
2399 if (strlen(line) == 0)
2401 file->end_of_file = TRUE;
2410 return fgets(line, size, file->file);
2413 int copyFile(char *filename_from, char *filename_to)
2415 File *file_from, *file_to;
2417 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2422 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2424 closeFile(file_from);
2429 while (!checkEndOfFile(file_from))
2431 byte buffer[MAX_BUFFER_SIZE];
2432 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2434 writeFile(file_to, buffer, 1, bytes_read);
2437 closeFile(file_from);
2444 // ----------------------------------------------------------------------------
2445 // functions for directory handling
2446 // ----------------------------------------------------------------------------
2448 Directory *openDirectory(char *dir_name)
2450 Directory *dir = checked_calloc(sizeof(Directory));
2452 dir->dir = opendir(dir_name);
2454 if (dir->dir != NULL)
2456 dir->filename = getStringCopy(dir_name);
2461 #if defined(PLATFORM_ANDROID)
2462 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2464 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2466 checked_free(asset_toc_filename);
2468 if (dir->asset_toc_file != NULL)
2470 dir->directory_is_asset = TRUE;
2471 dir->filename = getStringCopy(dir_name);
2482 int closeDirectory(Directory *dir)
2489 #if defined(PLATFORM_ANDROID)
2490 if (dir->asset_toc_file)
2491 result = SDL_RWclose(dir->asset_toc_file);
2495 result = closedir(dir->dir);
2498 freeDirectoryEntry(dir->dir_entry);
2500 checked_free(dir->filename);
2506 DirectoryEntry *readDirectory(Directory *dir)
2509 freeDirectoryEntry(dir->dir_entry);
2511 dir->dir_entry = NULL;
2513 #if defined(PLATFORM_ANDROID)
2514 if (dir->directory_is_asset)
2516 char line[MAX_LINE_LEN];
2517 char *line_ptr = line;
2518 int num_bytes_read = 0;
2520 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2521 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2530 if (strlen(line) == 0)
2533 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2535 dir->dir_entry->is_directory = FALSE;
2536 if (line[strlen(line) - 1] == '/')
2538 dir->dir_entry->is_directory = TRUE;
2540 line[strlen(line) - 1] = '\0';
2543 dir->dir_entry->basename = getStringCopy(line);
2544 dir->dir_entry->filename = getPath2(dir->filename, line);
2546 return dir->dir_entry;
2550 struct dirent *dir_entry = readdir(dir->dir);
2552 if (dir_entry == NULL)
2555 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2557 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2558 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2560 struct stat file_status;
2562 dir->dir_entry->is_directory =
2563 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2564 S_ISDIR(file_status.st_mode));
2566 return dir->dir_entry;
2569 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2571 if (dir_entry == NULL)
2574 checked_free(dir_entry->basename);
2575 checked_free(dir_entry->filename);
2576 checked_free(dir_entry);
2580 // ----------------------------------------------------------------------------
2581 // functions for checking files and filenames
2582 // ----------------------------------------------------------------------------
2584 boolean directoryExists(char *dir_name)
2586 if (dir_name == NULL)
2589 struct stat file_status;
2590 boolean success = (stat(dir_name, &file_status) == 0 &&
2591 S_ISDIR(file_status.st_mode));
2593 #if defined(PLATFORM_ANDROID)
2596 // this might be an asset directory; check by trying to open toc file
2597 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2598 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2600 checked_free(asset_toc_filename);
2602 success = (file != NULL);
2612 boolean fileExists(char *filename)
2614 if (filename == NULL)
2617 boolean success = (access(filename, F_OK) == 0);
2619 #if defined(PLATFORM_ANDROID)
2622 // this might be an asset file; check by trying to open it
2623 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2625 success = (file != NULL);
2636 static boolean fileHasPrefix(char *basename, char *prefix)
2638 static char *basename_lower = NULL;
2639 int basename_length, prefix_length;
2641 checked_free(basename_lower);
2643 if (basename == NULL || prefix == NULL)
2646 basename_lower = getStringToLower(basename);
2647 basename_length = strlen(basename_lower);
2648 prefix_length = strlen(prefix);
2650 if (basename_length > prefix_length + 1 &&
2651 basename_lower[prefix_length] == '.' &&
2652 strncmp(basename_lower, prefix, prefix_length) == 0)
2659 static boolean fileHasSuffix(char *basename, char *suffix)
2661 static char *basename_lower = NULL;
2662 int basename_length, suffix_length;
2664 checked_free(basename_lower);
2666 if (basename == NULL || suffix == NULL)
2669 basename_lower = getStringToLower(basename);
2670 basename_length = strlen(basename_lower);
2671 suffix_length = strlen(suffix);
2673 if (basename_length > suffix_length + 1 &&
2674 basename_lower[basename_length - suffix_length - 1] == '.' &&
2675 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2681 static boolean FileCouldBeArtwork(char *filename)
2683 char *basename = getBaseNamePtr(filename);
2685 return (!strEqual(basename, ".") &&
2686 !strEqual(basename, "..") &&
2687 !fileHasSuffix(basename, "txt") &&
2688 !fileHasSuffix(basename, "conf") &&
2689 !directoryExists(filename));
2692 boolean FileIsGraphic(char *filename)
2694 return FileCouldBeArtwork(filename);
2697 boolean FileIsSound(char *filename)
2699 return FileCouldBeArtwork(filename);
2702 boolean FileIsMusic(char *filename)
2704 return FileCouldBeArtwork(filename);
2707 boolean FileIsArtworkType(char *filename, int type)
2709 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2710 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2711 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2717 // ----------------------------------------------------------------------------
2718 // functions for loading artwork configuration information
2719 // ----------------------------------------------------------------------------
2721 char *get_mapped_token(char *token)
2723 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2724 static char *map_token_prefix[][2] =
2726 { "char_procent", "char_percent" },
2727 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2728 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2729 { "bd_butterfly_left", "bd_butterfly.left" },
2730 { "bd_butterfly_right", "bd_butterfly.right" },
2731 { "bd_butterfly_up", "bd_butterfly.up" },
2732 { "bd_butterfly_down", "bd_butterfly.down" },
2733 { "bd_firefly_left", "bd_firefly.left" },
2734 { "bd_firefly_right", "bd_firefly.right" },
2735 { "bd_firefly_up", "bd_firefly.up" },
2736 { "bd_firefly_down", "bd_firefly.down" },
2742 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2744 int len_token_prefix = strlen(map_token_prefix[i][0]);
2746 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2747 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2750 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2751 char *gfx_substring = ".gfx";
2752 char *gfx_prefix = "gfx.";
2753 if (strstr(token, gfx_substring) != NULL)
2755 char *token_prefix = getStringCopy(token);
2756 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2757 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2760 // cut off token string at ".gfx" substring position
2761 *token_gfx_pos = '\0';
2763 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2764 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2768 return mapped_token;
2774 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2777 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2778 static struct ConfigTypeInfo prefix_list[] =
2780 { "global.anim_1" },
2781 { "global.anim_2" },
2782 { "global.anim_3" },
2783 { "global.anim_4" },
2784 { "global.anim_5" },
2785 { "global.anim_6" },
2786 { "global.anim_7" },
2787 { "global.anim_8" },
2788 { "global.anim_9" },
2789 { "global.anim_10" },
2790 { "global.anim_11" },
2791 { "global.anim_12" },
2792 { "global.anim_13" },
2793 { "global.anim_14" },
2794 { "global.anim_15" },
2795 { "global.anim_16" },
2796 { "global.anim_17" },
2797 { "global.anim_18" },
2798 { "global.anim_19" },
2799 { "global.anim_20" },
2800 { "global.anim_21" },
2801 { "global.anim_22" },
2802 { "global.anim_23" },
2803 { "global.anim_24" },
2804 { "global.anim_25" },
2805 { "global.anim_26" },
2806 { "global.anim_27" },
2807 { "global.anim_28" },
2808 { "global.anim_29" },
2809 { "global.anim_30" },
2810 { "global.anim_31" },
2811 { "global.anim_32" },
2815 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2816 boolean prefix_found = FALSE;
2820 // search for prefix to check if base token has to be created
2821 for (i = 0; prefix_list[i].token != NULL; i++)
2822 if (strPrefix(token, prefix_list[i].token))
2823 prefix_found = TRUE;
2828 // search for suffix (parameter) to determine base token length
2829 for (i = 0; suffix_list[i].token != NULL; i++)
2830 if (strSuffix(token, suffix_list[i].token))
2831 len_suffix = strlen(suffix_list[i].token);
2833 return getStringCopyN(token, strlen(token) - len_suffix);
2836 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2837 struct ListNodeInfo ***, int *);
2839 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2840 struct ConfigTypeInfo *suffix_list,
2841 char **ignore_tokens,
2842 int num_file_list_entries)
2844 SetupFileHash *ignore_tokens_hash;
2845 struct FileInfo *file_list;
2846 int num_file_list_entries_found = 0;
2847 int num_suffix_list_entries = 0;
2851 // create hash from list of tokens to be ignored (for quick access)
2852 ignore_tokens_hash = newSetupFileHash();
2853 for (i = 0; ignore_tokens[i] != NULL; i++)
2854 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2856 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2858 for (i = 0; suffix_list[i].token != NULL; i++)
2859 num_suffix_list_entries++;
2861 // always start with reliable default values
2862 for (i = 0; i < num_file_list_entries; i++)
2864 file_list[i].token = NULL;
2866 file_list[i].default_filename = NULL;
2867 file_list[i].filename = NULL;
2869 if (num_suffix_list_entries > 0)
2871 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2873 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2874 file_list[i].parameter = checked_calloc(parameter_array_size);
2876 for (j = 0; j < num_suffix_list_entries; j++)
2878 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2879 setString(&file_list[i].parameter[j], suffix_list[j].value);
2882 file_list[i].redefined = FALSE;
2883 file_list[i].fallback_to_default = FALSE;
2884 file_list[i].default_is_cloned = FALSE;
2890 for (i = 0; config_list[i].token != NULL; i++)
2892 int len_config_token = strlen(config_list[i].token);
2893 boolean is_file_entry = TRUE;
2895 for (j = 0; suffix_list[j].token != NULL; j++)
2897 int len_suffix = strlen(suffix_list[j].token);
2899 if (len_suffix < len_config_token &&
2900 strEqual(&config_list[i].token[len_config_token - len_suffix],
2901 suffix_list[j].token))
2903 setString(&file_list[list_pos].default_parameter[j],
2904 config_list[i].value);
2906 is_file_entry = FALSE;
2912 // the following tokens are no file definitions, but other config tokens
2913 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
2914 is_file_entry = FALSE;
2921 if (list_pos >= num_file_list_entries)
2924 file_list[list_pos].token = config_list[i].token;
2925 file_list[list_pos].default_filename = config_list[i].value;
2928 if (strSuffix(config_list[i].token, ".clone_from"))
2929 file_list[list_pos].default_is_cloned = TRUE;
2932 num_file_list_entries_found = list_pos + 1;
2933 if (num_file_list_entries_found != num_file_list_entries)
2935 Error(ERR_INFO_LINE, "-");
2936 Error(ERR_INFO, "inconsistant config list information:");
2937 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2938 num_file_list_entries);
2939 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2940 num_file_list_entries_found);
2941 Error(ERR_EXIT, "please fix");
2944 freeSetupFileHash(ignore_tokens_hash);
2949 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2951 int len_token = strlen(token);
2952 int len_suffix = strlen(suffix);
2954 if (start_pos < 0) // compare suffix from end of string
2955 start_pos += len_token;
2957 if (start_pos < 0 || start_pos + len_suffix > len_token)
2960 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2963 if (token[start_pos + len_suffix] == '\0')
2966 if (token[start_pos + len_suffix] == '.')
2972 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2974 static void read_token_parameters(SetupFileHash *setup_file_hash,
2975 struct ConfigTypeInfo *suffix_list,
2976 struct FileInfo *file_list_entry)
2978 // check for config token that is the base token without any suffixes
2979 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2980 char *known_token_value = KNOWN_TOKEN_VALUE;
2983 if (filename != NULL)
2985 setString(&file_list_entry->filename, filename);
2987 // when file definition found, set all parameters to default values
2988 for (i = 0; suffix_list[i].token != NULL; i++)
2989 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2991 file_list_entry->redefined = TRUE;
2993 // mark config file token as well known from default config
2994 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2997 // check for config tokens that can be build by base token and suffixes
2998 for (i = 0; suffix_list[i].token != NULL; i++)
3000 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3001 char *value = getHashEntry(setup_file_hash, token);
3005 setString(&file_list_entry->parameter[i], value);
3007 // mark config file token as well known from default config
3008 setHashEntry(setup_file_hash, token, known_token_value);
3015 static void add_dynamic_file_list_entry(struct FileInfo **list,
3016 int *num_list_entries,
3017 SetupFileHash *extra_file_hash,
3018 struct ConfigTypeInfo *suffix_list,
3019 int num_suffix_list_entries,
3022 struct FileInfo *new_list_entry;
3023 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3025 (*num_list_entries)++;
3026 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3027 new_list_entry = &(*list)[*num_list_entries - 1];
3029 new_list_entry->token = getStringCopy(token);
3030 new_list_entry->default_filename = NULL;
3031 new_list_entry->filename = NULL;
3032 new_list_entry->parameter = checked_calloc(parameter_array_size);
3034 new_list_entry->redefined = FALSE;
3035 new_list_entry->fallback_to_default = FALSE;
3036 new_list_entry->default_is_cloned = FALSE;
3038 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3041 static void add_property_mapping(struct PropertyMapping **list,
3042 int *num_list_entries,
3043 int base_index, int ext1_index,
3044 int ext2_index, int ext3_index,
3047 struct PropertyMapping *new_list_entry;
3049 (*num_list_entries)++;
3050 *list = checked_realloc(*list,
3051 *num_list_entries * sizeof(struct PropertyMapping));
3052 new_list_entry = &(*list)[*num_list_entries - 1];
3054 new_list_entry->base_index = base_index;
3055 new_list_entry->ext1_index = ext1_index;
3056 new_list_entry->ext2_index = ext2_index;
3057 new_list_entry->ext3_index = ext3_index;
3059 new_list_entry->artwork_index = artwork_index;
3062 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3065 struct FileInfo *file_list = artwork_info->file_list;
3066 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3067 char **base_prefixes = artwork_info->base_prefixes;
3068 char **ext1_suffixes = artwork_info->ext1_suffixes;
3069 char **ext2_suffixes = artwork_info->ext2_suffixes;
3070 char **ext3_suffixes = artwork_info->ext3_suffixes;
3071 char **ignore_tokens = artwork_info->ignore_tokens;
3072 int num_file_list_entries = artwork_info->num_file_list_entries;
3073 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3074 int num_base_prefixes = artwork_info->num_base_prefixes;
3075 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3076 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3077 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3078 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3079 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3080 SetupFileHash *extra_file_hash, *empty_file_hash;
3081 char *known_token_value = KNOWN_TOKEN_VALUE;
3082 char *base_token_value = UNDEFINED_FILENAME;
3085 if (filename == NULL)
3088 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3091 // separate valid (defined) from empty (undefined) config token values
3092 valid_file_hash = newSetupFileHash();
3093 empty_file_hash = newSetupFileHash();
3094 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3096 char *value = HASH_ITERATION_VALUE(itr);
3098 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3099 HASH_ITERATION_TOKEN(itr), value);
3101 END_HASH_ITERATION(setup_file_hash, itr)
3103 // at this point, we do not need the setup file hash anymore -- free it
3104 freeSetupFileHash(setup_file_hash);
3106 // prevent changing hash while iterating over it by using a temporary copy
3107 valid_file_hash_tmp = newSetupFileHash();
3108 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3110 setHashEntry(valid_file_hash_tmp,
3111 HASH_ITERATION_TOKEN(itr),
3112 HASH_ITERATION_VALUE(itr));
3114 END_HASH_ITERATION(valid_file_hash, itr)
3116 // (iterate over same temporary hash, as modifications are independent)
3118 // map deprecated to current tokens (using prefix match and replace)
3119 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3121 char *token = HASH_ITERATION_TOKEN(itr);
3122 char *mapped_token = get_mapped_token(token);
3124 if (mapped_token != NULL)
3126 char *value = HASH_ITERATION_VALUE(itr);
3129 setHashEntry(valid_file_hash, mapped_token, value);
3131 // ignore old token (by setting it to "known" keyword)
3132 setHashEntry(valid_file_hash, token, known_token_value);
3137 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3139 // add special base tokens (using prefix match and replace)
3140 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3142 char *token = HASH_ITERATION_TOKEN(itr);
3143 char *base_token = get_special_base_token(artwork_info, token);
3145 if (base_token != NULL)
3147 // add base token only if it does not already exist
3148 if (getHashEntry(valid_file_hash, base_token) == NULL)
3149 setHashEntry(valid_file_hash, base_token, base_token_value);
3154 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3156 // free temporary hash used for iteration
3157 freeSetupFileHash(valid_file_hash_tmp);
3159 // read parameters for all known config file tokens
3160 for (i = 0; i < num_file_list_entries; i++)
3161 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3163 // set all tokens that can be ignored here to "known" keyword
3164 for (i = 0; i < num_ignore_tokens; i++)
3165 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3167 // copy all unknown config file tokens to extra config hash
3168 extra_file_hash = newSetupFileHash();
3169 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3171 char *value = HASH_ITERATION_VALUE(itr);
3173 if (!strEqual(value, known_token_value))
3174 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3176 END_HASH_ITERATION(valid_file_hash, itr)
3178 // at this point, we do not need the valid file hash anymore -- free it
3179 freeSetupFileHash(valid_file_hash);
3181 // now try to determine valid, dynamically defined config tokens
3183 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3185 struct FileInfo **dynamic_file_list =
3186 &artwork_info->dynamic_file_list;
3187 int *num_dynamic_file_list_entries =
3188 &artwork_info->num_dynamic_file_list_entries;
3189 struct PropertyMapping **property_mapping =
3190 &artwork_info->property_mapping;
3191 int *num_property_mapping_entries =
3192 &artwork_info->num_property_mapping_entries;
3193 int current_summarized_file_list_entry =
3194 artwork_info->num_file_list_entries +
3195 artwork_info->num_dynamic_file_list_entries;
3196 char *token = HASH_ITERATION_TOKEN(itr);
3197 int len_token = strlen(token);
3199 boolean base_prefix_found = FALSE;
3200 boolean parameter_suffix_found = FALSE;
3202 // skip all parameter definitions (handled by read_token_parameters())
3203 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3205 int len_suffix = strlen(suffix_list[i].token);
3207 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3208 parameter_suffix_found = TRUE;
3211 if (parameter_suffix_found)
3214 // ---------- step 0: search for matching base prefix ----------
3217 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3219 char *base_prefix = base_prefixes[i];
3220 int len_base_prefix = strlen(base_prefix);
3221 boolean ext1_suffix_found = FALSE;
3222 boolean ext2_suffix_found = FALSE;
3223 boolean ext3_suffix_found = FALSE;
3224 boolean exact_match = FALSE;
3225 int base_index = -1;
3226 int ext1_index = -1;
3227 int ext2_index = -1;
3228 int ext3_index = -1;
3230 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3232 if (!base_prefix_found)
3237 if (start_pos + len_base_prefix == len_token) // exact match
3241 add_dynamic_file_list_entry(dynamic_file_list,
3242 num_dynamic_file_list_entries,
3245 num_suffix_list_entries,
3247 add_property_mapping(property_mapping,
3248 num_property_mapping_entries,
3249 base_index, -1, -1, -1,
3250 current_summarized_file_list_entry);
3254 // ---------- step 1: search for matching first suffix ----------
3256 start_pos += len_base_prefix;
3257 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3259 char *ext1_suffix = ext1_suffixes[j];
3260 int len_ext1_suffix = strlen(ext1_suffix);
3262 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3264 if (!ext1_suffix_found)
3269 if (start_pos + len_ext1_suffix == len_token) // exact match
3273 add_dynamic_file_list_entry(dynamic_file_list,
3274 num_dynamic_file_list_entries,
3277 num_suffix_list_entries,
3279 add_property_mapping(property_mapping,
3280 num_property_mapping_entries,
3281 base_index, ext1_index, -1, -1,
3282 current_summarized_file_list_entry);
3286 start_pos += len_ext1_suffix;
3292 // ---------- step 2: search for matching second suffix ----------
3294 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3296 char *ext2_suffix = ext2_suffixes[k];
3297 int len_ext2_suffix = strlen(ext2_suffix);
3299 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3301 if (!ext2_suffix_found)
3306 if (start_pos + len_ext2_suffix == len_token) // exact match
3310 add_dynamic_file_list_entry(dynamic_file_list,
3311 num_dynamic_file_list_entries,
3314 num_suffix_list_entries,
3316 add_property_mapping(property_mapping,
3317 num_property_mapping_entries,
3318 base_index, ext1_index, ext2_index, -1,
3319 current_summarized_file_list_entry);
3323 start_pos += len_ext2_suffix;
3329 // ---------- step 3: search for matching third suffix ----------
3331 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3333 char *ext3_suffix = ext3_suffixes[l];
3334 int len_ext3_suffix = strlen(ext3_suffix);
3336 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3338 if (!ext3_suffix_found)
3343 if (start_pos + len_ext3_suffix == len_token) // exact match
3347 add_dynamic_file_list_entry(dynamic_file_list,
3348 num_dynamic_file_list_entries,
3351 num_suffix_list_entries,
3353 add_property_mapping(property_mapping,
3354 num_property_mapping_entries,
3355 base_index, ext1_index, ext2_index, ext3_index,
3356 current_summarized_file_list_entry);
3362 END_HASH_ITERATION(extra_file_hash, itr)
3364 if (artwork_info->num_dynamic_file_list_entries > 0)
3366 artwork_info->dynamic_artwork_list =
3367 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3368 artwork_info->sizeof_artwork_list_entry);
3371 if (options.verbose && IS_PARENT_PROCESS())
3373 SetupFileList *setup_file_list, *list;
3374 boolean dynamic_tokens_found = FALSE;
3375 boolean unknown_tokens_found = FALSE;
3376 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3378 // list may be NULL for empty artwork config files
3379 setup_file_list = loadSetupFileList(filename);
3381 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3383 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3384 dynamic_tokens_found = TRUE;
3386 unknown_tokens_found = TRUE;
3388 END_HASH_ITERATION(extra_file_hash, itr)
3390 if (options.debug && dynamic_tokens_found)
3392 Debug("config", "---");
3393 Debug("config", "dynamic token(s) found in config file:");
3394 Debug("config", "- config file: '%s'", filename);
3396 for (list = setup_file_list; list != NULL; list = list->next)
3398 char *value = getHashEntry(extra_file_hash, list->token);
3400 if (value != NULL && strEqual(value, known_token_value))
3401 Debug("config", "- dynamic token: '%s'", list->token);
3404 Debug("config", "---");
3407 if (unknown_tokens_found)
3410 Warn("unknown token(s) found in config file:");
3411 Warn("- config file: '%s'", filename);
3413 for (list = setup_file_list; list != NULL; list = list->next)
3415 char *value = getHashEntry(extra_file_hash, list->token);
3417 if (value != NULL && !strEqual(value, known_token_value))
3418 Warn("- dynamic token: '%s'", list->token);
3424 if (undefined_values_found)
3427 Warn("undefined values found in config file:");
3428 Warn("- config file: '%s'", filename);
3430 for (list = setup_file_list; list != NULL; list = list->next)
3432 char *value = getHashEntry(empty_file_hash, list->token);
3435 Warn("- undefined value for token: '%s'", list->token);
3441 freeSetupFileList(setup_file_list);
3444 freeSetupFileHash(extra_file_hash);
3445 freeSetupFileHash(empty_file_hash);
3448 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3450 struct FileInfo *file_list = artwork_info->file_list;
3451 int num_file_list_entries = artwork_info->num_file_list_entries;
3452 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3453 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3456 DrawInitText("Loading artwork config", 120, FC_GREEN);
3457 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3459 // always start with reliable default values
3460 for (i = 0; i < num_file_list_entries; i++)
3462 setString(&file_list[i].filename, file_list[i].default_filename);
3464 for (j = 0; j < num_suffix_list_entries; j++)
3465 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3467 file_list[i].redefined = FALSE;
3468 file_list[i].fallback_to_default = FALSE;
3471 // free previous dynamic artwork file array
3472 if (artwork_info->dynamic_file_list != NULL)
3474 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3476 free(artwork_info->dynamic_file_list[i].token);
3477 free(artwork_info->dynamic_file_list[i].filename);
3478 free(artwork_info->dynamic_file_list[i].parameter);
3481 free(artwork_info->dynamic_file_list);
3482 artwork_info->dynamic_file_list = NULL;
3484 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3485 &artwork_info->num_dynamic_file_list_entries);
3488 // free previous property mapping
3489 if (artwork_info->property_mapping != NULL)
3491 free(artwork_info->property_mapping);
3493 artwork_info->property_mapping = NULL;
3494 artwork_info->num_property_mapping_entries = 0;
3497 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3499 // first look for special artwork configured in level series config
3500 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3502 if (fileExists(filename_base))
3503 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3506 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3508 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3509 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3512 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3513 struct ListNodeInfo **listnode)
3517 char *filename = (*listnode)->source_filename;
3519 if (--(*listnode)->num_references <= 0)
3520 deleteNodeFromList(&artwork_info->content_list, filename,
3521 artwork_info->free_artwork);
3527 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3528 struct ListNodeInfo **listnode,
3529 struct FileInfo *file_list_entry)
3539 char *basename = file_list_entry->filename;
3540 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3542 if (filename == NULL)
3544 Warn("cannot find artwork file '%s'", basename);
3546 basename = file_list_entry->default_filename;
3548 // fail for cloned default artwork that has no default filename defined
3549 if (file_list_entry->default_is_cloned &&
3550 strEqual(basename, UNDEFINED_FILENAME))
3552 int error_mode = ERR_WARN;
3554 // we can get away without sounds and music, but not without graphics
3555 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3556 error_mode = ERR_EXIT;
3558 Error(error_mode, "token '%s' was cloned and has no default filename",
3559 file_list_entry->token);
3564 // dynamic artwork has no default filename / skip empty default artwork
3565 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3568 file_list_entry->fallback_to_default = TRUE;
3570 Warn("trying default artwork file '%s'", basename);
3572 filename = getCustomArtworkFilename(basename, artwork_info->type);
3574 if (filename == NULL)
3576 int error_mode = ERR_WARN;
3578 // we can get away without sounds and music, but not without graphics
3579 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3580 error_mode = ERR_EXIT;
3582 Error(error_mode, "cannot find default artwork file '%s'", basename);
3588 // check if the old and the new artwork file are the same
3589 if (*listnode && strEqual((*listnode)->source_filename, filename))
3591 // The old and new artwork are the same (have the same filename and path).
3592 // This usually means that this artwork does not exist in this artwork set
3593 // and a fallback to the existing artwork is done.
3598 // delete existing artwork file entry
3599 deleteArtworkListEntry(artwork_info, listnode);
3601 // check if the new artwork file already exists in the list of artwork
3602 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3604 *listnode = (struct ListNodeInfo *)node->content;
3605 (*listnode)->num_references++;
3610 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3611 DrawInitText(basename, 150, FC_YELLOW);
3613 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3615 // add new artwork file entry to the list of artwork files
3616 (*listnode)->num_references = 1;
3617 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3622 int error_mode = ERR_WARN;
3624 // we can get away without sounds and music, but not without graphics
3625 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3626 error_mode = ERR_EXIT;
3628 Error(error_mode, "cannot load artwork file '%s'", basename);
3634 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3635 struct ListNodeInfo **listnode,
3636 struct FileInfo *file_list_entry)
3638 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3640 deleteArtworkListEntry(artwork_info, listnode);
3645 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3648 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3650 struct FileInfo *file_list = artwork_info->file_list;
3651 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3652 int num_file_list_entries = artwork_info->num_file_list_entries;
3653 int num_dynamic_file_list_entries =
3654 artwork_info->num_dynamic_file_list_entries;
3657 print_timestamp_init("ReloadCustomArtworkList");
3659 for (i = 0; i < num_file_list_entries; i++)
3660 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3663 for (i = 0; i < num_dynamic_file_list_entries; i++)
3664 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3665 &dynamic_file_list[i]);
3667 print_timestamp_done("ReloadCustomArtworkList");
3670 dumpList(artwork_info->content_list);
3674 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3675 struct ListNodeInfo ***list,
3676 int *num_list_entries)
3683 for (i = 0; i < *num_list_entries; i++)
3684 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3688 *num_list_entries = 0;
3691 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3693 if (artwork_info == NULL)
3696 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3697 &artwork_info->num_file_list_entries);
3699 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3700 &artwork_info->num_dynamic_file_list_entries);
3704 // ----------------------------------------------------------------------------
3705 // functions only needed for non-Unix (non-command-line) systems
3706 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3707 // (now also added for Windows, to create files in user data directory)
3708 // ----------------------------------------------------------------------------
3710 char *getLogFilename(char *basename)
3712 return getPath2(getUserGameDataDir(), basename);
3715 void OpenLogFiles(void)
3719 InitUserDataDirectory();
3721 for (i = 0; i < NUM_LOGS; i++)
3723 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3726 program.log_file[i] = program.log_file_default[i]; // reset to default
3728 Warn("cannot open file '%s' for writing: %s",
3729 program.log_filename[i], strerror(errno));
3732 // output should be unbuffered so it is not truncated in a crash
3733 setbuf(program.log_file[i], NULL);
3737 void CloseLogFiles(void)
3741 for (i = 0; i < NUM_LOGS; i++)
3742 if (program.log_file[i] != program.log_file_default[i])
3743 fclose(program.log_file[i]);
3746 void DumpLogFile(int nr)
3748 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3750 if (log_file == NULL)
3753 while (!feof(log_file))
3754 fputc(fgetc(log_file), stdout);
3759 void NotifyUserAboutErrorFile(void)
3761 #if defined(PLATFORM_WIN32)
3762 char *title_text = getStringCat2(program.program_title, " Error Message");
3763 char *error_text = getStringCat2("The program was aborted due to an error; "
3764 "for details, see the following error file:"
3766 program.log_filename[LOG_ERR_ID]);
3768 MessageBox(NULL, error_text, title_text, MB_OK);
3773 // ----------------------------------------------------------------------------
3774 // the following is only for debugging purpose and normally not used
3775 // ----------------------------------------------------------------------------
3779 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3780 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3782 #define DEBUG_NUM_TIMESTAMPS 10
3783 #define DEBUG_TIME_IN_MICROSECONDS 0
3785 #if DEBUG_TIME_IN_MICROSECONDS
3786 static double Counter_Microseconds(void)
3788 static struct timeval base_time = { 0, 0 };
3789 struct timeval current_time;
3792 gettimeofday(¤t_time, NULL);
3794 // reset base time in case of wrap-around
3795 if (current_time.tv_sec < base_time.tv_sec)
3796 base_time = current_time;
3799 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3800 ((double)(current_time.tv_usec - base_time.tv_usec));
3802 return counter; // return microseconds since last init
3806 static char *debug_print_timestamp_get_padding(int padding_size)
3808 static char *padding = NULL;
3809 int max_padding_size = 100;
3811 if (padding == NULL)
3813 padding = checked_calloc(max_padding_size + 1);
3814 memset(padding, ' ', max_padding_size);
3817 return &padding[MAX(0, max_padding_size - padding_size)];
3820 void debug_print_timestamp(int counter_nr, char *message)
3822 int indent_size = 8;
3823 int padding_size = 40;
3824 float timestamp_interval;
3827 Error(ERR_EXIT, "debugging: invalid negative counter");
3828 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3829 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3831 #if DEBUG_TIME_IN_MICROSECONDS
3832 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3835 counter[counter_nr][0] = Counter_Microseconds();
3837 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3840 counter[counter_nr][0] = Counter();
3843 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3844 counter[counter_nr][1] = counter[counter_nr][0];
3847 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3848 debug_print_timestamp_get_padding(counter_nr * indent_size),
3850 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3851 timestamp_interval / 1000,
3856 static void debug_print_parent_only(char *format, ...)
3858 if (!IS_PARENT_PROCESS())
3865 va_start(ap, format);
3866 vprintf(format, ap);
3876 static void print_timestamp_ext(char *message, char *mode)
3878 #if DEBUG_PRINT_INIT_TIMESTAMPS
3879 static char *debug_message = NULL;
3880 static char *last_message = NULL;
3881 static int counter_nr = 0;
3882 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3884 checked_free(debug_message);
3885 debug_message = getStringCat3(mode, " ", message);
3887 if (strEqual(mode, "INIT"))
3889 debug_print_timestamp(counter_nr, NULL);
3891 if (counter_nr + 1 < max_depth)
3892 debug_print_timestamp(counter_nr, debug_message);
3896 debug_print_timestamp(counter_nr, NULL);
3898 else if (strEqual(mode, "DONE"))
3902 if (counter_nr + 1 < max_depth ||
3903 (counter_nr == 0 && max_depth == 1))
3905 last_message = message;
3907 if (counter_nr == 0 && max_depth == 1)
3909 checked_free(debug_message);
3910 debug_message = getStringCat3("TIME", " ", message);
3913 debug_print_timestamp(counter_nr, debug_message);
3916 else if (!strEqual(mode, "TIME") ||
3917 !strEqual(message, last_message))
3919 if (counter_nr < max_depth)
3920 debug_print_timestamp(counter_nr, debug_message);
3925 void print_timestamp_init(char *message)
3927 print_timestamp_ext(message, "INIT");
3930 void print_timestamp_time(char *message)
3932 print_timestamp_ext(message, "TIME");
3935 void print_timestamp_done(char *message)
3937 print_timestamp_ext(message, "DONE");