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_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOG_OUT_TO_STDOUT TRUE
45 #define DUPLICATE_LOG_ERR_TO_STDERR TRUE
48 #if defined(PLATFORM_ANDROID)
49 static int android_log_prio = ANDROID_LOG_INFO;
50 static char *android_log_buffer = NULL;
52 static void append_to_android_log_buffer(char *format, va_list ap)
54 char text_new[MAX_OUTPUT_LINESIZE];
56 // print text to temporary string
57 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
59 if (android_log_buffer == NULL)
61 android_log_buffer = getStringCopy(text_new);
65 char *android_log_buffer_old = android_log_buffer;
67 // append new text to existing text
68 android_log_buffer = getStringCat2(android_log_buffer, text_new);
70 checked_free(android_log_buffer_old);
74 static void vprintf_log_nonewline(char *format, va_list ap)
76 // add log output to buffer until text with newline is printed
77 append_to_android_log_buffer(format, ap);
80 static void vprintf_log(char *format, va_list ap)
82 // add log output to buffer
83 append_to_android_log_buffer(format, ap);
85 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
86 __android_log_write(android_log_prio, program.program_title,
89 checked_free(android_log_buffer);
90 android_log_buffer = NULL;
95 static void vprintf_log_nonewline(char *format, va_list ap)
97 FILE *file = program.log_file[LOG_ERR_ID];
99 #if DUPLICATE_LOG_ERR_TO_STDERR
100 if (file != program.log_file_default[LOG_ERR_ID])
105 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
111 vfprintf(file, format, ap);
114 static void vprintf_log(char *format, va_list ap)
116 FILE *file = program.log_file[LOG_ERR_ID];
117 char *newline = STRING_NEWLINE;
119 #if DUPLICATE_LOG_ERR_TO_STDERR
120 if (file != program.log_file_default[LOG_ERR_ID])
125 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
126 fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline);
132 vfprintf(file, format, ap);
133 fprintf(file, "%s", newline);
137 static void printf_log_nonewline(char *format, ...)
141 va_start(ap, format);
142 vprintf_log_nonewline(format, ap);
146 static void printf_log(char *format, ...)
150 va_start(ap, format);
151 vprintf_log(format, ap);
155 static void printf_log_line(char *line_chars, int line_length)
159 for (i = 0; i < line_length; i++)
160 printf_log_nonewline("%s", line_chars);
166 // ----------------------------------------------------------------------------
167 // platform independent wrappers for printf() et al.
168 // ----------------------------------------------------------------------------
170 void fprintf_line(FILE *file, char *line_chars, int line_length)
174 for (i = 0; i < line_length; i++)
175 fprintf(file, "%s", line_chars);
180 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
183 fprintf(file, "%s", prefix);
184 fprintf_line(file, line_chars, line_length);
187 void printf_line(char *line_chars, int line_length)
189 fprintf_line(stdout, line_chars, line_length);
192 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
194 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
197 static void vPrint(char *format, va_list ap)
199 FILE *file = program.log_file[LOG_OUT_ID];
201 #if DUPLICATE_LOG_OUT_TO_STDOUT
202 if (file != program.log_file_default[LOG_OUT_ID])
207 vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2);
213 vfprintf(file, format, ap);
216 void Print(char *format, ...)
220 va_start(ap, format);
225 void PrintNoLog(char *format, ...)
227 FILE *file = program.log_file_default[LOG_OUT_ID];
230 va_start(ap, format);
231 vfprintf(file, format, ap);
237 void PrintLine(char *line_chars, int line_length)
241 for (i = 0; i < line_length; i++)
247 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
250 PrintLine(line_chars, line_length);
254 // ----------------------------------------------------------------------------
255 // generic logging and error handling functions
256 // ----------------------------------------------------------------------------
268 static char *log_tokens[] =
278 static void printf_log_prefix(int log_level, char *mode)
280 if (log_level < 0 || log_level > LOG_FATAL)
283 char *log_token = log_tokens[log_level];
285 if (log_level == LOG_DEBUG)
286 printf_log_nonewline("[%s] [%s] ", log_token, mode);
288 printf_log_nonewline("[%s] ", log_token);
291 static void vLog(int log_level, char *mode, char *format, va_list ap)
293 if (log_level < 0 || log_level > LOG_FATAL)
296 if (log_level == LOG_DEBUG)
298 // only show debug messages when in debug mode
302 // if optional debug mode specified, limit debug output accordingly
303 if (options.debug_mode != NULL &&
304 strstr(mode, options.debug_mode) == NULL)
307 else if (log_level == LOG_WARN)
309 // only show warning messages when in verbose mode
310 if (!options.verbose)
314 #if defined(PLATFORM_ANDROID)
315 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
316 log_level == LOG_INFO ? ANDROID_LOG_INFO :
317 log_level == LOG_WARN ? ANDROID_LOG_WARN :
318 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
319 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
320 ANDROID_LOG_UNKNOWN);
323 static boolean last_line_was_separator = FALSE;
324 char *log_token = log_tokens[log_level];
326 if (strEqual(format, "===") ||
327 strEqual(format, "---"))
329 static char *mode_last = NULL;
330 char line_char[2] = { format[0], '\0' };
331 int line_length = 80 - strlen(log_token) - 3;
333 if (log_level == LOG_DEBUG)
334 line_length -= strlen(mode) + 3;
336 if (last_line_was_separator && strEqual(mode, mode_last))
339 printf_log_prefix(log_level, mode);
340 printf_log_line(line_char, line_length);
342 if (!strEqual(mode, mode_last))
343 setString(&mode_last, mode);
345 last_line_was_separator = TRUE;
350 last_line_was_separator = FALSE;
352 printf_log_prefix(log_level, mode);
354 vprintf_log(format, ap);
357 static void Log(int log_level, char *mode, char *format, ...)
361 va_start(ap, format);
362 vLog(log_level, mode, format, ap);
366 void DebugContinued(char *mode, char *format, ...)
368 static char message[MAX_LINE_LEN] = { 0 };
370 // initialize message (optional)
371 if (strEqual(format, ""))
378 char *message_ptr = message + strlen(message);
379 int size_left = MAX_LINE_LEN - strlen(message);
383 va_start(ap, format);
384 vsnprintf(message_ptr, size_left, format, ap);
388 if (strSuffix(format, "\n"))
390 message[strlen(message) - 1] = '\0';
392 Debug(mode, message);
398 void Debug(char *mode, char *format, ...)
402 va_start(ap, format);
403 vLog(LOG_DEBUG, mode, format, ap);
407 void Info(char *format, ...)
411 va_start(ap, format);
412 vLog(LOG_INFO, NULL, format, ap);
416 void Warn(char *format, ...)
420 va_start(ap, format);
421 vLog(LOG_WARN, NULL, format, ap);
425 void Error(char *format, ...)
429 va_start(ap, format);
430 vLog(LOG_ERROR, NULL, format, ap);
434 void Fail(char *format, ...)
438 va_start(ap, format);
439 vLog(LOG_FATAL, NULL, format, ap);
442 if (!network.is_server_thread)
444 va_start(ap, format);
445 program.exit_message_function(format, ap);
449 Log(LOG_FATAL, NULL, "aborting");
451 // network server thread: normal exit
452 if (network.is_server_thread)
455 // main process: clean up stuff
456 program.exit_function(1);
459 void FailWithHelp(char *format, ...)
463 va_start(ap, format);
464 vLog(LOG_FATAL, NULL, format, ap);
467 Log(LOG_FATAL, NULL, "try option '--help' for more information");
468 Log(LOG_FATAL, NULL, "aborting");
470 // main process: clean up stuff
471 program.exit_function(1);
475 // ----------------------------------------------------------------------------
477 // ----------------------------------------------------------------------------
479 /* int2str() returns a number converted to a string;
480 the used memory is static, but will be overwritten by later calls,
481 so if you want to save the result, copy it to a private string buffer;
482 there can be 10 local calls of int2str() without buffering the result --
483 the 11th call will then destroy the result from the first call and so on. */
485 char *int2str(int number, int size)
487 static char shift_array[10][40];
488 static int shift_counter = 0;
489 char *s = shift_array[shift_counter];
491 shift_counter = (shift_counter + 1) % 10;
498 sprintf(s, " %09d", number);
499 return &s[strlen(s) - size];
503 sprintf(s, "%d", number);
509 // something similar to "int2str()" above, but allocates its own memory
510 // and has a different interface; we cannot use "itoa()", because this
511 // seems to be already defined when cross-compiling to the win32 target
513 char *i_to_a(unsigned int i)
515 static char *a = NULL;
519 if (i > 2147483647) // yes, this is a kludge
522 a = checked_malloc(10 + 1);
530 // calculate base-2 logarithm of argument (rounded down to integer;
531 // this function returns the number of the highest bit set in argument)
533 int log_2(unsigned int x)
539 x -= (1 << e); // for rounding down (rounding up: remove this line)
546 boolean getTokenValueFromString(char *string, char **token, char **value)
548 return getTokenValueFromSetupLine(string, token, value);
552 // ----------------------------------------------------------------------------
554 // ----------------------------------------------------------------------------
556 // maximal allowed length of a command line option
557 #define MAX_OPTION_LEN 256
559 static unsigned int getCurrentMS(void)
561 return SDL_GetTicks();
564 static unsigned int mainCounter(int mode)
566 static unsigned int base_ms = 0;
567 unsigned int current_ms;
569 // get current system milliseconds
570 current_ms = getCurrentMS();
572 // reset base timestamp in case of counter reset or wrap-around
573 if (mode == INIT_COUNTER || current_ms < base_ms)
574 base_ms = current_ms;
576 // return milliseconds since last counter reset
577 return current_ms - base_ms;
580 void InitCounter() // set counter back to zero
582 mainCounter(INIT_COUNTER);
585 unsigned int Counter() // get milliseconds since last call of InitCounter()
587 return mainCounter(READ_COUNTER);
590 static void sleep_milliseconds(unsigned int milliseconds_delay)
592 SDL_Delay(milliseconds_delay);
595 void Delay(unsigned int delay) // Sleep specified number of milliseconds
597 sleep_milliseconds(delay);
600 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
601 unsigned int actual_counter)
603 if (actual_counter >= *counter_var &&
604 actual_counter < *counter_var + delay)
607 *counter_var = actual_counter;
612 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
614 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
617 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
619 return DelayReachedExt(counter_var, delay, Counter());
622 void ResetDelayCounterExt(unsigned int *counter_var,
623 unsigned int actual_counter)
625 DelayReachedExt(counter_var, 0, actual_counter);
628 void ResetFrameCounter(unsigned int *frame_counter_var)
630 FrameReached(frame_counter_var, 0);
633 void ResetDelayCounter(unsigned int *counter_var)
635 DelayReached(counter_var, 0);
638 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
640 unsigned int actual_counter;
645 actual_counter = Counter();
647 if (actual_counter >= *counter_var &&
648 actual_counter < *counter_var + delay)
649 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
654 if (*counter_var != 0 &&
656 actual_counter >= *counter_var + delay)
658 int lag = actual_counter - (*counter_var + delay);
659 int delay2 = (delay + 1) / 2;
662 skip_frames = (lag + delay2) / delay;
665 *counter_var = actual_counter;
670 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
671 int *loop_var, int last_loop_value)
673 int skip_frames = WaitUntilDelayReached(counter_var, delay);
678 Debug("internal:SkipUntilDelayReached",
679 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
681 skip_frames, skip_frames * delay);
683 Debug("internal:SkipUntilDelayReached",
689 if (skip_frames == 0)
692 // when skipping frames, make sure to never skip the last frame, as
693 // this may be needed for animations to reach a defined end state;
694 // furthermore, we assume that this function is called at the end
695 // of a "for" loop, which continues by incrementing the loop variable
696 // by one before checking the loop condition again; therefore we have
697 // to check against the last loop value minus one here
701 if (*loop_var < last_loop_value) // never skip the last frame
703 *loop_var += skip_frames;
705 if (*loop_var > last_loop_value) // never skip the last frame
706 *loop_var = last_loop_value;
711 // ----------------------------------------------------------------------------
712 // random generator functions
713 // ----------------------------------------------------------------------------
715 unsigned int init_random_number(int nr, int seed)
717 if (seed == NEW_RANDOMIZE)
719 // default random seed
720 seed = (int)time(NULL); // seconds since the epoch
722 #if !defined(PLATFORM_WIN32)
723 // add some more randomness
724 struct timeval current_time;
726 gettimeofday(¤t_time, NULL);
728 seed += (int)current_time.tv_usec; // microseconds since the epoch
731 // add some more randomness
732 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
734 // add some more randomness
735 seed += GetSimpleRandom(1000000);
738 srandom_linux_libc(nr, (unsigned int) seed);
740 return (unsigned int) seed;
743 unsigned int get_random_number(int nr, int max)
745 return (max > 0 ? random_linux_libc(nr) % max : 0);
749 // ----------------------------------------------------------------------------
750 // system info functions
751 // ----------------------------------------------------------------------------
753 #if !defined(PLATFORM_ANDROID)
754 static char *get_corrected_real_name(char *real_name)
756 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
757 char *from_ptr = real_name;
758 char *to_ptr = real_name_new;
760 // copy the name string, but not more than MAX_USERNAME_LEN characters
761 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
763 // the name field read from "passwd" file may also contain additional
764 // user information, separated by commas, which will be removed here
765 if (*from_ptr == ',')
768 // the user's real name may contain 'german sharp s' characters,
769 // which have no equivalent in upper case letters (used by our fonts)
770 if (*from_ptr == CHAR_BYTE_SHARP_S)
777 *to_ptr++ = *from_ptr++;
782 return real_name_new;
786 #if defined(PLATFORM_UNIX)
787 static struct passwd *getPasswdEntry(void)
789 #if defined(PLATFORM_EMSCRIPTEN)
790 // currently not fully supported; force fallback to default values
793 return getpwuid(getuid());
797 char *getUnixLoginName(void)
799 struct passwd *pwd = getPasswdEntry();
801 if (pwd != NULL && strlen(pwd->pw_name) != 0)
807 char *getUnixRealName(void)
809 struct passwd *pwd = getPasswdEntry();
811 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
812 return pwd->pw_gecos;
817 char *getUnixHomeDir(void)
819 struct passwd *pwd = getPasswdEntry();
821 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
828 char *getLoginName(void)
830 static char *login_name = NULL;
832 #if defined(PLATFORM_WIN32)
833 if (login_name == NULL)
835 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
837 login_name = checked_malloc(buffer_size);
839 if (GetUserName(login_name, &buffer_size) == 0)
840 strcpy(login_name, ANONYMOUS_NAME);
842 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
843 if (login_name == NULL)
845 char *name = getUnixLoginName();
848 login_name = getStringCopy(name);
850 login_name = ANONYMOUS_NAME;
853 login_name = ANONYMOUS_NAME;
859 char *getRealName(void)
861 static char *real_name = NULL;
863 #if defined(PLATFORM_WIN32)
864 if (real_name == NULL)
866 static char buffer[MAX_USERNAME_LEN + 1];
867 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
869 if (GetUserName(buffer, &buffer_size) != 0)
870 real_name = get_corrected_real_name(buffer);
872 real_name = ANONYMOUS_NAME;
874 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
875 if (real_name == NULL)
877 char *name = getUnixRealName();
880 real_name = get_corrected_real_name(name);
882 real_name = ANONYMOUS_NAME;
885 real_name = ANONYMOUS_NAME;
891 char *getFixedUserName(char *name)
893 // needed because player name must be a fixed length string
894 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
896 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
897 name_new[MAX_PLAYER_NAME_LEN] = '\0';
899 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
900 if (strchr(name_new, ' '))
901 *strchr(name_new, ' ') = '\0';
906 time_t getFileTimestampEpochSeconds(char *filename)
908 struct stat file_status;
910 if (stat(filename, &file_status) != 0) // cannot stat file
913 return file_status.st_mtime;
917 // ----------------------------------------------------------------------------
918 // path manipulation functions
919 // ----------------------------------------------------------------------------
921 static char *getLastPathSeparatorPtr(char *filename)
923 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
925 if (last_separator == NULL) // also try DOS/Windows variant
926 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
928 return last_separator;
931 char *getBaseNamePtr(char *filename)
933 char *last_separator = getLastPathSeparatorPtr(filename);
935 if (last_separator != NULL)
936 return last_separator + 1; // separator found: strip base path
938 return filename; // no separator found: filename has no path
941 char *getBaseName(char *filename)
943 return getStringCopy(getBaseNamePtr(filename));
946 char *getBaseNameNoSuffix(char *filename)
948 char *basename = getStringCopy(getBaseNamePtr(filename));
950 // remove trailing suffix (separated by dot or hyphen)
951 if (basename[0] != '.' && basename[0] != '-')
953 if (strchr(basename, '.') != NULL)
954 *strchr(basename, '.') = '\0';
956 if (strchr(basename, '-') != NULL)
957 *strchr(basename, '-') = '\0';
963 char *getBasePath(char *filename)
965 char *basepath = getStringCopy(filename);
966 char *last_separator = getLastPathSeparatorPtr(basepath);
968 // if no separator was found, use current directory
969 if (last_separator == NULL)
973 return getStringCopy(".");
976 // separator found: strip basename
977 *last_separator = '\0';
983 // ----------------------------------------------------------------------------
984 // various string functions
985 // ----------------------------------------------------------------------------
987 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
989 if (s1 == NULL || s2 == NULL || sep == NULL)
992 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
995 sprintf(complete_string, "%s%s%s", s1, sep, s2);
997 return complete_string;
1000 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1002 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1005 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1006 strlen(s2) + strlen(sep) +
1009 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1011 return complete_string;
1014 char *getStringCat2(char *s1, char *s2)
1016 return getStringCat2WithSeparator(s1, s2, "");
1019 char *getStringCat3(char *s1, char *s2, char *s3)
1021 return getStringCat3WithSeparator(s1, s2, s3, "");
1024 char *getPath2(char *path1, char *path2)
1026 #if defined(PLATFORM_ANDROID)
1027 // workaround for reading from assets directory -- skip "." subdirs in path
1028 if (strEqual(path1, "."))
1029 return getStringCopy(path2);
1030 else if (strEqual(path2, "."))
1031 return getStringCopy(path1);
1034 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1037 char *getPath3(char *path1, char *path2, char *path3)
1039 #if defined(PLATFORM_ANDROID)
1040 // workaround for reading from assets directory -- skip "." subdirs in path
1041 if (strEqual(path1, "."))
1042 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1043 else if (strEqual(path2, "."))
1044 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1045 else if (strEqual(path3, "."))
1046 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1049 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1052 static char *getPngOrPcxIfNotExists(char *filename)
1054 // switch from PNG to PCX file and vice versa, if file does not exist
1055 // (backwards compatibility with PCX files used in previous versions)
1057 if (!fileExists(filename) && strSuffix(filename, ".png"))
1058 strcpy(&filename[strlen(filename) - 3], "pcx");
1059 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1060 strcpy(&filename[strlen(filename) - 3], "png");
1065 char *getImg2(char *path1, char *path2)
1067 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1070 char *getImg3(char *path1, char *path2, char *path3)
1072 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1075 char *getStringCopy(const char *s)
1082 s_copy = checked_malloc(strlen(s) + 1);
1088 char *getStringCopyN(const char *s, int n)
1091 int s_len = MAX(0, n);
1096 s_copy = checked_malloc(s_len + 1);
1097 strncpy(s_copy, s, s_len);
1098 s_copy[s_len] = '\0';
1103 char *getStringCopyNStatic(const char *s, int n)
1105 static char *s_copy = NULL;
1107 checked_free(s_copy);
1109 s_copy = getStringCopyN(s, n);
1114 char *getStringToLower(const char *s)
1116 char *s_copy = checked_malloc(strlen(s) + 1);
1117 char *s_ptr = s_copy;
1120 *s_ptr++ = tolower(*s++);
1126 void setString(char **old_value, char *new_value)
1128 checked_free(*old_value);
1130 *old_value = getStringCopy(new_value);
1133 boolean strEqual(char *s1, char *s2)
1135 return (s1 == NULL && s2 == NULL ? TRUE :
1136 s1 == NULL && s2 != NULL ? FALSE :
1137 s1 != NULL && s2 == NULL ? FALSE :
1138 strcmp(s1, s2) == 0);
1141 boolean strEqualN(char *s1, char *s2, int n)
1143 return (s1 == NULL && s2 == NULL ? TRUE :
1144 s1 == NULL && s2 != NULL ? FALSE :
1145 s1 != NULL && s2 == NULL ? FALSE :
1146 strncmp(s1, s2, n) == 0);
1149 boolean strPrefix(char *s, char *prefix)
1151 return (s == NULL && prefix == NULL ? TRUE :
1152 s == NULL && prefix != NULL ? FALSE :
1153 s != NULL && prefix == NULL ? FALSE :
1154 strncmp(s, prefix, strlen(prefix)) == 0);
1157 boolean strSuffix(char *s, char *suffix)
1159 return (s == NULL && suffix == NULL ? TRUE :
1160 s == NULL && suffix != NULL ? FALSE :
1161 s != NULL && suffix == NULL ? FALSE :
1162 strlen(s) < strlen(suffix) ? FALSE :
1163 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1166 boolean strPrefixLower(char *s, char *prefix)
1168 char *s_lower = getStringToLower(s);
1169 boolean match = strPrefix(s_lower, prefix);
1176 boolean strSuffixLower(char *s, char *suffix)
1178 char *s_lower = getStringToLower(s);
1179 boolean match = strSuffix(s_lower, suffix);
1187 // ----------------------------------------------------------------------------
1188 // command line option handling functions
1189 // ----------------------------------------------------------------------------
1191 void GetOptions(int argc, char *argv[],
1192 void (*print_usage_function)(void),
1193 void (*print_version_function)(void))
1195 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1196 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1197 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1198 char **options_left = &argvplus[1];
1200 // replace original "argv" with null-terminated array of string pointers
1202 argvplus[argc] = argv[argc];
1204 // initialize global program options
1205 options.server_host = NULL;
1206 options.server_port = 0;
1208 options.ro_base_directory = ro_base_path;
1209 options.rw_base_directory = rw_base_path;
1210 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1211 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1212 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1213 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1214 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1215 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1217 options.execute_command = NULL;
1218 options.special_flags = NULL;
1219 options.debug_mode = NULL;
1221 options.mytapes = FALSE;
1222 options.serveronly = FALSE;
1223 options.network = FALSE;
1224 options.verbose = FALSE;
1225 options.debug = FALSE;
1228 options.verbose = TRUE;
1230 #if !defined(PLATFORM_UNIX)
1231 if (*options_left == NULL) // no options given -- enable verbose mode
1232 options.verbose = TRUE;
1237 #if defined(PLATFORM_ANDROID)
1238 options.debug = TRUE;
1242 while (*options_left)
1244 char option_str[MAX_OPTION_LEN];
1245 char *option = options_left[0];
1246 char *next_option = options_left[1];
1247 char *option_arg = NULL;
1248 int option_len = strlen(option);
1250 if (option_len >= MAX_OPTION_LEN)
1251 FailWithHelp("unrecognized option '%s'", option);
1253 strcpy(option_str, option); // copy argument into buffer
1254 option = option_str;
1256 if (strEqual(option, "--")) // stop scanning arguments
1259 if (strPrefix(option, "--")) // treat '--' like '-'
1262 option_arg = strchr(option, '=');
1263 if (option_arg == NULL) // no '=' in option
1264 option_arg = next_option;
1267 *option_arg++ = '\0'; // cut argument from option
1268 if (*option_arg == '\0') // no argument after '='
1269 FailWithHelp("option '%s' has invalid argument", option_str);
1272 option_len = strlen(option);
1274 if (strEqual(option, "-"))
1276 FailWithHelp("unrecognized option '%s'", option);
1278 else if (strncmp(option, "-help", option_len) == 0)
1280 print_usage_function();
1284 else if (strncmp(option, "-basepath", option_len) == 0)
1286 if (option_arg == NULL)
1287 FailWithHelp("option '%s' requires an argument", option_str);
1289 // this should be extended to separate options for ro and rw data
1290 options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1291 options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1292 if (option_arg == next_option)
1295 // adjust paths for sub-directories in base directory accordingly
1296 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1297 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1298 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1299 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1300 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1301 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1303 else if (strncmp(option, "-levels", option_len) == 0)
1305 if (option_arg == NULL)
1306 FailWithHelp("option '%s' requires an argument", option_str);
1308 options.level_directory = getStringCopy(option_arg);
1309 if (option_arg == next_option)
1312 else if (strncmp(option, "-graphics", option_len) == 0)
1314 if (option_arg == NULL)
1315 FailWithHelp("option '%s' requires an argument", option_str);
1317 options.graphics_directory = getStringCopy(option_arg);
1318 if (option_arg == next_option)
1321 else if (strncmp(option, "-sounds", option_len) == 0)
1323 if (option_arg == NULL)
1324 FailWithHelp("option '%s' requires an argument", option_str);
1326 options.sounds_directory = getStringCopy(option_arg);
1327 if (option_arg == next_option)
1330 else if (strncmp(option, "-music", option_len) == 0)
1332 if (option_arg == NULL)
1333 FailWithHelp("option '%s' requires an argument", option_str);
1335 options.music_directory = getStringCopy(option_arg);
1336 if (option_arg == next_option)
1339 else if (strncmp(option, "-mytapes", option_len) == 0)
1341 options.mytapes = TRUE;
1343 else if (strncmp(option, "-network", option_len) == 0)
1345 options.network = TRUE;
1347 else if (strncmp(option, "-serveronly", option_len) == 0)
1349 options.serveronly = TRUE;
1351 else if (strncmp(option, "-debug", option_len) == 0)
1353 options.debug = TRUE;
1355 // optionally, debug output can be limited to a specific debug mode
1356 if (option_arg != next_option)
1357 options.debug_mode = getStringCopy(option_arg);
1359 else if (strncmp(option, "-verbose", option_len) == 0)
1361 options.verbose = TRUE;
1363 else if (strncmp(option, "-version", option_len) == 0 ||
1364 strncmp(option, "-V", option_len) == 0)
1366 print_version_function();
1370 else if (strPrefix(option, "-D"))
1372 options.special_flags = getStringCopy(&option[2]);
1374 else if (strncmp(option, "-execute", option_len) == 0)
1376 if (option_arg == NULL)
1377 FailWithHelp("option '%s' requires an argument", option_str);
1379 options.execute_command = getStringCopy(option_arg);
1380 if (option_arg == next_option)
1383 // when doing batch processing, always enable verbose mode (warnings)
1384 options.verbose = TRUE;
1386 #if defined(PLATFORM_MACOSX)
1387 else if (strPrefix(option, "-psn"))
1389 // ignore process serial number when launched via GUI on Mac OS X
1392 else if (*option == '-')
1394 FailWithHelp("unrecognized option '%s'", option_str);
1396 else if (options.server_host == NULL)
1398 options.server_host = *options_left;
1400 else if (options.server_port == 0)
1402 options.server_port = atoi(*options_left);
1403 if (options.server_port < 1024)
1404 FailWithHelp("bad port number '%d'", options.server_port);
1407 FailWithHelp("too many arguments");
1414 // ----------------------------------------------------------------------------
1415 // checked memory allocation and freeing functions
1416 // ----------------------------------------------------------------------------
1418 void *checked_malloc(unsigned int size)
1425 Fail("cannot allocate %d bytes -- out of memory", size);
1430 void *checked_calloc(unsigned int size)
1434 ptr = calloc(1, size);
1437 Fail("cannot allocate %d bytes -- out of memory", size);
1442 void *checked_realloc(void *ptr, unsigned int size)
1444 ptr = realloc(ptr, size);
1447 Fail("cannot allocate %d bytes -- out of memory", size);
1452 void checked_free(void *ptr)
1454 if (ptr != NULL) // this check should be done by free() anyway
1458 void clear_mem(void *ptr, unsigned int size)
1460 #if defined(PLATFORM_WIN32)
1461 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1462 char *cptr = (char *)ptr;
1467 memset(ptr, 0, size);
1472 // ----------------------------------------------------------------------------
1473 // various helper functions
1474 // ----------------------------------------------------------------------------
1476 void swap_numbers(int *i1, int *i2)
1484 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1496 /* the "put" variants of the following file access functions check for the file
1497 pointer being != NULL and return the number of bytes they have or would have
1498 written; this allows for chunk writing functions to first determine the size
1499 of the (not yet written) chunk, write the correct chunk size and finally
1500 write the chunk itself */
1502 int getFile8BitInteger(File *file)
1504 return getByteFromFile(file);
1507 int putFile8BitInteger(FILE *file, int value)
1515 int getFile16BitInteger(File *file, int byte_order)
1517 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1518 return ((getByteFromFile(file) << 8) |
1519 (getByteFromFile(file) << 0));
1520 else // BYTE_ORDER_LITTLE_ENDIAN
1521 return ((getByteFromFile(file) << 0) |
1522 (getByteFromFile(file) << 8));
1525 int putFile16BitInteger(FILE *file, int value, int byte_order)
1529 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1531 fputc((value >> 8) & 0xff, file);
1532 fputc((value >> 0) & 0xff, file);
1534 else // BYTE_ORDER_LITTLE_ENDIAN
1536 fputc((value >> 0) & 0xff, file);
1537 fputc((value >> 8) & 0xff, file);
1544 int getFile32BitInteger(File *file, int byte_order)
1546 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1547 return ((getByteFromFile(file) << 24) |
1548 (getByteFromFile(file) << 16) |
1549 (getByteFromFile(file) << 8) |
1550 (getByteFromFile(file) << 0));
1551 else // BYTE_ORDER_LITTLE_ENDIAN
1552 return ((getByteFromFile(file) << 0) |
1553 (getByteFromFile(file) << 8) |
1554 (getByteFromFile(file) << 16) |
1555 (getByteFromFile(file) << 24));
1558 int putFile32BitInteger(FILE *file, int value, int byte_order)
1562 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1564 fputc((value >> 24) & 0xff, file);
1565 fputc((value >> 16) & 0xff, file);
1566 fputc((value >> 8) & 0xff, file);
1567 fputc((value >> 0) & 0xff, file);
1569 else // BYTE_ORDER_LITTLE_ENDIAN
1571 fputc((value >> 0) & 0xff, file);
1572 fputc((value >> 8) & 0xff, file);
1573 fputc((value >> 16) & 0xff, file);
1574 fputc((value >> 24) & 0xff, file);
1581 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1584 const int chunk_name_length = 4;
1587 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1590 if (chunk_size != NULL)
1593 *chunk_size = getFile32BitInteger(file, byte_order);
1596 return (checkEndOfFile(file) ? FALSE : TRUE);
1599 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1606 fputs(chunk_name, file);
1608 num_bytes += strlen(chunk_name);
1610 if (chunk_size >= 0)
1614 putFile32BitInteger(file, chunk_size, byte_order);
1622 int getFileVersion(File *file)
1624 int version_super = getByteFromFile(file);
1625 int version_major = getByteFromFile(file);
1626 int version_minor = getByteFromFile(file);
1627 int version_patch = getByteFromFile(file);
1629 return VERSION_IDENT(version_super, version_major, version_minor,
1633 int putFileVersion(FILE *file, int version)
1637 int version_super = VERSION_SUPER(version);
1638 int version_major = VERSION_MAJOR(version);
1639 int version_minor = VERSION_MINOR(version);
1640 int version_patch = VERSION_PATCH(version);
1642 fputc(version_super, file);
1643 fputc(version_major, file);
1644 fputc(version_minor, file);
1645 fputc(version_patch, file);
1651 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1655 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1656 buffer[i] = getByteFromFile(file);
1659 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1663 for (i = 0; i < bytes; i++)
1664 fputc(buffer[i], file);
1667 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1669 while (bytes-- && !checkEndOfFile(file))
1670 getByteFromFile(file);
1673 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1680 // ----------------------------------------------------------------------------
1681 // functions to translate key identifiers between different format
1682 // ----------------------------------------------------------------------------
1684 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1685 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1686 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1687 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1689 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1698 // return and escape keys
1699 { KSYM_Return, "XK_Return", "return" },
1700 { KSYM_Escape, "XK_Escape", "escape" },
1702 // normal cursor keys
1703 { KSYM_Left, "XK_Left", "cursor left" },
1704 { KSYM_Right, "XK_Right", "cursor right" },
1705 { KSYM_Up, "XK_Up", "cursor up" },
1706 { KSYM_Down, "XK_Down", "cursor down" },
1708 // keypad cursor keys
1710 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1711 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1712 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1713 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1716 // other keypad keys
1717 #ifdef KSYM_KP_Enter
1718 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1719 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1720 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1721 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1722 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1723 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1727 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1728 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1729 { KSYM_Control_L, "XK_Control_L", "left control" },
1730 { KSYM_Control_R, "XK_Control_R", "right control" },
1731 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1732 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1733 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1734 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1735 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1736 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1738 // some special keys
1739 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1740 { KSYM_Delete, "XK_Delete", "delete" },
1741 { KSYM_Insert, "XK_Insert", "insert" },
1742 { KSYM_Tab, "XK_Tab", "tab" },
1743 { KSYM_Home, "XK_Home", "home" },
1744 { KSYM_End, "XK_End", "end" },
1745 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1746 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1748 { KSYM_Select, "XK_Select", "select" },
1749 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1750 { KSYM_Back, "XK_Back", "back" }, // back key
1751 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1752 #if defined(PLATFORM_ANDROID)
1753 { KSYM_Rewind, "XK_Rewind", "rewind" },
1754 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1757 // ASCII 0x20 to 0x40 keys (except numbers)
1758 { KSYM_space, "XK_space", "space" },
1759 { KSYM_exclam, "XK_exclam", "!" },
1760 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1761 { KSYM_numbersign, "XK_numbersign", "#" },
1762 { KSYM_dollar, "XK_dollar", "$" },
1763 { KSYM_percent, "XK_percent", "%" },
1764 { KSYM_ampersand, "XK_ampersand", "&" },
1765 { KSYM_apostrophe, "XK_apostrophe", "'" },
1766 { KSYM_parenleft, "XK_parenleft", "(" },
1767 { KSYM_parenright, "XK_parenright", ")" },
1768 { KSYM_asterisk, "XK_asterisk", "*" },
1769 { KSYM_plus, "XK_plus", "+" },
1770 { KSYM_comma, "XK_comma", "," },
1771 { KSYM_minus, "XK_minus", "-" },
1772 { KSYM_period, "XK_period", "." },
1773 { KSYM_slash, "XK_slash", "/" },
1774 { KSYM_colon, "XK_colon", ":" },
1775 { KSYM_semicolon, "XK_semicolon", ";" },
1776 { KSYM_less, "XK_less", "<" },
1777 { KSYM_equal, "XK_equal", "=" },
1778 { KSYM_greater, "XK_greater", ">" },
1779 { KSYM_question, "XK_question", "?" },
1780 { KSYM_at, "XK_at", "@" },
1783 { KSYM_bracketleft, "XK_bracketleft", "[" },
1784 { KSYM_backslash, "XK_backslash", "\\" },
1785 { KSYM_bracketright,"XK_bracketright", "]" },
1786 { KSYM_asciicircum, "XK_asciicircum", "^" },
1787 { KSYM_underscore, "XK_underscore", "_" },
1788 { KSYM_grave, "XK_grave", "grave" },
1789 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1790 { KSYM_braceleft, "XK_braceleft", "brace left" },
1791 { KSYM_bar, "XK_bar", "bar" },
1792 { KSYM_braceright, "XK_braceright", "brace right" },
1793 { KSYM_asciitilde, "XK_asciitilde", "~" },
1795 // special (non-ASCII) keys
1796 { KSYM_degree, "XK_degree", "degree" },
1797 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1798 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1799 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1800 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1801 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1802 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1803 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1805 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1806 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1807 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1808 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1809 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1810 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1811 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1812 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1813 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1815 // other keys (for reverse mapping only)
1816 { KSYM_space, "XK_space", " " },
1818 // keypad keys are not in numerical order in SDL2
1819 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1820 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1821 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1822 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1823 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1824 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1825 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1826 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1827 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1828 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1830 // end-of-array identifier
1836 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1838 static char name_buffer[30];
1841 if (key >= KSYM_A && key <= KSYM_Z)
1842 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1843 else if (key >= KSYM_a && key <= KSYM_z)
1844 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1845 else if (key >= KSYM_0 && key <= KSYM_9)
1846 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1847 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1848 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1849 else if (key == KSYM_UNDEFINED)
1850 strcpy(name_buffer, "(undefined)");
1857 if (key == translate_key[i].key)
1859 strcpy(name_buffer, translate_key[i].name);
1863 while (translate_key[++i].name);
1865 if (!translate_key[i].name)
1866 strcpy(name_buffer, "(unknown)");
1869 *name = name_buffer;
1871 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1873 static char name_buffer[30];
1876 if (key >= KSYM_A && key <= KSYM_Z)
1877 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1878 else if (key >= KSYM_a && key <= KSYM_z)
1879 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1880 else if (key >= KSYM_0 && key <= KSYM_9)
1881 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1882 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1883 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1884 else if (key == KSYM_UNDEFINED)
1885 strcpy(name_buffer, "[undefined]");
1892 if (key == translate_key[i].key)
1894 strcpy(name_buffer, translate_key[i].x11name);
1898 while (translate_key[++i].x11name);
1900 if (!translate_key[i].x11name)
1901 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1904 *x11name = name_buffer;
1906 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1908 Key key = KSYM_UNDEFINED;
1909 char *name_ptr = *name;
1911 if (strlen(*name) == 1)
1913 char c = name_ptr[0];
1915 if (c >= 'A' && c <= 'Z')
1916 key = KSYM_A + (Key)(c - 'A');
1917 else if (c >= 'a' && c <= 'z')
1918 key = KSYM_a + (Key)(c - 'a');
1919 else if (c >= '0' && c <= '9')
1920 key = KSYM_0 + (Key)(c - '0');
1923 if (key == KSYM_UNDEFINED)
1929 if (strEqual(translate_key[i].name, *name))
1931 key = translate_key[i].key;
1935 while (translate_key[++i].x11name);
1938 if (key == KSYM_UNDEFINED)
1939 Warn("getKeyFromKeyName(): not completely implemented");
1943 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1945 Key key = KSYM_UNDEFINED;
1946 char *name_ptr = *x11name;
1948 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1950 char c = name_ptr[3];
1952 if (c >= 'A' && c <= 'Z')
1953 key = KSYM_A + (Key)(c - 'A');
1954 else if (c >= 'a' && c <= 'z')
1955 key = KSYM_a + (Key)(c - 'a');
1956 else if (c >= '0' && c <= '9')
1957 key = KSYM_0 + (Key)(c - '0');
1959 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1961 char c1 = name_ptr[4];
1962 char c2 = name_ptr[5];
1965 if ((c1 >= '0' && c1 <= '9') &&
1966 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1967 d = atoi(&name_ptr[4]);
1969 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1970 key = KSYM_F1 + (Key)(d - 1);
1972 else if (strPrefix(name_ptr, "XK_"))
1978 if (strEqual(name_ptr, translate_key[i].x11name))
1980 key = translate_key[i].key;
1984 while (translate_key[++i].x11name);
1986 else if (strPrefix(name_ptr, "0x"))
1988 unsigned int value = 0;
1994 char c = *name_ptr++;
1997 if (c >= '0' && c <= '9')
1999 else if (c >= 'a' && c <= 'f')
2000 d = (int)(c - 'a' + 10);
2001 else if (c >= 'A' && c <= 'F')
2002 d = (int)(c - 'A' + 10);
2010 value = value * 16 + d;
2021 char *getKeyNameFromKey(Key key)
2025 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2029 char *getX11KeyNameFromKey(Key key)
2033 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2037 Key getKeyFromKeyName(char *name)
2041 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2045 Key getKeyFromX11KeyName(char *x11name)
2049 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2053 char getCharFromKey(Key key)
2059 } translate_key_char[] =
2061 // special (non-ASCII) keys (ISO-8859-1)
2062 { KSYM_degree, CHAR_BYTE_DEGREE },
2063 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2064 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2065 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2066 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2067 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2068 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2069 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2071 // end-of-array identifier
2075 char *keyname = getKeyNameFromKey(key);
2078 if (strlen(keyname) == 1)
2080 else if (strEqual(keyname, "space"))
2088 if (key == translate_key_char[i].key)
2090 c = translate_key_char[i].key_char;
2095 while (translate_key_char[++i].key_char);
2101 char getValidConfigValueChar(char c)
2103 if (c == '#' || // used to mark comments
2104 c == '\\') // used to mark continued lines
2111 // ----------------------------------------------------------------------------
2112 // functions to translate string identifiers to integer or boolean value
2113 // ----------------------------------------------------------------------------
2115 int get_integer_from_string(char *s)
2117 static char *number_text[][3] =
2119 { "0", "zero", "null", },
2120 { "1", "one", "first" },
2121 { "2", "two", "second" },
2122 { "3", "three", "third" },
2123 { "4", "four", "fourth" },
2124 { "5", "five", "fifth" },
2125 { "6", "six", "sixth" },
2126 { "7", "seven", "seventh" },
2127 { "8", "eight", "eighth" },
2128 { "9", "nine", "ninth" },
2129 { "10", "ten", "tenth" },
2130 { "11", "eleven", "eleventh" },
2131 { "12", "twelve", "twelfth" },
2133 { NULL, NULL, NULL },
2137 char *s_lower = getStringToLower(s);
2140 for (i = 0; number_text[i][0] != NULL; i++)
2141 for (j = 0; j < 3; j++)
2142 if (strEqual(s_lower, number_text[i][j]))
2147 if (strEqual(s_lower, "false") ||
2148 strEqual(s_lower, "no") ||
2149 strEqual(s_lower, "off"))
2151 else if (strEqual(s_lower, "true") ||
2152 strEqual(s_lower, "yes") ||
2153 strEqual(s_lower, "on"))
2164 boolean get_boolean_from_string(char *s)
2166 char *s_lower = getStringToLower(s);
2167 boolean result = FALSE;
2169 if (strEqual(s_lower, "true") ||
2170 strEqual(s_lower, "yes") ||
2171 strEqual(s_lower, "on") ||
2172 get_integer_from_string(s) == 1)
2180 int get_switch3_from_string(char *s)
2182 char *s_lower = getStringToLower(s);
2185 if (strEqual(s_lower, "true") ||
2186 strEqual(s_lower, "yes") ||
2187 strEqual(s_lower, "on") ||
2188 get_integer_from_string(s) == 1)
2190 else if (strEqual(s_lower, "auto"))
2198 int get_player_nr_from_string(char *s)
2200 static char *player_text[] =
2210 char *s_lower = getStringToLower(s);
2214 for (i = 0; player_text[i] != NULL; i++)
2215 if (strEqual(s_lower, player_text[i]))
2224 // ----------------------------------------------------------------------------
2225 // functions for generic lists
2226 // ----------------------------------------------------------------------------
2228 ListNode *newListNode(void)
2230 return checked_calloc(sizeof(ListNode));
2233 void addNodeToList(ListNode **node_first, char *key, void *content)
2235 ListNode *node_new = newListNode();
2237 node_new->key = getStringCopy(key);
2238 node_new->content = content;
2239 node_new->next = *node_first;
2242 (*node_first)->prev = node_new;
2244 *node_first = node_new;
2247 void deleteNodeFromList(ListNode **node_first, char *key,
2248 void (*destructor_function)(void *))
2250 if (node_first == NULL || *node_first == NULL)
2253 if (strEqual((*node_first)->key, key))
2255 // after first recursion, (*node_first)->prev->next == *node_first,
2256 // so *node_first would be overwritten with (*node_first)->next
2257 // => use a copy of *node_first (and later of (*node_first)->next)
2258 ListNode *node = *node_first;
2259 ListNode *node_next = node->next;
2261 checked_free(node->key);
2263 if (destructor_function)
2264 destructor_function(node->content);
2267 node->prev->next = node->next;
2270 node->next->prev = node->prev;
2274 // after removing node, set list pointer to next valid list node
2275 // (this is important if the first node of the list was deleted)
2276 *node_first = node_next;
2280 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2284 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2286 if (node_first == NULL)
2289 if (strEqual(node_first->key, key))
2292 return getNodeFromKey(node_first->next, key);
2295 int getNumNodes(ListNode *node_first)
2297 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2301 static void dumpList(ListNode *node_first)
2303 ListNode *node = node_first;
2307 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2308 ((struct ListNodeInfo *)node->content)->num_references);
2312 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2317 // ----------------------------------------------------------------------------
2318 // functions for file handling
2319 // ----------------------------------------------------------------------------
2321 #define MAX_BUFFER_SIZE 4096
2323 File *openFile(char *filename, char *mode)
2325 File *file = checked_calloc(sizeof(File));
2327 file->file = fopen(filename, mode);
2329 if (file->file != NULL)
2331 file->filename = getStringCopy(filename);
2336 #if defined(PLATFORM_ANDROID)
2337 file->asset_file = SDL_RWFromFile(filename, mode);
2339 if (file->asset_file != NULL)
2341 file->file_is_asset = TRUE;
2342 file->filename = getStringCopy(filename);
2353 int closeFile(File *file)
2360 #if defined(PLATFORM_ANDROID)
2361 if (file->asset_file)
2362 result = SDL_RWclose(file->asset_file);
2366 result = fclose(file->file);
2368 checked_free(file->filename);
2374 int checkEndOfFile(File *file)
2376 #if defined(PLATFORM_ANDROID)
2377 if (file->file_is_asset)
2378 return file->end_of_file;
2381 return feof(file->file);
2384 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2386 #if defined(PLATFORM_ANDROID)
2387 if (file->file_is_asset)
2389 if (file->end_of_file)
2392 size_t num_items_read =
2393 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2395 if (num_items_read < num_items)
2396 file->end_of_file = TRUE;
2398 return num_items_read;
2402 return fread(buffer, item_size, num_items, file->file);
2405 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2407 return fwrite(buffer, item_size, num_items, file->file);
2410 int seekFile(File *file, long offset, int whence)
2412 #if defined(PLATFORM_ANDROID)
2413 if (file->file_is_asset)
2415 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2416 whence == SEEK_CUR ? RW_SEEK_CUR :
2417 whence == SEEK_END ? RW_SEEK_END : 0);
2419 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2423 return fseek(file->file, offset, whence);
2426 int getByteFromFile(File *file)
2428 #if defined(PLATFORM_ANDROID)
2429 if (file->file_is_asset)
2431 if (file->end_of_file)
2435 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2437 if (num_bytes_read < 1)
2438 file->end_of_file = TRUE;
2440 return (file->end_of_file ? EOF : (int)c);
2444 return fgetc(file->file);
2447 char *getStringFromFile(File *file, char *line, int size)
2449 #if defined(PLATFORM_ANDROID)
2450 if (file->file_is_asset)
2452 if (file->end_of_file)
2455 char *line_ptr = line;
2456 int num_bytes_read = 0;
2458 while (num_bytes_read < size - 1 &&
2459 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2460 *line_ptr++ != '\n')
2465 if (strlen(line) == 0)
2467 file->end_of_file = TRUE;
2476 return fgets(line, size, file->file);
2479 int copyFile(char *filename_from, char *filename_to)
2481 File *file_from, *file_to;
2483 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2488 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2490 closeFile(file_from);
2495 while (!checkEndOfFile(file_from))
2497 byte buffer[MAX_BUFFER_SIZE];
2498 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2500 writeFile(file_to, buffer, 1, bytes_read);
2503 closeFile(file_from);
2510 // ----------------------------------------------------------------------------
2511 // functions for directory handling
2512 // ----------------------------------------------------------------------------
2514 Directory *openDirectory(char *dir_name)
2516 Directory *dir = checked_calloc(sizeof(Directory));
2518 dir->dir = opendir(dir_name);
2520 if (dir->dir != NULL)
2522 dir->filename = getStringCopy(dir_name);
2527 #if defined(PLATFORM_ANDROID)
2528 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2530 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2532 checked_free(asset_toc_filename);
2534 if (dir->asset_toc_file != NULL)
2536 dir->directory_is_asset = TRUE;
2537 dir->filename = getStringCopy(dir_name);
2548 int closeDirectory(Directory *dir)
2555 #if defined(PLATFORM_ANDROID)
2556 if (dir->asset_toc_file)
2557 result = SDL_RWclose(dir->asset_toc_file);
2561 result = closedir(dir->dir);
2564 freeDirectoryEntry(dir->dir_entry);
2566 checked_free(dir->filename);
2572 DirectoryEntry *readDirectory(Directory *dir)
2575 freeDirectoryEntry(dir->dir_entry);
2577 dir->dir_entry = NULL;
2579 #if defined(PLATFORM_ANDROID)
2580 if (dir->directory_is_asset)
2582 char line[MAX_LINE_LEN];
2583 char *line_ptr = line;
2584 int num_bytes_read = 0;
2586 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2587 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2596 if (strlen(line) == 0)
2599 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2601 dir->dir_entry->is_directory = FALSE;
2602 if (line[strlen(line) - 1] == '/')
2604 dir->dir_entry->is_directory = TRUE;
2606 line[strlen(line) - 1] = '\0';
2609 dir->dir_entry->basename = getStringCopy(line);
2610 dir->dir_entry->filename = getPath2(dir->filename, line);
2612 return dir->dir_entry;
2616 struct dirent *dir_entry = readdir(dir->dir);
2618 if (dir_entry == NULL)
2621 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2623 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2624 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2626 struct stat file_status;
2628 dir->dir_entry->is_directory =
2629 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2630 S_ISDIR(file_status.st_mode));
2632 return dir->dir_entry;
2635 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2637 if (dir_entry == NULL)
2640 checked_free(dir_entry->basename);
2641 checked_free(dir_entry->filename);
2642 checked_free(dir_entry);
2646 // ----------------------------------------------------------------------------
2647 // functions for checking files and filenames
2648 // ----------------------------------------------------------------------------
2650 boolean directoryExists(char *dir_name)
2652 if (dir_name == NULL)
2655 struct stat file_status;
2656 boolean success = (stat(dir_name, &file_status) == 0 &&
2657 S_ISDIR(file_status.st_mode));
2659 #if defined(PLATFORM_ANDROID)
2662 // this might be an asset directory; check by trying to open toc file
2663 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2664 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2666 checked_free(asset_toc_filename);
2668 success = (file != NULL);
2678 boolean fileExists(char *filename)
2680 if (filename == NULL)
2683 boolean success = (access(filename, F_OK) == 0);
2685 #if defined(PLATFORM_ANDROID)
2688 // this might be an asset file; check by trying to open it
2689 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2691 success = (file != NULL);
2702 static boolean fileHasPrefix(char *basename, char *prefix)
2704 static char *basename_lower = NULL;
2705 int basename_length, prefix_length;
2707 checked_free(basename_lower);
2709 if (basename == NULL || prefix == NULL)
2712 basename_lower = getStringToLower(basename);
2713 basename_length = strlen(basename_lower);
2714 prefix_length = strlen(prefix);
2716 if (basename_length > prefix_length + 1 &&
2717 basename_lower[prefix_length] == '.' &&
2718 strncmp(basename_lower, prefix, prefix_length) == 0)
2725 static boolean fileHasSuffix(char *basename, char *suffix)
2727 static char *basename_lower = NULL;
2728 int basename_length, suffix_length;
2730 checked_free(basename_lower);
2732 if (basename == NULL || suffix == NULL)
2735 basename_lower = getStringToLower(basename);
2736 basename_length = strlen(basename_lower);
2737 suffix_length = strlen(suffix);
2739 if (basename_length > suffix_length + 1 &&
2740 basename_lower[basename_length - suffix_length - 1] == '.' &&
2741 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2747 static boolean FileCouldBeArtwork(char *filename)
2749 char *basename = getBaseNamePtr(filename);
2751 return (!strEqual(basename, ".") &&
2752 !strEqual(basename, "..") &&
2753 !fileHasSuffix(basename, "txt") &&
2754 !fileHasSuffix(basename, "conf") &&
2755 !directoryExists(filename));
2758 boolean FileIsGraphic(char *filename)
2760 return FileCouldBeArtwork(filename);
2763 boolean FileIsSound(char *filename)
2765 return FileCouldBeArtwork(filename);
2768 boolean FileIsMusic(char *filename)
2770 return FileCouldBeArtwork(filename);
2773 boolean FileIsArtworkType(char *filename, int type)
2775 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2776 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2777 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2783 // ----------------------------------------------------------------------------
2784 // functions for loading artwork configuration information
2785 // ----------------------------------------------------------------------------
2787 char *get_mapped_token(char *token)
2789 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2790 static char *map_token_prefix[][2] =
2792 { "char_procent", "char_percent" },
2793 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2794 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2795 { "bd_butterfly_left", "bd_butterfly.left" },
2796 { "bd_butterfly_right", "bd_butterfly.right" },
2797 { "bd_butterfly_up", "bd_butterfly.up" },
2798 { "bd_butterfly_down", "bd_butterfly.down" },
2799 { "bd_firefly_left", "bd_firefly.left" },
2800 { "bd_firefly_right", "bd_firefly.right" },
2801 { "bd_firefly_up", "bd_firefly.up" },
2802 { "bd_firefly_down", "bd_firefly.down" },
2808 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2810 int len_token_prefix = strlen(map_token_prefix[i][0]);
2812 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2813 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2816 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2817 char *gfx_substring = ".gfx";
2818 char *gfx_prefix = "gfx.";
2819 if (strstr(token, gfx_substring) != NULL)
2821 char *token_prefix = getStringCopy(token);
2822 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2823 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2826 // cut off token string at ".gfx" substring position
2827 *token_gfx_pos = '\0';
2829 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2830 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2834 return mapped_token;
2840 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2843 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2844 static struct ConfigTypeInfo prefix_list[] =
2846 { "global.anim_1" },
2847 { "global.anim_2" },
2848 { "global.anim_3" },
2849 { "global.anim_4" },
2850 { "global.anim_5" },
2851 { "global.anim_6" },
2852 { "global.anim_7" },
2853 { "global.anim_8" },
2854 { "global.anim_9" },
2855 { "global.anim_10" },
2856 { "global.anim_11" },
2857 { "global.anim_12" },
2858 { "global.anim_13" },
2859 { "global.anim_14" },
2860 { "global.anim_15" },
2861 { "global.anim_16" },
2862 { "global.anim_17" },
2863 { "global.anim_18" },
2864 { "global.anim_19" },
2865 { "global.anim_20" },
2866 { "global.anim_21" },
2867 { "global.anim_22" },
2868 { "global.anim_23" },
2869 { "global.anim_24" },
2870 { "global.anim_25" },
2871 { "global.anim_26" },
2872 { "global.anim_27" },
2873 { "global.anim_28" },
2874 { "global.anim_29" },
2875 { "global.anim_30" },
2876 { "global.anim_31" },
2877 { "global.anim_32" },
2881 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2882 boolean prefix_found = FALSE;
2886 // search for prefix to check if base token has to be created
2887 for (i = 0; prefix_list[i].token != NULL; i++)
2888 if (strPrefix(token, prefix_list[i].token))
2889 prefix_found = TRUE;
2894 // search for suffix (parameter) to determine base token length
2895 for (i = 0; suffix_list[i].token != NULL; i++)
2896 if (strSuffix(token, suffix_list[i].token))
2897 len_suffix = strlen(suffix_list[i].token);
2899 return getStringCopyN(token, strlen(token) - len_suffix);
2902 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2903 struct ListNodeInfo ***, int *);
2905 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2906 struct ConfigTypeInfo *suffix_list,
2907 char **ignore_tokens,
2908 int num_file_list_entries)
2910 SetupFileHash *ignore_tokens_hash;
2911 struct FileInfo *file_list;
2912 int num_file_list_entries_found = 0;
2913 int num_suffix_list_entries = 0;
2917 // create hash from list of tokens to be ignored (for quick access)
2918 ignore_tokens_hash = newSetupFileHash();
2919 for (i = 0; ignore_tokens[i] != NULL; i++)
2920 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2922 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2924 for (i = 0; suffix_list[i].token != NULL; i++)
2925 num_suffix_list_entries++;
2927 // always start with reliable default values
2928 for (i = 0; i < num_file_list_entries; i++)
2930 file_list[i].token = NULL;
2932 file_list[i].default_filename = NULL;
2933 file_list[i].filename = NULL;
2935 if (num_suffix_list_entries > 0)
2937 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2939 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2940 file_list[i].parameter = checked_calloc(parameter_array_size);
2942 for (j = 0; j < num_suffix_list_entries; j++)
2944 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2945 setString(&file_list[i].parameter[j], suffix_list[j].value);
2948 file_list[i].redefined = FALSE;
2949 file_list[i].fallback_to_default = FALSE;
2950 file_list[i].default_is_cloned = FALSE;
2956 for (i = 0; config_list[i].token != NULL; i++)
2958 int len_config_token = strlen(config_list[i].token);
2959 boolean is_file_entry = TRUE;
2961 for (j = 0; suffix_list[j].token != NULL; j++)
2963 int len_suffix = strlen(suffix_list[j].token);
2965 if (len_suffix < len_config_token &&
2966 strEqual(&config_list[i].token[len_config_token - len_suffix],
2967 suffix_list[j].token))
2969 setString(&file_list[list_pos].default_parameter[j],
2970 config_list[i].value);
2972 is_file_entry = FALSE;
2978 // the following tokens are no file definitions, but other config tokens
2979 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
2980 is_file_entry = FALSE;
2987 if (list_pos >= num_file_list_entries)
2990 file_list[list_pos].token = config_list[i].token;
2991 file_list[list_pos].default_filename = config_list[i].value;
2994 if (strSuffix(config_list[i].token, ".clone_from"))
2995 file_list[list_pos].default_is_cloned = TRUE;
2998 num_file_list_entries_found = list_pos + 1;
2999 if (num_file_list_entries_found != num_file_list_entries)
3002 Error("inconsistant config list information:");
3003 Error("- should be: %d (according to 'src/conf_xxx.h')",
3004 num_file_list_entries);
3005 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3006 num_file_list_entries_found);
3011 freeSetupFileHash(ignore_tokens_hash);
3016 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3018 int len_token = strlen(token);
3019 int len_suffix = strlen(suffix);
3021 if (start_pos < 0) // compare suffix from end of string
3022 start_pos += len_token;
3024 if (start_pos < 0 || start_pos + len_suffix > len_token)
3027 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3030 if (token[start_pos + len_suffix] == '\0')
3033 if (token[start_pos + len_suffix] == '.')
3039 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3041 static void read_token_parameters(SetupFileHash *setup_file_hash,
3042 struct ConfigTypeInfo *suffix_list,
3043 struct FileInfo *file_list_entry)
3045 // check for config token that is the base token without any suffixes
3046 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3047 char *known_token_value = KNOWN_TOKEN_VALUE;
3050 if (filename != NULL)
3052 setString(&file_list_entry->filename, filename);
3054 // when file definition found, set all parameters to default values
3055 for (i = 0; suffix_list[i].token != NULL; i++)
3056 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3058 file_list_entry->redefined = TRUE;
3060 // mark config file token as well known from default config
3061 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3064 // check for config tokens that can be build by base token and suffixes
3065 for (i = 0; suffix_list[i].token != NULL; i++)
3067 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3068 char *value = getHashEntry(setup_file_hash, token);
3072 setString(&file_list_entry->parameter[i], value);
3074 // mark config file token as well known from default config
3075 setHashEntry(setup_file_hash, token, known_token_value);
3082 static void add_dynamic_file_list_entry(struct FileInfo **list,
3083 int *num_list_entries,
3084 SetupFileHash *extra_file_hash,
3085 struct ConfigTypeInfo *suffix_list,
3086 int num_suffix_list_entries,
3089 struct FileInfo *new_list_entry;
3090 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3092 (*num_list_entries)++;
3093 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3094 new_list_entry = &(*list)[*num_list_entries - 1];
3096 new_list_entry->token = getStringCopy(token);
3097 new_list_entry->default_filename = NULL;
3098 new_list_entry->filename = NULL;
3099 new_list_entry->parameter = checked_calloc(parameter_array_size);
3101 new_list_entry->redefined = FALSE;
3102 new_list_entry->fallback_to_default = FALSE;
3103 new_list_entry->default_is_cloned = FALSE;
3105 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3108 static void add_property_mapping(struct PropertyMapping **list,
3109 int *num_list_entries,
3110 int base_index, int ext1_index,
3111 int ext2_index, int ext3_index,
3114 struct PropertyMapping *new_list_entry;
3116 (*num_list_entries)++;
3117 *list = checked_realloc(*list,
3118 *num_list_entries * sizeof(struct PropertyMapping));
3119 new_list_entry = &(*list)[*num_list_entries - 1];
3121 new_list_entry->base_index = base_index;
3122 new_list_entry->ext1_index = ext1_index;
3123 new_list_entry->ext2_index = ext2_index;
3124 new_list_entry->ext3_index = ext3_index;
3126 new_list_entry->artwork_index = artwork_index;
3129 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3132 struct FileInfo *file_list = artwork_info->file_list;
3133 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3134 char **base_prefixes = artwork_info->base_prefixes;
3135 char **ext1_suffixes = artwork_info->ext1_suffixes;
3136 char **ext2_suffixes = artwork_info->ext2_suffixes;
3137 char **ext3_suffixes = artwork_info->ext3_suffixes;
3138 char **ignore_tokens = artwork_info->ignore_tokens;
3139 int num_file_list_entries = artwork_info->num_file_list_entries;
3140 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3141 int num_base_prefixes = artwork_info->num_base_prefixes;
3142 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3143 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3144 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3145 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3146 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3147 SetupFileHash *extra_file_hash, *empty_file_hash;
3148 char *known_token_value = KNOWN_TOKEN_VALUE;
3149 char *base_token_value = UNDEFINED_FILENAME;
3152 if (filename == NULL)
3155 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3158 // separate valid (defined) from empty (undefined) config token values
3159 valid_file_hash = newSetupFileHash();
3160 empty_file_hash = newSetupFileHash();
3161 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3163 char *value = HASH_ITERATION_VALUE(itr);
3165 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3166 HASH_ITERATION_TOKEN(itr), value);
3168 END_HASH_ITERATION(setup_file_hash, itr)
3170 // at this point, we do not need the setup file hash anymore -- free it
3171 freeSetupFileHash(setup_file_hash);
3173 // prevent changing hash while iterating over it by using a temporary copy
3174 valid_file_hash_tmp = newSetupFileHash();
3175 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3177 setHashEntry(valid_file_hash_tmp,
3178 HASH_ITERATION_TOKEN(itr),
3179 HASH_ITERATION_VALUE(itr));
3181 END_HASH_ITERATION(valid_file_hash, itr)
3183 // (iterate over same temporary hash, as modifications are independent)
3185 // map deprecated to current tokens (using prefix match and replace)
3186 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3188 char *token = HASH_ITERATION_TOKEN(itr);
3189 char *mapped_token = get_mapped_token(token);
3191 if (mapped_token != NULL)
3193 char *value = HASH_ITERATION_VALUE(itr);
3196 setHashEntry(valid_file_hash, mapped_token, value);
3198 // ignore old token (by setting it to "known" keyword)
3199 setHashEntry(valid_file_hash, token, known_token_value);
3204 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3206 // add special base tokens (using prefix match and replace)
3207 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3209 char *token = HASH_ITERATION_TOKEN(itr);
3210 char *base_token = get_special_base_token(artwork_info, token);
3212 if (base_token != NULL)
3214 // add base token only if it does not already exist
3215 if (getHashEntry(valid_file_hash, base_token) == NULL)
3216 setHashEntry(valid_file_hash, base_token, base_token_value);
3221 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3223 // free temporary hash used for iteration
3224 freeSetupFileHash(valid_file_hash_tmp);
3226 // read parameters for all known config file tokens
3227 for (i = 0; i < num_file_list_entries; i++)
3228 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3230 // set all tokens that can be ignored here to "known" keyword
3231 for (i = 0; i < num_ignore_tokens; i++)
3232 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3234 // copy all unknown config file tokens to extra config hash
3235 extra_file_hash = newSetupFileHash();
3236 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3238 char *value = HASH_ITERATION_VALUE(itr);
3240 if (!strEqual(value, known_token_value))
3241 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3243 END_HASH_ITERATION(valid_file_hash, itr)
3245 // at this point, we do not need the valid file hash anymore -- free it
3246 freeSetupFileHash(valid_file_hash);
3248 // now try to determine valid, dynamically defined config tokens
3250 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3252 struct FileInfo **dynamic_file_list =
3253 &artwork_info->dynamic_file_list;
3254 int *num_dynamic_file_list_entries =
3255 &artwork_info->num_dynamic_file_list_entries;
3256 struct PropertyMapping **property_mapping =
3257 &artwork_info->property_mapping;
3258 int *num_property_mapping_entries =
3259 &artwork_info->num_property_mapping_entries;
3260 int current_summarized_file_list_entry =
3261 artwork_info->num_file_list_entries +
3262 artwork_info->num_dynamic_file_list_entries;
3263 char *token = HASH_ITERATION_TOKEN(itr);
3264 int len_token = strlen(token);
3266 boolean base_prefix_found = FALSE;
3267 boolean parameter_suffix_found = FALSE;
3269 // skip all parameter definitions (handled by read_token_parameters())
3270 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3272 int len_suffix = strlen(suffix_list[i].token);
3274 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3275 parameter_suffix_found = TRUE;
3278 if (parameter_suffix_found)
3281 // ---------- step 0: search for matching base prefix ----------
3284 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3286 char *base_prefix = base_prefixes[i];
3287 int len_base_prefix = strlen(base_prefix);
3288 boolean ext1_suffix_found = FALSE;
3289 boolean ext2_suffix_found = FALSE;
3290 boolean ext3_suffix_found = FALSE;
3291 boolean exact_match = FALSE;
3292 int base_index = -1;
3293 int ext1_index = -1;
3294 int ext2_index = -1;
3295 int ext3_index = -1;
3297 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3299 if (!base_prefix_found)
3304 if (start_pos + len_base_prefix == len_token) // exact match
3308 add_dynamic_file_list_entry(dynamic_file_list,
3309 num_dynamic_file_list_entries,
3312 num_suffix_list_entries,
3314 add_property_mapping(property_mapping,
3315 num_property_mapping_entries,
3316 base_index, -1, -1, -1,
3317 current_summarized_file_list_entry);
3321 // ---------- step 1: search for matching first suffix ----------
3323 start_pos += len_base_prefix;
3324 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3326 char *ext1_suffix = ext1_suffixes[j];
3327 int len_ext1_suffix = strlen(ext1_suffix);
3329 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3331 if (!ext1_suffix_found)
3336 if (start_pos + len_ext1_suffix == len_token) // exact match
3340 add_dynamic_file_list_entry(dynamic_file_list,
3341 num_dynamic_file_list_entries,
3344 num_suffix_list_entries,
3346 add_property_mapping(property_mapping,
3347 num_property_mapping_entries,
3348 base_index, ext1_index, -1, -1,
3349 current_summarized_file_list_entry);
3353 start_pos += len_ext1_suffix;
3359 // ---------- step 2: search for matching second suffix ----------
3361 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3363 char *ext2_suffix = ext2_suffixes[k];
3364 int len_ext2_suffix = strlen(ext2_suffix);
3366 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3368 if (!ext2_suffix_found)
3373 if (start_pos + len_ext2_suffix == len_token) // exact match
3377 add_dynamic_file_list_entry(dynamic_file_list,
3378 num_dynamic_file_list_entries,
3381 num_suffix_list_entries,
3383 add_property_mapping(property_mapping,
3384 num_property_mapping_entries,
3385 base_index, ext1_index, ext2_index, -1,
3386 current_summarized_file_list_entry);
3390 start_pos += len_ext2_suffix;
3396 // ---------- step 3: search for matching third suffix ----------
3398 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3400 char *ext3_suffix = ext3_suffixes[l];
3401 int len_ext3_suffix = strlen(ext3_suffix);
3403 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3405 if (!ext3_suffix_found)
3410 if (start_pos + len_ext3_suffix == len_token) // exact match
3414 add_dynamic_file_list_entry(dynamic_file_list,
3415 num_dynamic_file_list_entries,
3418 num_suffix_list_entries,
3420 add_property_mapping(property_mapping,
3421 num_property_mapping_entries,
3422 base_index, ext1_index, ext2_index, ext3_index,
3423 current_summarized_file_list_entry);
3429 END_HASH_ITERATION(extra_file_hash, itr)
3431 if (artwork_info->num_dynamic_file_list_entries > 0)
3433 artwork_info->dynamic_artwork_list =
3434 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3435 artwork_info->sizeof_artwork_list_entry);
3438 if (options.verbose && IS_PARENT_PROCESS())
3440 SetupFileList *setup_file_list, *list;
3441 boolean dynamic_tokens_found = FALSE;
3442 boolean unknown_tokens_found = FALSE;
3443 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3445 // list may be NULL for empty artwork config files
3446 setup_file_list = loadSetupFileList(filename);
3448 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3450 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3451 dynamic_tokens_found = TRUE;
3453 unknown_tokens_found = TRUE;
3455 END_HASH_ITERATION(extra_file_hash, itr)
3457 if (options.debug && dynamic_tokens_found)
3459 Debug("config", "---");
3460 Debug("config", "dynamic token(s) found in config file:");
3461 Debug("config", "- config file: '%s'", filename);
3463 for (list = setup_file_list; list != NULL; list = list->next)
3465 char *value = getHashEntry(extra_file_hash, list->token);
3467 if (value != NULL && strEqual(value, known_token_value))
3468 Debug("config", "- dynamic token: '%s'", list->token);
3471 Debug("config", "---");
3474 if (unknown_tokens_found)
3477 Warn("unknown token(s) found in config file:");
3478 Warn("- config file: '%s'", filename);
3480 for (list = setup_file_list; list != NULL; list = list->next)
3482 char *value = getHashEntry(extra_file_hash, list->token);
3484 if (value != NULL && !strEqual(value, known_token_value))
3485 Warn("- dynamic token: '%s'", list->token);
3491 if (undefined_values_found)
3494 Warn("undefined values found in config file:");
3495 Warn("- config file: '%s'", filename);
3497 for (list = setup_file_list; list != NULL; list = list->next)
3499 char *value = getHashEntry(empty_file_hash, list->token);
3502 Warn("- undefined value for token: '%s'", list->token);
3508 freeSetupFileList(setup_file_list);
3511 freeSetupFileHash(extra_file_hash);
3512 freeSetupFileHash(empty_file_hash);
3515 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3517 struct FileInfo *file_list = artwork_info->file_list;
3518 int num_file_list_entries = artwork_info->num_file_list_entries;
3519 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3520 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3523 DrawInitText("Loading artwork config", 120, FC_GREEN);
3524 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3526 // always start with reliable default values
3527 for (i = 0; i < num_file_list_entries; i++)
3529 setString(&file_list[i].filename, file_list[i].default_filename);
3531 for (j = 0; j < num_suffix_list_entries; j++)
3532 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3534 file_list[i].redefined = FALSE;
3535 file_list[i].fallback_to_default = FALSE;
3538 // free previous dynamic artwork file array
3539 if (artwork_info->dynamic_file_list != NULL)
3541 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3543 free(artwork_info->dynamic_file_list[i].token);
3544 free(artwork_info->dynamic_file_list[i].filename);
3545 free(artwork_info->dynamic_file_list[i].parameter);
3548 free(artwork_info->dynamic_file_list);
3549 artwork_info->dynamic_file_list = NULL;
3551 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3552 &artwork_info->num_dynamic_file_list_entries);
3555 // free previous property mapping
3556 if (artwork_info->property_mapping != NULL)
3558 free(artwork_info->property_mapping);
3560 artwork_info->property_mapping = NULL;
3561 artwork_info->num_property_mapping_entries = 0;
3564 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3566 // first look for special artwork configured in level series config
3567 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3569 if (fileExists(filename_base))
3570 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3573 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3575 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3576 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3579 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3580 struct ListNodeInfo **listnode)
3584 char *filename = (*listnode)->source_filename;
3586 if (--(*listnode)->num_references <= 0)
3587 deleteNodeFromList(&artwork_info->content_list, filename,
3588 artwork_info->free_artwork);
3594 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3595 struct ListNodeInfo **listnode,
3596 struct FileInfo *file_list_entry)
3606 char *basename = file_list_entry->filename;
3607 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3609 if (filename == NULL)
3611 Warn("cannot find artwork file '%s'", basename);
3613 basename = file_list_entry->default_filename;
3615 // fail for cloned default artwork that has no default filename defined
3616 if (file_list_entry->default_is_cloned &&
3617 strEqual(basename, UNDEFINED_FILENAME))
3619 void (*error_func)(char *, ...) = Warn;
3621 // we can get away without sounds and music, but not without graphics
3622 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3625 error_func("token '%s' was cloned and has no default filename",
3626 file_list_entry->token);
3631 // dynamic artwork has no default filename / skip empty default artwork
3632 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3635 file_list_entry->fallback_to_default = TRUE;
3637 Warn("trying default artwork file '%s'", basename);
3639 filename = getCustomArtworkFilename(basename, artwork_info->type);
3641 if (filename == NULL)
3643 void (*error_func)(char *, ...) = Warn;
3645 // we can get away without sounds and music, but not without graphics
3646 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3649 error_func("cannot find default artwork file '%s'", basename);
3655 // check if the old and the new artwork file are the same
3656 if (*listnode && strEqual((*listnode)->source_filename, filename))
3658 // The old and new artwork are the same (have the same filename and path).
3659 // This usually means that this artwork does not exist in this artwork set
3660 // and a fallback to the existing artwork is done.
3665 // delete existing artwork file entry
3666 deleteArtworkListEntry(artwork_info, listnode);
3668 // check if the new artwork file already exists in the list of artwork
3669 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3671 *listnode = (struct ListNodeInfo *)node->content;
3672 (*listnode)->num_references++;
3677 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3678 DrawInitText(basename, 150, FC_YELLOW);
3680 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3682 // add new artwork file entry to the list of artwork files
3683 (*listnode)->num_references = 1;
3684 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3689 void (*error_func)(char *, ...) = Warn;
3691 // we can get away without sounds and music, but not without graphics
3692 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3695 error_func("cannot load artwork file '%s'", basename);
3701 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3702 struct ListNodeInfo **listnode,
3703 struct FileInfo *file_list_entry)
3705 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3707 deleteArtworkListEntry(artwork_info, listnode);
3712 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3715 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3717 struct FileInfo *file_list = artwork_info->file_list;
3718 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3719 int num_file_list_entries = artwork_info->num_file_list_entries;
3720 int num_dynamic_file_list_entries =
3721 artwork_info->num_dynamic_file_list_entries;
3724 print_timestamp_init("ReloadCustomArtworkList");
3726 for (i = 0; i < num_file_list_entries; i++)
3727 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3730 for (i = 0; i < num_dynamic_file_list_entries; i++)
3731 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3732 &dynamic_file_list[i]);
3734 print_timestamp_done("ReloadCustomArtworkList");
3737 dumpList(artwork_info->content_list);
3741 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3742 struct ListNodeInfo ***list,
3743 int *num_list_entries)
3750 for (i = 0; i < *num_list_entries; i++)
3751 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3755 *num_list_entries = 0;
3758 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3760 if (artwork_info == NULL)
3763 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3764 &artwork_info->num_file_list_entries);
3766 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3767 &artwork_info->num_dynamic_file_list_entries);
3771 // ----------------------------------------------------------------------------
3772 // functions only needed for non-Unix (non-command-line) systems
3773 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3774 // (now also added for Windows, to create files in user data directory)
3775 // ----------------------------------------------------------------------------
3777 char *getLogFilename(char *basename)
3779 return getPath2(getMainUserGameDataDir(), basename);
3782 void OpenLogFiles(void)
3786 InitMainUserDataDirectory();
3788 for (i = 0; i < NUM_LOGS; i++)
3790 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3793 program.log_file[i] = program.log_file_default[i]; // reset to default
3795 Warn("cannot open file '%s' for writing: %s",
3796 program.log_filename[i], strerror(errno));
3799 // output should be unbuffered so it is not truncated in a crash
3800 setbuf(program.log_file[i], NULL);
3804 void CloseLogFiles(void)
3808 for (i = 0; i < NUM_LOGS; i++)
3809 if (program.log_file[i] != program.log_file_default[i])
3810 fclose(program.log_file[i]);
3813 void DumpLogFile(int nr)
3815 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3817 if (log_file == NULL)
3820 while (!feof(log_file))
3821 fputc(fgetc(log_file), stdout);
3826 void NotifyUserAboutErrorFile(void)
3828 #if defined(PLATFORM_WIN32)
3829 char *title_text = getStringCat2(program.program_title, " Error Message");
3830 char *error_text = getStringCat2("The program was aborted due to an error; "
3831 "for details, see the following error file:"
3833 program.log_filename[LOG_ERR_ID]);
3835 MessageBox(NULL, error_text, title_text, MB_OK);
3840 // ----------------------------------------------------------------------------
3841 // the following is only for debugging purpose and normally not used
3842 // ----------------------------------------------------------------------------
3846 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
3847 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3849 #define DEBUG_NUM_TIMESTAMPS 10
3850 #define DEBUG_TIME_IN_MICROSECONDS 0
3852 #if DEBUG_TIME_IN_MICROSECONDS
3853 static double Counter_Microseconds(void)
3855 static struct timeval base_time = { 0, 0 };
3856 struct timeval current_time;
3859 gettimeofday(¤t_time, NULL);
3861 // reset base time in case of wrap-around
3862 if (current_time.tv_sec < base_time.tv_sec)
3863 base_time = current_time;
3866 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3867 ((double)(current_time.tv_usec - base_time.tv_usec));
3869 return counter; // return microseconds since last init
3873 static char *debug_print_timestamp_get_padding(int padding_size)
3875 static char *padding = NULL;
3876 int max_padding_size = 100;
3878 if (padding == NULL)
3880 padding = checked_calloc(max_padding_size + 1);
3881 memset(padding, ' ', max_padding_size);
3884 return &padding[MAX(0, max_padding_size - padding_size)];
3887 void debug_print_timestamp(int counter_nr, char *message)
3889 int indent_size = 8;
3890 int padding_size = 40;
3891 float timestamp_interval;
3894 Fail("debugging: invalid negative counter");
3895 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3896 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3898 #if DEBUG_TIME_IN_MICROSECONDS
3899 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3902 counter[counter_nr][0] = Counter_Microseconds();
3904 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3907 counter[counter_nr][0] = Counter();
3910 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3911 counter[counter_nr][1] = counter[counter_nr][0];
3914 Debug("time:init", "%s%s%s %.3f %s",
3915 debug_print_timestamp_get_padding(counter_nr * indent_size),
3917 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3918 timestamp_interval / 1000,
3923 static void debug_print_parent_only(char *format, ...)
3925 if (!IS_PARENT_PROCESS())
3932 va_start(ap, format);
3933 vprintf(format, ap);
3943 static void print_timestamp_ext(char *message, char *mode)
3945 #if DEBUG_PRINT_INIT_TIMESTAMPS
3946 static char *debug_message = NULL;
3947 static char *last_message = NULL;
3948 static int counter_nr = 0;
3949 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3951 checked_free(debug_message);
3952 debug_message = getStringCat3(mode, " ", message);
3954 if (strEqual(mode, "INIT"))
3956 debug_print_timestamp(counter_nr, NULL);
3958 if (counter_nr + 1 < max_depth)
3959 debug_print_timestamp(counter_nr, debug_message);
3963 debug_print_timestamp(counter_nr, NULL);
3965 else if (strEqual(mode, "DONE"))
3969 if (counter_nr + 1 < max_depth ||
3970 (counter_nr == 0 && max_depth == 1))
3972 last_message = message;
3974 if (counter_nr == 0 && max_depth == 1)
3976 checked_free(debug_message);
3977 debug_message = getStringCat3("TIME", " ", message);
3980 debug_print_timestamp(counter_nr, debug_message);
3983 else if (!strEqual(mode, "TIME") ||
3984 !strEqual(message, last_message))
3986 if (counter_nr < max_depth)
3987 debug_print_timestamp(counter_nr, debug_message);
3992 void print_timestamp_init(char *message)
3994 print_timestamp_ext(message, "INIT");
3997 void print_timestamp_time(char *message)
3999 print_timestamp_ext(message, "TIME");
4002 void print_timestamp_done(char *message)
4004 print_timestamp_ext(message, "DONE");