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_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter() // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter() // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1093 if (s1 == NULL || s2 == NULL || sep == NULL)
1096 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1099 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1101 return complete_string;
1104 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1106 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1109 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1110 strlen(s2) + strlen(sep) +
1113 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1115 return complete_string;
1118 char *getStringCat2(char *s1, char *s2)
1120 return getStringCat2WithSeparator(s1, s2, "");
1123 char *getStringCat3(char *s1, char *s2, char *s3)
1125 return getStringCat3WithSeparator(s1, s2, s3, "");
1128 char *getPath2(char *path1, char *path2)
1130 #if defined(PLATFORM_ANDROID)
1131 // workaround for reading from assets directory -- skip "." subdirs in path
1132 if (strEqual(path1, "."))
1133 return getStringCopy(path2);
1134 else if (strEqual(path2, "."))
1135 return getStringCopy(path1);
1138 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1141 char *getPath3(char *path1, char *path2, char *path3)
1143 #if defined(PLATFORM_ANDROID)
1144 // workaround for reading from assets directory -- skip "." subdirs in path
1145 if (strEqual(path1, "."))
1146 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1147 else if (strEqual(path2, "."))
1148 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1149 else if (strEqual(path3, "."))
1150 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1153 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1156 static char *getPngOrPcxIfNotExists(char *filename)
1158 // switch from PNG to PCX file and vice versa, if file does not exist
1159 // (backwards compatibility with PCX files used in previous versions)
1161 if (!fileExists(filename) && strSuffix(filename, ".png"))
1162 strcpy(&filename[strlen(filename) - 3], "pcx");
1163 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1164 strcpy(&filename[strlen(filename) - 3], "png");
1169 char *getImg2(char *path1, char *path2)
1171 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1174 char *getImg3(char *path1, char *path2, char *path3)
1176 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1179 char *getStringCopy(const char *s)
1186 s_copy = checked_malloc(strlen(s) + 1);
1192 char *getStringCopyN(const char *s, int n)
1195 int s_len = MAX(0, n);
1200 s_copy = checked_malloc(s_len + 1);
1201 strncpy(s_copy, s, s_len);
1202 s_copy[s_len] = '\0';
1207 char *getStringCopyNStatic(const char *s, int n)
1209 static char *s_copy = NULL;
1211 checked_free(s_copy);
1213 s_copy = getStringCopyN(s, n);
1218 char *getStringToLower(const char *s)
1220 char *s_copy = checked_malloc(strlen(s) + 1);
1221 char *s_ptr = s_copy;
1224 *s_ptr++ = tolower(*s++);
1230 void setString(char **old_value, char *new_value)
1232 checked_free(*old_value);
1234 *old_value = getStringCopy(new_value);
1237 boolean strEqual(char *s1, char *s2)
1239 return (s1 == NULL && s2 == NULL ? TRUE :
1240 s1 == NULL && s2 != NULL ? FALSE :
1241 s1 != NULL && s2 == NULL ? FALSE :
1242 strcmp(s1, s2) == 0);
1245 boolean strEqualN(char *s1, char *s2, int n)
1247 return (s1 == NULL && s2 == NULL ? TRUE :
1248 s1 == NULL && s2 != NULL ? FALSE :
1249 s1 != NULL && s2 == NULL ? FALSE :
1250 strncmp(s1, s2, n) == 0);
1253 boolean strEqualCase(char *s1, char *s2)
1255 return (s1 == NULL && s2 == NULL ? TRUE :
1256 s1 == NULL && s2 != NULL ? FALSE :
1257 s1 != NULL && s2 == NULL ? FALSE :
1258 strcasecmp(s1, s2) == 0);
1261 boolean strEqualCaseN(char *s1, char *s2, int n)
1263 return (s1 == NULL && s2 == NULL ? TRUE :
1264 s1 == NULL && s2 != NULL ? FALSE :
1265 s1 != NULL && s2 == NULL ? FALSE :
1266 strncasecmp(s1, s2, n) == 0);
1269 boolean strPrefix(char *s, char *prefix)
1271 return (s == NULL && prefix == NULL ? TRUE :
1272 s == NULL && prefix != NULL ? FALSE :
1273 s != NULL && prefix == NULL ? FALSE :
1274 strncmp(s, prefix, strlen(prefix)) == 0);
1277 boolean strSuffix(char *s, char *suffix)
1279 return (s == NULL && suffix == NULL ? TRUE :
1280 s == NULL && suffix != NULL ? FALSE :
1281 s != NULL && suffix == NULL ? FALSE :
1282 strlen(s) < strlen(suffix) ? FALSE :
1283 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1286 boolean strPrefixLower(char *s, char *prefix)
1288 char *s_lower = getStringToLower(s);
1289 boolean match = strPrefix(s_lower, prefix);
1296 boolean strSuffixLower(char *s, char *suffix)
1298 char *s_lower = getStringToLower(s);
1299 boolean match = strSuffix(s_lower, suffix);
1306 boolean isURL(char *s)
1308 while (*s && *s >= 'a' && *s <= 'z')
1311 return strPrefix(s, "://");
1315 // ----------------------------------------------------------------------------
1316 // command line option handling functions
1317 // ----------------------------------------------------------------------------
1319 void GetOptions(int argc, char *argv[],
1320 void (*print_usage_function)(void),
1321 void (*print_version_function)(void))
1323 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1324 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1325 char **options_left = &argvplus[1];
1327 // replace original "argv" with null-terminated array of string pointers
1329 argvplus[argc] = argv[argc];
1331 // initialize global program options
1332 options.server_host = NULL;
1333 options.server_port = 0;
1335 options.base_directory = base_path;
1337 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1338 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1339 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1340 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1341 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1342 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1344 options.execute_command = NULL;
1345 options.tape_log_filename = NULL;
1346 options.special_flags = NULL;
1347 options.debug_mode = NULL;
1348 options.player_name = NULL;
1349 options.identifier = NULL;
1350 options.level_nr = NULL;
1352 options.display_nr = 0;
1354 options.mytapes = FALSE;
1355 options.serveronly = FALSE;
1356 options.network = FALSE;
1357 options.verbose = FALSE;
1358 options.debug = FALSE;
1361 options.verbose = TRUE;
1363 #if !defined(PLATFORM_UNIX)
1364 if (*options_left == NULL) // no options given -- enable verbose mode
1365 options.verbose = TRUE;
1370 #if defined(PLATFORM_ANDROID)
1371 options.debug = TRUE;
1375 while (*options_left)
1377 char option_str[MAX_OPTION_LEN];
1378 char *option = options_left[0];
1379 char *next_option = options_left[1];
1380 char *option_arg = NULL;
1381 int option_len = strlen(option);
1383 if (option_len >= MAX_OPTION_LEN)
1384 FailWithHelp("unrecognized option '%s'", option);
1386 strcpy(option_str, option); // copy argument into buffer
1387 option = option_str;
1389 if (strEqual(option, "--")) // stop scanning arguments
1392 if (strPrefix(option, "--")) // treat '--' like '-'
1395 option_arg = strchr(option, '=');
1396 if (option_arg == NULL) // no '=' in option
1397 option_arg = next_option;
1400 *option_arg++ = '\0'; // cut argument from option
1401 if (*option_arg == '\0') // no argument after '='
1402 FailWithHelp("option '%s' has invalid argument", option_str);
1405 option_len = strlen(option);
1407 if (strEqual(option, "-"))
1409 FailWithHelp("unrecognized option '%s'", option);
1411 else if (strncmp(option, "-help", option_len) == 0)
1413 print_usage_function();
1417 else if (strncmp(option, "-basepath", option_len) == 0)
1419 if (option_arg == NULL)
1420 FailWithHelp("option '%s' requires an argument", option_str);
1422 options.base_directory = base_path = getStringCopy(option_arg);
1423 if (option_arg == next_option)
1426 // adjust paths for sub-directories in base directory accordingly
1427 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1428 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1429 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1430 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1431 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1432 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1434 else if (strncmp(option, "-levels", option_len) == 0)
1436 if (option_arg == NULL)
1437 FailWithHelp("option '%s' requires an argument", option_str);
1439 options.level_directory = getStringCopy(option_arg);
1440 if (option_arg == next_option)
1443 else if (strncmp(option, "-graphics", option_len) == 0)
1445 if (option_arg == NULL)
1446 FailWithHelp("option '%s' requires an argument", option_str);
1448 options.graphics_directory = getStringCopy(option_arg);
1449 if (option_arg == next_option)
1452 else if (strncmp(option, "-sounds", option_len) == 0)
1454 if (option_arg == NULL)
1455 FailWithHelp("option '%s' requires an argument", option_str);
1457 options.sounds_directory = getStringCopy(option_arg);
1458 if (option_arg == next_option)
1461 else if (strncmp(option, "-music", option_len) == 0)
1463 if (option_arg == NULL)
1464 FailWithHelp("option '%s' requires an argument", option_str);
1466 options.music_directory = getStringCopy(option_arg);
1467 if (option_arg == next_option)
1470 else if (strncmp(option, "-mytapes", option_len) == 0)
1472 options.mytapes = TRUE;
1474 else if (strncmp(option, "-network", option_len) == 0)
1476 options.network = TRUE;
1478 else if (strncmp(option, "-serveronly", option_len) == 0)
1480 options.serveronly = TRUE;
1482 else if (strncmp(option, "-debug", option_len) == 0)
1484 options.debug = TRUE;
1486 // optionally, debug output can be limited to a specific debug mode
1487 if (option_arg != next_option)
1488 options.debug_mode = getStringCopy(option_arg);
1490 else if (strncmp(option, "-player-name", option_len) == 0)
1492 if (option_arg == NULL)
1493 FailWithHelp("option '%s' requires an argument", option_str);
1495 options.player_name = getStringCopy(option_arg);
1496 if (option_arg == next_option)
1499 else if (strncmp(option, "-identifier", option_len) == 0)
1501 if (option_arg == NULL)
1502 FailWithHelp("option '%s' requires an argument", option_str);
1504 options.identifier = getStringCopy(option_arg);
1505 if (option_arg == next_option)
1508 else if (strncmp(option, "-level-nr", option_len) == 0)
1510 if (option_arg == NULL)
1511 FailWithHelp("option '%s' requires an argument", option_str);
1513 options.level_nr = getStringCopy(option_arg);
1514 if (option_arg == next_option)
1517 else if (strncmp(option, "-verbose", option_len) == 0)
1519 options.verbose = TRUE;
1521 else if (strncmp(option, "-version", option_len) == 0 ||
1522 strncmp(option, "-V", option_len) == 0)
1524 print_version_function();
1528 else if (strPrefix(option, "-D"))
1530 options.special_flags = getStringCopy(&option[2]);
1532 else if (strncmp(option, "-execute", option_len) == 0)
1534 if (option_arg == NULL)
1535 FailWithHelp("option '%s' requires an argument", option_str);
1537 options.execute_command = getStringCopy(option_arg);
1538 if (option_arg == next_option)
1541 // when doing batch processing, always enable verbose mode (warnings)
1542 options.verbose = TRUE;
1544 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1546 if (option_arg == NULL)
1547 FailWithHelp("option '%s' requires an argument", option_str);
1549 options.tape_log_filename = getStringCopy(option_arg);
1550 if (option_arg == next_option)
1553 else if (strncmp(option, "-display", option_len) == 0)
1555 if (option_arg == NULL)
1556 FailWithHelp("option '%s' requires an argument", option_str);
1558 if (option_arg == next_option)
1561 int display_nr = atoi(option_arg);
1564 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1565 options.display_nr = display_nr;
1567 options.display_nr =
1568 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1570 if (display_nr != options.display_nr)
1571 Warn("invalid display %d -- using display %d",
1572 display_nr, options.display_nr);
1575 #if defined(PLATFORM_MAC)
1576 else if (strPrefix(option, "-psn"))
1578 // ignore process serial number when launched via GUI on Mac OS X
1581 else if (*option == '-')
1583 FailWithHelp("unrecognized option '%s'", option_str);
1585 else if (options.server_host == NULL)
1587 options.server_host = *options_left;
1589 else if (options.server_port == 0)
1591 options.server_port = atoi(*options_left);
1592 if (options.server_port < 1024)
1593 FailWithHelp("bad port number '%d'", options.server_port);
1596 FailWithHelp("too many arguments");
1603 // ----------------------------------------------------------------------------
1604 // checked memory allocation and freeing functions
1605 // ----------------------------------------------------------------------------
1607 void *checked_malloc(unsigned int size)
1614 Fail("cannot allocate %d bytes -- out of memory", size);
1619 void *checked_calloc(unsigned int size)
1623 ptr = calloc(1, size);
1626 Fail("cannot allocate %d bytes -- out of memory", size);
1631 void *checked_realloc(void *ptr, unsigned int size)
1633 ptr = realloc(ptr, size);
1636 Fail("cannot allocate %d bytes -- out of memory", size);
1641 void checked_free(void *ptr)
1643 if (ptr != NULL) // this check should be done by free() anyway
1647 void clear_mem(void *ptr, unsigned int size)
1649 #if defined(PLATFORM_WINDOWS)
1650 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1651 char *cptr = (char *)ptr;
1656 memset(ptr, 0, size);
1661 // ----------------------------------------------------------------------------
1662 // various helper functions
1663 // ----------------------------------------------------------------------------
1665 void swap_numbers(int *i1, int *i2)
1673 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1685 /* the "put" variants of the following file access functions check for the file
1686 pointer being != NULL and return the number of bytes they have or would have
1687 written; this allows for chunk writing functions to first determine the size
1688 of the (not yet written) chunk, write the correct chunk size and finally
1689 write the chunk itself */
1691 int getFile8BitInteger(File *file)
1693 return getByteFromFile(file);
1696 int putFile8BitInteger(FILE *file, int value)
1704 int getFile16BitInteger(File *file, int byte_order)
1706 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1707 return ((getByteFromFile(file) << 8) |
1708 (getByteFromFile(file) << 0));
1709 else // BYTE_ORDER_LITTLE_ENDIAN
1710 return ((getByteFromFile(file) << 0) |
1711 (getByteFromFile(file) << 8));
1714 int putFile16BitInteger(FILE *file, int value, int byte_order)
1718 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1720 fputc((value >> 8) & 0xff, file);
1721 fputc((value >> 0) & 0xff, file);
1723 else // BYTE_ORDER_LITTLE_ENDIAN
1725 fputc((value >> 0) & 0xff, file);
1726 fputc((value >> 8) & 0xff, file);
1733 int getFile32BitInteger(File *file, int byte_order)
1735 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1736 return ((getByteFromFile(file) << 24) |
1737 (getByteFromFile(file) << 16) |
1738 (getByteFromFile(file) << 8) |
1739 (getByteFromFile(file) << 0));
1740 else // BYTE_ORDER_LITTLE_ENDIAN
1741 return ((getByteFromFile(file) << 0) |
1742 (getByteFromFile(file) << 8) |
1743 (getByteFromFile(file) << 16) |
1744 (getByteFromFile(file) << 24));
1747 int putFile32BitInteger(FILE *file, int value, int byte_order)
1751 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1753 fputc((value >> 24) & 0xff, file);
1754 fputc((value >> 16) & 0xff, file);
1755 fputc((value >> 8) & 0xff, file);
1756 fputc((value >> 0) & 0xff, file);
1758 else // BYTE_ORDER_LITTLE_ENDIAN
1760 fputc((value >> 0) & 0xff, file);
1761 fputc((value >> 8) & 0xff, file);
1762 fputc((value >> 16) & 0xff, file);
1763 fputc((value >> 24) & 0xff, file);
1770 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1773 const int chunk_name_length = 4;
1776 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1779 if (chunk_size != NULL)
1782 *chunk_size = getFile32BitInteger(file, byte_order);
1785 return (checkEndOfFile(file) ? FALSE : TRUE);
1788 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1795 fputs(chunk_name, file);
1797 num_bytes += strlen(chunk_name);
1799 if (chunk_size >= 0)
1803 putFile32BitInteger(file, chunk_size, byte_order);
1811 int getFileVersion(File *file)
1813 int version_super = getByteFromFile(file);
1814 int version_major = getByteFromFile(file);
1815 int version_minor = getByteFromFile(file);
1816 int version_patch = getByteFromFile(file);
1818 return VERSION_IDENT(version_super, version_major, version_minor,
1822 int putFileVersion(FILE *file, int version)
1826 int version_super = VERSION_SUPER(version);
1827 int version_major = VERSION_MAJOR(version);
1828 int version_minor = VERSION_MINOR(version);
1829 int version_patch = VERSION_PATCH(version);
1831 fputc(version_super, file);
1832 fputc(version_major, file);
1833 fputc(version_minor, file);
1834 fputc(version_patch, file);
1840 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1844 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1845 buffer[i] = getByteFromFile(file);
1848 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1852 for (i = 0; i < bytes; i++)
1853 fputc(buffer[i], file);
1856 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1858 while (bytes-- && !checkEndOfFile(file))
1859 getByteFromFile(file);
1862 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1869 // ----------------------------------------------------------------------------
1870 // functions to convert between ISO-8859-1 and UTF-8
1871 // ----------------------------------------------------------------------------
1873 char *getUTF8FromLatin1(char *latin1)
1875 int max_utf8_size = 2 * strlen(latin1) + 1;
1876 char *utf8 = checked_calloc(max_utf8_size);
1877 unsigned char *src = (unsigned char *)latin1;
1878 unsigned char *dst = (unsigned char *)utf8;
1882 if (*src < 128) // pure 7-bit ASCII
1886 else if (*src >= 160) // non-ASCII characters
1888 *dst++ = 194 + (*src >= 192);
1889 *dst++ = 128 + (*src & 63);
1891 else // undefined in ISO-8859-1
1899 // only use the smallest possible string buffer size
1900 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1905 char *getLatin1FromUTF8(char *utf8)
1907 int max_latin1_size = strlen(utf8) + 1;
1908 char *latin1 = checked_calloc(max_latin1_size);
1909 unsigned char *src = (unsigned char *)utf8;
1910 unsigned char *dst = (unsigned char *)latin1;
1914 if (*src < 128) // pure 7-bit ASCII
1918 else if (src[0] == 194 &&
1919 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1924 else if (src[0] == 195 &&
1925 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1927 *dst++ = src[1] + 64;
1931 // all other UTF-8 characters are undefined in ISO-8859-1
1933 else if (src[0] >= 192 && src[0] < 224 &&
1934 src[1] >= 128 && src[1] < 192)
1939 else if (src[0] >= 224 && src[0] < 240 &&
1940 src[1] >= 128 && src[1] < 192 &&
1941 src[2] >= 128 && src[2] < 192)
1946 else if (src[0] >= 240 && src[0] < 248 &&
1947 src[1] >= 128 && src[1] < 192 &&
1948 src[2] >= 128 && src[2] < 192 &&
1949 src[3] >= 128 && src[3] < 192)
1954 else if (src[0] >= 248 && src[0] < 252 &&
1955 src[1] >= 128 && src[1] < 192 &&
1956 src[2] >= 128 && src[2] < 192 &&
1957 src[3] >= 128 && src[3] < 192 &&
1958 src[4] >= 128 && src[4] < 192)
1963 else if (src[0] >= 252 && src[0] < 254 &&
1964 src[1] >= 128 && src[1] < 192 &&
1965 src[2] >= 128 && src[2] < 192 &&
1966 src[3] >= 128 && src[3] < 192 &&
1967 src[4] >= 128 && src[4] < 192 &&
1968 src[5] >= 128 && src[5] < 192)
1980 // only use the smallest possible string buffer size
1981 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1986 int getTextEncoding(char *text)
1988 unsigned char *src = (unsigned char *)text;
1989 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
1994 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2000 else if (src[0] >= 192 && src[0] < 224 &&
2001 src[1] >= 128 && src[1] < 192)
2005 else if (src[0] >= 224 && src[0] < 240 &&
2006 src[1] >= 128 && src[1] < 192 &&
2007 src[2] >= 128 && src[2] < 192)
2011 else if (src[0] >= 240 && src[0] < 248 &&
2012 src[1] >= 128 && src[1] < 192 &&
2013 src[2] >= 128 && src[2] < 192 &&
2014 src[3] >= 128 && src[3] < 192)
2018 else if (src[0] >= 248 && src[0] < 252 &&
2019 src[1] >= 128 && src[1] < 192 &&
2020 src[2] >= 128 && src[2] < 192 &&
2021 src[3] >= 128 && src[3] < 192 &&
2022 src[4] >= 128 && src[4] < 192)
2026 else if (src[0] >= 252 && src[0] < 254 &&
2027 src[1] >= 128 && src[1] < 192 &&
2028 src[2] >= 128 && src[2] < 192 &&
2029 src[3] >= 128 && src[3] < 192 &&
2030 src[4] >= 128 && src[4] < 192 &&
2031 src[5] >= 128 && src[5] < 192)
2037 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2045 // ----------------------------------------------------------------------------
2046 // functions for JSON handling
2047 // ----------------------------------------------------------------------------
2049 char *getEscapedJSON(char *s)
2051 int max_json_size = 2 * strlen(s) + 1;
2052 char *json = checked_calloc(max_json_size);
2053 unsigned char *src = (unsigned char *)s;
2054 unsigned char *dst = (unsigned char *)json;
2055 char *escaped[256] =
2068 if (escaped[*src] != NULL)
2070 char *esc = escaped[*src++];
2081 // only use the smallest possible string buffer size
2082 json = checked_realloc(json, strlen(json) + 1);
2088 // ----------------------------------------------------------------------------
2089 // functions to translate key identifiers between different format
2090 // ----------------------------------------------------------------------------
2092 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2093 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2094 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2095 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2097 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2106 // return and escape keys
2107 { KSYM_Return, "XK_Return", "return" },
2108 { KSYM_Escape, "XK_Escape", "escape" },
2110 // normal cursor keys
2111 { KSYM_Left, "XK_Left", "cursor left" },
2112 { KSYM_Right, "XK_Right", "cursor right" },
2113 { KSYM_Up, "XK_Up", "cursor up" },
2114 { KSYM_Down, "XK_Down", "cursor down" },
2116 // keypad cursor keys
2118 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2119 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2120 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2121 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2124 // other keypad keys
2125 #ifdef KSYM_KP_Enter
2126 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2127 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2128 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2129 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2130 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2131 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2135 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2136 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2137 { KSYM_Control_L, "XK_Control_L", "left control" },
2138 { KSYM_Control_R, "XK_Control_R", "right control" },
2139 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2140 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2141 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2142 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2143 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2144 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2146 // some special keys
2147 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2148 { KSYM_Delete, "XK_Delete", "delete" },
2149 { KSYM_Insert, "XK_Insert", "insert" },
2150 { KSYM_Tab, "XK_Tab", "tab" },
2151 { KSYM_Home, "XK_Home", "home" },
2152 { KSYM_End, "XK_End", "end" },
2153 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2154 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2156 { KSYM_Select, "XK_Select", "select" },
2157 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2158 { KSYM_Back, "XK_Back", "back" }, // back key
2159 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2160 #if defined(PLATFORM_ANDROID)
2161 { KSYM_Rewind, "XK_Rewind", "rewind" },
2162 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2165 // ASCII 0x20 to 0x40 keys (except numbers)
2166 { KSYM_space, "XK_space", "space" },
2167 { KSYM_exclam, "XK_exclam", "!" },
2168 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2169 { KSYM_numbersign, "XK_numbersign", "#" },
2170 { KSYM_dollar, "XK_dollar", "$" },
2171 { KSYM_percent, "XK_percent", "%" },
2172 { KSYM_ampersand, "XK_ampersand", "&" },
2173 { KSYM_apostrophe, "XK_apostrophe", "'" },
2174 { KSYM_parenleft, "XK_parenleft", "(" },
2175 { KSYM_parenright, "XK_parenright", ")" },
2176 { KSYM_asterisk, "XK_asterisk", "*" },
2177 { KSYM_plus, "XK_plus", "+" },
2178 { KSYM_comma, "XK_comma", "," },
2179 { KSYM_minus, "XK_minus", "-" },
2180 { KSYM_period, "XK_period", "." },
2181 { KSYM_slash, "XK_slash", "/" },
2182 { KSYM_colon, "XK_colon", ":" },
2183 { KSYM_semicolon, "XK_semicolon", ";" },
2184 { KSYM_less, "XK_less", "<" },
2185 { KSYM_equal, "XK_equal", "=" },
2186 { KSYM_greater, "XK_greater", ">" },
2187 { KSYM_question, "XK_question", "?" },
2188 { KSYM_at, "XK_at", "@" },
2191 { KSYM_bracketleft, "XK_bracketleft", "[" },
2192 { KSYM_backslash, "XK_backslash", "\\" },
2193 { KSYM_bracketright,"XK_bracketright", "]" },
2194 { KSYM_asciicircum, "XK_asciicircum", "^" },
2195 { KSYM_underscore, "XK_underscore", "_" },
2196 { KSYM_grave, "XK_grave", "grave" },
2197 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2198 { KSYM_braceleft, "XK_braceleft", "brace left" },
2199 { KSYM_bar, "XK_bar", "bar" },
2200 { KSYM_braceright, "XK_braceright", "brace right" },
2201 { KSYM_asciitilde, "XK_asciitilde", "~" },
2203 // special (non-ASCII) keys
2204 { KSYM_degree, "XK_degree", "degree" },
2205 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2206 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2207 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2208 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2209 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2210 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2211 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2213 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2214 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2215 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2216 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2217 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2218 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2219 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2220 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2221 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2223 // other keys (for reverse mapping only)
2224 { KSYM_space, "XK_space", " " },
2226 // keypad keys are not in numerical order in SDL2
2227 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2228 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2229 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2230 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2231 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2232 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2233 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2234 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2235 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2236 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2238 // end-of-array identifier
2244 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2246 static char name_buffer[30];
2249 if (key >= KSYM_A && key <= KSYM_Z)
2250 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2251 else if (key >= KSYM_a && key <= KSYM_z)
2252 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2253 else if (key >= KSYM_0 && key <= KSYM_9)
2254 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2255 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2256 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2257 else if (key == KSYM_UNDEFINED)
2258 strcpy(name_buffer, "(undefined)");
2265 if (key == translate_key[i].key)
2267 strcpy(name_buffer, translate_key[i].name);
2271 while (translate_key[++i].name);
2273 if (!translate_key[i].name)
2274 strcpy(name_buffer, "(unknown)");
2277 *name = name_buffer;
2279 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2281 static char name_buffer[30];
2284 if (key >= KSYM_A && key <= KSYM_Z)
2285 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2286 else if (key >= KSYM_a && key <= KSYM_z)
2287 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2288 else if (key >= KSYM_0 && key <= KSYM_9)
2289 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2290 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2291 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2292 else if (key == KSYM_UNDEFINED)
2293 strcpy(name_buffer, "[undefined]");
2300 if (key == translate_key[i].key)
2302 strcpy(name_buffer, translate_key[i].x11name);
2306 while (translate_key[++i].x11name);
2308 if (!translate_key[i].x11name)
2309 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2312 *x11name = name_buffer;
2314 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2316 Key key = KSYM_UNDEFINED;
2317 char *name_ptr = *name;
2319 if (strlen(*name) == 1)
2321 char c = name_ptr[0];
2323 if (c >= 'A' && c <= 'Z')
2324 key = KSYM_A + (Key)(c - 'A');
2325 else if (c >= 'a' && c <= 'z')
2326 key = KSYM_a + (Key)(c - 'a');
2327 else if (c >= '0' && c <= '9')
2328 key = KSYM_0 + (Key)(c - '0');
2331 if (key == KSYM_UNDEFINED)
2337 if (strEqual(translate_key[i].name, *name))
2339 key = translate_key[i].key;
2343 while (translate_key[++i].x11name);
2346 if (key == KSYM_UNDEFINED)
2347 Warn("getKeyFromKeyName(): not completely implemented");
2351 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2353 Key key = KSYM_UNDEFINED;
2354 char *name_ptr = *x11name;
2356 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2358 char c = name_ptr[3];
2360 if (c >= 'A' && c <= 'Z')
2361 key = KSYM_A + (Key)(c - 'A');
2362 else if (c >= 'a' && c <= 'z')
2363 key = KSYM_a + (Key)(c - 'a');
2364 else if (c >= '0' && c <= '9')
2365 key = KSYM_0 + (Key)(c - '0');
2367 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2369 char c1 = name_ptr[4];
2370 char c2 = name_ptr[5];
2373 if ((c1 >= '0' && c1 <= '9') &&
2374 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2375 d = atoi(&name_ptr[4]);
2377 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2378 key = KSYM_F1 + (Key)(d - 1);
2380 else if (strPrefix(name_ptr, "XK_"))
2386 if (strEqual(name_ptr, translate_key[i].x11name))
2388 key = translate_key[i].key;
2392 while (translate_key[++i].x11name);
2394 else if (strPrefix(name_ptr, "0x"))
2396 unsigned int value = 0;
2402 char c = *name_ptr++;
2405 if (c >= '0' && c <= '9')
2407 else if (c >= 'a' && c <= 'f')
2408 d = (int)(c - 'a' + 10);
2409 else if (c >= 'A' && c <= 'F')
2410 d = (int)(c - 'A' + 10);
2418 value = value * 16 + d;
2429 char *getKeyNameFromKey(Key key)
2433 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2437 char *getX11KeyNameFromKey(Key key)
2441 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2445 Key getKeyFromKeyName(char *name)
2449 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2453 Key getKeyFromX11KeyName(char *x11name)
2457 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2461 char getCharFromKey(Key key)
2467 } translate_key_char[] =
2469 // special (non-ASCII) keys (ISO-8859-1)
2470 { KSYM_degree, CHAR_BYTE_DEGREE },
2471 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2472 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2473 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2474 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2475 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2476 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2477 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2479 // end-of-array identifier
2483 char *keyname = getKeyNameFromKey(key);
2486 if (strlen(keyname) == 1)
2488 else if (strEqual(keyname, "space"))
2496 if (key == translate_key_char[i].key)
2498 c = translate_key_char[i].key_char;
2503 while (translate_key_char[++i].key_char);
2509 char getValidConfigValueChar(char c)
2511 if (c == '#' || // used to mark comments
2512 c == '\\') // used to mark continued lines
2519 // ----------------------------------------------------------------------------
2520 // functions to translate string identifiers to integer or boolean value
2521 // ----------------------------------------------------------------------------
2523 int get_integer_from_string(char *s)
2525 // check for the most common case first
2526 if (s[0] >= '0' && s[0] <= '9')
2529 char *s_lower = getStringToLower(s);
2532 if (strEqual(s_lower, "false") ||
2533 strEqual(s_lower, "no") ||
2534 strEqual(s_lower, "off"))
2536 else if (strEqual(s_lower, "true") ||
2537 strEqual(s_lower, "yes") ||
2538 strEqual(s_lower, "on"))
2548 boolean get_boolean_from_string(char *s)
2550 char *s_lower = getStringToLower(s);
2551 boolean result = FALSE;
2553 if (strEqual(s_lower, "true") ||
2554 strEqual(s_lower, "yes") ||
2555 strEqual(s_lower, "on") ||
2556 get_integer_from_string(s) == 1)
2564 int get_switch3_from_string(char *s)
2566 char *s_lower = getStringToLower(s);
2569 if (strEqual(s_lower, "true") ||
2570 strEqual(s_lower, "yes") ||
2571 strEqual(s_lower, "on") ||
2572 get_integer_from_string(s) == 1)
2574 else if (strEqual(s_lower, "auto"))
2582 int get_player_nr_from_string(char *s)
2584 static char *player_text[] =
2594 char *s_lower = getStringToLower(s);
2598 for (i = 0; player_text[i] != NULL; i++)
2599 if (strEqual(s_lower, player_text[i]))
2608 // ----------------------------------------------------------------------------
2609 // functions for generic lists
2610 // ----------------------------------------------------------------------------
2612 ListNode *newListNode(void)
2614 return checked_calloc(sizeof(ListNode));
2617 void addNodeToList(ListNode **node_first, char *key, void *content)
2619 ListNode *node_new = newListNode();
2621 node_new->key = getStringCopy(key);
2622 node_new->content = content;
2623 node_new->next = *node_first;
2626 (*node_first)->prev = node_new;
2628 *node_first = node_new;
2631 void deleteNodeFromList(ListNode **node_first, char *key,
2632 void (*destructor_function)(void *))
2634 if (node_first == NULL || *node_first == NULL)
2637 if (strEqual((*node_first)->key, key))
2639 // after first recursion, (*node_first)->prev->next == *node_first,
2640 // so *node_first would be overwritten with (*node_first)->next
2641 // => use a copy of *node_first (and later of (*node_first)->next)
2642 ListNode *node = *node_first;
2643 ListNode *node_next = node->next;
2645 checked_free(node->key);
2647 if (destructor_function)
2648 destructor_function(node->content);
2651 node->prev->next = node->next;
2654 node->next->prev = node->prev;
2658 // after removing node, set list pointer to next valid list node
2659 // (this is important if the first node of the list was deleted)
2660 *node_first = node_next;
2664 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2668 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2670 if (node_first == NULL)
2673 if (strEqual(node_first->key, key))
2676 return getNodeFromKey(node_first->next, key);
2679 int getNumNodes(ListNode *node_first)
2681 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2685 static void dumpList(ListNode *node_first)
2687 ListNode *node = node_first;
2691 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2692 ((struct ListNodeInfo *)node->content)->num_references);
2696 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2701 // ----------------------------------------------------------------------------
2702 // functions for file handling
2703 // ----------------------------------------------------------------------------
2705 #define MAX_BUFFER_SIZE 4096
2707 File *openFile(char *filename, char *mode)
2709 File *file = checked_calloc(sizeof(File));
2711 file->file = fopen(filename, mode);
2713 if (file->file != NULL)
2715 file->filename = getStringCopy(filename);
2720 #if defined(PLATFORM_ANDROID)
2721 file->asset_file = SDL_RWFromFile(filename, mode);
2723 if (file->asset_file != NULL)
2725 file->file_is_asset = TRUE;
2726 file->filename = getStringCopy(filename);
2737 int closeFile(File *file)
2744 #if defined(PLATFORM_ANDROID)
2745 if (file->asset_file)
2746 result = SDL_RWclose(file->asset_file);
2750 result = fclose(file->file);
2752 checked_free(file->filename);
2758 int checkEndOfFile(File *file)
2760 #if defined(PLATFORM_ANDROID)
2761 if (file->file_is_asset)
2762 return file->end_of_file;
2765 return feof(file->file);
2768 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2770 #if defined(PLATFORM_ANDROID)
2771 if (file->file_is_asset)
2773 if (file->end_of_file)
2776 size_t num_items_read =
2777 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2779 if (num_items_read < num_items)
2780 file->end_of_file = TRUE;
2782 return num_items_read;
2786 return fread(buffer, item_size, num_items, file->file);
2789 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2791 return fwrite(buffer, item_size, num_items, file->file);
2794 int seekFile(File *file, long offset, int whence)
2796 #if defined(PLATFORM_ANDROID)
2797 if (file->file_is_asset)
2799 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2800 whence == SEEK_CUR ? RW_SEEK_CUR :
2801 whence == SEEK_END ? RW_SEEK_END : 0);
2803 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2807 return fseek(file->file, offset, whence);
2810 int getByteFromFile(File *file)
2812 #if defined(PLATFORM_ANDROID)
2813 if (file->file_is_asset)
2815 if (file->end_of_file)
2819 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2821 if (num_bytes_read < 1)
2822 file->end_of_file = TRUE;
2824 return (file->end_of_file ? EOF : (int)c);
2828 return fgetc(file->file);
2831 char *getStringFromFile(File *file, char *line, int size)
2833 #if defined(PLATFORM_ANDROID)
2834 if (file->file_is_asset)
2836 if (file->end_of_file)
2839 char *line_ptr = line;
2840 int num_bytes_read = 0;
2842 while (num_bytes_read < size - 1 &&
2843 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2844 *line_ptr++ != '\n')
2849 if (strlen(line) == 0)
2851 file->end_of_file = TRUE;
2860 return fgets(line, size, file->file);
2863 int copyFile(char *filename_from, char *filename_to)
2865 File *file_from, *file_to;
2867 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2872 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2874 closeFile(file_from);
2879 while (!checkEndOfFile(file_from))
2881 byte buffer[MAX_BUFFER_SIZE];
2882 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2884 writeFile(file_to, buffer, 1, bytes_read);
2887 closeFile(file_from);
2893 boolean touchFile(char *filename)
2897 if (!(file = fopen(filename, MODE_WRITE)))
2899 Warn("cannot touch file '%s'", filename);
2910 // ----------------------------------------------------------------------------
2911 // functions for directory handling
2912 // ----------------------------------------------------------------------------
2914 Directory *openDirectory(char *dir_name)
2916 Directory *dir = checked_calloc(sizeof(Directory));
2918 dir->dir = opendir(dir_name);
2920 if (dir->dir != NULL)
2922 dir->filename = getStringCopy(dir_name);
2927 #if defined(PLATFORM_ANDROID)
2928 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2930 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2932 checked_free(asset_toc_filename);
2934 if (dir->asset_toc_file != NULL)
2936 dir->directory_is_asset = TRUE;
2937 dir->filename = getStringCopy(dir_name);
2948 int closeDirectory(Directory *dir)
2955 #if defined(PLATFORM_ANDROID)
2956 if (dir->asset_toc_file)
2957 result = SDL_RWclose(dir->asset_toc_file);
2961 result = closedir(dir->dir);
2964 freeDirectoryEntry(dir->dir_entry);
2966 checked_free(dir->filename);
2972 DirectoryEntry *readDirectory(Directory *dir)
2975 freeDirectoryEntry(dir->dir_entry);
2977 dir->dir_entry = NULL;
2979 #if defined(PLATFORM_ANDROID)
2980 if (dir->directory_is_asset)
2982 char line[MAX_LINE_LEN];
2983 char *line_ptr = line;
2984 int num_bytes_read = 0;
2986 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2987 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2996 if (strlen(line) == 0)
2999 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3001 dir->dir_entry->is_directory = FALSE;
3002 if (line[strlen(line) - 1] == '/')
3004 dir->dir_entry->is_directory = TRUE;
3006 line[strlen(line) - 1] = '\0';
3009 dir->dir_entry->basename = getStringCopy(line);
3010 dir->dir_entry->filename = getPath2(dir->filename, line);
3012 return dir->dir_entry;
3016 struct dirent *dir_entry = readdir(dir->dir);
3018 if (dir_entry == NULL)
3021 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3023 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3024 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3026 struct stat file_status;
3028 dir->dir_entry->is_directory =
3029 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3030 S_ISDIR(file_status.st_mode));
3032 return dir->dir_entry;
3035 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3037 if (dir_entry == NULL)
3040 checked_free(dir_entry->basename);
3041 checked_free(dir_entry->filename);
3042 checked_free(dir_entry);
3046 // ----------------------------------------------------------------------------
3047 // functions for checking files and filenames
3048 // ----------------------------------------------------------------------------
3050 boolean directoryExists(char *dir_name)
3052 if (dir_name == NULL)
3055 struct stat file_status;
3056 boolean success = (stat(dir_name, &file_status) == 0 &&
3057 S_ISDIR(file_status.st_mode));
3059 #if defined(PLATFORM_ANDROID)
3062 // this might be an asset directory; check by trying to open toc file
3063 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3064 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3066 checked_free(asset_toc_filename);
3068 success = (file != NULL);
3078 boolean fileExists(char *filename)
3080 if (filename == NULL)
3083 boolean success = (access(filename, F_OK) == 0);
3085 #if defined(PLATFORM_ANDROID)
3088 // this might be an asset file; check by trying to open it
3089 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3091 success = (file != NULL);
3102 static boolean fileHasPrefix(char *basename, char *prefix)
3104 static char *basename_lower = NULL;
3105 int basename_length, prefix_length;
3107 checked_free(basename_lower);
3109 if (basename == NULL || prefix == NULL)
3112 basename_lower = getStringToLower(basename);
3113 basename_length = strlen(basename_lower);
3114 prefix_length = strlen(prefix);
3116 if (basename_length > prefix_length + 1 &&
3117 basename_lower[prefix_length] == '.' &&
3118 strncmp(basename_lower, prefix, prefix_length) == 0)
3125 static boolean fileHasSuffix(char *basename, char *suffix)
3127 static char *basename_lower = NULL;
3128 int basename_length, suffix_length;
3130 checked_free(basename_lower);
3132 if (basename == NULL || suffix == NULL)
3135 basename_lower = getStringToLower(basename);
3136 basename_length = strlen(basename_lower);
3137 suffix_length = strlen(suffix);
3139 if (basename_length > suffix_length + 1 &&
3140 basename_lower[basename_length - suffix_length - 1] == '.' &&
3141 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3147 static boolean FileCouldBeArtwork(char *filename)
3149 char *basename = getBaseNamePtr(filename);
3151 return (!strEqual(basename, ".") &&
3152 !strEqual(basename, "..") &&
3153 !fileHasSuffix(basename, "txt") &&
3154 !fileHasSuffix(basename, "conf") &&
3155 !directoryExists(filename));
3158 boolean FileIsGraphic(char *filename)
3160 return FileCouldBeArtwork(filename);
3163 boolean FileIsSound(char *filename)
3165 return FileCouldBeArtwork(filename);
3168 boolean FileIsMusic(char *filename)
3170 return FileCouldBeArtwork(filename);
3173 boolean FileIsArtworkType(char *filename, int type)
3175 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3176 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3177 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3183 // ----------------------------------------------------------------------------
3184 // functions for loading artwork configuration information
3185 // ----------------------------------------------------------------------------
3187 char *get_mapped_token(char *token)
3189 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3190 static char *map_token_prefix[][2] =
3192 { "char_procent", "char_percent" },
3193 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3194 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3195 { "bd_butterfly_left", "bd_butterfly.left" },
3196 { "bd_butterfly_right", "bd_butterfly.right" },
3197 { "bd_butterfly_up", "bd_butterfly.up" },
3198 { "bd_butterfly_down", "bd_butterfly.down" },
3199 { "bd_firefly_left", "bd_firefly.left" },
3200 { "bd_firefly_right", "bd_firefly.right" },
3201 { "bd_firefly_up", "bd_firefly.up" },
3202 { "bd_firefly_down", "bd_firefly.down" },
3208 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3210 int len_token_prefix = strlen(map_token_prefix[i][0]);
3212 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3213 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3216 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3217 char *gfx_substring = ".gfx";
3218 char *gfx_prefix = "gfx.";
3219 if (strstr(token, gfx_substring) != NULL)
3221 char *token_prefix = getStringCopy(token);
3222 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3223 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3226 // cut off token string at ".gfx" substring position
3227 *token_gfx_pos = '\0';
3229 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3230 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3234 return mapped_token;
3240 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3243 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3244 static struct ConfigTypeInfo prefix_list[] =
3246 { "global.anim_1" },
3247 { "global.anim_2" },
3248 { "global.anim_3" },
3249 { "global.anim_4" },
3250 { "global.anim_5" },
3251 { "global.anim_6" },
3252 { "global.anim_7" },
3253 { "global.anim_8" },
3254 { "global.anim_9" },
3255 { "global.anim_10" },
3256 { "global.anim_11" },
3257 { "global.anim_12" },
3258 { "global.anim_13" },
3259 { "global.anim_14" },
3260 { "global.anim_15" },
3261 { "global.anim_16" },
3262 { "global.anim_17" },
3263 { "global.anim_18" },
3264 { "global.anim_19" },
3265 { "global.anim_20" },
3266 { "global.anim_21" },
3267 { "global.anim_22" },
3268 { "global.anim_23" },
3269 { "global.anim_24" },
3270 { "global.anim_25" },
3271 { "global.anim_26" },
3272 { "global.anim_27" },
3273 { "global.anim_28" },
3274 { "global.anim_29" },
3275 { "global.anim_30" },
3276 { "global.anim_31" },
3277 { "global.anim_32" },
3281 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3282 boolean prefix_found = FALSE;
3286 // search for prefix to check if base token has to be created
3287 for (i = 0; prefix_list[i].token != NULL; i++)
3288 if (strPrefix(token, prefix_list[i].token))
3289 prefix_found = TRUE;
3294 // search for suffix (parameter) to determine base token length
3295 for (i = 0; suffix_list[i].token != NULL; i++)
3296 if (strSuffix(token, suffix_list[i].token))
3297 len_suffix = strlen(suffix_list[i].token);
3299 return getStringCopyN(token, strlen(token) - len_suffix);
3302 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3303 struct ListNodeInfo ***, int *);
3305 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3306 struct ConfigTypeInfo *suffix_list,
3307 char **ignore_tokens,
3308 int num_file_list_entries)
3310 SetupFileHash *ignore_tokens_hash;
3311 struct FileInfo *file_list;
3312 int num_file_list_entries_found = 0;
3313 int num_suffix_list_entries = 0;
3317 // create hash from list of tokens to be ignored (for quick access)
3318 ignore_tokens_hash = newSetupFileHash();
3319 for (i = 0; ignore_tokens[i] != NULL; i++)
3320 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3322 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3324 for (i = 0; suffix_list[i].token != NULL; i++)
3325 num_suffix_list_entries++;
3327 // always start with reliable default values
3328 for (i = 0; i < num_file_list_entries; i++)
3330 file_list[i].token = NULL;
3332 file_list[i].default_filename = NULL;
3333 file_list[i].filename = NULL;
3335 if (num_suffix_list_entries > 0)
3337 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3339 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3340 file_list[i].parameter = checked_calloc(parameter_array_size);
3342 for (j = 0; j < num_suffix_list_entries; j++)
3344 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3345 setString(&file_list[i].parameter[j], suffix_list[j].value);
3348 file_list[i].redefined = FALSE;
3349 file_list[i].fallback_to_default = FALSE;
3350 file_list[i].default_is_cloned = FALSE;
3356 for (i = 0; config_list[i].token != NULL; i++)
3358 int len_config_token = strlen(config_list[i].token);
3359 boolean is_file_entry = TRUE;
3361 for (j = 0; suffix_list[j].token != NULL; j++)
3363 int len_suffix = strlen(suffix_list[j].token);
3365 if (len_suffix < len_config_token &&
3366 strEqual(&config_list[i].token[len_config_token - len_suffix],
3367 suffix_list[j].token))
3369 setString(&file_list[list_pos].default_parameter[j],
3370 config_list[i].value);
3372 is_file_entry = FALSE;
3378 // the following tokens are no file definitions, but other config tokens
3379 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3380 is_file_entry = FALSE;
3387 if (list_pos >= num_file_list_entries)
3390 file_list[list_pos].token = config_list[i].token;
3391 file_list[list_pos].default_filename = config_list[i].value;
3394 if (strSuffix(config_list[i].token, ".clone_from"))
3395 file_list[list_pos].default_is_cloned = TRUE;
3398 num_file_list_entries_found = list_pos + 1;
3399 if (num_file_list_entries_found != num_file_list_entries)
3402 Error("inconsistant config list information:");
3403 Error("- should be: %d (according to 'src/conf_xxx.h')",
3404 num_file_list_entries);
3405 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3406 num_file_list_entries_found);
3411 freeSetupFileHash(ignore_tokens_hash);
3416 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3418 int len_token = strlen(token);
3419 int len_suffix = strlen(suffix);
3421 if (start_pos < 0) // compare suffix from end of string
3422 start_pos += len_token;
3424 if (start_pos < 0 || start_pos + len_suffix > len_token)
3427 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3430 if (token[start_pos + len_suffix] == '\0')
3433 if (token[start_pos + len_suffix] == '.')
3439 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3441 static void read_token_parameters(SetupFileHash *setup_file_hash,
3442 struct ConfigTypeInfo *suffix_list,
3443 struct FileInfo *file_list_entry)
3445 // check for config token that is the base token without any suffixes
3446 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3447 char *known_token_value = KNOWN_TOKEN_VALUE;
3450 if (filename != NULL)
3452 setString(&file_list_entry->filename, filename);
3454 // when file definition found, set all parameters to default values
3455 for (i = 0; suffix_list[i].token != NULL; i++)
3456 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3458 file_list_entry->redefined = TRUE;
3460 // mark config file token as well known from default config
3461 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3464 // check for config tokens that can be build by base token and suffixes
3465 for (i = 0; suffix_list[i].token != NULL; i++)
3467 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3468 char *value = getHashEntry(setup_file_hash, token);
3472 setString(&file_list_entry->parameter[i], value);
3474 // mark config file token as well known from default config
3475 setHashEntry(setup_file_hash, token, known_token_value);
3482 static void add_dynamic_file_list_entry(struct FileInfo **list,
3483 int *num_list_entries,
3484 SetupFileHash *extra_file_hash,
3485 struct ConfigTypeInfo *suffix_list,
3486 int num_suffix_list_entries,
3489 struct FileInfo *new_list_entry;
3490 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3492 (*num_list_entries)++;
3493 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3494 new_list_entry = &(*list)[*num_list_entries - 1];
3496 new_list_entry->token = getStringCopy(token);
3497 new_list_entry->default_filename = NULL;
3498 new_list_entry->filename = NULL;
3499 new_list_entry->parameter = checked_calloc(parameter_array_size);
3501 new_list_entry->redefined = FALSE;
3502 new_list_entry->fallback_to_default = FALSE;
3503 new_list_entry->default_is_cloned = FALSE;
3505 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3508 static void add_property_mapping(struct PropertyMapping **list,
3509 int *num_list_entries,
3510 int base_index, int ext1_index,
3511 int ext2_index, int ext3_index,
3514 struct PropertyMapping *new_list_entry;
3516 (*num_list_entries)++;
3517 *list = checked_realloc(*list,
3518 *num_list_entries * sizeof(struct PropertyMapping));
3519 new_list_entry = &(*list)[*num_list_entries - 1];
3521 new_list_entry->base_index = base_index;
3522 new_list_entry->ext1_index = ext1_index;
3523 new_list_entry->ext2_index = ext2_index;
3524 new_list_entry->ext3_index = ext3_index;
3526 new_list_entry->artwork_index = artwork_index;
3529 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3532 struct FileInfo *file_list = artwork_info->file_list;
3533 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3534 char **base_prefixes = artwork_info->base_prefixes;
3535 char **ext1_suffixes = artwork_info->ext1_suffixes;
3536 char **ext2_suffixes = artwork_info->ext2_suffixes;
3537 char **ext3_suffixes = artwork_info->ext3_suffixes;
3538 char **ignore_tokens = artwork_info->ignore_tokens;
3539 int num_file_list_entries = artwork_info->num_file_list_entries;
3540 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3541 int num_base_prefixes = artwork_info->num_base_prefixes;
3542 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3543 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3544 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3545 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3546 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3547 SetupFileHash *extra_file_hash, *empty_file_hash;
3548 char *known_token_value = KNOWN_TOKEN_VALUE;
3549 char *base_token_value = UNDEFINED_FILENAME;
3552 if (filename == NULL)
3555 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3558 // separate valid (defined) from empty (undefined) config token values
3559 valid_file_hash = newSetupFileHash();
3560 empty_file_hash = newSetupFileHash();
3561 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3563 char *value = HASH_ITERATION_VALUE(itr);
3565 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3566 HASH_ITERATION_TOKEN(itr), value);
3568 END_HASH_ITERATION(setup_file_hash, itr)
3570 // at this point, we do not need the setup file hash anymore -- free it
3571 freeSetupFileHash(setup_file_hash);
3573 // prevent changing hash while iterating over it by using a temporary copy
3574 valid_file_hash_tmp = newSetupFileHash();
3575 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3577 setHashEntry(valid_file_hash_tmp,
3578 HASH_ITERATION_TOKEN(itr),
3579 HASH_ITERATION_VALUE(itr));
3581 END_HASH_ITERATION(valid_file_hash, itr)
3583 // (iterate over same temporary hash, as modifications are independent)
3585 // map deprecated to current tokens (using prefix match and replace)
3586 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3588 char *token = HASH_ITERATION_TOKEN(itr);
3589 char *mapped_token = get_mapped_token(token);
3591 if (mapped_token != NULL)
3593 char *value = HASH_ITERATION_VALUE(itr);
3596 setHashEntry(valid_file_hash, mapped_token, value);
3598 // ignore old token (by setting it to "known" keyword)
3599 setHashEntry(valid_file_hash, token, known_token_value);
3604 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3606 // add special base tokens (using prefix match and replace)
3607 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3609 char *token = HASH_ITERATION_TOKEN(itr);
3610 char *base_token = get_special_base_token(artwork_info, token);
3612 if (base_token != NULL)
3614 // add base token only if it does not already exist
3615 if (getHashEntry(valid_file_hash, base_token) == NULL)
3616 setHashEntry(valid_file_hash, base_token, base_token_value);
3621 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3623 // free temporary hash used for iteration
3624 freeSetupFileHash(valid_file_hash_tmp);
3626 // read parameters for all known config file tokens
3627 for (i = 0; i < num_file_list_entries; i++)
3628 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3630 // set all tokens that can be ignored here to "known" keyword
3631 for (i = 0; i < num_ignore_tokens; i++)
3632 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3634 // copy all unknown config file tokens to extra config hash
3635 extra_file_hash = newSetupFileHash();
3636 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3638 char *value = HASH_ITERATION_VALUE(itr);
3640 if (!strEqual(value, known_token_value))
3641 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3643 END_HASH_ITERATION(valid_file_hash, itr)
3645 // at this point, we do not need the valid file hash anymore -- free it
3646 freeSetupFileHash(valid_file_hash);
3648 // now try to determine valid, dynamically defined config tokens
3650 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3652 struct FileInfo **dynamic_file_list =
3653 &artwork_info->dynamic_file_list;
3654 int *num_dynamic_file_list_entries =
3655 &artwork_info->num_dynamic_file_list_entries;
3656 struct PropertyMapping **property_mapping =
3657 &artwork_info->property_mapping;
3658 int *num_property_mapping_entries =
3659 &artwork_info->num_property_mapping_entries;
3660 int current_summarized_file_list_entry =
3661 artwork_info->num_file_list_entries +
3662 artwork_info->num_dynamic_file_list_entries;
3663 char *token = HASH_ITERATION_TOKEN(itr);
3664 int len_token = strlen(token);
3666 boolean base_prefix_found = FALSE;
3667 boolean parameter_suffix_found = FALSE;
3669 // skip all parameter definitions (handled by read_token_parameters())
3670 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3672 int len_suffix = strlen(suffix_list[i].token);
3674 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3675 parameter_suffix_found = TRUE;
3678 if (parameter_suffix_found)
3681 // ---------- step 0: search for matching base prefix ----------
3684 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3686 char *base_prefix = base_prefixes[i];
3687 int len_base_prefix = strlen(base_prefix);
3688 boolean ext1_suffix_found = FALSE;
3689 boolean ext2_suffix_found = FALSE;
3690 boolean ext3_suffix_found = FALSE;
3691 boolean exact_match = FALSE;
3692 int base_index = -1;
3693 int ext1_index = -1;
3694 int ext2_index = -1;
3695 int ext3_index = -1;
3697 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3699 if (!base_prefix_found)
3704 if (start_pos + len_base_prefix == len_token) // exact match
3708 add_dynamic_file_list_entry(dynamic_file_list,
3709 num_dynamic_file_list_entries,
3712 num_suffix_list_entries,
3714 add_property_mapping(property_mapping,
3715 num_property_mapping_entries,
3716 base_index, -1, -1, -1,
3717 current_summarized_file_list_entry);
3721 // ---------- step 1: search for matching first suffix ----------
3723 start_pos += len_base_prefix;
3724 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3726 char *ext1_suffix = ext1_suffixes[j];
3727 int len_ext1_suffix = strlen(ext1_suffix);
3729 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3731 if (!ext1_suffix_found)
3736 if (start_pos + len_ext1_suffix == len_token) // exact match
3740 add_dynamic_file_list_entry(dynamic_file_list,
3741 num_dynamic_file_list_entries,
3744 num_suffix_list_entries,
3746 add_property_mapping(property_mapping,
3747 num_property_mapping_entries,
3748 base_index, ext1_index, -1, -1,
3749 current_summarized_file_list_entry);
3753 start_pos += len_ext1_suffix;
3759 // ---------- step 2: search for matching second suffix ----------
3761 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3763 char *ext2_suffix = ext2_suffixes[k];
3764 int len_ext2_suffix = strlen(ext2_suffix);
3766 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3768 if (!ext2_suffix_found)
3773 if (start_pos + len_ext2_suffix == len_token) // exact match
3777 add_dynamic_file_list_entry(dynamic_file_list,
3778 num_dynamic_file_list_entries,
3781 num_suffix_list_entries,
3783 add_property_mapping(property_mapping,
3784 num_property_mapping_entries,
3785 base_index, ext1_index, ext2_index, -1,
3786 current_summarized_file_list_entry);
3790 start_pos += len_ext2_suffix;
3796 // ---------- step 3: search for matching third suffix ----------
3798 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3800 char *ext3_suffix = ext3_suffixes[l];
3801 int len_ext3_suffix = strlen(ext3_suffix);
3803 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3805 if (!ext3_suffix_found)
3810 if (start_pos + len_ext3_suffix == len_token) // exact match
3814 add_dynamic_file_list_entry(dynamic_file_list,
3815 num_dynamic_file_list_entries,
3818 num_suffix_list_entries,
3820 add_property_mapping(property_mapping,
3821 num_property_mapping_entries,
3822 base_index, ext1_index, ext2_index, ext3_index,
3823 current_summarized_file_list_entry);
3829 END_HASH_ITERATION(extra_file_hash, itr)
3831 if (artwork_info->num_dynamic_file_list_entries > 0)
3833 artwork_info->dynamic_artwork_list =
3834 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3835 artwork_info->sizeof_artwork_list_entry);
3838 if (options.verbose && IS_PARENT_PROCESS())
3840 SetupFileList *setup_file_list, *list;
3841 boolean dynamic_tokens_found = FALSE;
3842 boolean unknown_tokens_found = FALSE;
3843 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3845 // list may be NULL for empty artwork config files
3846 setup_file_list = loadSetupFileList(filename);
3848 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3850 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3851 dynamic_tokens_found = TRUE;
3853 unknown_tokens_found = TRUE;
3855 END_HASH_ITERATION(extra_file_hash, itr)
3857 if (options.debug && dynamic_tokens_found)
3859 Debug("config", "---");
3860 Debug("config", "dynamic token(s) found in config file:");
3861 Debug("config", "- config file: '%s'", filename);
3863 for (list = setup_file_list; list != NULL; list = list->next)
3865 char *value = getHashEntry(extra_file_hash, list->token);
3867 if (value != NULL && strEqual(value, known_token_value))
3868 Debug("config", "- dynamic token: '%s'", list->token);
3871 Debug("config", "---");
3874 if (unknown_tokens_found)
3877 Warn("unknown token(s) found in config file:");
3878 Warn("- config file: '%s'", filename);
3880 for (list = setup_file_list; list != NULL; list = list->next)
3882 char *value = getHashEntry(extra_file_hash, list->token);
3884 if (value != NULL && !strEqual(value, known_token_value))
3885 Warn("- dynamic token: '%s'", list->token);
3891 if (undefined_values_found)
3894 Warn("undefined values found in config file:");
3895 Warn("- config file: '%s'", filename);
3897 for (list = setup_file_list; list != NULL; list = list->next)
3899 char *value = getHashEntry(empty_file_hash, list->token);
3902 Warn("- undefined value for token: '%s'", list->token);
3908 freeSetupFileList(setup_file_list);
3911 freeSetupFileHash(extra_file_hash);
3912 freeSetupFileHash(empty_file_hash);
3915 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3917 struct FileInfo *file_list = artwork_info->file_list;
3918 int num_file_list_entries = artwork_info->num_file_list_entries;
3919 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3920 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3923 DrawInitTextHead("Loading artwork config");
3924 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
3926 // always start with reliable default values
3927 for (i = 0; i < num_file_list_entries; i++)
3929 setString(&file_list[i].filename, file_list[i].default_filename);
3931 for (j = 0; j < num_suffix_list_entries; j++)
3932 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3934 file_list[i].redefined = FALSE;
3935 file_list[i].fallback_to_default = FALSE;
3938 // free previous dynamic artwork file array
3939 if (artwork_info->dynamic_file_list != NULL)
3941 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3943 free(artwork_info->dynamic_file_list[i].token);
3944 free(artwork_info->dynamic_file_list[i].filename);
3945 free(artwork_info->dynamic_file_list[i].parameter);
3948 free(artwork_info->dynamic_file_list);
3949 artwork_info->dynamic_file_list = NULL;
3951 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3952 &artwork_info->num_dynamic_file_list_entries);
3955 // free previous property mapping
3956 if (artwork_info->property_mapping != NULL)
3958 free(artwork_info->property_mapping);
3960 artwork_info->property_mapping = NULL;
3961 artwork_info->num_property_mapping_entries = 0;
3964 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3966 // first look for special artwork configured in level series config
3967 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3969 if (fileExists(filename_base))
3970 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3973 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3975 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3976 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3979 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3980 struct ListNodeInfo **listnode)
3984 char *filename = (*listnode)->source_filename;
3986 if (--(*listnode)->num_references <= 0)
3987 deleteNodeFromList(&artwork_info->content_list, filename,
3988 artwork_info->free_artwork);
3994 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3995 struct ListNodeInfo **listnode,
3996 struct FileInfo *file_list_entry)
4006 char *basename = file_list_entry->filename;
4007 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4009 // mark all images from non-default graphics directory as "redefined"
4010 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4011 !strPrefix(filename, options.graphics_directory))
4012 file_list_entry->redefined = TRUE;
4014 if (filename == NULL)
4016 Warn("cannot find artwork file '%s'", basename);
4018 basename = file_list_entry->default_filename;
4020 // fail for cloned default artwork that has no default filename defined
4021 if (file_list_entry->default_is_cloned &&
4022 strEqual(basename, UNDEFINED_FILENAME))
4024 void (*error_func)(char *, ...) = Warn;
4026 // we can get away without sounds and music, but not without graphics
4027 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4030 error_func("token '%s' was cloned and has no default filename",
4031 file_list_entry->token);
4036 // dynamic artwork has no default filename / skip empty default artwork
4037 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4040 file_list_entry->fallback_to_default = TRUE;
4042 Warn("trying default artwork file '%s'", basename);
4044 filename = getCustomArtworkFilename(basename, artwork_info->type);
4046 if (filename == NULL)
4048 void (*error_func)(char *, ...) = Warn;
4050 // we can get away without sounds and music, but not without graphics
4051 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4054 error_func("cannot find default artwork file '%s'", basename);
4060 // check if the old and the new artwork file are the same
4061 if (*listnode && strEqual((*listnode)->source_filename, filename))
4063 // The old and new artwork are the same (have the same filename and path).
4064 // This usually means that this artwork does not exist in this artwork set
4065 // and a fallback to the existing artwork is done.
4070 // delete existing artwork file entry
4071 deleteArtworkListEntry(artwork_info, listnode);
4073 // check if the new artwork file already exists in the list of artwork
4074 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4076 *listnode = (struct ListNodeInfo *)node->content;
4077 (*listnode)->num_references++;
4082 DrawInitTextHead(init_text[artwork_info->type]);
4083 DrawInitTextItem(basename);
4085 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4087 // add new artwork file entry to the list of artwork files
4088 (*listnode)->num_references = 1;
4089 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4094 void (*error_func)(char *, ...) = Warn;
4096 // we can get away without sounds and music, but not without graphics
4097 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4100 error_func("cannot load artwork file '%s'", basename);
4106 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4107 struct ListNodeInfo **listnode,
4108 struct FileInfo *file_list_entry)
4110 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4112 deleteArtworkListEntry(artwork_info, listnode);
4117 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4120 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4122 struct FileInfo *file_list = artwork_info->file_list;
4123 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4124 int num_file_list_entries = artwork_info->num_file_list_entries;
4125 int num_dynamic_file_list_entries =
4126 artwork_info->num_dynamic_file_list_entries;
4129 print_timestamp_init("ReloadCustomArtworkList");
4131 for (i = 0; i < num_file_list_entries; i++)
4132 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4135 for (i = 0; i < num_dynamic_file_list_entries; i++)
4136 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4137 &dynamic_file_list[i]);
4139 print_timestamp_done("ReloadCustomArtworkList");
4142 dumpList(artwork_info->content_list);
4146 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4147 struct ListNodeInfo ***list,
4148 int *num_list_entries)
4155 for (i = 0; i < *num_list_entries; i++)
4156 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4160 *num_list_entries = 0;
4163 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4165 if (artwork_info == NULL)
4168 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4169 &artwork_info->num_file_list_entries);
4171 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4172 &artwork_info->num_dynamic_file_list_entries);
4176 // ----------------------------------------------------------------------------
4177 // functions only needed for non-Unix (non-command-line) systems
4178 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4179 // (now also added for Windows, to create files in user data directory)
4180 // ----------------------------------------------------------------------------
4182 char *getLogBasename(char *basename)
4184 return getStringCat2(basename, ".log");
4187 char *getLogFilename(char *basename)
4189 return getPath2(getMainUserGameDataDir(), basename);
4192 void OpenLogFile(void)
4194 InitMainUserDataDirectory();
4196 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4198 program.log_file = program.log_file_default; // reset to default
4200 Warn("cannot open file '%s' for writing: %s",
4201 program.log_filename, strerror(errno));
4204 // output should be unbuffered so it is not truncated in a crash
4205 setbuf(program.log_file, NULL);
4208 void CloseLogFile(void)
4210 if (program.log_file != program.log_file_default)
4211 fclose(program.log_file);
4214 void DumpLogFile(void)
4216 FILE *log_file = fopen(program.log_filename, MODE_READ);
4218 if (log_file == NULL)
4221 while (!feof(log_file))
4222 fputc(fgetc(log_file), stdout);
4227 void NotifyUserAboutErrorFile(void)
4229 #if defined(PLATFORM_WINDOWS)
4230 char *title_text = getStringCat2(program.program_title, " Error Message");
4231 char *error_text = getStringCat2("The program was aborted due to an error; "
4232 "for details, see the following error file:"
4234 program.log_filename);
4236 MessageBox(NULL, error_text, title_text, MB_OK);
4241 // ----------------------------------------------------------------------------
4242 // the following is only for debugging purpose and normally not used
4243 // ----------------------------------------------------------------------------
4247 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4248 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4250 #define DEBUG_NUM_TIMESTAMPS 10
4251 #define DEBUG_TIME_IN_MICROSECONDS 0
4253 #if DEBUG_TIME_IN_MICROSECONDS
4254 static double Counter_Microseconds(void)
4256 static struct timeval base_time = { 0, 0 };
4257 struct timeval current_time;
4260 gettimeofday(¤t_time, NULL);
4262 // reset base time in case of wrap-around
4263 if (current_time.tv_sec < base_time.tv_sec)
4264 base_time = current_time;
4267 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4268 ((double)(current_time.tv_usec - base_time.tv_usec));
4270 return counter; // return microseconds since last init
4274 static char *debug_print_timestamp_get_padding(int padding_size)
4276 static char *padding = NULL;
4277 int max_padding_size = 100;
4279 if (padding == NULL)
4281 padding = checked_calloc(max_padding_size + 1);
4282 memset(padding, ' ', max_padding_size);
4285 return &padding[MAX(0, max_padding_size - padding_size)];
4288 void debug_print_timestamp(int counter_nr, char *message)
4290 int indent_size = 8;
4291 int padding_size = 40;
4292 float timestamp_interval;
4295 Fail("debugging: invalid negative counter");
4296 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4297 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4299 #if DEBUG_TIME_IN_MICROSECONDS
4300 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4303 counter[counter_nr][0] = Counter_Microseconds();
4305 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4308 counter[counter_nr][0] = Counter();
4311 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4312 counter[counter_nr][1] = counter[counter_nr][0];
4315 Debug("time:init", "%s%s%s %.3f %s",
4316 debug_print_timestamp_get_padding(counter_nr * indent_size),
4318 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4319 timestamp_interval / 1000,
4324 static void debug_print_parent_only(char *format, ...)
4326 if (!IS_PARENT_PROCESS())
4333 va_start(ap, format);
4334 vprintf(format, ap);
4344 static void print_timestamp_ext(char *message, char *mode)
4346 #if DEBUG_PRINT_INIT_TIMESTAMPS
4347 static char *debug_message = NULL;
4348 static char *last_message = NULL;
4349 static int counter_nr = 0;
4350 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4352 checked_free(debug_message);
4353 debug_message = getStringCat3(mode, " ", message);
4355 if (strEqual(mode, "INIT"))
4357 debug_print_timestamp(counter_nr, NULL);
4359 if (counter_nr + 1 < max_depth)
4360 debug_print_timestamp(counter_nr, debug_message);
4364 debug_print_timestamp(counter_nr, NULL);
4366 else if (strEqual(mode, "DONE"))
4370 if (counter_nr + 1 < max_depth ||
4371 (counter_nr == 0 && max_depth == 1))
4373 last_message = message;
4375 if (counter_nr == 0 && max_depth == 1)
4377 checked_free(debug_message);
4378 debug_message = getStringCat3("TIME", " ", message);
4381 debug_print_timestamp(counter_nr, debug_message);
4384 else if (!strEqual(mode, "TIME") ||
4385 !strEqual(message, last_message))
4387 if (counter_nr < max_depth)
4388 debug_print_timestamp(counter_nr, debug_message);
4393 void print_timestamp_init(char *message)
4395 print_timestamp_ext(message, "INIT");
4398 void print_timestamp_time(char *message)
4400 print_timestamp_ext(message, "TIME");
4403 void print_timestamp_done(char *message)
4405 print_timestamp_ext(message, "DONE");