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 (log_level == LOG_DEBUG)
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 !strEqual(options.debug_mode, mode))
307 #if defined(PLATFORM_ANDROID)
308 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
309 log_level == LOG_INFO ? ANDROID_LOG_INFO :
310 log_level == LOG_WARN ? ANDROID_LOG_WARN :
311 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
312 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
313 ANDROID_LOG_UNKNOWN);
316 static boolean last_line_was_separator = FALSE;
317 char *log_token = log_tokens[log_level];
319 if (strEqual(format, "===") ||
320 strEqual(format, "---"))
322 static char *mode_last = NULL;
323 char line_char[2] = { format[0], '\0' };
324 int line_length = 80 - strlen(log_token) - 3;
326 if (log_level == LOG_DEBUG)
327 line_length -= strlen(mode) + 3;
329 if (last_line_was_separator && strEqual(mode, mode_last))
332 printf_log_prefix(log_level, mode);
333 printf_log_line(line_char, line_length);
335 if (!strEqual(mode, mode_last))
336 setString(&mode_last, mode);
338 last_line_was_separator = TRUE;
343 last_line_was_separator = FALSE;
345 printf_log_prefix(log_level, mode);
347 vprintf_log(format, ap);
350 void Debug(char *mode, char *format, ...)
354 va_start(ap, format);
355 Log(LOG_DEBUG, mode, format, ap);
359 void Info(char *format, ...)
363 va_start(ap, format);
364 Log(LOG_INFO, NULL, format, ap);
368 void Warn(char *format, ...)
372 va_start(ap, format);
373 Log(LOG_WARN, NULL, format, ap);
378 // ----------------------------------------------------------------------------
380 // ----------------------------------------------------------------------------
382 /* int2str() returns a number converted to a string;
383 the used memory is static, but will be overwritten by later calls,
384 so if you want to save the result, copy it to a private string buffer;
385 there can be 10 local calls of int2str() without buffering the result --
386 the 11th call will then destroy the result from the first call and so on. */
388 char *int2str(int number, int size)
390 static char shift_array[10][40];
391 static int shift_counter = 0;
392 char *s = shift_array[shift_counter];
394 shift_counter = (shift_counter + 1) % 10;
401 sprintf(s, " %09d", number);
402 return &s[strlen(s) - size];
406 sprintf(s, "%d", number);
412 // something similar to "int2str()" above, but allocates its own memory
413 // and has a different interface; we cannot use "itoa()", because this
414 // seems to be already defined when cross-compiling to the win32 target
416 char *i_to_a(unsigned int i)
418 static char *a = NULL;
422 if (i > 2147483647) // yes, this is a kludge
425 a = checked_malloc(10 + 1);
433 // calculate base-2 logarithm of argument (rounded down to integer;
434 // this function returns the number of the highest bit set in argument)
436 int log_2(unsigned int x)
442 x -= (1 << e); // for rounding down (rounding up: remove this line)
449 boolean getTokenValueFromString(char *string, char **token, char **value)
451 return getTokenValueFromSetupLine(string, token, value);
455 // ----------------------------------------------------------------------------
457 // ----------------------------------------------------------------------------
459 // maximal allowed length of a command line option
460 #define MAX_OPTION_LEN 256
462 static unsigned int getCurrentMS(void)
464 return SDL_GetTicks();
467 static unsigned int mainCounter(int mode)
469 static unsigned int base_ms = 0;
470 unsigned int current_ms;
472 // get current system milliseconds
473 current_ms = getCurrentMS();
475 // reset base timestamp in case of counter reset or wrap-around
476 if (mode == INIT_COUNTER || current_ms < base_ms)
477 base_ms = current_ms;
479 // return milliseconds since last counter reset
480 return current_ms - base_ms;
483 void InitCounter() // set counter back to zero
485 mainCounter(INIT_COUNTER);
488 unsigned int Counter() // get milliseconds since last call of InitCounter()
490 return mainCounter(READ_COUNTER);
493 static void sleep_milliseconds(unsigned int milliseconds_delay)
495 SDL_Delay(milliseconds_delay);
498 void Delay(unsigned int delay) // Sleep specified number of milliseconds
500 sleep_milliseconds(delay);
503 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
504 unsigned int actual_counter)
506 if (actual_counter >= *counter_var &&
507 actual_counter < *counter_var + delay)
510 *counter_var = actual_counter;
515 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
517 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
520 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
522 return DelayReachedExt(counter_var, delay, Counter());
525 void ResetDelayCounterExt(unsigned int *counter_var,
526 unsigned int actual_counter)
528 DelayReachedExt(counter_var, 0, actual_counter);
531 void ResetFrameCounter(unsigned int *frame_counter_var)
533 FrameReached(frame_counter_var, 0);
536 void ResetDelayCounter(unsigned int *counter_var)
538 DelayReached(counter_var, 0);
541 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
543 unsigned int actual_counter;
548 actual_counter = Counter();
550 if (actual_counter >= *counter_var &&
551 actual_counter < *counter_var + delay)
552 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
557 if (*counter_var != 0 &&
559 actual_counter >= *counter_var + delay)
561 int lag = actual_counter - (*counter_var + delay);
562 int delay2 = (delay + 1) / 2;
565 skip_frames = (lag + delay2) / delay;
568 *counter_var = actual_counter;
573 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
574 int *loop_var, int last_loop_value)
576 int skip_frames = WaitUntilDelayReached(counter_var, delay);
581 Debug("internal:SkipUntilDelayReached",
582 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
584 skip_frames, skip_frames * delay);
586 Debug("internal:SkipUntilDelayReached",
592 if (skip_frames == 0)
595 // when skipping frames, make sure to never skip the last frame, as
596 // this may be needed for animations to reach a defined end state;
597 // furthermore, we assume that this function is called at the end
598 // of a "for" loop, which continues by incrementing the loop variable
599 // by one before checking the loop condition again; therefore we have
600 // to check against the last loop value minus one here
604 if (*loop_var < last_loop_value) // never skip the last frame
606 *loop_var += skip_frames;
608 if (*loop_var > last_loop_value) // never skip the last frame
609 *loop_var = last_loop_value;
614 // ----------------------------------------------------------------------------
615 // random generator functions
616 // ----------------------------------------------------------------------------
618 unsigned int init_random_number(int nr, int seed)
620 if (seed == NEW_RANDOMIZE)
622 // default random seed
623 seed = (int)time(NULL); // seconds since the epoch
625 #if !defined(PLATFORM_WIN32)
626 // add some more randomness
627 struct timeval current_time;
629 gettimeofday(¤t_time, NULL);
631 seed += (int)current_time.tv_usec; // microseconds since the epoch
634 // add some more randomness
635 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
637 // add some more randomness
638 seed += GetSimpleRandom(1000000);
641 srandom_linux_libc(nr, (unsigned int) seed);
643 return (unsigned int) seed;
646 unsigned int get_random_number(int nr, int max)
648 return (max > 0 ? random_linux_libc(nr) % max : 0);
652 // ----------------------------------------------------------------------------
653 // system info functions
654 // ----------------------------------------------------------------------------
656 #if !defined(PLATFORM_ANDROID)
657 static char *get_corrected_real_name(char *real_name)
659 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
660 char *from_ptr = real_name;
661 char *to_ptr = real_name_new;
663 // copy the name string, but not more than MAX_USERNAME_LEN characters
664 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
666 // the name field read from "passwd" file may also contain additional
667 // user information, separated by commas, which will be removed here
668 if (*from_ptr == ',')
671 // the user's real name may contain 'german sharp s' characters,
672 // which have no equivalent in upper case letters (used by our fonts)
673 if (*from_ptr == CHAR_BYTE_SHARP_S)
680 *to_ptr++ = *from_ptr++;
685 return real_name_new;
689 char *getLoginName(void)
691 static char *login_name = NULL;
693 #if defined(PLATFORM_WIN32)
694 if (login_name == NULL)
696 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
697 login_name = checked_malloc(buffer_size);
699 if (GetUserName(login_name, &buffer_size) == 0)
700 strcpy(login_name, ANONYMOUS_NAME);
702 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
703 if (login_name == NULL)
707 if ((pwd = getpwuid(getuid())) == NULL)
708 login_name = ANONYMOUS_NAME;
710 login_name = getStringCopy(pwd->pw_name);
713 login_name = ANONYMOUS_NAME;
719 char *getRealName(void)
721 static char *real_name = NULL;
723 #if defined(PLATFORM_WIN32)
724 if (real_name == NULL)
726 static char buffer[MAX_USERNAME_LEN + 1];
727 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
729 if (GetUserName(buffer, &buffer_size) != 0)
730 real_name = get_corrected_real_name(buffer);
732 real_name = ANONYMOUS_NAME;
734 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
735 if (real_name == NULL)
739 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
740 real_name = get_corrected_real_name(pwd->pw_gecos);
742 real_name = ANONYMOUS_NAME;
745 real_name = ANONYMOUS_NAME;
751 time_t getFileTimestampEpochSeconds(char *filename)
753 struct stat file_status;
755 if (stat(filename, &file_status) != 0) // cannot stat file
758 return file_status.st_mtime;
762 // ----------------------------------------------------------------------------
763 // path manipulation functions
764 // ----------------------------------------------------------------------------
766 static char *getLastPathSeparatorPtr(char *filename)
768 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
770 if (last_separator == NULL) // also try DOS/Windows variant
771 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
773 return last_separator;
776 char *getBaseNamePtr(char *filename)
778 char *last_separator = getLastPathSeparatorPtr(filename);
780 if (last_separator != NULL)
781 return last_separator + 1; // separator found: strip base path
783 return filename; // no separator found: filename has no path
786 char *getBaseName(char *filename)
788 return getStringCopy(getBaseNamePtr(filename));
791 char *getBaseNameNoSuffix(char *filename)
793 char *basename = getStringCopy(getBaseNamePtr(filename));
795 // remove trailing suffix (separated by dot or hyphen)
796 if (basename[0] != '.' && basename[0] != '-')
798 if (strchr(basename, '.') != NULL)
799 *strchr(basename, '.') = '\0';
801 if (strchr(basename, '-') != NULL)
802 *strchr(basename, '-') = '\0';
808 char *getBasePath(char *filename)
810 char *basepath = getStringCopy(filename);
811 char *last_separator = getLastPathSeparatorPtr(basepath);
813 // if no separator was found, use current directory
814 if (last_separator == NULL)
818 return getStringCopy(".");
821 // separator found: strip basename
822 *last_separator = '\0';
828 // ----------------------------------------------------------------------------
829 // various string functions
830 // ----------------------------------------------------------------------------
832 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
834 if (s1 == NULL || s2 == NULL || sep == NULL)
837 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
840 sprintf(complete_string, "%s%s%s", s1, sep, s2);
842 return complete_string;
845 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
847 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
850 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
851 strlen(s2) + strlen(sep) +
854 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
856 return complete_string;
859 char *getStringCat2(char *s1, char *s2)
861 return getStringCat2WithSeparator(s1, s2, "");
864 char *getStringCat3(char *s1, char *s2, char *s3)
866 return getStringCat3WithSeparator(s1, s2, s3, "");
869 char *getPath2(char *path1, char *path2)
871 #if defined(PLATFORM_ANDROID)
872 // workaround for reading from assets directory -- skip "." subdirs in path
873 if (strEqual(path1, "."))
874 return getStringCopy(path2);
875 else if (strEqual(path2, "."))
876 return getStringCopy(path1);
879 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
882 char *getPath3(char *path1, char *path2, char *path3)
884 #if defined(PLATFORM_ANDROID)
885 // workaround for reading from assets directory -- skip "." subdirs in path
886 if (strEqual(path1, "."))
887 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
888 else if (strEqual(path2, "."))
889 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
890 else if (strEqual(path3, "."))
891 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
894 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
897 static char *getPngOrPcxIfNotExists(char *filename)
899 // switch from PNG to PCX file and vice versa, if file does not exist
900 // (backwards compatibility with PCX files used in previous versions)
902 if (!fileExists(filename) && strSuffix(filename, ".png"))
903 strcpy(&filename[strlen(filename) - 3], "pcx");
904 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
905 strcpy(&filename[strlen(filename) - 3], "png");
910 char *getImg2(char *path1, char *path2)
912 return getPngOrPcxIfNotExists(getPath2(path1, path2));
915 char *getImg3(char *path1, char *path2, char *path3)
917 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
920 char *getStringCopy(const char *s)
927 s_copy = checked_malloc(strlen(s) + 1);
933 char *getStringCopyN(const char *s, int n)
936 int s_len = MAX(0, n);
941 s_copy = checked_malloc(s_len + 1);
942 strncpy(s_copy, s, s_len);
943 s_copy[s_len] = '\0';
948 char *getStringCopyNStatic(const char *s, int n)
950 static char *s_copy = NULL;
952 checked_free(s_copy);
954 s_copy = getStringCopyN(s, n);
959 char *getStringToLower(const char *s)
961 char *s_copy = checked_malloc(strlen(s) + 1);
962 char *s_ptr = s_copy;
965 *s_ptr++ = tolower(*s++);
971 void setString(char **old_value, char *new_value)
973 checked_free(*old_value);
975 *old_value = getStringCopy(new_value);
978 boolean strEqual(char *s1, char *s2)
980 return (s1 == NULL && s2 == NULL ? TRUE :
981 s1 == NULL && s2 != NULL ? FALSE :
982 s1 != NULL && s2 == NULL ? FALSE :
983 strcmp(s1, s2) == 0);
986 boolean strEqualN(char *s1, char *s2, int n)
988 return (s1 == NULL && s2 == NULL ? TRUE :
989 s1 == NULL && s2 != NULL ? FALSE :
990 s1 != NULL && s2 == NULL ? FALSE :
991 strncmp(s1, s2, n) == 0);
994 boolean strPrefix(char *s, char *prefix)
996 return (s == NULL && prefix == NULL ? TRUE :
997 s == NULL && prefix != NULL ? FALSE :
998 s != NULL && prefix == NULL ? FALSE :
999 strncmp(s, prefix, strlen(prefix)) == 0);
1002 boolean strSuffix(char *s, char *suffix)
1004 return (s == NULL && suffix == NULL ? TRUE :
1005 s == NULL && suffix != NULL ? FALSE :
1006 s != NULL && suffix == NULL ? FALSE :
1007 strlen(s) < strlen(suffix) ? FALSE :
1008 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1011 boolean strPrefixLower(char *s, char *prefix)
1013 char *s_lower = getStringToLower(s);
1014 boolean match = strPrefix(s_lower, prefix);
1021 boolean strSuffixLower(char *s, char *suffix)
1023 char *s_lower = getStringToLower(s);
1024 boolean match = strSuffix(s_lower, suffix);
1032 // ----------------------------------------------------------------------------
1033 // command line option handling functions
1034 // ----------------------------------------------------------------------------
1036 void GetOptions(int argc, char *argv[],
1037 void (*print_usage_function)(void),
1038 void (*print_version_function)(void))
1040 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1041 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1042 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1043 char **options_left = &argvplus[1];
1045 // replace original "argv" with null-terminated array of string pointers
1047 argvplus[argc] = argv[argc];
1049 // initialize global program options
1050 options.server_host = NULL;
1051 options.server_port = 0;
1053 options.ro_base_directory = ro_base_path;
1054 options.rw_base_directory = rw_base_path;
1055 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1056 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1057 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1058 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1059 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1060 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1062 options.execute_command = NULL;
1063 options.special_flags = NULL;
1064 options.debug_mode = NULL;
1066 options.mytapes = FALSE;
1067 options.serveronly = FALSE;
1068 options.network = FALSE;
1069 options.verbose = FALSE;
1070 options.debug = FALSE;
1073 options.verbose = TRUE;
1075 #if !defined(PLATFORM_UNIX)
1076 if (*options_left == NULL) // no options given -- enable verbose mode
1077 options.verbose = TRUE;
1082 #if defined(PLATFORM_ANDROID)
1083 options.debug = TRUE;
1087 while (*options_left)
1089 char option_str[MAX_OPTION_LEN];
1090 char *option = options_left[0];
1091 char *next_option = options_left[1];
1092 char *option_arg = NULL;
1093 int option_len = strlen(option);
1095 if (option_len >= MAX_OPTION_LEN)
1096 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1098 strcpy(option_str, option); // copy argument into buffer
1099 option = option_str;
1101 if (strEqual(option, "--")) // stop scanning arguments
1104 if (strPrefix(option, "--")) // treat '--' like '-'
1107 option_arg = strchr(option, '=');
1108 if (option_arg == NULL) // no '=' in option
1109 option_arg = next_option;
1112 *option_arg++ = '\0'; // cut argument from option
1113 if (*option_arg == '\0') // no argument after '='
1114 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1117 option_len = strlen(option);
1119 if (strEqual(option, "-"))
1121 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1123 else if (strncmp(option, "-help", option_len) == 0)
1125 print_usage_function();
1129 else if (strncmp(option, "-basepath", option_len) == 0)
1131 if (option_arg == NULL)
1132 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1134 // this should be extended to separate options for ro and rw data
1135 options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1136 options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1137 if (option_arg == next_option)
1140 // adjust paths for sub-directories in base directory accordingly
1141 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1142 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1143 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1144 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1145 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1146 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1148 else if (strncmp(option, "-levels", option_len) == 0)
1150 if (option_arg == NULL)
1151 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1153 options.level_directory = getStringCopy(option_arg);
1154 if (option_arg == next_option)
1157 else if (strncmp(option, "-graphics", option_len) == 0)
1159 if (option_arg == NULL)
1160 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1162 options.graphics_directory = getStringCopy(option_arg);
1163 if (option_arg == next_option)
1166 else if (strncmp(option, "-sounds", option_len) == 0)
1168 if (option_arg == NULL)
1169 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1171 options.sounds_directory = getStringCopy(option_arg);
1172 if (option_arg == next_option)
1175 else if (strncmp(option, "-music", option_len) == 0)
1177 if (option_arg == NULL)
1178 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1180 options.music_directory = getStringCopy(option_arg);
1181 if (option_arg == next_option)
1184 else if (strncmp(option, "-mytapes", option_len) == 0)
1186 options.mytapes = TRUE;
1188 else if (strncmp(option, "-network", option_len) == 0)
1190 options.network = TRUE;
1192 else if (strncmp(option, "-serveronly", option_len) == 0)
1194 options.serveronly = TRUE;
1196 else if (strncmp(option, "-debug", option_len) == 0)
1198 options.debug = TRUE;
1200 // optionally, debug output can be limited to a specific debug mode
1201 if (option_arg != next_option)
1202 options.debug_mode = getStringCopy(option_arg);
1204 else if (strncmp(option, "-verbose", option_len) == 0)
1206 options.verbose = TRUE;
1208 else if (strncmp(option, "-version", option_len) == 0 ||
1209 strncmp(option, "-V", option_len) == 0)
1211 print_version_function();
1215 else if (strPrefix(option, "-D"))
1217 options.special_flags = getStringCopy(&option[2]);
1219 else if (strncmp(option, "-execute", option_len) == 0)
1221 if (option_arg == NULL)
1222 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1224 options.execute_command = getStringCopy(option_arg);
1225 if (option_arg == next_option)
1228 // when doing batch processing, always enable verbose mode (warnings)
1229 options.verbose = TRUE;
1231 #if defined(PLATFORM_MACOSX)
1232 else if (strPrefix(option, "-psn"))
1234 // ignore process serial number when launched via GUI on Mac OS X
1237 else if (*option == '-')
1239 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1241 else if (options.server_host == NULL)
1243 options.server_host = *options_left;
1245 else if (options.server_port == 0)
1247 options.server_port = atoi(*options_left);
1248 if (options.server_port < 1024)
1249 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1252 Error(ERR_EXIT_HELP, "too many arguments");
1259 // ----------------------------------------------------------------------------
1260 // error handling functions
1261 // ----------------------------------------------------------------------------
1263 #define MAX_INTERNAL_ERROR_SIZE 1024
1265 // used by SetError() and GetError() to store internal error messages
1266 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1268 void SetError(char *format, ...)
1272 va_start(ap, format);
1273 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1277 char *GetError(void)
1279 return internal_error;
1282 void Error(int mode, char *format, ...)
1284 static boolean last_line_was_separator = FALSE;
1285 char *process_name = "";
1287 if (program.log_file[LOG_ERR_ID] == NULL)
1290 #if defined(PLATFORM_ANDROID)
1291 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1292 mode & ERR_INFO ? ANDROID_LOG_INFO :
1293 mode & ERR_WARN ? ANDROID_LOG_WARN :
1294 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1295 ANDROID_LOG_UNKNOWN);
1298 // display debug messages only when running in debug mode
1299 if (mode & ERR_DEBUG && !options.debug)
1302 // display warnings only when running in verbose mode
1303 if (mode & ERR_WARN && !options.verbose)
1306 if (mode == ERR_INFO_LINE)
1308 if (!last_line_was_separator)
1309 printf_log_line(format, 79);
1311 last_line_was_separator = TRUE;
1316 last_line_was_separator = FALSE;
1318 if (mode & ERR_SOUND_SERVER)
1319 process_name = " sound server";
1320 else if (mode & ERR_NETWORK_SERVER)
1321 process_name = " network server";
1322 else if (mode & ERR_NETWORK_CLIENT)
1323 process_name = " network client **";
1327 #if !defined(PLATFORM_ANDROID)
1328 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1331 if (mode & ERR_WARN)
1332 printf_log_nonewline("warning: ");
1334 if (mode & ERR_EXIT)
1335 printf_log_nonewline("fatal error: ");
1339 va_start(ap, format);
1340 vprintf_log(format, ap);
1343 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1345 va_start(ap, format);
1346 program.exit_message_function(format, ap);
1351 if (mode & ERR_HELP)
1352 printf_log("%s: Try option '--help' for more information.",
1353 program.command_basename);
1355 if (mode & ERR_EXIT)
1356 printf_log("%s%s: aborting", program.command_basename, process_name);
1358 if (mode & ERR_EXIT)
1360 if (mode & ERR_FROM_SERVER)
1361 exit(1); // child process: normal exit
1363 program.exit_function(1); // main process: clean up stuff
1368 // ----------------------------------------------------------------------------
1369 // checked memory allocation and freeing functions
1370 // ----------------------------------------------------------------------------
1372 void *checked_malloc(unsigned int size)
1379 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1384 void *checked_calloc(unsigned int size)
1388 ptr = calloc(1, size);
1391 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1396 void *checked_realloc(void *ptr, unsigned int size)
1398 ptr = realloc(ptr, size);
1401 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1406 void checked_free(void *ptr)
1408 if (ptr != NULL) // this check should be done by free() anyway
1412 void clear_mem(void *ptr, unsigned int size)
1414 #if defined(PLATFORM_WIN32)
1415 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1416 char *cptr = (char *)ptr;
1421 memset(ptr, 0, size);
1426 // ----------------------------------------------------------------------------
1427 // various helper functions
1428 // ----------------------------------------------------------------------------
1430 void swap_numbers(int *i1, int *i2)
1438 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1450 /* the "put" variants of the following file access functions check for the file
1451 pointer being != NULL and return the number of bytes they have or would have
1452 written; this allows for chunk writing functions to first determine the size
1453 of the (not yet written) chunk, write the correct chunk size and finally
1454 write the chunk itself */
1456 int getFile8BitInteger(File *file)
1458 return getByteFromFile(file);
1461 int putFile8BitInteger(FILE *file, int value)
1469 int getFile16BitInteger(File *file, int byte_order)
1471 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1472 return ((getByteFromFile(file) << 8) |
1473 (getByteFromFile(file) << 0));
1474 else // BYTE_ORDER_LITTLE_ENDIAN
1475 return ((getByteFromFile(file) << 0) |
1476 (getByteFromFile(file) << 8));
1479 int putFile16BitInteger(FILE *file, int value, int byte_order)
1483 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1485 fputc((value >> 8) & 0xff, file);
1486 fputc((value >> 0) & 0xff, file);
1488 else // BYTE_ORDER_LITTLE_ENDIAN
1490 fputc((value >> 0) & 0xff, file);
1491 fputc((value >> 8) & 0xff, file);
1498 int getFile32BitInteger(File *file, int byte_order)
1500 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1501 return ((getByteFromFile(file) << 24) |
1502 (getByteFromFile(file) << 16) |
1503 (getByteFromFile(file) << 8) |
1504 (getByteFromFile(file) << 0));
1505 else // BYTE_ORDER_LITTLE_ENDIAN
1506 return ((getByteFromFile(file) << 0) |
1507 (getByteFromFile(file) << 8) |
1508 (getByteFromFile(file) << 16) |
1509 (getByteFromFile(file) << 24));
1512 int putFile32BitInteger(FILE *file, int value, int byte_order)
1516 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1518 fputc((value >> 24) & 0xff, file);
1519 fputc((value >> 16) & 0xff, file);
1520 fputc((value >> 8) & 0xff, file);
1521 fputc((value >> 0) & 0xff, file);
1523 else // BYTE_ORDER_LITTLE_ENDIAN
1525 fputc((value >> 0) & 0xff, file);
1526 fputc((value >> 8) & 0xff, file);
1527 fputc((value >> 16) & 0xff, file);
1528 fputc((value >> 24) & 0xff, file);
1535 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1538 const int chunk_name_length = 4;
1541 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1544 if (chunk_size != NULL)
1547 *chunk_size = getFile32BitInteger(file, byte_order);
1550 return (checkEndOfFile(file) ? FALSE : TRUE);
1553 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1560 fputs(chunk_name, file);
1562 num_bytes += strlen(chunk_name);
1564 if (chunk_size >= 0)
1568 putFile32BitInteger(file, chunk_size, byte_order);
1576 int getFileVersion(File *file)
1578 int version_super = getByteFromFile(file);
1579 int version_major = getByteFromFile(file);
1580 int version_minor = getByteFromFile(file);
1581 int version_patch = getByteFromFile(file);
1583 return VERSION_IDENT(version_super, version_major, version_minor,
1587 int putFileVersion(FILE *file, int version)
1591 int version_super = VERSION_SUPER(version);
1592 int version_major = VERSION_MAJOR(version);
1593 int version_minor = VERSION_MINOR(version);
1594 int version_patch = VERSION_PATCH(version);
1596 fputc(version_super, file);
1597 fputc(version_major, file);
1598 fputc(version_minor, file);
1599 fputc(version_patch, file);
1605 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1609 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1610 buffer[i] = getByteFromFile(file);
1613 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1617 for (i = 0; i < bytes; i++)
1618 fputc(buffer[i], file);
1621 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1623 while (bytes-- && !checkEndOfFile(file))
1624 getByteFromFile(file);
1627 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1634 // ----------------------------------------------------------------------------
1635 // functions to translate key identifiers between different format
1636 // ----------------------------------------------------------------------------
1638 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1639 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1640 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1641 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1643 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1652 // return and escape keys
1653 { KSYM_Return, "XK_Return", "return" },
1654 { KSYM_Escape, "XK_Escape", "escape" },
1656 // normal cursor keys
1657 { KSYM_Left, "XK_Left", "cursor left" },
1658 { KSYM_Right, "XK_Right", "cursor right" },
1659 { KSYM_Up, "XK_Up", "cursor up" },
1660 { KSYM_Down, "XK_Down", "cursor down" },
1662 // keypad cursor keys
1664 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1665 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1666 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1667 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1670 // other keypad keys
1671 #ifdef KSYM_KP_Enter
1672 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1673 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1674 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1675 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1676 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1677 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1681 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1682 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1683 { KSYM_Control_L, "XK_Control_L", "left control" },
1684 { KSYM_Control_R, "XK_Control_R", "right control" },
1685 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1686 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1687 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1688 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1689 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1690 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1692 // some special keys
1693 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1694 { KSYM_Delete, "XK_Delete", "delete" },
1695 { KSYM_Insert, "XK_Insert", "insert" },
1696 { KSYM_Tab, "XK_Tab", "tab" },
1697 { KSYM_Home, "XK_Home", "home" },
1698 { KSYM_End, "XK_End", "end" },
1699 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1700 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1702 { KSYM_Select, "XK_Select", "select" },
1703 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1704 { KSYM_Back, "XK_Back", "back" }, // back key
1705 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1706 #if defined(PLATFORM_ANDROID)
1707 { KSYM_Rewind, "XK_Rewind", "rewind" },
1708 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1711 // ASCII 0x20 to 0x40 keys (except numbers)
1712 { KSYM_space, "XK_space", "space" },
1713 { KSYM_exclam, "XK_exclam", "!" },
1714 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1715 { KSYM_numbersign, "XK_numbersign", "#" },
1716 { KSYM_dollar, "XK_dollar", "$" },
1717 { KSYM_percent, "XK_percent", "%" },
1718 { KSYM_ampersand, "XK_ampersand", "&" },
1719 { KSYM_apostrophe, "XK_apostrophe", "'" },
1720 { KSYM_parenleft, "XK_parenleft", "(" },
1721 { KSYM_parenright, "XK_parenright", ")" },
1722 { KSYM_asterisk, "XK_asterisk", "*" },
1723 { KSYM_plus, "XK_plus", "+" },
1724 { KSYM_comma, "XK_comma", "," },
1725 { KSYM_minus, "XK_minus", "-" },
1726 { KSYM_period, "XK_period", "." },
1727 { KSYM_slash, "XK_slash", "/" },
1728 { KSYM_colon, "XK_colon", ":" },
1729 { KSYM_semicolon, "XK_semicolon", ";" },
1730 { KSYM_less, "XK_less", "<" },
1731 { KSYM_equal, "XK_equal", "=" },
1732 { KSYM_greater, "XK_greater", ">" },
1733 { KSYM_question, "XK_question", "?" },
1734 { KSYM_at, "XK_at", "@" },
1737 { KSYM_bracketleft, "XK_bracketleft", "[" },
1738 { KSYM_backslash, "XK_backslash", "\\" },
1739 { KSYM_bracketright,"XK_bracketright", "]" },
1740 { KSYM_asciicircum, "XK_asciicircum", "^" },
1741 { KSYM_underscore, "XK_underscore", "_" },
1742 { KSYM_grave, "XK_grave", "grave" },
1743 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1744 { KSYM_braceleft, "XK_braceleft", "brace left" },
1745 { KSYM_bar, "XK_bar", "bar" },
1746 { KSYM_braceright, "XK_braceright", "brace right" },
1747 { KSYM_asciitilde, "XK_asciitilde", "~" },
1749 // special (non-ASCII) keys
1750 { KSYM_degree, "XK_degree", "degree" },
1751 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1752 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1753 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1754 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1755 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1756 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1757 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1759 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1760 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1761 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1762 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1763 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1764 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1765 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1766 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1767 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1769 // other keys (for reverse mapping only)
1770 { KSYM_space, "XK_space", " " },
1772 // keypad keys are not in numerical order in SDL2
1773 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1774 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1775 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1776 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1777 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1778 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1779 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1780 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1781 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1782 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1784 // end-of-array identifier
1790 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1792 static char name_buffer[30];
1795 if (key >= KSYM_A && key <= KSYM_Z)
1796 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1797 else if (key >= KSYM_a && key <= KSYM_z)
1798 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1799 else if (key >= KSYM_0 && key <= KSYM_9)
1800 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1801 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1802 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1803 else if (key == KSYM_UNDEFINED)
1804 strcpy(name_buffer, "(undefined)");
1811 if (key == translate_key[i].key)
1813 strcpy(name_buffer, translate_key[i].name);
1817 while (translate_key[++i].name);
1819 if (!translate_key[i].name)
1820 strcpy(name_buffer, "(unknown)");
1823 *name = name_buffer;
1825 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1827 static char name_buffer[30];
1830 if (key >= KSYM_A && key <= KSYM_Z)
1831 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1832 else if (key >= KSYM_a && key <= KSYM_z)
1833 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1834 else if (key >= KSYM_0 && key <= KSYM_9)
1835 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1836 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1837 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1838 else if (key == KSYM_UNDEFINED)
1839 strcpy(name_buffer, "[undefined]");
1846 if (key == translate_key[i].key)
1848 strcpy(name_buffer, translate_key[i].x11name);
1852 while (translate_key[++i].x11name);
1854 if (!translate_key[i].x11name)
1855 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1858 *x11name = name_buffer;
1860 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1862 Key key = KSYM_UNDEFINED;
1863 char *name_ptr = *name;
1865 if (strlen(*name) == 1)
1867 char c = name_ptr[0];
1869 if (c >= 'A' && c <= 'Z')
1870 key = KSYM_A + (Key)(c - 'A');
1871 else if (c >= 'a' && c <= 'z')
1872 key = KSYM_a + (Key)(c - 'a');
1873 else if (c >= '0' && c <= '9')
1874 key = KSYM_0 + (Key)(c - '0');
1877 if (key == KSYM_UNDEFINED)
1883 if (strEqual(translate_key[i].name, *name))
1885 key = translate_key[i].key;
1889 while (translate_key[++i].x11name);
1892 if (key == KSYM_UNDEFINED)
1893 Warn("getKeyFromKeyName(): not completely implemented");
1897 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1899 Key key = KSYM_UNDEFINED;
1900 char *name_ptr = *x11name;
1902 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1904 char c = name_ptr[3];
1906 if (c >= 'A' && c <= 'Z')
1907 key = KSYM_A + (Key)(c - 'A');
1908 else if (c >= 'a' && c <= 'z')
1909 key = KSYM_a + (Key)(c - 'a');
1910 else if (c >= '0' && c <= '9')
1911 key = KSYM_0 + (Key)(c - '0');
1913 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1915 char c1 = name_ptr[4];
1916 char c2 = name_ptr[5];
1919 if ((c1 >= '0' && c1 <= '9') &&
1920 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1921 d = atoi(&name_ptr[4]);
1923 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1924 key = KSYM_F1 + (Key)(d - 1);
1926 else if (strPrefix(name_ptr, "XK_"))
1932 if (strEqual(name_ptr, translate_key[i].x11name))
1934 key = translate_key[i].key;
1938 while (translate_key[++i].x11name);
1940 else if (strPrefix(name_ptr, "0x"))
1942 unsigned int value = 0;
1948 char c = *name_ptr++;
1951 if (c >= '0' && c <= '9')
1953 else if (c >= 'a' && c <= 'f')
1954 d = (int)(c - 'a' + 10);
1955 else if (c >= 'A' && c <= 'F')
1956 d = (int)(c - 'A' + 10);
1964 value = value * 16 + d;
1975 char *getKeyNameFromKey(Key key)
1979 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1983 char *getX11KeyNameFromKey(Key key)
1987 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1991 Key getKeyFromKeyName(char *name)
1995 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1999 Key getKeyFromX11KeyName(char *x11name)
2003 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2007 char getCharFromKey(Key key)
2013 } translate_key_char[] =
2015 // special (non-ASCII) keys (ISO-8859-1)
2016 { KSYM_degree, CHAR_BYTE_DEGREE },
2017 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2018 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2019 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2020 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2021 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2022 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2023 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2025 // end-of-array identifier
2029 char *keyname = getKeyNameFromKey(key);
2032 if (strlen(keyname) == 1)
2034 else if (strEqual(keyname, "space"))
2042 if (key == translate_key_char[i].key)
2044 c = translate_key_char[i].key_char;
2049 while (translate_key_char[++i].key_char);
2055 char getValidConfigValueChar(char c)
2057 if (c == '#' || // used to mark comments
2058 c == '\\') // used to mark continued lines
2065 // ----------------------------------------------------------------------------
2066 // functions to translate string identifiers to integer or boolean value
2067 // ----------------------------------------------------------------------------
2069 int get_integer_from_string(char *s)
2071 static char *number_text[][3] =
2073 { "0", "zero", "null", },
2074 { "1", "one", "first" },
2075 { "2", "two", "second" },
2076 { "3", "three", "third" },
2077 { "4", "four", "fourth" },
2078 { "5", "five", "fifth" },
2079 { "6", "six", "sixth" },
2080 { "7", "seven", "seventh" },
2081 { "8", "eight", "eighth" },
2082 { "9", "nine", "ninth" },
2083 { "10", "ten", "tenth" },
2084 { "11", "eleven", "eleventh" },
2085 { "12", "twelve", "twelfth" },
2087 { NULL, NULL, NULL },
2091 char *s_lower = getStringToLower(s);
2094 for (i = 0; number_text[i][0] != NULL; i++)
2095 for (j = 0; j < 3; j++)
2096 if (strEqual(s_lower, number_text[i][j]))
2101 if (strEqual(s_lower, "false") ||
2102 strEqual(s_lower, "no") ||
2103 strEqual(s_lower, "off"))
2105 else if (strEqual(s_lower, "true") ||
2106 strEqual(s_lower, "yes") ||
2107 strEqual(s_lower, "on"))
2118 boolean get_boolean_from_string(char *s)
2120 char *s_lower = getStringToLower(s);
2121 boolean result = FALSE;
2123 if (strEqual(s_lower, "true") ||
2124 strEqual(s_lower, "yes") ||
2125 strEqual(s_lower, "on") ||
2126 get_integer_from_string(s) == 1)
2134 int get_switch3_from_string(char *s)
2136 char *s_lower = getStringToLower(s);
2139 if (strEqual(s_lower, "true") ||
2140 strEqual(s_lower, "yes") ||
2141 strEqual(s_lower, "on") ||
2142 get_integer_from_string(s) == 1)
2144 else if (strEqual(s_lower, "auto"))
2152 int get_player_nr_from_string(char *s)
2154 static char *player_text[] =
2164 char *s_lower = getStringToLower(s);
2168 for (i = 0; player_text[i] != NULL; i++)
2169 if (strEqual(s_lower, player_text[i]))
2178 // ----------------------------------------------------------------------------
2179 // functions for generic lists
2180 // ----------------------------------------------------------------------------
2182 ListNode *newListNode(void)
2184 return checked_calloc(sizeof(ListNode));
2187 void addNodeToList(ListNode **node_first, char *key, void *content)
2189 ListNode *node_new = newListNode();
2191 node_new->key = getStringCopy(key);
2192 node_new->content = content;
2193 node_new->next = *node_first;
2196 (*node_first)->prev = node_new;
2198 *node_first = node_new;
2201 void deleteNodeFromList(ListNode **node_first, char *key,
2202 void (*destructor_function)(void *))
2204 if (node_first == NULL || *node_first == NULL)
2207 if (strEqual((*node_first)->key, key))
2209 // after first recursion, (*node_first)->prev->next == *node_first,
2210 // so *node_first would be overwritten with (*node_first)->next
2211 // => use a copy of *node_first (and later of (*node_first)->next)
2212 ListNode *node = *node_first;
2213 ListNode *node_next = node->next;
2215 checked_free(node->key);
2217 if (destructor_function)
2218 destructor_function(node->content);
2221 node->prev->next = node->next;
2224 node->next->prev = node->prev;
2228 // after removing node, set list pointer to next valid list node
2229 // (this is important if the first node of the list was deleted)
2230 *node_first = node_next;
2234 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2238 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2240 if (node_first == NULL)
2243 if (strEqual(node_first->key, key))
2246 return getNodeFromKey(node_first->next, key);
2249 int getNumNodes(ListNode *node_first)
2251 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2255 static void dumpList(ListNode *node_first)
2257 ListNode *node = node_first;
2261 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2262 ((struct ListNodeInfo *)node->content)->num_references);
2266 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2271 // ----------------------------------------------------------------------------
2272 // functions for file handling
2273 // ----------------------------------------------------------------------------
2275 #define MAX_BUFFER_SIZE 4096
2277 File *openFile(char *filename, char *mode)
2279 File *file = checked_calloc(sizeof(File));
2281 file->file = fopen(filename, mode);
2283 if (file->file != NULL)
2285 file->filename = getStringCopy(filename);
2290 #if defined(PLATFORM_ANDROID)
2291 file->asset_file = SDL_RWFromFile(filename, mode);
2293 if (file->asset_file != NULL)
2295 file->file_is_asset = TRUE;
2296 file->filename = getStringCopy(filename);
2307 int closeFile(File *file)
2314 #if defined(PLATFORM_ANDROID)
2315 if (file->asset_file)
2316 result = SDL_RWclose(file->asset_file);
2320 result = fclose(file->file);
2322 checked_free(file->filename);
2328 int checkEndOfFile(File *file)
2330 #if defined(PLATFORM_ANDROID)
2331 if (file->file_is_asset)
2332 return file->end_of_file;
2335 return feof(file->file);
2338 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2340 #if defined(PLATFORM_ANDROID)
2341 if (file->file_is_asset)
2343 if (file->end_of_file)
2346 size_t num_items_read =
2347 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2349 if (num_items_read < num_items)
2350 file->end_of_file = TRUE;
2352 return num_items_read;
2356 return fread(buffer, item_size, num_items, file->file);
2359 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2361 return fwrite(buffer, item_size, num_items, file->file);
2364 int seekFile(File *file, long offset, int whence)
2366 #if defined(PLATFORM_ANDROID)
2367 if (file->file_is_asset)
2369 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2370 whence == SEEK_CUR ? RW_SEEK_CUR :
2371 whence == SEEK_END ? RW_SEEK_END : 0);
2373 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2377 return fseek(file->file, offset, whence);
2380 int getByteFromFile(File *file)
2382 #if defined(PLATFORM_ANDROID)
2383 if (file->file_is_asset)
2385 if (file->end_of_file)
2389 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2391 if (num_bytes_read < 1)
2392 file->end_of_file = TRUE;
2394 return (file->end_of_file ? EOF : (int)c);
2398 return fgetc(file->file);
2401 char *getStringFromFile(File *file, char *line, int size)
2403 #if defined(PLATFORM_ANDROID)
2404 if (file->file_is_asset)
2406 if (file->end_of_file)
2409 char *line_ptr = line;
2410 int num_bytes_read = 0;
2412 while (num_bytes_read < size - 1 &&
2413 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2414 *line_ptr++ != '\n')
2419 if (strlen(line) == 0)
2421 file->end_of_file = TRUE;
2430 return fgets(line, size, file->file);
2433 int copyFile(char *filename_from, char *filename_to)
2435 File *file_from, *file_to;
2437 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2442 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2444 closeFile(file_from);
2449 while (!checkEndOfFile(file_from))
2451 byte buffer[MAX_BUFFER_SIZE];
2452 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2454 writeFile(file_to, buffer, 1, bytes_read);
2457 closeFile(file_from);
2464 // ----------------------------------------------------------------------------
2465 // functions for directory handling
2466 // ----------------------------------------------------------------------------
2468 Directory *openDirectory(char *dir_name)
2470 Directory *dir = checked_calloc(sizeof(Directory));
2472 dir->dir = opendir(dir_name);
2474 if (dir->dir != NULL)
2476 dir->filename = getStringCopy(dir_name);
2481 #if defined(PLATFORM_ANDROID)
2482 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2484 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2486 checked_free(asset_toc_filename);
2488 if (dir->asset_toc_file != NULL)
2490 dir->directory_is_asset = TRUE;
2491 dir->filename = getStringCopy(dir_name);
2502 int closeDirectory(Directory *dir)
2509 #if defined(PLATFORM_ANDROID)
2510 if (dir->asset_toc_file)
2511 result = SDL_RWclose(dir->asset_toc_file);
2515 result = closedir(dir->dir);
2518 freeDirectoryEntry(dir->dir_entry);
2520 checked_free(dir->filename);
2526 DirectoryEntry *readDirectory(Directory *dir)
2529 freeDirectoryEntry(dir->dir_entry);
2531 dir->dir_entry = NULL;
2533 #if defined(PLATFORM_ANDROID)
2534 if (dir->directory_is_asset)
2536 char line[MAX_LINE_LEN];
2537 char *line_ptr = line;
2538 int num_bytes_read = 0;
2540 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2541 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2550 if (strlen(line) == 0)
2553 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2555 dir->dir_entry->is_directory = FALSE;
2556 if (line[strlen(line) - 1] == '/')
2558 dir->dir_entry->is_directory = TRUE;
2560 line[strlen(line) - 1] = '\0';
2563 dir->dir_entry->basename = getStringCopy(line);
2564 dir->dir_entry->filename = getPath2(dir->filename, line);
2566 return dir->dir_entry;
2570 struct dirent *dir_entry = readdir(dir->dir);
2572 if (dir_entry == NULL)
2575 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2577 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2578 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2580 struct stat file_status;
2582 dir->dir_entry->is_directory =
2583 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2584 S_ISDIR(file_status.st_mode));
2586 return dir->dir_entry;
2589 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2591 if (dir_entry == NULL)
2594 checked_free(dir_entry->basename);
2595 checked_free(dir_entry->filename);
2596 checked_free(dir_entry);
2600 // ----------------------------------------------------------------------------
2601 // functions for checking files and filenames
2602 // ----------------------------------------------------------------------------
2604 boolean directoryExists(char *dir_name)
2606 if (dir_name == NULL)
2609 struct stat file_status;
2610 boolean success = (stat(dir_name, &file_status) == 0 &&
2611 S_ISDIR(file_status.st_mode));
2613 #if defined(PLATFORM_ANDROID)
2616 // this might be an asset directory; check by trying to open toc file
2617 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2618 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2620 checked_free(asset_toc_filename);
2622 success = (file != NULL);
2632 boolean fileExists(char *filename)
2634 if (filename == NULL)
2637 boolean success = (access(filename, F_OK) == 0);
2639 #if defined(PLATFORM_ANDROID)
2642 // this might be an asset file; check by trying to open it
2643 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2645 success = (file != NULL);
2656 static boolean fileHasPrefix(char *basename, char *prefix)
2658 static char *basename_lower = NULL;
2659 int basename_length, prefix_length;
2661 checked_free(basename_lower);
2663 if (basename == NULL || prefix == NULL)
2666 basename_lower = getStringToLower(basename);
2667 basename_length = strlen(basename_lower);
2668 prefix_length = strlen(prefix);
2670 if (basename_length > prefix_length + 1 &&
2671 basename_lower[prefix_length] == '.' &&
2672 strncmp(basename_lower, prefix, prefix_length) == 0)
2679 static boolean fileHasSuffix(char *basename, char *suffix)
2681 static char *basename_lower = NULL;
2682 int basename_length, suffix_length;
2684 checked_free(basename_lower);
2686 if (basename == NULL || suffix == NULL)
2689 basename_lower = getStringToLower(basename);
2690 basename_length = strlen(basename_lower);
2691 suffix_length = strlen(suffix);
2693 if (basename_length > suffix_length + 1 &&
2694 basename_lower[basename_length - suffix_length - 1] == '.' &&
2695 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2701 static boolean FileCouldBeArtwork(char *filename)
2703 char *basename = getBaseNamePtr(filename);
2705 return (!strEqual(basename, ".") &&
2706 !strEqual(basename, "..") &&
2707 !fileHasSuffix(basename, "txt") &&
2708 !fileHasSuffix(basename, "conf") &&
2709 !directoryExists(filename));
2712 boolean FileIsGraphic(char *filename)
2714 return FileCouldBeArtwork(filename);
2717 boolean FileIsSound(char *filename)
2719 return FileCouldBeArtwork(filename);
2722 boolean FileIsMusic(char *filename)
2724 return FileCouldBeArtwork(filename);
2727 boolean FileIsArtworkType(char *filename, int type)
2729 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2730 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2731 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2737 // ----------------------------------------------------------------------------
2738 // functions for loading artwork configuration information
2739 // ----------------------------------------------------------------------------
2741 char *get_mapped_token(char *token)
2743 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2744 static char *map_token_prefix[][2] =
2746 { "char_procent", "char_percent" },
2747 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2748 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2749 { "bd_butterfly_left", "bd_butterfly.left" },
2750 { "bd_butterfly_right", "bd_butterfly.right" },
2751 { "bd_butterfly_up", "bd_butterfly.up" },
2752 { "bd_butterfly_down", "bd_butterfly.down" },
2753 { "bd_firefly_left", "bd_firefly.left" },
2754 { "bd_firefly_right", "bd_firefly.right" },
2755 { "bd_firefly_up", "bd_firefly.up" },
2756 { "bd_firefly_down", "bd_firefly.down" },
2762 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2764 int len_token_prefix = strlen(map_token_prefix[i][0]);
2766 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2767 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2770 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2771 char *gfx_substring = ".gfx";
2772 char *gfx_prefix = "gfx.";
2773 if (strstr(token, gfx_substring) != NULL)
2775 char *token_prefix = getStringCopy(token);
2776 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2777 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2780 // cut off token string at ".gfx" substring position
2781 *token_gfx_pos = '\0';
2783 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2784 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2788 return mapped_token;
2794 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2797 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2798 static struct ConfigTypeInfo prefix_list[] =
2800 { "global.anim_1" },
2801 { "global.anim_2" },
2802 { "global.anim_3" },
2803 { "global.anim_4" },
2804 { "global.anim_5" },
2805 { "global.anim_6" },
2806 { "global.anim_7" },
2807 { "global.anim_8" },
2808 { "global.anim_9" },
2809 { "global.anim_10" },
2810 { "global.anim_11" },
2811 { "global.anim_12" },
2812 { "global.anim_13" },
2813 { "global.anim_14" },
2814 { "global.anim_15" },
2815 { "global.anim_16" },
2816 { "global.anim_17" },
2817 { "global.anim_18" },
2818 { "global.anim_19" },
2819 { "global.anim_20" },
2820 { "global.anim_21" },
2821 { "global.anim_22" },
2822 { "global.anim_23" },
2823 { "global.anim_24" },
2824 { "global.anim_25" },
2825 { "global.anim_26" },
2826 { "global.anim_27" },
2827 { "global.anim_28" },
2828 { "global.anim_29" },
2829 { "global.anim_30" },
2830 { "global.anim_31" },
2831 { "global.anim_32" },
2835 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2836 boolean prefix_found = FALSE;
2840 // search for prefix to check if base token has to be created
2841 for (i = 0; prefix_list[i].token != NULL; i++)
2842 if (strPrefix(token, prefix_list[i].token))
2843 prefix_found = TRUE;
2848 // search for suffix (parameter) to determine base token length
2849 for (i = 0; suffix_list[i].token != NULL; i++)
2850 if (strSuffix(token, suffix_list[i].token))
2851 len_suffix = strlen(suffix_list[i].token);
2853 return getStringCopyN(token, strlen(token) - len_suffix);
2856 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2857 struct ListNodeInfo ***, int *);
2859 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2860 struct ConfigTypeInfo *suffix_list,
2861 char **ignore_tokens,
2862 int num_file_list_entries)
2864 SetupFileHash *ignore_tokens_hash;
2865 struct FileInfo *file_list;
2866 int num_file_list_entries_found = 0;
2867 int num_suffix_list_entries = 0;
2871 // create hash from list of tokens to be ignored (for quick access)
2872 ignore_tokens_hash = newSetupFileHash();
2873 for (i = 0; ignore_tokens[i] != NULL; i++)
2874 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2876 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2878 for (i = 0; suffix_list[i].token != NULL; i++)
2879 num_suffix_list_entries++;
2881 // always start with reliable default values
2882 for (i = 0; i < num_file_list_entries; i++)
2884 file_list[i].token = NULL;
2886 file_list[i].default_filename = NULL;
2887 file_list[i].filename = NULL;
2889 if (num_suffix_list_entries > 0)
2891 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2893 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2894 file_list[i].parameter = checked_calloc(parameter_array_size);
2896 for (j = 0; j < num_suffix_list_entries; j++)
2898 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2899 setString(&file_list[i].parameter[j], suffix_list[j].value);
2902 file_list[i].redefined = FALSE;
2903 file_list[i].fallback_to_default = FALSE;
2904 file_list[i].default_is_cloned = FALSE;
2910 for (i = 0; config_list[i].token != NULL; i++)
2912 int len_config_token = strlen(config_list[i].token);
2913 boolean is_file_entry = TRUE;
2915 for (j = 0; suffix_list[j].token != NULL; j++)
2917 int len_suffix = strlen(suffix_list[j].token);
2919 if (len_suffix < len_config_token &&
2920 strEqual(&config_list[i].token[len_config_token - len_suffix],
2921 suffix_list[j].token))
2923 setString(&file_list[list_pos].default_parameter[j],
2924 config_list[i].value);
2926 is_file_entry = FALSE;
2932 // the following tokens are no file definitions, but other config tokens
2933 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
2934 is_file_entry = FALSE;
2941 if (list_pos >= num_file_list_entries)
2944 file_list[list_pos].token = config_list[i].token;
2945 file_list[list_pos].default_filename = config_list[i].value;
2948 if (strSuffix(config_list[i].token, ".clone_from"))
2949 file_list[list_pos].default_is_cloned = TRUE;
2952 num_file_list_entries_found = list_pos + 1;
2953 if (num_file_list_entries_found != num_file_list_entries)
2955 Error(ERR_INFO_LINE, "-");
2956 Error(ERR_INFO, "inconsistant config list information:");
2957 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2958 num_file_list_entries);
2959 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2960 num_file_list_entries_found);
2961 Error(ERR_EXIT, "please fix");
2964 freeSetupFileHash(ignore_tokens_hash);
2969 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2971 int len_token = strlen(token);
2972 int len_suffix = strlen(suffix);
2974 if (start_pos < 0) // compare suffix from end of string
2975 start_pos += len_token;
2977 if (start_pos < 0 || start_pos + len_suffix > len_token)
2980 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2983 if (token[start_pos + len_suffix] == '\0')
2986 if (token[start_pos + len_suffix] == '.')
2992 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2994 static void read_token_parameters(SetupFileHash *setup_file_hash,
2995 struct ConfigTypeInfo *suffix_list,
2996 struct FileInfo *file_list_entry)
2998 // check for config token that is the base token without any suffixes
2999 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3000 char *known_token_value = KNOWN_TOKEN_VALUE;
3003 if (filename != NULL)
3005 setString(&file_list_entry->filename, filename);
3007 // when file definition found, set all parameters to default values
3008 for (i = 0; suffix_list[i].token != NULL; i++)
3009 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3011 file_list_entry->redefined = TRUE;
3013 // mark config file token as well known from default config
3014 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3017 // check for config tokens that can be build by base token and suffixes
3018 for (i = 0; suffix_list[i].token != NULL; i++)
3020 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3021 char *value = getHashEntry(setup_file_hash, token);
3025 setString(&file_list_entry->parameter[i], value);
3027 // mark config file token as well known from default config
3028 setHashEntry(setup_file_hash, token, known_token_value);
3035 static void add_dynamic_file_list_entry(struct FileInfo **list,
3036 int *num_list_entries,
3037 SetupFileHash *extra_file_hash,
3038 struct ConfigTypeInfo *suffix_list,
3039 int num_suffix_list_entries,
3042 struct FileInfo *new_list_entry;
3043 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3045 (*num_list_entries)++;
3046 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3047 new_list_entry = &(*list)[*num_list_entries - 1];
3049 new_list_entry->token = getStringCopy(token);
3050 new_list_entry->default_filename = NULL;
3051 new_list_entry->filename = NULL;
3052 new_list_entry->parameter = checked_calloc(parameter_array_size);
3054 new_list_entry->redefined = FALSE;
3055 new_list_entry->fallback_to_default = FALSE;
3056 new_list_entry->default_is_cloned = FALSE;
3058 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3061 static void add_property_mapping(struct PropertyMapping **list,
3062 int *num_list_entries,
3063 int base_index, int ext1_index,
3064 int ext2_index, int ext3_index,
3067 struct PropertyMapping *new_list_entry;
3069 (*num_list_entries)++;
3070 *list = checked_realloc(*list,
3071 *num_list_entries * sizeof(struct PropertyMapping));
3072 new_list_entry = &(*list)[*num_list_entries - 1];
3074 new_list_entry->base_index = base_index;
3075 new_list_entry->ext1_index = ext1_index;
3076 new_list_entry->ext2_index = ext2_index;
3077 new_list_entry->ext3_index = ext3_index;
3079 new_list_entry->artwork_index = artwork_index;
3082 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3085 struct FileInfo *file_list = artwork_info->file_list;
3086 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3087 char **base_prefixes = artwork_info->base_prefixes;
3088 char **ext1_suffixes = artwork_info->ext1_suffixes;
3089 char **ext2_suffixes = artwork_info->ext2_suffixes;
3090 char **ext3_suffixes = artwork_info->ext3_suffixes;
3091 char **ignore_tokens = artwork_info->ignore_tokens;
3092 int num_file_list_entries = artwork_info->num_file_list_entries;
3093 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3094 int num_base_prefixes = artwork_info->num_base_prefixes;
3095 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3096 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3097 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3098 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3099 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3100 SetupFileHash *extra_file_hash, *empty_file_hash;
3101 char *known_token_value = KNOWN_TOKEN_VALUE;
3102 char *base_token_value = UNDEFINED_FILENAME;
3105 if (filename == NULL)
3108 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3111 // separate valid (defined) from empty (undefined) config token values
3112 valid_file_hash = newSetupFileHash();
3113 empty_file_hash = newSetupFileHash();
3114 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3116 char *value = HASH_ITERATION_VALUE(itr);
3118 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3119 HASH_ITERATION_TOKEN(itr), value);
3121 END_HASH_ITERATION(setup_file_hash, itr)
3123 // at this point, we do not need the setup file hash anymore -- free it
3124 freeSetupFileHash(setup_file_hash);
3126 // prevent changing hash while iterating over it by using a temporary copy
3127 valid_file_hash_tmp = newSetupFileHash();
3128 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3130 setHashEntry(valid_file_hash_tmp,
3131 HASH_ITERATION_TOKEN(itr),
3132 HASH_ITERATION_VALUE(itr));
3134 END_HASH_ITERATION(valid_file_hash, itr)
3136 // (iterate over same temporary hash, as modifications are independent)
3138 // map deprecated to current tokens (using prefix match and replace)
3139 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3141 char *token = HASH_ITERATION_TOKEN(itr);
3142 char *mapped_token = get_mapped_token(token);
3144 if (mapped_token != NULL)
3146 char *value = HASH_ITERATION_VALUE(itr);
3149 setHashEntry(valid_file_hash, mapped_token, value);
3151 // ignore old token (by setting it to "known" keyword)
3152 setHashEntry(valid_file_hash, token, known_token_value);
3157 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3159 // add special base tokens (using prefix match and replace)
3160 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3162 char *token = HASH_ITERATION_TOKEN(itr);
3163 char *base_token = get_special_base_token(artwork_info, token);
3165 if (base_token != NULL)
3167 // add base token only if it does not already exist
3168 if (getHashEntry(valid_file_hash, base_token) == NULL)
3169 setHashEntry(valid_file_hash, base_token, base_token_value);
3174 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3176 // free temporary hash used for iteration
3177 freeSetupFileHash(valid_file_hash_tmp);
3179 // read parameters for all known config file tokens
3180 for (i = 0; i < num_file_list_entries; i++)
3181 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3183 // set all tokens that can be ignored here to "known" keyword
3184 for (i = 0; i < num_ignore_tokens; i++)
3185 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3187 // copy all unknown config file tokens to extra config hash
3188 extra_file_hash = newSetupFileHash();
3189 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3191 char *value = HASH_ITERATION_VALUE(itr);
3193 if (!strEqual(value, known_token_value))
3194 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3196 END_HASH_ITERATION(valid_file_hash, itr)
3198 // at this point, we do not need the valid file hash anymore -- free it
3199 freeSetupFileHash(valid_file_hash);
3201 // now try to determine valid, dynamically defined config tokens
3203 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3205 struct FileInfo **dynamic_file_list =
3206 &artwork_info->dynamic_file_list;
3207 int *num_dynamic_file_list_entries =
3208 &artwork_info->num_dynamic_file_list_entries;
3209 struct PropertyMapping **property_mapping =
3210 &artwork_info->property_mapping;
3211 int *num_property_mapping_entries =
3212 &artwork_info->num_property_mapping_entries;
3213 int current_summarized_file_list_entry =
3214 artwork_info->num_file_list_entries +
3215 artwork_info->num_dynamic_file_list_entries;
3216 char *token = HASH_ITERATION_TOKEN(itr);
3217 int len_token = strlen(token);
3219 boolean base_prefix_found = FALSE;
3220 boolean parameter_suffix_found = FALSE;
3222 // skip all parameter definitions (handled by read_token_parameters())
3223 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3225 int len_suffix = strlen(suffix_list[i].token);
3227 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3228 parameter_suffix_found = TRUE;
3231 if (parameter_suffix_found)
3234 // ---------- step 0: search for matching base prefix ----------
3237 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3239 char *base_prefix = base_prefixes[i];
3240 int len_base_prefix = strlen(base_prefix);
3241 boolean ext1_suffix_found = FALSE;
3242 boolean ext2_suffix_found = FALSE;
3243 boolean ext3_suffix_found = FALSE;
3244 boolean exact_match = FALSE;
3245 int base_index = -1;
3246 int ext1_index = -1;
3247 int ext2_index = -1;
3248 int ext3_index = -1;
3250 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3252 if (!base_prefix_found)
3257 if (start_pos + len_base_prefix == len_token) // exact match
3261 add_dynamic_file_list_entry(dynamic_file_list,
3262 num_dynamic_file_list_entries,
3265 num_suffix_list_entries,
3267 add_property_mapping(property_mapping,
3268 num_property_mapping_entries,
3269 base_index, -1, -1, -1,
3270 current_summarized_file_list_entry);
3274 // ---------- step 1: search for matching first suffix ----------
3276 start_pos += len_base_prefix;
3277 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3279 char *ext1_suffix = ext1_suffixes[j];
3280 int len_ext1_suffix = strlen(ext1_suffix);
3282 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3284 if (!ext1_suffix_found)
3289 if (start_pos + len_ext1_suffix == len_token) // exact match
3293 add_dynamic_file_list_entry(dynamic_file_list,
3294 num_dynamic_file_list_entries,
3297 num_suffix_list_entries,
3299 add_property_mapping(property_mapping,
3300 num_property_mapping_entries,
3301 base_index, ext1_index, -1, -1,
3302 current_summarized_file_list_entry);
3306 start_pos += len_ext1_suffix;
3312 // ---------- step 2: search for matching second suffix ----------
3314 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3316 char *ext2_suffix = ext2_suffixes[k];
3317 int len_ext2_suffix = strlen(ext2_suffix);
3319 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3321 if (!ext2_suffix_found)
3326 if (start_pos + len_ext2_suffix == len_token) // exact match
3330 add_dynamic_file_list_entry(dynamic_file_list,
3331 num_dynamic_file_list_entries,
3334 num_suffix_list_entries,
3336 add_property_mapping(property_mapping,
3337 num_property_mapping_entries,
3338 base_index, ext1_index, ext2_index, -1,
3339 current_summarized_file_list_entry);
3343 start_pos += len_ext2_suffix;
3349 // ---------- step 3: search for matching third suffix ----------
3351 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3353 char *ext3_suffix = ext3_suffixes[l];
3354 int len_ext3_suffix = strlen(ext3_suffix);
3356 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3358 if (!ext3_suffix_found)
3363 if (start_pos + len_ext3_suffix == len_token) // exact match
3367 add_dynamic_file_list_entry(dynamic_file_list,
3368 num_dynamic_file_list_entries,
3371 num_suffix_list_entries,
3373 add_property_mapping(property_mapping,
3374 num_property_mapping_entries,
3375 base_index, ext1_index, ext2_index, ext3_index,
3376 current_summarized_file_list_entry);
3382 END_HASH_ITERATION(extra_file_hash, itr)
3384 if (artwork_info->num_dynamic_file_list_entries > 0)
3386 artwork_info->dynamic_artwork_list =
3387 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3388 artwork_info->sizeof_artwork_list_entry);
3391 if (options.verbose && IS_PARENT_PROCESS())
3393 SetupFileList *setup_file_list, *list;
3394 boolean dynamic_tokens_found = FALSE;
3395 boolean unknown_tokens_found = FALSE;
3396 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3398 // list may be NULL for empty artwork config files
3399 setup_file_list = loadSetupFileList(filename);
3401 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3403 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3404 dynamic_tokens_found = TRUE;
3406 unknown_tokens_found = TRUE;
3408 END_HASH_ITERATION(extra_file_hash, itr)
3410 if (options.debug && dynamic_tokens_found)
3412 Debug("config", "---");
3413 Debug("config", "dynamic token(s) found in config file:");
3414 Debug("config", "- config file: '%s'", filename);
3416 for (list = setup_file_list; list != NULL; list = list->next)
3418 char *value = getHashEntry(extra_file_hash, list->token);
3420 if (value != NULL && strEqual(value, known_token_value))
3421 Debug("config", "- dynamic token: '%s'", list->token);
3424 Debug("config", "---");
3427 if (unknown_tokens_found)
3430 Warn("unknown token(s) found in config file:");
3431 Warn("- config file: '%s'", filename);
3433 for (list = setup_file_list; list != NULL; list = list->next)
3435 char *value = getHashEntry(extra_file_hash, list->token);
3437 if (value != NULL && !strEqual(value, known_token_value))
3438 Warn("- dynamic token: '%s'", list->token);
3444 if (undefined_values_found)
3447 Warn("undefined values found in config file:");
3448 Warn("- config file: '%s'", filename);
3450 for (list = setup_file_list; list != NULL; list = list->next)
3452 char *value = getHashEntry(empty_file_hash, list->token);
3455 Warn("- undefined value for token: '%s'", list->token);
3461 freeSetupFileList(setup_file_list);
3464 freeSetupFileHash(extra_file_hash);
3465 freeSetupFileHash(empty_file_hash);
3468 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3470 struct FileInfo *file_list = artwork_info->file_list;
3471 int num_file_list_entries = artwork_info->num_file_list_entries;
3472 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3473 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3476 DrawInitText("Loading artwork config", 120, FC_GREEN);
3477 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3479 // always start with reliable default values
3480 for (i = 0; i < num_file_list_entries; i++)
3482 setString(&file_list[i].filename, file_list[i].default_filename);
3484 for (j = 0; j < num_suffix_list_entries; j++)
3485 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3487 file_list[i].redefined = FALSE;
3488 file_list[i].fallback_to_default = FALSE;
3491 // free previous dynamic artwork file array
3492 if (artwork_info->dynamic_file_list != NULL)
3494 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3496 free(artwork_info->dynamic_file_list[i].token);
3497 free(artwork_info->dynamic_file_list[i].filename);
3498 free(artwork_info->dynamic_file_list[i].parameter);
3501 free(artwork_info->dynamic_file_list);
3502 artwork_info->dynamic_file_list = NULL;
3504 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3505 &artwork_info->num_dynamic_file_list_entries);
3508 // free previous property mapping
3509 if (artwork_info->property_mapping != NULL)
3511 free(artwork_info->property_mapping);
3513 artwork_info->property_mapping = NULL;
3514 artwork_info->num_property_mapping_entries = 0;
3517 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3519 // first look for special artwork configured in level series config
3520 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3522 if (fileExists(filename_base))
3523 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3526 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3528 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3529 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3532 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3533 struct ListNodeInfo **listnode)
3537 char *filename = (*listnode)->source_filename;
3539 if (--(*listnode)->num_references <= 0)
3540 deleteNodeFromList(&artwork_info->content_list, filename,
3541 artwork_info->free_artwork);
3547 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3548 struct ListNodeInfo **listnode,
3549 struct FileInfo *file_list_entry)
3559 char *basename = file_list_entry->filename;
3560 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3562 if (filename == NULL)
3564 Warn("cannot find artwork file '%s'", basename);
3566 basename = file_list_entry->default_filename;
3568 // fail for cloned default artwork that has no default filename defined
3569 if (file_list_entry->default_is_cloned &&
3570 strEqual(basename, UNDEFINED_FILENAME))
3572 int error_mode = ERR_WARN;
3574 // we can get away without sounds and music, but not without graphics
3575 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3576 error_mode = ERR_EXIT;
3578 Error(error_mode, "token '%s' was cloned and has no default filename",
3579 file_list_entry->token);
3584 // dynamic artwork has no default filename / skip empty default artwork
3585 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3588 file_list_entry->fallback_to_default = TRUE;
3590 Warn("trying default artwork file '%s'", basename);
3592 filename = getCustomArtworkFilename(basename, artwork_info->type);
3594 if (filename == NULL)
3596 int error_mode = ERR_WARN;
3598 // we can get away without sounds and music, but not without graphics
3599 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3600 error_mode = ERR_EXIT;
3602 Error(error_mode, "cannot find default artwork file '%s'", basename);
3608 // check if the old and the new artwork file are the same
3609 if (*listnode && strEqual((*listnode)->source_filename, filename))
3611 // The old and new artwork are the same (have the same filename and path).
3612 // This usually means that this artwork does not exist in this artwork set
3613 // and a fallback to the existing artwork is done.
3618 // delete existing artwork file entry
3619 deleteArtworkListEntry(artwork_info, listnode);
3621 // check if the new artwork file already exists in the list of artwork
3622 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3624 *listnode = (struct ListNodeInfo *)node->content;
3625 (*listnode)->num_references++;
3630 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3631 DrawInitText(basename, 150, FC_YELLOW);
3633 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3635 // add new artwork file entry to the list of artwork files
3636 (*listnode)->num_references = 1;
3637 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3642 int error_mode = ERR_WARN;
3644 // we can get away without sounds and music, but not without graphics
3645 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3646 error_mode = ERR_EXIT;
3648 Error(error_mode, "cannot load artwork file '%s'", basename);
3654 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3655 struct ListNodeInfo **listnode,
3656 struct FileInfo *file_list_entry)
3658 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3660 deleteArtworkListEntry(artwork_info, listnode);
3665 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3668 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3670 struct FileInfo *file_list = artwork_info->file_list;
3671 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3672 int num_file_list_entries = artwork_info->num_file_list_entries;
3673 int num_dynamic_file_list_entries =
3674 artwork_info->num_dynamic_file_list_entries;
3677 print_timestamp_init("ReloadCustomArtworkList");
3679 for (i = 0; i < num_file_list_entries; i++)
3680 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3683 for (i = 0; i < num_dynamic_file_list_entries; i++)
3684 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3685 &dynamic_file_list[i]);
3687 print_timestamp_done("ReloadCustomArtworkList");
3690 dumpList(artwork_info->content_list);
3694 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3695 struct ListNodeInfo ***list,
3696 int *num_list_entries)
3703 for (i = 0; i < *num_list_entries; i++)
3704 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3708 *num_list_entries = 0;
3711 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3713 if (artwork_info == NULL)
3716 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3717 &artwork_info->num_file_list_entries);
3719 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3720 &artwork_info->num_dynamic_file_list_entries);
3724 // ----------------------------------------------------------------------------
3725 // functions only needed for non-Unix (non-command-line) systems
3726 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3727 // (now also added for Windows, to create files in user data directory)
3728 // ----------------------------------------------------------------------------
3730 char *getLogFilename(char *basename)
3732 return getPath2(getUserGameDataDir(), basename);
3735 void OpenLogFiles(void)
3739 InitUserDataDirectory();
3741 for (i = 0; i < NUM_LOGS; i++)
3743 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3746 program.log_file[i] = program.log_file_default[i]; // reset to default
3748 Warn("cannot open file '%s' for writing: %s",
3749 program.log_filename[i], strerror(errno));
3752 // output should be unbuffered so it is not truncated in a crash
3753 setbuf(program.log_file[i], NULL);
3757 void CloseLogFiles(void)
3761 for (i = 0; i < NUM_LOGS; i++)
3762 if (program.log_file[i] != program.log_file_default[i])
3763 fclose(program.log_file[i]);
3766 void DumpLogFile(int nr)
3768 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3770 if (log_file == NULL)
3773 while (!feof(log_file))
3774 fputc(fgetc(log_file), stdout);
3779 void NotifyUserAboutErrorFile(void)
3781 #if defined(PLATFORM_WIN32)
3782 char *title_text = getStringCat2(program.program_title, " Error Message");
3783 char *error_text = getStringCat2("The program was aborted due to an error; "
3784 "for details, see the following error file:"
3786 program.log_filename[LOG_ERR_ID]);
3788 MessageBox(NULL, error_text, title_text, MB_OK);
3793 // ----------------------------------------------------------------------------
3794 // the following is only for debugging purpose and normally not used
3795 // ----------------------------------------------------------------------------
3799 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3800 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3802 #define DEBUG_NUM_TIMESTAMPS 10
3803 #define DEBUG_TIME_IN_MICROSECONDS 0
3805 #if DEBUG_TIME_IN_MICROSECONDS
3806 static double Counter_Microseconds(void)
3808 static struct timeval base_time = { 0, 0 };
3809 struct timeval current_time;
3812 gettimeofday(¤t_time, NULL);
3814 // reset base time in case of wrap-around
3815 if (current_time.tv_sec < base_time.tv_sec)
3816 base_time = current_time;
3819 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3820 ((double)(current_time.tv_usec - base_time.tv_usec));
3822 return counter; // return microseconds since last init
3826 static char *debug_print_timestamp_get_padding(int padding_size)
3828 static char *padding = NULL;
3829 int max_padding_size = 100;
3831 if (padding == NULL)
3833 padding = checked_calloc(max_padding_size + 1);
3834 memset(padding, ' ', max_padding_size);
3837 return &padding[MAX(0, max_padding_size - padding_size)];
3840 void debug_print_timestamp(int counter_nr, char *message)
3842 int indent_size = 8;
3843 int padding_size = 40;
3844 float timestamp_interval;
3847 Error(ERR_EXIT, "debugging: invalid negative counter");
3848 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3849 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3851 #if DEBUG_TIME_IN_MICROSECONDS
3852 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3855 counter[counter_nr][0] = Counter_Microseconds();
3857 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3860 counter[counter_nr][0] = Counter();
3863 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3864 counter[counter_nr][1] = counter[counter_nr][0];
3867 Debug("time", "%s%s%s %.3f %s",
3868 debug_print_timestamp_get_padding(counter_nr * indent_size),
3870 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3871 timestamp_interval / 1000,
3876 static void debug_print_parent_only(char *format, ...)
3878 if (!IS_PARENT_PROCESS())
3885 va_start(ap, format);
3886 vprintf(format, ap);
3896 static void print_timestamp_ext(char *message, char *mode)
3898 #if DEBUG_PRINT_INIT_TIMESTAMPS
3899 static char *debug_message = NULL;
3900 static char *last_message = NULL;
3901 static int counter_nr = 0;
3902 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3904 checked_free(debug_message);
3905 debug_message = getStringCat3(mode, " ", message);
3907 if (strEqual(mode, "INIT"))
3909 debug_print_timestamp(counter_nr, NULL);
3911 if (counter_nr + 1 < max_depth)
3912 debug_print_timestamp(counter_nr, debug_message);
3916 debug_print_timestamp(counter_nr, NULL);
3918 else if (strEqual(mode, "DONE"))
3922 if (counter_nr + 1 < max_depth ||
3923 (counter_nr == 0 && max_depth == 1))
3925 last_message = message;
3927 if (counter_nr == 0 && max_depth == 1)
3929 checked_free(debug_message);
3930 debug_message = getStringCat3("TIME", " ", message);
3933 debug_print_timestamp(counter_nr, debug_message);
3936 else if (!strEqual(mode, "TIME") ||
3937 !strEqual(message, last_message))
3939 if (counter_nr < max_depth)
3940 debug_print_timestamp(counter_nr, debug_message);
3945 void print_timestamp_init(char *message)
3947 print_timestamp_ext(message, "INIT");
3950 void print_timestamp_time(char *message)
3952 print_timestamp_ext(message, "TIME");
3955 void print_timestamp_done(char *message)
3957 print_timestamp_ext(message, "DONE");