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(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToLower(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = tolower(*s++);
1235 void setString(char **old_value, const char *new_value)
1237 checked_free(*old_value);
1239 *old_value = getStringCopy(new_value);
1242 boolean strEqual(const char *s1, const char *s2)
1244 return (s1 == NULL && s2 == NULL ? TRUE :
1245 s1 == NULL && s2 != NULL ? FALSE :
1246 s1 != NULL && s2 == NULL ? FALSE :
1247 strcmp(s1, s2) == 0);
1250 boolean strEqualN(const char *s1, const char *s2, int n)
1252 return (s1 == NULL && s2 == NULL ? TRUE :
1253 s1 == NULL && s2 != NULL ? FALSE :
1254 s1 != NULL && s2 == NULL ? FALSE :
1255 strncmp(s1, s2, n) == 0);
1258 boolean strEqualCase(const char *s1, const char *s2)
1260 return (s1 == NULL && s2 == NULL ? TRUE :
1261 s1 == NULL && s2 != NULL ? FALSE :
1262 s1 != NULL && s2 == NULL ? FALSE :
1263 strcasecmp(s1, s2) == 0);
1266 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1268 return (s1 == NULL && s2 == NULL ? TRUE :
1269 s1 == NULL && s2 != NULL ? FALSE :
1270 s1 != NULL && s2 == NULL ? FALSE :
1271 strncasecmp(s1, s2, n) == 0);
1274 boolean strPrefix(const char *s, const char *prefix)
1276 return (s == NULL && prefix == NULL ? TRUE :
1277 s == NULL && prefix != NULL ? FALSE :
1278 s != NULL && prefix == NULL ? FALSE :
1279 strncmp(s, prefix, strlen(prefix)) == 0);
1282 boolean strSuffix(const char *s, const char *suffix)
1284 return (s == NULL && suffix == NULL ? TRUE :
1285 s == NULL && suffix != NULL ? FALSE :
1286 s != NULL && suffix == NULL ? FALSE :
1287 strlen(s) < strlen(suffix) ? FALSE :
1288 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1291 boolean strPrefixLower(const char *s, const char *prefix)
1293 char *s_lower = getStringToLower(s);
1294 boolean match = strPrefix(s_lower, prefix);
1301 boolean strSuffixLower(const char *s, const char *suffix)
1303 char *s_lower = getStringToLower(s);
1304 boolean match = strSuffix(s_lower, suffix);
1311 boolean isURL(const char *s)
1313 while (*s && *s >= 'a' && *s <= 'z')
1316 return strPrefix(s, "://");
1320 // ----------------------------------------------------------------------------
1321 // command line option handling functions
1322 // ----------------------------------------------------------------------------
1324 void GetOptions(int argc, char *argv[],
1325 void (*print_usage_function)(void),
1326 void (*print_version_function)(void))
1328 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1329 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1330 char **options_left = &argvplus[1];
1332 // replace original "argv" with null-terminated array of string pointers
1334 argvplus[argc] = argv[argc];
1336 // initialize global program options
1337 options.server_host = NULL;
1338 options.server_port = 0;
1340 options.base_directory = base_path;
1342 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1343 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1344 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1345 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1346 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1347 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1349 options.execute_command = NULL;
1350 options.tape_log_filename = NULL;
1351 options.special_flags = NULL;
1352 options.debug_mode = NULL;
1353 options.player_name = NULL;
1354 options.identifier = NULL;
1355 options.level_nr = NULL;
1357 options.display_nr = 0;
1359 options.mytapes = FALSE;
1360 options.serveronly = FALSE;
1361 options.network = FALSE;
1362 options.verbose = FALSE;
1363 options.debug = FALSE;
1366 options.verbose = TRUE;
1368 #if !defined(PLATFORM_UNIX)
1369 if (*options_left == NULL) // no options given -- enable verbose mode
1370 options.verbose = TRUE;
1375 #if defined(PLATFORM_ANDROID)
1376 options.debug = TRUE;
1380 while (*options_left)
1382 char option_str[MAX_OPTION_LEN];
1383 char *option = options_left[0];
1384 char *next_option = options_left[1];
1385 char *option_arg = NULL;
1386 int option_len = strlen(option);
1388 if (option_len >= MAX_OPTION_LEN)
1389 FailWithHelp("unrecognized option '%s'", option);
1391 strcpy(option_str, option); // copy argument into buffer
1392 option = option_str;
1394 if (strEqual(option, "--")) // stop scanning arguments
1397 if (strPrefix(option, "--")) // treat '--' like '-'
1400 option_arg = strchr(option, '=');
1401 if (option_arg == NULL) // no '=' in option
1402 option_arg = next_option;
1405 *option_arg++ = '\0'; // cut argument from option
1406 if (*option_arg == '\0') // no argument after '='
1407 FailWithHelp("option '%s' has invalid argument", option_str);
1410 option_len = strlen(option);
1412 if (strEqual(option, "-"))
1414 FailWithHelp("unrecognized option '%s'", option);
1416 else if (strncmp(option, "-help", option_len) == 0)
1418 print_usage_function();
1422 else if (strncmp(option, "-basepath", option_len) == 0)
1424 if (option_arg == NULL)
1425 FailWithHelp("option '%s' requires an argument", option_str);
1427 options.base_directory = base_path = getStringCopy(option_arg);
1428 if (option_arg == next_option)
1431 // adjust paths for sub-directories in base directory accordingly
1432 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1433 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1434 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1435 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1436 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1437 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1439 else if (strncmp(option, "-levels", option_len) == 0)
1441 if (option_arg == NULL)
1442 FailWithHelp("option '%s' requires an argument", option_str);
1444 options.level_directory = getStringCopy(option_arg);
1445 if (option_arg == next_option)
1448 else if (strncmp(option, "-graphics", option_len) == 0)
1450 if (option_arg == NULL)
1451 FailWithHelp("option '%s' requires an argument", option_str);
1453 options.graphics_directory = getStringCopy(option_arg);
1454 if (option_arg == next_option)
1457 else if (strncmp(option, "-sounds", option_len) == 0)
1459 if (option_arg == NULL)
1460 FailWithHelp("option '%s' requires an argument", option_str);
1462 options.sounds_directory = getStringCopy(option_arg);
1463 if (option_arg == next_option)
1466 else if (strncmp(option, "-music", option_len) == 0)
1468 if (option_arg == NULL)
1469 FailWithHelp("option '%s' requires an argument", option_str);
1471 options.music_directory = getStringCopy(option_arg);
1472 if (option_arg == next_option)
1475 else if (strncmp(option, "-mytapes", option_len) == 0)
1477 options.mytapes = TRUE;
1479 else if (strncmp(option, "-network", option_len) == 0)
1481 options.network = TRUE;
1483 else if (strncmp(option, "-serveronly", option_len) == 0)
1485 options.serveronly = TRUE;
1487 else if (strncmp(option, "-debug", option_len) == 0)
1489 options.debug = TRUE;
1491 // optionally, debug output can be limited to a specific debug mode
1492 if (option_arg != next_option)
1493 options.debug_mode = getStringCopy(option_arg);
1495 else if (strncmp(option, "-player-name", option_len) == 0)
1497 if (option_arg == NULL)
1498 FailWithHelp("option '%s' requires an argument", option_str);
1500 options.player_name = getStringCopy(option_arg);
1501 if (option_arg == next_option)
1504 else if (strncmp(option, "-identifier", option_len) == 0)
1506 if (option_arg == NULL)
1507 FailWithHelp("option '%s' requires an argument", option_str);
1509 options.identifier = getStringCopy(option_arg);
1510 if (option_arg == next_option)
1513 else if (strncmp(option, "-level-nr", option_len) == 0)
1515 if (option_arg == NULL)
1516 FailWithHelp("option '%s' requires an argument", option_str);
1518 options.level_nr = getStringCopy(option_arg);
1519 if (option_arg == next_option)
1522 else if (strncmp(option, "-verbose", option_len) == 0)
1524 options.verbose = TRUE;
1526 else if (strncmp(option, "-version", option_len) == 0 ||
1527 strncmp(option, "-V", option_len) == 0)
1529 print_version_function();
1533 else if (strPrefix(option, "-D"))
1535 options.special_flags = getStringCopy(&option[2]);
1537 else if (strncmp(option, "-execute", option_len) == 0)
1539 if (option_arg == NULL)
1540 FailWithHelp("option '%s' requires an argument", option_str);
1542 options.execute_command = getStringCopy(option_arg);
1543 if (option_arg == next_option)
1546 // when doing batch processing, always enable verbose mode (warnings)
1547 options.verbose = TRUE;
1549 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1551 if (option_arg == NULL)
1552 FailWithHelp("option '%s' requires an argument", option_str);
1554 options.tape_log_filename = getStringCopy(option_arg);
1555 if (option_arg == next_option)
1558 else if (strncmp(option, "-display", option_len) == 0)
1560 if (option_arg == NULL)
1561 FailWithHelp("option '%s' requires an argument", option_str);
1563 if (option_arg == next_option)
1566 int display_nr = atoi(option_arg);
1569 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1570 options.display_nr = display_nr;
1572 options.display_nr =
1573 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1575 if (display_nr != options.display_nr)
1576 Warn("invalid display %d -- using display %d",
1577 display_nr, options.display_nr);
1580 #if defined(PLATFORM_MAC)
1581 else if (strPrefix(option, "-psn"))
1583 // ignore process serial number when launched via GUI on Mac OS X
1586 else if (*option == '-')
1588 FailWithHelp("unrecognized option '%s'", option_str);
1590 else if (options.server_host == NULL)
1592 options.server_host = *options_left;
1594 else if (options.server_port == 0)
1596 options.server_port = atoi(*options_left);
1597 if (options.server_port < 1024)
1598 FailWithHelp("bad port number '%d'", options.server_port);
1601 FailWithHelp("too many arguments");
1608 // ----------------------------------------------------------------------------
1609 // checked memory allocation and freeing functions
1610 // ----------------------------------------------------------------------------
1612 void *checked_malloc(unsigned int size)
1619 Fail("cannot allocate %d bytes -- out of memory", size);
1624 void *checked_calloc(unsigned int size)
1628 ptr = calloc(1, size);
1631 Fail("cannot allocate %d bytes -- out of memory", size);
1636 void *checked_realloc(void *ptr, unsigned int size)
1638 ptr = realloc(ptr, size);
1641 Fail("cannot allocate %d bytes -- out of memory", size);
1646 void checked_free(void *ptr)
1648 if (ptr != NULL) // this check should be done by free() anyway
1652 void clear_mem(void *ptr, unsigned int size)
1654 #if defined(PLATFORM_WINDOWS)
1655 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1656 char *cptr = (char *)ptr;
1661 memset(ptr, 0, size);
1666 // ----------------------------------------------------------------------------
1667 // various helper functions
1668 // ----------------------------------------------------------------------------
1670 void swap_numbers(int *i1, int *i2)
1678 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1690 int get_number_of_bits(int bits)
1693 Counting bits set, Brian Kernighan's way
1695 Brian Kernighan's method goes through as many iterations as there are set
1696 bits. So if we have a 32-bit word with only the high bit set, then it will
1697 only go once through the loop.
1699 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1700 and Dennis M. Ritchie) mentions this in exercise 2-9.
1701 First published by Peter Wegner in CACM 3 (1960), 322.
1708 bits &= bits - 1; // clear the least significant bit set
1715 /* the "put" variants of the following file access functions check for the file
1716 pointer being != NULL and return the number of bytes they have or would have
1717 written; this allows for chunk writing functions to first determine the size
1718 of the (not yet written) chunk, write the correct chunk size and finally
1719 write the chunk itself */
1721 int getFile8BitInteger(File *file)
1723 return getByteFromFile(file);
1726 int putFile8BitInteger(FILE *file, int value)
1734 int getFile16BitInteger(File *file, int byte_order)
1736 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1737 return ((getByteFromFile(file) << 8) |
1738 (getByteFromFile(file) << 0));
1739 else // BYTE_ORDER_LITTLE_ENDIAN
1740 return ((getByteFromFile(file) << 0) |
1741 (getByteFromFile(file) << 8));
1744 int putFile16BitInteger(FILE *file, int value, int byte_order)
1748 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1750 fputc((value >> 8) & 0xff, file);
1751 fputc((value >> 0) & 0xff, file);
1753 else // BYTE_ORDER_LITTLE_ENDIAN
1755 fputc((value >> 0) & 0xff, file);
1756 fputc((value >> 8) & 0xff, file);
1763 int getFile32BitInteger(File *file, int byte_order)
1765 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1766 return ((getByteFromFile(file) << 24) |
1767 (getByteFromFile(file) << 16) |
1768 (getByteFromFile(file) << 8) |
1769 (getByteFromFile(file) << 0));
1770 else // BYTE_ORDER_LITTLE_ENDIAN
1771 return ((getByteFromFile(file) << 0) |
1772 (getByteFromFile(file) << 8) |
1773 (getByteFromFile(file) << 16) |
1774 (getByteFromFile(file) << 24));
1777 int putFile32BitInteger(FILE *file, int value, int byte_order)
1781 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1783 fputc((value >> 24) & 0xff, file);
1784 fputc((value >> 16) & 0xff, file);
1785 fputc((value >> 8) & 0xff, file);
1786 fputc((value >> 0) & 0xff, file);
1788 else // BYTE_ORDER_LITTLE_ENDIAN
1790 fputc((value >> 0) & 0xff, file);
1791 fputc((value >> 8) & 0xff, file);
1792 fputc((value >> 16) & 0xff, file);
1793 fputc((value >> 24) & 0xff, file);
1800 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1803 const int chunk_name_length = 4;
1806 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1809 if (chunk_size != NULL)
1812 *chunk_size = getFile32BitInteger(file, byte_order);
1815 return (checkEndOfFile(file) ? FALSE : TRUE);
1818 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1825 fputs(chunk_name, file);
1827 num_bytes += strlen(chunk_name);
1829 if (chunk_size >= 0)
1833 putFile32BitInteger(file, chunk_size, byte_order);
1841 int getFileVersion(File *file)
1843 int version_super = getByteFromFile(file);
1844 int version_major = getByteFromFile(file);
1845 int version_minor = getByteFromFile(file);
1846 int version_patch = getByteFromFile(file);
1848 return VERSION_IDENT(version_super, version_major, version_minor,
1852 int putFileVersion(FILE *file, int version)
1856 int version_super = VERSION_SUPER(version);
1857 int version_major = VERSION_MAJOR(version);
1858 int version_minor = VERSION_MINOR(version);
1859 int version_patch = VERSION_PATCH(version);
1861 fputc(version_super, file);
1862 fputc(version_major, file);
1863 fputc(version_minor, file);
1864 fputc(version_patch, file);
1870 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1874 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1875 buffer[i] = getByteFromFile(file);
1878 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1882 for (i = 0; i < bytes; i++)
1883 fputc(buffer[i], file);
1886 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1888 while (bytes-- && !checkEndOfFile(file))
1889 getByteFromFile(file);
1892 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1899 // ----------------------------------------------------------------------------
1900 // functions to convert between ISO-8859-1 and UTF-8
1901 // ----------------------------------------------------------------------------
1903 char *getUTF8FromLatin1(char *latin1)
1905 int max_utf8_size = 2 * strlen(latin1) + 1;
1906 char *utf8 = checked_calloc(max_utf8_size);
1907 unsigned char *src = (unsigned char *)latin1;
1908 unsigned char *dst = (unsigned char *)utf8;
1912 if (*src < 128) // pure 7-bit ASCII
1916 else if (*src >= 160) // non-ASCII characters
1918 *dst++ = 194 + (*src >= 192);
1919 *dst++ = 128 + (*src & 63);
1921 else // undefined in ISO-8859-1
1929 // only use the smallest possible string buffer size
1930 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1935 char *getLatin1FromUTF8(char *utf8)
1937 int max_latin1_size = strlen(utf8) + 1;
1938 char *latin1 = checked_calloc(max_latin1_size);
1939 unsigned char *src = (unsigned char *)utf8;
1940 unsigned char *dst = (unsigned char *)latin1;
1944 if (*src < 128) // pure 7-bit ASCII
1948 else if (src[0] == 194 &&
1949 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1954 else if (src[0] == 195 &&
1955 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1957 *dst++ = src[1] + 64;
1961 // all other UTF-8 characters are undefined in ISO-8859-1
1963 else if (src[0] >= 192 && src[0] < 224 &&
1964 src[1] >= 128 && src[1] < 192)
1969 else if (src[0] >= 224 && src[0] < 240 &&
1970 src[1] >= 128 && src[1] < 192 &&
1971 src[2] >= 128 && src[2] < 192)
1976 else if (src[0] >= 240 && src[0] < 248 &&
1977 src[1] >= 128 && src[1] < 192 &&
1978 src[2] >= 128 && src[2] < 192 &&
1979 src[3] >= 128 && src[3] < 192)
1984 else if (src[0] >= 248 && src[0] < 252 &&
1985 src[1] >= 128 && src[1] < 192 &&
1986 src[2] >= 128 && src[2] < 192 &&
1987 src[3] >= 128 && src[3] < 192 &&
1988 src[4] >= 128 && src[4] < 192)
1993 else if (src[0] >= 252 && src[0] < 254 &&
1994 src[1] >= 128 && src[1] < 192 &&
1995 src[2] >= 128 && src[2] < 192 &&
1996 src[3] >= 128 && src[3] < 192 &&
1997 src[4] >= 128 && src[4] < 192 &&
1998 src[5] >= 128 && src[5] < 192)
2010 // only use the smallest possible string buffer size
2011 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2016 int getTextEncoding(char *text)
2018 unsigned char *src = (unsigned char *)text;
2019 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2024 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2030 else if (src[0] >= 192 && src[0] < 224 &&
2031 src[1] >= 128 && src[1] < 192)
2035 else if (src[0] >= 224 && src[0] < 240 &&
2036 src[1] >= 128 && src[1] < 192 &&
2037 src[2] >= 128 && src[2] < 192)
2041 else if (src[0] >= 240 && src[0] < 248 &&
2042 src[1] >= 128 && src[1] < 192 &&
2043 src[2] >= 128 && src[2] < 192 &&
2044 src[3] >= 128 && src[3] < 192)
2048 else if (src[0] >= 248 && src[0] < 252 &&
2049 src[1] >= 128 && src[1] < 192 &&
2050 src[2] >= 128 && src[2] < 192 &&
2051 src[3] >= 128 && src[3] < 192 &&
2052 src[4] >= 128 && src[4] < 192)
2056 else if (src[0] >= 252 && src[0] < 254 &&
2057 src[1] >= 128 && src[1] < 192 &&
2058 src[2] >= 128 && src[2] < 192 &&
2059 src[3] >= 128 && src[3] < 192 &&
2060 src[4] >= 128 && src[4] < 192 &&
2061 src[5] >= 128 && src[5] < 192)
2067 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2075 // ----------------------------------------------------------------------------
2076 // functions for JSON handling
2077 // ----------------------------------------------------------------------------
2079 char *getEscapedJSON(char *s)
2081 int max_json_size = 2 * strlen(s) + 1;
2082 char *json = checked_calloc(max_json_size);
2083 unsigned char *src = (unsigned char *)s;
2084 unsigned char *dst = (unsigned char *)json;
2085 char *escaped[256] =
2098 if (escaped[*src] != NULL)
2100 char *esc = escaped[*src++];
2111 // only use the smallest possible string buffer size
2112 json = checked_realloc(json, strlen(json) + 1);
2118 // ----------------------------------------------------------------------------
2119 // functions to translate key identifiers between different format
2120 // ----------------------------------------------------------------------------
2122 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2123 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2124 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2125 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2127 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2136 // return and escape keys
2137 { KSYM_Return, "XK_Return", "return" },
2138 { KSYM_Escape, "XK_Escape", "escape" },
2140 // normal cursor keys
2141 { KSYM_Left, "XK_Left", "cursor left" },
2142 { KSYM_Right, "XK_Right", "cursor right" },
2143 { KSYM_Up, "XK_Up", "cursor up" },
2144 { KSYM_Down, "XK_Down", "cursor down" },
2146 // keypad cursor keys
2148 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2149 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2150 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2151 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2154 // other keypad keys
2155 #ifdef KSYM_KP_Enter
2156 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2157 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2158 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2159 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2160 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2161 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2165 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2166 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2167 { KSYM_Control_L, "XK_Control_L", "left control" },
2168 { KSYM_Control_R, "XK_Control_R", "right control" },
2169 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2170 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2171 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2172 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2173 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2174 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2176 // some special keys
2177 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2178 { KSYM_Delete, "XK_Delete", "delete" },
2179 { KSYM_Insert, "XK_Insert", "insert" },
2180 { KSYM_Tab, "XK_Tab", "tab" },
2181 { KSYM_Home, "XK_Home", "home" },
2182 { KSYM_End, "XK_End", "end" },
2183 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2184 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2186 { KSYM_Select, "XK_Select", "select" },
2187 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2188 { KSYM_Back, "XK_Back", "back" }, // back key
2189 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2190 #if defined(PLATFORM_ANDROID)
2191 { KSYM_Rewind, "XK_Rewind", "rewind" },
2192 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2195 // ASCII 0x20 to 0x40 keys (except numbers)
2196 { KSYM_space, "XK_space", "space" },
2197 { KSYM_exclam, "XK_exclam", "!" },
2198 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2199 { KSYM_numbersign, "XK_numbersign", "#" },
2200 { KSYM_dollar, "XK_dollar", "$" },
2201 { KSYM_percent, "XK_percent", "%" },
2202 { KSYM_ampersand, "XK_ampersand", "&" },
2203 { KSYM_apostrophe, "XK_apostrophe", "'" },
2204 { KSYM_parenleft, "XK_parenleft", "(" },
2205 { KSYM_parenright, "XK_parenright", ")" },
2206 { KSYM_asterisk, "XK_asterisk", "*" },
2207 { KSYM_plus, "XK_plus", "+" },
2208 { KSYM_comma, "XK_comma", "," },
2209 { KSYM_minus, "XK_minus", "-" },
2210 { KSYM_period, "XK_period", "." },
2211 { KSYM_slash, "XK_slash", "/" },
2212 { KSYM_colon, "XK_colon", ":" },
2213 { KSYM_semicolon, "XK_semicolon", ";" },
2214 { KSYM_less, "XK_less", "<" },
2215 { KSYM_equal, "XK_equal", "=" },
2216 { KSYM_greater, "XK_greater", ">" },
2217 { KSYM_question, "XK_question", "?" },
2218 { KSYM_at, "XK_at", "@" },
2221 { KSYM_bracketleft, "XK_bracketleft", "[" },
2222 { KSYM_backslash, "XK_backslash", "\\" },
2223 { KSYM_bracketright,"XK_bracketright", "]" },
2224 { KSYM_asciicircum, "XK_asciicircum", "^" },
2225 { KSYM_underscore, "XK_underscore", "_" },
2226 { KSYM_grave, "XK_grave", "grave" },
2227 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2228 { KSYM_braceleft, "XK_braceleft", "brace left" },
2229 { KSYM_bar, "XK_bar", "bar" },
2230 { KSYM_braceright, "XK_braceright", "brace right" },
2231 { KSYM_asciitilde, "XK_asciitilde", "~" },
2233 // special (non-ASCII) keys
2234 { KSYM_degree, "XK_degree", "degree" },
2235 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2236 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2237 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2238 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2239 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2240 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2241 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2243 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2244 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2245 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2246 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2247 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2248 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2249 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2250 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2251 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2253 // other keys (for reverse mapping only)
2254 { KSYM_space, "XK_space", " " },
2256 // keypad keys are not in numerical order in SDL2
2257 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2258 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2259 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2260 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2261 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2262 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2263 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2264 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2265 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2266 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2268 // end-of-array identifier
2274 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2276 static char name_buffer[30];
2279 if (key >= KSYM_A && key <= KSYM_Z)
2280 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2281 else if (key >= KSYM_a && key <= KSYM_z)
2282 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2283 else if (key >= KSYM_0 && key <= KSYM_9)
2284 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2285 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2286 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2287 else if (key == KSYM_UNDEFINED)
2288 strcpy(name_buffer, "(undefined)");
2295 if (key == translate_key[i].key)
2297 strcpy(name_buffer, translate_key[i].name);
2301 while (translate_key[++i].name);
2303 if (!translate_key[i].name)
2304 strcpy(name_buffer, "(unknown)");
2307 *name = name_buffer;
2309 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2311 static char name_buffer[30];
2314 if (key >= KSYM_A && key <= KSYM_Z)
2315 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2316 else if (key >= KSYM_a && key <= KSYM_z)
2317 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2318 else if (key >= KSYM_0 && key <= KSYM_9)
2319 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2320 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2321 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2322 else if (key == KSYM_UNDEFINED)
2323 strcpy(name_buffer, "[undefined]");
2330 if (key == translate_key[i].key)
2332 strcpy(name_buffer, translate_key[i].x11name);
2336 while (translate_key[++i].x11name);
2338 if (!translate_key[i].x11name)
2339 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2342 *x11name = name_buffer;
2344 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2346 Key key = KSYM_UNDEFINED;
2347 char *name_ptr = *name;
2349 if (strlen(*name) == 1)
2351 char c = name_ptr[0];
2353 if (c >= 'A' && c <= 'Z')
2354 key = KSYM_A + (Key)(c - 'A');
2355 else if (c >= 'a' && c <= 'z')
2356 key = KSYM_a + (Key)(c - 'a');
2357 else if (c >= '0' && c <= '9')
2358 key = KSYM_0 + (Key)(c - '0');
2361 if (key == KSYM_UNDEFINED)
2367 if (strEqual(translate_key[i].name, *name))
2369 key = translate_key[i].key;
2373 while (translate_key[++i].x11name);
2376 if (key == KSYM_UNDEFINED)
2377 Warn("getKeyFromKeyName(): not completely implemented");
2381 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2383 Key key = KSYM_UNDEFINED;
2384 char *name_ptr = *x11name;
2386 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2388 char c = name_ptr[3];
2390 if (c >= 'A' && c <= 'Z')
2391 key = KSYM_A + (Key)(c - 'A');
2392 else if (c >= 'a' && c <= 'z')
2393 key = KSYM_a + (Key)(c - 'a');
2394 else if (c >= '0' && c <= '9')
2395 key = KSYM_0 + (Key)(c - '0');
2397 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2399 char c1 = name_ptr[4];
2400 char c2 = name_ptr[5];
2403 if ((c1 >= '0' && c1 <= '9') &&
2404 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2405 d = atoi(&name_ptr[4]);
2407 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2408 key = KSYM_F1 + (Key)(d - 1);
2410 else if (strPrefix(name_ptr, "XK_"))
2416 if (strEqual(name_ptr, translate_key[i].x11name))
2418 key = translate_key[i].key;
2422 while (translate_key[++i].x11name);
2424 else if (strPrefix(name_ptr, "0x"))
2426 unsigned int value = 0;
2432 char c = *name_ptr++;
2435 if (c >= '0' && c <= '9')
2437 else if (c >= 'a' && c <= 'f')
2438 d = (int)(c - 'a' + 10);
2439 else if (c >= 'A' && c <= 'F')
2440 d = (int)(c - 'A' + 10);
2448 value = value * 16 + d;
2459 char *getKeyNameFromKey(Key key)
2463 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2467 char *getX11KeyNameFromKey(Key key)
2471 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2475 Key getKeyFromKeyName(char *name)
2479 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2483 Key getKeyFromX11KeyName(char *x11name)
2487 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2491 char getCharFromKey(Key key)
2497 } translate_key_char[] =
2499 // special (non-ASCII) keys (ISO-8859-1)
2500 { KSYM_degree, CHAR_BYTE_DEGREE },
2501 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2502 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2503 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2504 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2505 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2506 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2507 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2509 // end-of-array identifier
2513 char *keyname = getKeyNameFromKey(key);
2516 if (strlen(keyname) == 1)
2518 else if (strEqual(keyname, "space"))
2526 if (key == translate_key_char[i].key)
2528 c = translate_key_char[i].key_char;
2533 while (translate_key_char[++i].key_char);
2539 char getValidConfigValueChar(char c)
2541 if (c == '#' || // used to mark comments
2542 c == '\\') // used to mark continued lines
2549 // ----------------------------------------------------------------------------
2550 // functions to translate string identifiers to integer or boolean value
2551 // ----------------------------------------------------------------------------
2553 int get_integer_from_string(char *s)
2555 // check for the most common case first
2556 if (s[0] >= '0' && s[0] <= '9')
2559 char *s_lower = getStringToLower(s);
2562 if (strEqual(s_lower, "false") ||
2563 strEqual(s_lower, "no") ||
2564 strEqual(s_lower, "off"))
2566 else if (strEqual(s_lower, "true") ||
2567 strEqual(s_lower, "yes") ||
2568 strEqual(s_lower, "on"))
2578 boolean get_boolean_from_string(char *s)
2580 char *s_lower = getStringToLower(s);
2581 boolean result = FALSE;
2583 if (strEqual(s_lower, "true") ||
2584 strEqual(s_lower, "yes") ||
2585 strEqual(s_lower, "on") ||
2586 get_integer_from_string(s) == 1)
2594 int get_switch3_from_string(char *s)
2596 char *s_lower = getStringToLower(s);
2599 if (strEqual(s_lower, "true") ||
2600 strEqual(s_lower, "yes") ||
2601 strEqual(s_lower, "on") ||
2602 get_integer_from_string(s) == 1)
2604 else if (strEqual(s_lower, "auto"))
2612 int get_player_nr_from_string(char *s)
2614 static char *player_text[] =
2624 char *s_lower = getStringToLower(s);
2628 for (i = 0; player_text[i] != NULL; i++)
2629 if (strEqual(s_lower, player_text[i]))
2638 // ----------------------------------------------------------------------------
2639 // functions for generic lists
2640 // ----------------------------------------------------------------------------
2642 ListNode *newListNode(void)
2644 return checked_calloc(sizeof(ListNode));
2647 void addNodeToList(ListNode **node_first, char *key, void *content)
2649 ListNode *node_new = newListNode();
2651 node_new->key = getStringCopy(key);
2652 node_new->content = content;
2653 node_new->next = *node_first;
2656 (*node_first)->prev = node_new;
2658 *node_first = node_new;
2661 void deleteNodeFromList(ListNode **node_first, char *key,
2662 void (*destructor_function)(void *))
2664 if (node_first == NULL || *node_first == NULL)
2667 if (strEqual((*node_first)->key, key))
2669 // after first recursion, (*node_first)->prev->next == *node_first,
2670 // so *node_first would be overwritten with (*node_first)->next
2671 // => use a copy of *node_first (and later of (*node_first)->next)
2672 ListNode *node = *node_first;
2673 ListNode *node_next = node->next;
2675 checked_free(node->key);
2677 if (destructor_function)
2678 destructor_function(node->content);
2681 node->prev->next = node->next;
2684 node->next->prev = node->prev;
2688 // after removing node, set list pointer to next valid list node
2689 // (this is important if the first node of the list was deleted)
2690 *node_first = node_next;
2694 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2698 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2700 if (node_first == NULL)
2703 if (strEqual(node_first->key, key))
2706 return getNodeFromKey(node_first->next, key);
2709 int getNumNodes(ListNode *node_first)
2711 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2715 static void dumpList(ListNode *node_first)
2717 ListNode *node = node_first;
2721 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2722 ((struct ListNodeInfo *)node->content)->num_references);
2726 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2731 // ----------------------------------------------------------------------------
2732 // functions for file handling
2733 // ----------------------------------------------------------------------------
2735 #define MAX_BUFFER_SIZE 4096
2737 File *openFile(char *filename, char *mode)
2739 File *file = checked_calloc(sizeof(File));
2741 file->file = fopen(filename, mode);
2743 if (file->file != NULL)
2745 file->filename = getStringCopy(filename);
2750 #if defined(PLATFORM_ANDROID)
2751 file->asset_file = SDL_RWFromFile(filename, mode);
2753 if (file->asset_file != NULL)
2755 file->file_is_asset = TRUE;
2756 file->filename = getStringCopy(filename);
2767 int closeFile(File *file)
2774 #if defined(PLATFORM_ANDROID)
2775 if (file->asset_file)
2776 result = SDL_RWclose(file->asset_file);
2780 result = fclose(file->file);
2782 checked_free(file->filename);
2788 int checkEndOfFile(File *file)
2790 #if defined(PLATFORM_ANDROID)
2791 if (file->file_is_asset)
2792 return file->end_of_file;
2795 return feof(file->file);
2798 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2800 #if defined(PLATFORM_ANDROID)
2801 if (file->file_is_asset)
2803 if (file->end_of_file)
2806 size_t num_items_read =
2807 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2809 if (num_items_read < num_items)
2810 file->end_of_file = TRUE;
2812 return num_items_read;
2816 return fread(buffer, item_size, num_items, file->file);
2819 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2821 return fwrite(buffer, item_size, num_items, file->file);
2824 int seekFile(File *file, long offset, int whence)
2826 #if defined(PLATFORM_ANDROID)
2827 if (file->file_is_asset)
2829 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2830 whence == SEEK_CUR ? RW_SEEK_CUR :
2831 whence == SEEK_END ? RW_SEEK_END : 0);
2833 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2837 return fseek(file->file, offset, whence);
2840 int getByteFromFile(File *file)
2842 #if defined(PLATFORM_ANDROID)
2843 if (file->file_is_asset)
2845 if (file->end_of_file)
2849 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2851 if (num_bytes_read < 1)
2852 file->end_of_file = TRUE;
2854 return (file->end_of_file ? EOF : (int)c);
2858 return fgetc(file->file);
2861 char *getStringFromFile(File *file, char *line, int size)
2863 #if defined(PLATFORM_ANDROID)
2864 if (file->file_is_asset)
2866 if (file->end_of_file)
2869 char *line_ptr = line;
2870 int num_bytes_read = 0;
2872 while (num_bytes_read < size - 1 &&
2873 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2874 *line_ptr++ != '\n')
2879 if (strlen(line) == 0)
2881 file->end_of_file = TRUE;
2890 return fgets(line, size, file->file);
2893 int copyFile(char *filename_from, char *filename_to)
2895 File *file_from, *file_to;
2897 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2902 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2904 closeFile(file_from);
2909 while (!checkEndOfFile(file_from))
2911 byte buffer[MAX_BUFFER_SIZE];
2912 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2914 writeFile(file_to, buffer, 1, bytes_read);
2917 closeFile(file_from);
2923 boolean touchFile(char *filename)
2927 if (!(file = fopen(filename, MODE_WRITE)))
2929 Warn("cannot touch file '%s'", filename);
2940 // ----------------------------------------------------------------------------
2941 // functions for directory handling
2942 // ----------------------------------------------------------------------------
2944 Directory *openDirectory(char *dir_name)
2946 Directory *dir = checked_calloc(sizeof(Directory));
2948 dir->dir = opendir(dir_name);
2950 if (dir->dir != NULL)
2952 dir->filename = getStringCopy(dir_name);
2957 #if defined(PLATFORM_ANDROID)
2958 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2960 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2962 checked_free(asset_toc_filename);
2964 if (dir->asset_toc_file != NULL)
2966 dir->directory_is_asset = TRUE;
2967 dir->filename = getStringCopy(dir_name);
2978 int closeDirectory(Directory *dir)
2985 #if defined(PLATFORM_ANDROID)
2986 if (dir->asset_toc_file)
2987 result = SDL_RWclose(dir->asset_toc_file);
2991 result = closedir(dir->dir);
2994 freeDirectoryEntry(dir->dir_entry);
2996 checked_free(dir->filename);
3002 DirectoryEntry *readDirectory(Directory *dir)
3005 freeDirectoryEntry(dir->dir_entry);
3007 dir->dir_entry = NULL;
3009 #if defined(PLATFORM_ANDROID)
3010 if (dir->directory_is_asset)
3012 char line[MAX_LINE_LEN];
3013 char *line_ptr = line;
3014 int num_bytes_read = 0;
3016 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3017 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3026 if (strlen(line) == 0)
3029 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3031 dir->dir_entry->is_directory = FALSE;
3032 if (line[strlen(line) - 1] == '/')
3034 dir->dir_entry->is_directory = TRUE;
3036 line[strlen(line) - 1] = '\0';
3039 dir->dir_entry->basename = getStringCopy(line);
3040 dir->dir_entry->filename = getPath2(dir->filename, line);
3042 return dir->dir_entry;
3046 struct dirent *dir_entry = readdir(dir->dir);
3048 if (dir_entry == NULL)
3051 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3053 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3054 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3056 struct stat file_status;
3058 dir->dir_entry->is_directory =
3059 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3060 S_ISDIR(file_status.st_mode));
3062 return dir->dir_entry;
3065 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3067 if (dir_entry == NULL)
3070 checked_free(dir_entry->basename);
3071 checked_free(dir_entry->filename);
3072 checked_free(dir_entry);
3076 // ----------------------------------------------------------------------------
3077 // functions for checking files and filenames
3078 // ----------------------------------------------------------------------------
3080 boolean directoryExists(const char *dir_name)
3082 if (dir_name == NULL)
3085 struct stat file_status;
3086 boolean success = (stat(dir_name, &file_status) == 0 &&
3087 S_ISDIR(file_status.st_mode));
3089 #if defined(PLATFORM_ANDROID)
3092 // this might be an asset directory; check by trying to open toc file
3093 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3094 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3096 checked_free(asset_toc_filename);
3098 success = (file != NULL);
3108 boolean fileExists(const char *filename)
3110 if (filename == NULL)
3113 boolean success = (access(filename, F_OK) == 0);
3115 #if defined(PLATFORM_ANDROID)
3118 // this might be an asset file; check by trying to open it
3119 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3121 success = (file != NULL);
3132 static boolean fileHasPrefix(const char *basename, const char *prefix)
3134 static char *basename_lower = NULL;
3135 int basename_length, prefix_length;
3137 checked_free(basename_lower);
3139 if (basename == NULL || prefix == NULL)
3142 basename_lower = getStringToLower(basename);
3143 basename_length = strlen(basename_lower);
3144 prefix_length = strlen(prefix);
3146 if (basename_length > prefix_length + 1 &&
3147 basename_lower[prefix_length] == '.' &&
3148 strncmp(basename_lower, prefix, prefix_length) == 0)
3155 static boolean fileHasSuffix(const char *basename, const char *suffix)
3157 static char *basename_lower = NULL;
3158 int basename_length, suffix_length;
3160 checked_free(basename_lower);
3162 if (basename == NULL || suffix == NULL)
3165 basename_lower = getStringToLower(basename);
3166 basename_length = strlen(basename_lower);
3167 suffix_length = strlen(suffix);
3169 if (basename_length > suffix_length + 1 &&
3170 basename_lower[basename_length - suffix_length - 1] == '.' &&
3171 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3177 static boolean FileCouldBeArtwork(char *filename)
3179 char *basename = getBaseNamePtr(filename);
3181 return (!strEqual(basename, ".") &&
3182 !strEqual(basename, "..") &&
3183 !fileHasSuffix(basename, "txt") &&
3184 !fileHasSuffix(basename, "conf") &&
3185 !directoryExists(filename));
3188 boolean FileIsGraphic(char *filename)
3190 return FileCouldBeArtwork(filename);
3193 boolean FileIsSound(char *filename)
3195 return FileCouldBeArtwork(filename);
3198 boolean FileIsMusic(char *filename)
3200 return FileCouldBeArtwork(filename);
3203 boolean FileIsArtworkType(char *filename, int type)
3205 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3206 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3207 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3213 // ----------------------------------------------------------------------------
3214 // functions for loading artwork configuration information
3215 // ----------------------------------------------------------------------------
3217 char *get_mapped_token(char *token)
3219 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3220 static char *map_token_prefix[][2] =
3222 { "char_procent", "char_percent" },
3223 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3224 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3225 { "bd_butterfly_left", "bd_butterfly.left" },
3226 { "bd_butterfly_right", "bd_butterfly.right" },
3227 { "bd_butterfly_up", "bd_butterfly.up" },
3228 { "bd_butterfly_down", "bd_butterfly.down" },
3229 { "bd_firefly_left", "bd_firefly.left" },
3230 { "bd_firefly_right", "bd_firefly.right" },
3231 { "bd_firefly_up", "bd_firefly.up" },
3232 { "bd_firefly_down", "bd_firefly.down" },
3238 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3240 int len_token_prefix = strlen(map_token_prefix[i][0]);
3242 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3243 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3246 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3247 char *gfx_substring = ".gfx";
3248 char *gfx_prefix = "gfx.";
3249 if (strstr(token, gfx_substring) != NULL)
3251 char *token_prefix = getStringCopy(token);
3252 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3253 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3256 // cut off token string at ".gfx" substring position
3257 *token_gfx_pos = '\0';
3259 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3260 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3264 return mapped_token;
3270 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3273 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3274 static struct ConfigTypeInfo prefix_list[] =
3276 { "global.anim_1" },
3277 { "global.anim_2" },
3278 { "global.anim_3" },
3279 { "global.anim_4" },
3280 { "global.anim_5" },
3281 { "global.anim_6" },
3282 { "global.anim_7" },
3283 { "global.anim_8" },
3284 { "global.anim_9" },
3285 { "global.anim_10" },
3286 { "global.anim_11" },
3287 { "global.anim_12" },
3288 { "global.anim_13" },
3289 { "global.anim_14" },
3290 { "global.anim_15" },
3291 { "global.anim_16" },
3292 { "global.anim_17" },
3293 { "global.anim_18" },
3294 { "global.anim_19" },
3295 { "global.anim_20" },
3296 { "global.anim_21" },
3297 { "global.anim_22" },
3298 { "global.anim_23" },
3299 { "global.anim_24" },
3300 { "global.anim_25" },
3301 { "global.anim_26" },
3302 { "global.anim_27" },
3303 { "global.anim_28" },
3304 { "global.anim_29" },
3305 { "global.anim_30" },
3306 { "global.anim_31" },
3307 { "global.anim_32" },
3311 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3312 boolean prefix_found = FALSE;
3316 // search for prefix to check if base token has to be created
3317 for (i = 0; prefix_list[i].token != NULL; i++)
3318 if (strPrefix(token, prefix_list[i].token))
3319 prefix_found = TRUE;
3324 // search for suffix (parameter) to determine base token length
3325 for (i = 0; suffix_list[i].token != NULL; i++)
3326 if (strSuffix(token, suffix_list[i].token))
3327 len_suffix = strlen(suffix_list[i].token);
3329 return getStringCopyN(token, strlen(token) - len_suffix);
3332 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3333 struct ListNodeInfo ***, int *);
3335 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3336 struct ConfigTypeInfo *suffix_list,
3337 char **ignore_tokens,
3338 int num_file_list_entries)
3340 SetupFileHash *ignore_tokens_hash;
3341 struct FileInfo *file_list;
3342 int num_file_list_entries_found = 0;
3343 int num_suffix_list_entries = 0;
3347 // create hash from list of tokens to be ignored (for quick access)
3348 ignore_tokens_hash = newSetupFileHash();
3349 for (i = 0; ignore_tokens[i] != NULL; i++)
3350 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3352 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3354 for (i = 0; suffix_list[i].token != NULL; i++)
3355 num_suffix_list_entries++;
3357 // always start with reliable default values
3358 for (i = 0; i < num_file_list_entries; i++)
3360 file_list[i].token = NULL;
3362 file_list[i].default_filename = NULL;
3363 file_list[i].filename = NULL;
3365 if (num_suffix_list_entries > 0)
3367 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3369 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3370 file_list[i].parameter = checked_calloc(parameter_array_size);
3372 for (j = 0; j < num_suffix_list_entries; j++)
3374 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3375 setString(&file_list[i].parameter[j], suffix_list[j].value);
3378 file_list[i].redefined = FALSE;
3379 file_list[i].fallback_to_default = FALSE;
3380 file_list[i].default_is_cloned = FALSE;
3386 for (i = 0; config_list[i].token != NULL; i++)
3388 int len_config_token = strlen(config_list[i].token);
3389 boolean is_file_entry = TRUE;
3391 for (j = 0; suffix_list[j].token != NULL; j++)
3393 int len_suffix = strlen(suffix_list[j].token);
3395 if (len_suffix < len_config_token &&
3396 strEqual(&config_list[i].token[len_config_token - len_suffix],
3397 suffix_list[j].token))
3399 setString(&file_list[list_pos].default_parameter[j],
3400 config_list[i].value);
3402 is_file_entry = FALSE;
3408 // the following tokens are no file definitions, but other config tokens
3409 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3410 is_file_entry = FALSE;
3417 if (list_pos >= num_file_list_entries)
3420 file_list[list_pos].token = config_list[i].token;
3421 file_list[list_pos].default_filename = config_list[i].value;
3424 if (strSuffix(config_list[i].token, ".clone_from"))
3425 file_list[list_pos].default_is_cloned = TRUE;
3428 num_file_list_entries_found = list_pos + 1;
3429 if (num_file_list_entries_found != num_file_list_entries)
3432 Error("inconsistant config list information:");
3433 Error("- should be: %d (according to 'src/conf_xxx.h')",
3434 num_file_list_entries);
3435 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3436 num_file_list_entries_found);
3441 freeSetupFileHash(ignore_tokens_hash);
3446 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3448 int len_token = strlen(token);
3449 int len_suffix = strlen(suffix);
3451 if (start_pos < 0) // compare suffix from end of string
3452 start_pos += len_token;
3454 if (start_pos < 0 || start_pos + len_suffix > len_token)
3457 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3460 if (token[start_pos + len_suffix] == '\0')
3463 if (token[start_pos + len_suffix] == '.')
3469 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3471 static void read_token_parameters(SetupFileHash *setup_file_hash,
3472 struct ConfigTypeInfo *suffix_list,
3473 struct FileInfo *file_list_entry)
3475 // check for config token that is the base token without any suffixes
3476 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3477 char *known_token_value = KNOWN_TOKEN_VALUE;
3480 if (filename != NULL)
3482 setString(&file_list_entry->filename, filename);
3484 // when file definition found, set all parameters to default values
3485 for (i = 0; suffix_list[i].token != NULL; i++)
3486 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3488 file_list_entry->redefined = TRUE;
3490 // mark config file token as well known from default config
3491 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3494 // check for config tokens that can be build by base token and suffixes
3495 for (i = 0; suffix_list[i].token != NULL; i++)
3497 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3498 char *value = getHashEntry(setup_file_hash, token);
3502 setString(&file_list_entry->parameter[i], value);
3504 // mark config file token as well known from default config
3505 setHashEntry(setup_file_hash, token, known_token_value);
3512 static void add_dynamic_file_list_entry(struct FileInfo **list,
3513 int *num_list_entries,
3514 SetupFileHash *extra_file_hash,
3515 struct ConfigTypeInfo *suffix_list,
3516 int num_suffix_list_entries,
3519 struct FileInfo *new_list_entry;
3520 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3522 (*num_list_entries)++;
3523 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3524 new_list_entry = &(*list)[*num_list_entries - 1];
3526 new_list_entry->token = getStringCopy(token);
3527 new_list_entry->default_filename = NULL;
3528 new_list_entry->filename = NULL;
3529 new_list_entry->parameter = checked_calloc(parameter_array_size);
3531 new_list_entry->redefined = FALSE;
3532 new_list_entry->fallback_to_default = FALSE;
3533 new_list_entry->default_is_cloned = FALSE;
3535 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3538 static void add_property_mapping(struct PropertyMapping **list,
3539 int *num_list_entries,
3540 int base_index, int ext1_index,
3541 int ext2_index, int ext3_index,
3544 struct PropertyMapping *new_list_entry;
3546 (*num_list_entries)++;
3547 *list = checked_realloc(*list,
3548 *num_list_entries * sizeof(struct PropertyMapping));
3549 new_list_entry = &(*list)[*num_list_entries - 1];
3551 new_list_entry->base_index = base_index;
3552 new_list_entry->ext1_index = ext1_index;
3553 new_list_entry->ext2_index = ext2_index;
3554 new_list_entry->ext3_index = ext3_index;
3556 new_list_entry->artwork_index = artwork_index;
3559 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3562 struct FileInfo *file_list = artwork_info->file_list;
3563 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3564 char **base_prefixes = artwork_info->base_prefixes;
3565 char **ext1_suffixes = artwork_info->ext1_suffixes;
3566 char **ext2_suffixes = artwork_info->ext2_suffixes;
3567 char **ext3_suffixes = artwork_info->ext3_suffixes;
3568 char **ignore_tokens = artwork_info->ignore_tokens;
3569 int num_file_list_entries = artwork_info->num_file_list_entries;
3570 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3571 int num_base_prefixes = artwork_info->num_base_prefixes;
3572 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3573 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3574 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3575 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3576 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3577 SetupFileHash *extra_file_hash, *empty_file_hash;
3578 char *known_token_value = KNOWN_TOKEN_VALUE;
3579 char *base_token_value = UNDEFINED_FILENAME;
3582 if (filename == NULL)
3585 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3588 // separate valid (defined) from empty (undefined) config token values
3589 valid_file_hash = newSetupFileHash();
3590 empty_file_hash = newSetupFileHash();
3591 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3593 char *value = HASH_ITERATION_VALUE(itr);
3595 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3596 HASH_ITERATION_TOKEN(itr), value);
3598 END_HASH_ITERATION(setup_file_hash, itr)
3600 // at this point, we do not need the setup file hash anymore -- free it
3601 freeSetupFileHash(setup_file_hash);
3603 // prevent changing hash while iterating over it by using a temporary copy
3604 valid_file_hash_tmp = newSetupFileHash();
3605 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3607 setHashEntry(valid_file_hash_tmp,
3608 HASH_ITERATION_TOKEN(itr),
3609 HASH_ITERATION_VALUE(itr));
3611 END_HASH_ITERATION(valid_file_hash, itr)
3613 // (iterate over same temporary hash, as modifications are independent)
3615 // map deprecated to current tokens (using prefix match and replace)
3616 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3618 char *token = HASH_ITERATION_TOKEN(itr);
3619 char *mapped_token = get_mapped_token(token);
3621 if (mapped_token != NULL)
3623 char *value = HASH_ITERATION_VALUE(itr);
3626 setHashEntry(valid_file_hash, mapped_token, value);
3628 // ignore old token (by setting it to "known" keyword)
3629 setHashEntry(valid_file_hash, token, known_token_value);
3634 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3636 // add special base tokens (using prefix match and replace)
3637 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3639 char *token = HASH_ITERATION_TOKEN(itr);
3640 char *base_token = get_special_base_token(artwork_info, token);
3642 if (base_token != NULL)
3644 // add base token only if it does not already exist
3645 if (getHashEntry(valid_file_hash, base_token) == NULL)
3646 setHashEntry(valid_file_hash, base_token, base_token_value);
3651 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3653 // free temporary hash used for iteration
3654 freeSetupFileHash(valid_file_hash_tmp);
3656 // read parameters for all known config file tokens
3657 for (i = 0; i < num_file_list_entries; i++)
3658 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3660 // set all tokens that can be ignored here to "known" keyword
3661 for (i = 0; i < num_ignore_tokens; i++)
3662 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3664 // copy all unknown config file tokens to extra config hash
3665 extra_file_hash = newSetupFileHash();
3666 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3668 char *value = HASH_ITERATION_VALUE(itr);
3670 if (!strEqual(value, known_token_value))
3671 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3673 END_HASH_ITERATION(valid_file_hash, itr)
3675 // at this point, we do not need the valid file hash anymore -- free it
3676 freeSetupFileHash(valid_file_hash);
3678 // now try to determine valid, dynamically defined config tokens
3680 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3682 struct FileInfo **dynamic_file_list =
3683 &artwork_info->dynamic_file_list;
3684 int *num_dynamic_file_list_entries =
3685 &artwork_info->num_dynamic_file_list_entries;
3686 struct PropertyMapping **property_mapping =
3687 &artwork_info->property_mapping;
3688 int *num_property_mapping_entries =
3689 &artwork_info->num_property_mapping_entries;
3690 int current_summarized_file_list_entry =
3691 artwork_info->num_file_list_entries +
3692 artwork_info->num_dynamic_file_list_entries;
3693 char *token = HASH_ITERATION_TOKEN(itr);
3694 int len_token = strlen(token);
3696 boolean base_prefix_found = FALSE;
3697 boolean parameter_suffix_found = FALSE;
3699 // skip all parameter definitions (handled by read_token_parameters())
3700 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3702 int len_suffix = strlen(suffix_list[i].token);
3704 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3705 parameter_suffix_found = TRUE;
3708 if (parameter_suffix_found)
3711 // ---------- step 0: search for matching base prefix ----------
3714 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3716 char *base_prefix = base_prefixes[i];
3717 int len_base_prefix = strlen(base_prefix);
3718 boolean ext1_suffix_found = FALSE;
3719 boolean ext2_suffix_found = FALSE;
3720 boolean ext3_suffix_found = FALSE;
3721 boolean exact_match = FALSE;
3722 int base_index = -1;
3723 int ext1_index = -1;
3724 int ext2_index = -1;
3725 int ext3_index = -1;
3727 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3729 if (!base_prefix_found)
3734 if (start_pos + len_base_prefix == len_token) // exact match
3738 add_dynamic_file_list_entry(dynamic_file_list,
3739 num_dynamic_file_list_entries,
3742 num_suffix_list_entries,
3744 add_property_mapping(property_mapping,
3745 num_property_mapping_entries,
3746 base_index, -1, -1, -1,
3747 current_summarized_file_list_entry);
3751 // ---------- step 1: search for matching first suffix ----------
3753 start_pos += len_base_prefix;
3754 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3756 char *ext1_suffix = ext1_suffixes[j];
3757 int len_ext1_suffix = strlen(ext1_suffix);
3759 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3761 if (!ext1_suffix_found)
3766 if (start_pos + len_ext1_suffix == len_token) // exact match
3770 add_dynamic_file_list_entry(dynamic_file_list,
3771 num_dynamic_file_list_entries,
3774 num_suffix_list_entries,
3776 add_property_mapping(property_mapping,
3777 num_property_mapping_entries,
3778 base_index, ext1_index, -1, -1,
3779 current_summarized_file_list_entry);
3783 start_pos += len_ext1_suffix;
3789 // ---------- step 2: search for matching second suffix ----------
3791 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3793 char *ext2_suffix = ext2_suffixes[k];
3794 int len_ext2_suffix = strlen(ext2_suffix);
3796 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3798 if (!ext2_suffix_found)
3803 if (start_pos + len_ext2_suffix == len_token) // exact match
3807 add_dynamic_file_list_entry(dynamic_file_list,
3808 num_dynamic_file_list_entries,
3811 num_suffix_list_entries,
3813 add_property_mapping(property_mapping,
3814 num_property_mapping_entries,
3815 base_index, ext1_index, ext2_index, -1,
3816 current_summarized_file_list_entry);
3820 start_pos += len_ext2_suffix;
3826 // ---------- step 3: search for matching third suffix ----------
3828 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3830 char *ext3_suffix = ext3_suffixes[l];
3831 int len_ext3_suffix = strlen(ext3_suffix);
3833 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3835 if (!ext3_suffix_found)
3840 if (start_pos + len_ext3_suffix == len_token) // exact match
3844 add_dynamic_file_list_entry(dynamic_file_list,
3845 num_dynamic_file_list_entries,
3848 num_suffix_list_entries,
3850 add_property_mapping(property_mapping,
3851 num_property_mapping_entries,
3852 base_index, ext1_index, ext2_index, ext3_index,
3853 current_summarized_file_list_entry);
3859 END_HASH_ITERATION(extra_file_hash, itr)
3861 if (artwork_info->num_dynamic_file_list_entries > 0)
3863 artwork_info->dynamic_artwork_list =
3864 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3865 artwork_info->sizeof_artwork_list_entry);
3868 if (options.verbose && IS_PARENT_PROCESS())
3870 SetupFileList *setup_file_list, *list;
3871 boolean dynamic_tokens_found = FALSE;
3872 boolean unknown_tokens_found = FALSE;
3873 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3875 // list may be NULL for empty artwork config files
3876 setup_file_list = loadSetupFileList(filename);
3878 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3880 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3881 dynamic_tokens_found = TRUE;
3883 unknown_tokens_found = TRUE;
3885 END_HASH_ITERATION(extra_file_hash, itr)
3887 if (options.debug && dynamic_tokens_found)
3889 Debug("config", "---");
3890 Debug("config", "dynamic token(s) found in config file:");
3891 Debug("config", "- config file: '%s'", filename);
3893 for (list = setup_file_list; list != NULL; list = list->next)
3895 char *value = getHashEntry(extra_file_hash, list->token);
3897 if (value != NULL && strEqual(value, known_token_value))
3898 Debug("config", "- dynamic token: '%s'", list->token);
3901 Debug("config", "---");
3904 if (unknown_tokens_found)
3907 Warn("unknown token(s) found in config file:");
3908 Warn("- config file: '%s'", filename);
3910 for (list = setup_file_list; list != NULL; list = list->next)
3912 char *value = getHashEntry(extra_file_hash, list->token);
3914 if (value != NULL && !strEqual(value, known_token_value))
3915 Warn("- dynamic token: '%s'", list->token);
3921 if (undefined_values_found)
3924 Warn("undefined values found in config file:");
3925 Warn("- config file: '%s'", filename);
3927 for (list = setup_file_list; list != NULL; list = list->next)
3929 char *value = getHashEntry(empty_file_hash, list->token);
3932 Warn("- undefined value for token: '%s'", list->token);
3938 freeSetupFileList(setup_file_list);
3941 freeSetupFileHash(extra_file_hash);
3942 freeSetupFileHash(empty_file_hash);
3945 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3947 struct FileInfo *file_list = artwork_info->file_list;
3948 int num_file_list_entries = artwork_info->num_file_list_entries;
3949 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3950 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3953 DrawInitTextHead("Loading artwork config");
3954 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
3956 // always start with reliable default values
3957 for (i = 0; i < num_file_list_entries; i++)
3959 setString(&file_list[i].filename, file_list[i].default_filename);
3961 for (j = 0; j < num_suffix_list_entries; j++)
3962 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3964 file_list[i].redefined = FALSE;
3965 file_list[i].fallback_to_default = FALSE;
3968 // free previous dynamic artwork file array
3969 if (artwork_info->dynamic_file_list != NULL)
3971 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3973 free(artwork_info->dynamic_file_list[i].token);
3974 free(artwork_info->dynamic_file_list[i].filename);
3975 free(artwork_info->dynamic_file_list[i].parameter);
3978 free(artwork_info->dynamic_file_list);
3979 artwork_info->dynamic_file_list = NULL;
3981 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3982 &artwork_info->num_dynamic_file_list_entries);
3985 // free previous property mapping
3986 if (artwork_info->property_mapping != NULL)
3988 free(artwork_info->property_mapping);
3990 artwork_info->property_mapping = NULL;
3991 artwork_info->num_property_mapping_entries = 0;
3994 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3996 // first look for special artwork configured in level series config
3997 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3999 if (fileExists(filename_base))
4000 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4003 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4005 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4006 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4009 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4010 struct ListNodeInfo **listnode)
4014 char *filename = (*listnode)->source_filename;
4016 if (--(*listnode)->num_references <= 0)
4017 deleteNodeFromList(&artwork_info->content_list, filename,
4018 artwork_info->free_artwork);
4024 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4025 struct ListNodeInfo **listnode,
4026 struct FileInfo *file_list_entry)
4036 char *basename = file_list_entry->filename;
4037 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4039 // mark all images from non-default graphics directory as "redefined"
4040 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4041 !strPrefix(filename, options.graphics_directory))
4042 file_list_entry->redefined = TRUE;
4044 if (filename == NULL)
4046 Warn("cannot find artwork file '%s'", basename);
4048 basename = file_list_entry->default_filename;
4050 // fail for cloned default artwork that has no default filename defined
4051 if (file_list_entry->default_is_cloned &&
4052 strEqual(basename, UNDEFINED_FILENAME))
4054 void (*error_func)(char *, ...) = Warn;
4056 // we can get away without sounds and music, but not without graphics
4057 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4060 error_func("token '%s' was cloned and has no default filename",
4061 file_list_entry->token);
4066 // dynamic artwork has no default filename / skip empty default artwork
4067 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4070 file_list_entry->fallback_to_default = TRUE;
4072 Warn("trying default artwork file '%s'", basename);
4074 filename = getCustomArtworkFilename(basename, artwork_info->type);
4076 if (filename == NULL)
4078 void (*error_func)(char *, ...) = Warn;
4080 // we can get away without sounds and music, but not without graphics
4081 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4084 error_func("cannot find default artwork file '%s'", basename);
4090 // check if the old and the new artwork file are the same
4091 if (*listnode && strEqual((*listnode)->source_filename, filename))
4093 // The old and new artwork are the same (have the same filename and path).
4094 // This usually means that this artwork does not exist in this artwork set
4095 // and a fallback to the existing artwork is done.
4100 // delete existing artwork file entry
4101 deleteArtworkListEntry(artwork_info, listnode);
4103 // check if the new artwork file already exists in the list of artwork
4104 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4106 *listnode = (struct ListNodeInfo *)node->content;
4107 (*listnode)->num_references++;
4112 DrawInitTextHead(init_text[artwork_info->type]);
4113 DrawInitTextItem(basename);
4115 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4117 // add new artwork file entry to the list of artwork files
4118 (*listnode)->num_references = 1;
4119 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4124 void (*error_func)(char *, ...) = Warn;
4126 // we can get away without sounds and music, but not without graphics
4127 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4130 error_func("cannot load artwork file '%s'", basename);
4136 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4137 struct ListNodeInfo **listnode,
4138 struct FileInfo *file_list_entry)
4140 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4142 deleteArtworkListEntry(artwork_info, listnode);
4147 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4150 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4152 struct FileInfo *file_list = artwork_info->file_list;
4153 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4154 int num_file_list_entries = artwork_info->num_file_list_entries;
4155 int num_dynamic_file_list_entries =
4156 artwork_info->num_dynamic_file_list_entries;
4159 print_timestamp_init("ReloadCustomArtworkList");
4161 for (i = 0; i < num_file_list_entries; i++)
4162 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4165 for (i = 0; i < num_dynamic_file_list_entries; i++)
4166 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4167 &dynamic_file_list[i]);
4169 print_timestamp_done("ReloadCustomArtworkList");
4172 dumpList(artwork_info->content_list);
4176 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4177 struct ListNodeInfo ***list,
4178 int *num_list_entries)
4185 for (i = 0; i < *num_list_entries; i++)
4186 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4190 *num_list_entries = 0;
4193 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4195 if (artwork_info == NULL)
4198 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4199 &artwork_info->num_file_list_entries);
4201 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4202 &artwork_info->num_dynamic_file_list_entries);
4206 // ----------------------------------------------------------------------------
4207 // functions only needed for non-Unix (non-command-line) systems
4208 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4209 // (now also added for Windows, to create files in user data directory)
4210 // ----------------------------------------------------------------------------
4212 char *getLogBasename(char *basename)
4214 return getStringCat2(basename, ".log");
4217 char *getLogFilename(char *basename)
4219 return getPath2(getMainUserGameDataDir(), basename);
4222 void OpenLogFile(void)
4224 InitMainUserDataDirectory();
4226 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4228 program.log_file = program.log_file_default; // reset to default
4230 Warn("cannot open file '%s' for writing: %s",
4231 program.log_filename, strerror(errno));
4234 // output should be unbuffered so it is not truncated in a crash
4235 setbuf(program.log_file, NULL);
4238 void CloseLogFile(void)
4240 if (program.log_file != program.log_file_default)
4241 fclose(program.log_file);
4244 void DumpLogFile(void)
4246 FILE *log_file = fopen(program.log_filename, MODE_READ);
4248 if (log_file == NULL)
4251 while (!feof(log_file))
4252 fputc(fgetc(log_file), stdout);
4257 void NotifyUserAboutErrorFile(void)
4259 #if defined(PLATFORM_WINDOWS)
4260 char *title_text = getStringCat2(program.program_title, " Error Message");
4261 char *error_text = getStringCat2("The program was aborted due to an error; "
4262 "for details, see the following error file:"
4264 program.log_filename);
4266 MessageBox(NULL, error_text, title_text, MB_OK);
4271 // ----------------------------------------------------------------------------
4272 // the following is only for debugging purpose and normally not used
4273 // ----------------------------------------------------------------------------
4277 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4278 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4280 #define DEBUG_NUM_TIMESTAMPS 10
4281 #define DEBUG_TIME_IN_MICROSECONDS 0
4283 #if DEBUG_TIME_IN_MICROSECONDS
4284 static double Counter_Microseconds(void)
4286 static struct timeval base_time = { 0, 0 };
4287 struct timeval current_time;
4290 gettimeofday(¤t_time, NULL);
4292 // reset base time in case of wrap-around
4293 if (current_time.tv_sec < base_time.tv_sec)
4294 base_time = current_time;
4297 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4298 ((double)(current_time.tv_usec - base_time.tv_usec));
4300 return counter; // return microseconds since last init
4304 static char *debug_print_timestamp_get_padding(int padding_size)
4306 static char *padding = NULL;
4307 int max_padding_size = 100;
4309 if (padding == NULL)
4311 padding = checked_calloc(max_padding_size + 1);
4312 memset(padding, ' ', max_padding_size);
4315 return &padding[MAX(0, max_padding_size - padding_size)];
4318 void debug_print_timestamp(int counter_nr, char *message)
4320 int indent_size = 8;
4321 int padding_size = 40;
4322 float timestamp_interval;
4325 Fail("debugging: invalid negative counter");
4326 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4327 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4329 #if DEBUG_TIME_IN_MICROSECONDS
4330 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4333 counter[counter_nr][0] = Counter_Microseconds();
4335 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4338 counter[counter_nr][0] = Counter();
4341 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4342 counter[counter_nr][1] = counter[counter_nr][0];
4345 Debug("time:init", "%s%s%s %.3f %s",
4346 debug_print_timestamp_get_padding(counter_nr * indent_size),
4348 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4349 timestamp_interval / 1000,
4354 static void debug_print_parent_only(char *format, ...)
4356 if (!IS_PARENT_PROCESS())
4363 va_start(ap, format);
4364 vprintf(format, ap);
4374 static void print_timestamp_ext(char *message, char *mode)
4376 #if DEBUG_PRINT_INIT_TIMESTAMPS
4377 static char *debug_message = NULL;
4378 static char *last_message = NULL;
4379 static int counter_nr = 0;
4380 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4382 checked_free(debug_message);
4383 debug_message = getStringCat3(mode, " ", message);
4385 if (strEqual(mode, "INIT"))
4387 debug_print_timestamp(counter_nr, NULL);
4389 if (counter_nr + 1 < max_depth)
4390 debug_print_timestamp(counter_nr, debug_message);
4394 debug_print_timestamp(counter_nr, NULL);
4396 else if (strEqual(mode, "DONE"))
4400 if (counter_nr + 1 < max_depth ||
4401 (counter_nr == 0 && max_depth == 1))
4403 last_message = message;
4405 if (counter_nr == 0 && max_depth == 1)
4407 checked_free(debug_message);
4408 debug_message = getStringCat3("TIME", " ", message);
4411 debug_print_timestamp(counter_nr, debug_message);
4414 else if (!strEqual(mode, "TIME") ||
4415 !strEqual(message, last_message))
4417 if (counter_nr < max_depth)
4418 debug_print_timestamp(counter_nr, debug_message);
4423 void print_timestamp_init(char *message)
4425 print_timestamp_ext(message, "INIT");
4428 void print_timestamp_time(char *message)
4430 print_timestamp_ext(message, "TIME");
4433 void print_timestamp_done(char *message)
4435 print_timestamp_ext(message, "DONE");