1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter() // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter() // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1093 if (s1 == NULL || s2 == NULL || sep == NULL)
1096 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1099 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1101 return complete_string;
1104 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1106 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1109 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1110 strlen(s2) + strlen(sep) +
1113 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1115 return complete_string;
1118 char *getStringCat2(char *s1, char *s2)
1120 return getStringCat2WithSeparator(s1, s2, "");
1123 char *getStringCat3(char *s1, char *s2, char *s3)
1125 return getStringCat3WithSeparator(s1, s2, s3, "");
1128 char *getPath2(char *path1, char *path2)
1130 #if defined(PLATFORM_ANDROID)
1131 // workaround for reading from assets directory -- skip "." subdirs in path
1132 if (strEqual(path1, "."))
1133 return getStringCopy(path2);
1134 else if (strEqual(path2, "."))
1135 return getStringCopy(path1);
1138 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1141 char *getPath3(char *path1, char *path2, char *path3)
1143 #if defined(PLATFORM_ANDROID)
1144 // workaround for reading from assets directory -- skip "." subdirs in path
1145 if (strEqual(path1, "."))
1146 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1147 else if (strEqual(path2, "."))
1148 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1149 else if (strEqual(path3, "."))
1150 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1153 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1156 static char *getPngOrPcxIfNotExists(char *filename)
1158 // switch from PNG to PCX file and vice versa, if file does not exist
1159 // (backwards compatibility with PCX files used in previous versions)
1161 if (!fileExists(filename) && strSuffix(filename, ".png"))
1162 strcpy(&filename[strlen(filename) - 3], "pcx");
1163 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1164 strcpy(&filename[strlen(filename) - 3], "png");
1169 char *getImg2(char *path1, char *path2)
1171 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1174 char *getImg3(char *path1, char *path2, char *path3)
1176 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1179 char *getStringCopy(const char *s)
1186 s_copy = checked_malloc(strlen(s) + 1);
1192 char *getStringCopyN(const char *s, int n)
1195 int s_len = MAX(0, n);
1200 s_copy = checked_malloc(s_len + 1);
1201 strncpy(s_copy, s, s_len);
1202 s_copy[s_len] = '\0';
1207 char *getStringCopyNStatic(const char *s, int n)
1209 static char *s_copy = NULL;
1211 checked_free(s_copy);
1213 s_copy = getStringCopyN(s, n);
1218 char *getStringToLower(const char *s)
1220 char *s_copy = checked_malloc(strlen(s) + 1);
1221 char *s_ptr = s_copy;
1224 *s_ptr++ = tolower(*s++);
1230 void setString(char **old_value, char *new_value)
1232 checked_free(*old_value);
1234 *old_value = getStringCopy(new_value);
1237 boolean strEqual(char *s1, char *s2)
1239 return (s1 == NULL && s2 == NULL ? TRUE :
1240 s1 == NULL && s2 != NULL ? FALSE :
1241 s1 != NULL && s2 == NULL ? FALSE :
1242 strcmp(s1, s2) == 0);
1245 boolean strEqualN(char *s1, char *s2, int n)
1247 return (s1 == NULL && s2 == NULL ? TRUE :
1248 s1 == NULL && s2 != NULL ? FALSE :
1249 s1 != NULL && s2 == NULL ? FALSE :
1250 strncmp(s1, s2, n) == 0);
1253 boolean strEqualCase(char *s1, char *s2)
1255 return (s1 == NULL && s2 == NULL ? TRUE :
1256 s1 == NULL && s2 != NULL ? FALSE :
1257 s1 != NULL && s2 == NULL ? FALSE :
1258 strcasecmp(s1, s2) == 0);
1261 boolean strEqualCaseN(char *s1, char *s2, int n)
1263 return (s1 == NULL && s2 == NULL ? TRUE :
1264 s1 == NULL && s2 != NULL ? FALSE :
1265 s1 != NULL && s2 == NULL ? FALSE :
1266 strncasecmp(s1, s2, n) == 0);
1269 boolean strPrefix(char *s, char *prefix)
1271 return (s == NULL && prefix == NULL ? TRUE :
1272 s == NULL && prefix != NULL ? FALSE :
1273 s != NULL && prefix == NULL ? FALSE :
1274 strncmp(s, prefix, strlen(prefix)) == 0);
1277 boolean strSuffix(char *s, char *suffix)
1279 return (s == NULL && suffix == NULL ? TRUE :
1280 s == NULL && suffix != NULL ? FALSE :
1281 s != NULL && suffix == NULL ? FALSE :
1282 strlen(s) < strlen(suffix) ? FALSE :
1283 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1286 boolean strPrefixLower(char *s, char *prefix)
1288 char *s_lower = getStringToLower(s);
1289 boolean match = strPrefix(s_lower, prefix);
1296 boolean strSuffixLower(char *s, char *suffix)
1298 char *s_lower = getStringToLower(s);
1299 boolean match = strSuffix(s_lower, suffix);
1306 boolean isURL(char *s)
1308 while (*s && *s >= 'a' && *s <= 'z')
1311 return strPrefix(s, "://");
1315 // ----------------------------------------------------------------------------
1316 // command line option handling functions
1317 // ----------------------------------------------------------------------------
1319 void GetOptions(int argc, char *argv[],
1320 void (*print_usage_function)(void),
1321 void (*print_version_function)(void))
1323 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1324 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1325 char **options_left = &argvplus[1];
1327 // replace original "argv" with null-terminated array of string pointers
1329 argvplus[argc] = argv[argc];
1331 // initialize global program options
1332 options.server_host = NULL;
1333 options.server_port = 0;
1335 options.base_directory = base_path;
1337 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1338 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1339 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1340 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1341 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1342 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1344 options.execute_command = NULL;
1345 options.tape_log_filename = NULL;
1346 options.special_flags = NULL;
1347 options.debug_mode = NULL;
1348 options.player_name = NULL;
1349 options.identifier = NULL;
1350 options.level_nr = NULL;
1352 options.display_nr = 0;
1354 options.mytapes = FALSE;
1355 options.serveronly = FALSE;
1356 options.network = FALSE;
1357 options.verbose = FALSE;
1358 options.debug = FALSE;
1361 options.verbose = TRUE;
1363 #if !defined(PLATFORM_UNIX)
1364 if (*options_left == NULL) // no options given -- enable verbose mode
1365 options.verbose = TRUE;
1370 #if defined(PLATFORM_ANDROID)
1371 options.debug = TRUE;
1375 while (*options_left)
1377 char option_str[MAX_OPTION_LEN];
1378 char *option = options_left[0];
1379 char *next_option = options_left[1];
1380 char *option_arg = NULL;
1381 int option_len = strlen(option);
1383 if (option_len >= MAX_OPTION_LEN)
1384 FailWithHelp("unrecognized option '%s'", option);
1386 strcpy(option_str, option); // copy argument into buffer
1387 option = option_str;
1389 if (strEqual(option, "--")) // stop scanning arguments
1392 if (strPrefix(option, "--")) // treat '--' like '-'
1395 option_arg = strchr(option, '=');
1396 if (option_arg == NULL) // no '=' in option
1397 option_arg = next_option;
1400 *option_arg++ = '\0'; // cut argument from option
1401 if (*option_arg == '\0') // no argument after '='
1402 FailWithHelp("option '%s' has invalid argument", option_str);
1405 option_len = strlen(option);
1407 if (strEqual(option, "-"))
1409 FailWithHelp("unrecognized option '%s'", option);
1411 else if (strncmp(option, "-help", option_len) == 0)
1413 print_usage_function();
1417 else if (strncmp(option, "-basepath", option_len) == 0)
1419 if (option_arg == NULL)
1420 FailWithHelp("option '%s' requires an argument", option_str);
1422 options.base_directory = base_path = getStringCopy(option_arg);
1423 if (option_arg == next_option)
1426 // adjust paths for sub-directories in base directory accordingly
1427 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1428 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1429 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1430 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1431 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1432 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1434 else if (strncmp(option, "-levels", option_len) == 0)
1436 if (option_arg == NULL)
1437 FailWithHelp("option '%s' requires an argument", option_str);
1439 options.level_directory = getStringCopy(option_arg);
1440 if (option_arg == next_option)
1443 else if (strncmp(option, "-graphics", option_len) == 0)
1445 if (option_arg == NULL)
1446 FailWithHelp("option '%s' requires an argument", option_str);
1448 options.graphics_directory = getStringCopy(option_arg);
1449 if (option_arg == next_option)
1452 else if (strncmp(option, "-sounds", option_len) == 0)
1454 if (option_arg == NULL)
1455 FailWithHelp("option '%s' requires an argument", option_str);
1457 options.sounds_directory = getStringCopy(option_arg);
1458 if (option_arg == next_option)
1461 else if (strncmp(option, "-music", option_len) == 0)
1463 if (option_arg == NULL)
1464 FailWithHelp("option '%s' requires an argument", option_str);
1466 options.music_directory = getStringCopy(option_arg);
1467 if (option_arg == next_option)
1470 else if (strncmp(option, "-mytapes", option_len) == 0)
1472 options.mytapes = TRUE;
1474 else if (strncmp(option, "-network", option_len) == 0)
1476 options.network = TRUE;
1478 else if (strncmp(option, "-serveronly", option_len) == 0)
1480 options.serveronly = TRUE;
1482 else if (strncmp(option, "-debug", option_len) == 0)
1484 options.debug = TRUE;
1486 // optionally, debug output can be limited to a specific debug mode
1487 if (option_arg != next_option)
1488 options.debug_mode = getStringCopy(option_arg);
1490 else if (strncmp(option, "-player-name", option_len) == 0)
1492 if (option_arg == NULL)
1493 FailWithHelp("option '%s' requires an argument", option_str);
1495 options.player_name = getStringCopy(option_arg);
1496 if (option_arg == next_option)
1499 else if (strncmp(option, "-identifier", option_len) == 0)
1501 if (option_arg == NULL)
1502 FailWithHelp("option '%s' requires an argument", option_str);
1504 options.identifier = getStringCopy(option_arg);
1505 if (option_arg == next_option)
1508 else if (strncmp(option, "-level-nr", option_len) == 0)
1510 if (option_arg == NULL)
1511 FailWithHelp("option '%s' requires an argument", option_str);
1513 options.level_nr = getStringCopy(option_arg);
1514 if (option_arg == next_option)
1517 else if (strncmp(option, "-verbose", option_len) == 0)
1519 options.verbose = TRUE;
1521 else if (strncmp(option, "-version", option_len) == 0 ||
1522 strncmp(option, "-V", option_len) == 0)
1524 print_version_function();
1528 else if (strPrefix(option, "-D"))
1530 options.special_flags = getStringCopy(&option[2]);
1532 else if (strncmp(option, "-execute", option_len) == 0)
1534 if (option_arg == NULL)
1535 FailWithHelp("option '%s' requires an argument", option_str);
1537 options.execute_command = getStringCopy(option_arg);
1538 if (option_arg == next_option)
1541 // when doing batch processing, always enable verbose mode (warnings)
1542 options.verbose = TRUE;
1544 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1546 if (option_arg == NULL)
1547 FailWithHelp("option '%s' requires an argument", option_str);
1549 options.tape_log_filename = getStringCopy(option_arg);
1550 if (option_arg == next_option)
1553 else if (strncmp(option, "-display", option_len) == 0)
1555 if (option_arg == NULL)
1556 FailWithHelp("option '%s' requires an argument", option_str);
1558 if (option_arg == next_option)
1561 int display_nr = atoi(option_arg);
1564 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1565 options.display_nr = display_nr;
1567 options.display_nr =
1568 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1570 if (display_nr != options.display_nr)
1571 Warn("invalid display %d -- using display %d",
1572 display_nr, options.display_nr);
1575 #if defined(PLATFORM_MAC)
1576 else if (strPrefix(option, "-psn"))
1578 // ignore process serial number when launched via GUI on Mac OS X
1581 else if (*option == '-')
1583 FailWithHelp("unrecognized option '%s'", option_str);
1585 else if (options.server_host == NULL)
1587 options.server_host = *options_left;
1589 else if (options.server_port == 0)
1591 options.server_port = atoi(*options_left);
1592 if (options.server_port < 1024)
1593 FailWithHelp("bad port number '%d'", options.server_port);
1596 FailWithHelp("too many arguments");
1603 // ----------------------------------------------------------------------------
1604 // checked memory allocation and freeing functions
1605 // ----------------------------------------------------------------------------
1607 void *checked_malloc(unsigned int size)
1614 Fail("cannot allocate %d bytes -- out of memory", size);
1619 void *checked_calloc(unsigned int size)
1623 ptr = calloc(1, size);
1626 Fail("cannot allocate %d bytes -- out of memory", size);
1631 void *checked_realloc(void *ptr, unsigned int size)
1633 ptr = realloc(ptr, size);
1636 Fail("cannot allocate %d bytes -- out of memory", size);
1641 void checked_free(void *ptr)
1643 if (ptr != NULL) // this check should be done by free() anyway
1647 void clear_mem(void *ptr, unsigned int size)
1649 #if defined(PLATFORM_WINDOWS)
1650 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1651 char *cptr = (char *)ptr;
1656 memset(ptr, 0, size);
1661 // ----------------------------------------------------------------------------
1662 // various helper functions
1663 // ----------------------------------------------------------------------------
1665 void swap_numbers(int *i1, int *i2)
1673 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1685 int get_number_of_bits(int bits)
1688 Counting bits set, Brian Kernighan's way
1690 Brian Kernighan's method goes through as many iterations as there are set
1691 bits. So if we have a 32-bit word with only the high bit set, then it will
1692 only go once through the loop.
1694 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1695 and Dennis M. Ritchie) mentions this in exercise 2-9.
1696 First published by Peter Wegner in CACM 3 (1960), 322.
1703 bits &= bits - 1; // clear the least significant bit set
1710 /* the "put" variants of the following file access functions check for the file
1711 pointer being != NULL and return the number of bytes they have or would have
1712 written; this allows for chunk writing functions to first determine the size
1713 of the (not yet written) chunk, write the correct chunk size and finally
1714 write the chunk itself */
1716 int getFile8BitInteger(File *file)
1718 return getByteFromFile(file);
1721 int putFile8BitInteger(FILE *file, int value)
1729 int getFile16BitInteger(File *file, int byte_order)
1731 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1732 return ((getByteFromFile(file) << 8) |
1733 (getByteFromFile(file) << 0));
1734 else // BYTE_ORDER_LITTLE_ENDIAN
1735 return ((getByteFromFile(file) << 0) |
1736 (getByteFromFile(file) << 8));
1739 int putFile16BitInteger(FILE *file, int value, int byte_order)
1743 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1745 fputc((value >> 8) & 0xff, file);
1746 fputc((value >> 0) & 0xff, file);
1748 else // BYTE_ORDER_LITTLE_ENDIAN
1750 fputc((value >> 0) & 0xff, file);
1751 fputc((value >> 8) & 0xff, file);
1758 int getFile32BitInteger(File *file, int byte_order)
1760 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1761 return ((getByteFromFile(file) << 24) |
1762 (getByteFromFile(file) << 16) |
1763 (getByteFromFile(file) << 8) |
1764 (getByteFromFile(file) << 0));
1765 else // BYTE_ORDER_LITTLE_ENDIAN
1766 return ((getByteFromFile(file) << 0) |
1767 (getByteFromFile(file) << 8) |
1768 (getByteFromFile(file) << 16) |
1769 (getByteFromFile(file) << 24));
1772 int putFile32BitInteger(FILE *file, int value, int byte_order)
1776 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1778 fputc((value >> 24) & 0xff, file);
1779 fputc((value >> 16) & 0xff, file);
1780 fputc((value >> 8) & 0xff, file);
1781 fputc((value >> 0) & 0xff, file);
1783 else // BYTE_ORDER_LITTLE_ENDIAN
1785 fputc((value >> 0) & 0xff, file);
1786 fputc((value >> 8) & 0xff, file);
1787 fputc((value >> 16) & 0xff, file);
1788 fputc((value >> 24) & 0xff, file);
1795 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1798 const int chunk_name_length = 4;
1801 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1804 if (chunk_size != NULL)
1807 *chunk_size = getFile32BitInteger(file, byte_order);
1810 return (checkEndOfFile(file) ? FALSE : TRUE);
1813 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1820 fputs(chunk_name, file);
1822 num_bytes += strlen(chunk_name);
1824 if (chunk_size >= 0)
1828 putFile32BitInteger(file, chunk_size, byte_order);
1836 int getFileVersion(File *file)
1838 int version_super = getByteFromFile(file);
1839 int version_major = getByteFromFile(file);
1840 int version_minor = getByteFromFile(file);
1841 int version_patch = getByteFromFile(file);
1843 return VERSION_IDENT(version_super, version_major, version_minor,
1847 int putFileVersion(FILE *file, int version)
1851 int version_super = VERSION_SUPER(version);
1852 int version_major = VERSION_MAJOR(version);
1853 int version_minor = VERSION_MINOR(version);
1854 int version_patch = VERSION_PATCH(version);
1856 fputc(version_super, file);
1857 fputc(version_major, file);
1858 fputc(version_minor, file);
1859 fputc(version_patch, file);
1865 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1869 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1870 buffer[i] = getByteFromFile(file);
1873 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1877 for (i = 0; i < bytes; i++)
1878 fputc(buffer[i], file);
1881 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1883 while (bytes-- && !checkEndOfFile(file))
1884 getByteFromFile(file);
1887 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1894 // ----------------------------------------------------------------------------
1895 // functions to convert between ISO-8859-1 and UTF-8
1896 // ----------------------------------------------------------------------------
1898 char *getUTF8FromLatin1(char *latin1)
1900 int max_utf8_size = 2 * strlen(latin1) + 1;
1901 char *utf8 = checked_calloc(max_utf8_size);
1902 unsigned char *src = (unsigned char *)latin1;
1903 unsigned char *dst = (unsigned char *)utf8;
1907 if (*src < 128) // pure 7-bit ASCII
1911 else if (*src >= 160) // non-ASCII characters
1913 *dst++ = 194 + (*src >= 192);
1914 *dst++ = 128 + (*src & 63);
1916 else // undefined in ISO-8859-1
1924 // only use the smallest possible string buffer size
1925 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1930 char *getLatin1FromUTF8(char *utf8)
1932 int max_latin1_size = strlen(utf8) + 1;
1933 char *latin1 = checked_calloc(max_latin1_size);
1934 unsigned char *src = (unsigned char *)utf8;
1935 unsigned char *dst = (unsigned char *)latin1;
1939 if (*src < 128) // pure 7-bit ASCII
1943 else if (src[0] == 194 &&
1944 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1949 else if (src[0] == 195 &&
1950 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1952 *dst++ = src[1] + 64;
1956 // all other UTF-8 characters are undefined in ISO-8859-1
1958 else if (src[0] >= 192 && src[0] < 224 &&
1959 src[1] >= 128 && src[1] < 192)
1964 else if (src[0] >= 224 && src[0] < 240 &&
1965 src[1] >= 128 && src[1] < 192 &&
1966 src[2] >= 128 && src[2] < 192)
1971 else if (src[0] >= 240 && src[0] < 248 &&
1972 src[1] >= 128 && src[1] < 192 &&
1973 src[2] >= 128 && src[2] < 192 &&
1974 src[3] >= 128 && src[3] < 192)
1979 else if (src[0] >= 248 && src[0] < 252 &&
1980 src[1] >= 128 && src[1] < 192 &&
1981 src[2] >= 128 && src[2] < 192 &&
1982 src[3] >= 128 && src[3] < 192 &&
1983 src[4] >= 128 && src[4] < 192)
1988 else if (src[0] >= 252 && src[0] < 254 &&
1989 src[1] >= 128 && src[1] < 192 &&
1990 src[2] >= 128 && src[2] < 192 &&
1991 src[3] >= 128 && src[3] < 192 &&
1992 src[4] >= 128 && src[4] < 192 &&
1993 src[5] >= 128 && src[5] < 192)
2005 // only use the smallest possible string buffer size
2006 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2011 int getTextEncoding(char *text)
2013 unsigned char *src = (unsigned char *)text;
2014 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2019 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2025 else if (src[0] >= 192 && src[0] < 224 &&
2026 src[1] >= 128 && src[1] < 192)
2030 else if (src[0] >= 224 && src[0] < 240 &&
2031 src[1] >= 128 && src[1] < 192 &&
2032 src[2] >= 128 && src[2] < 192)
2036 else if (src[0] >= 240 && src[0] < 248 &&
2037 src[1] >= 128 && src[1] < 192 &&
2038 src[2] >= 128 && src[2] < 192 &&
2039 src[3] >= 128 && src[3] < 192)
2043 else if (src[0] >= 248 && src[0] < 252 &&
2044 src[1] >= 128 && src[1] < 192 &&
2045 src[2] >= 128 && src[2] < 192 &&
2046 src[3] >= 128 && src[3] < 192 &&
2047 src[4] >= 128 && src[4] < 192)
2051 else if (src[0] >= 252 && src[0] < 254 &&
2052 src[1] >= 128 && src[1] < 192 &&
2053 src[2] >= 128 && src[2] < 192 &&
2054 src[3] >= 128 && src[3] < 192 &&
2055 src[4] >= 128 && src[4] < 192 &&
2056 src[5] >= 128 && src[5] < 192)
2062 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2070 // ----------------------------------------------------------------------------
2071 // functions for JSON handling
2072 // ----------------------------------------------------------------------------
2074 char *getEscapedJSON(char *s)
2076 int max_json_size = 2 * strlen(s) + 1;
2077 char *json = checked_calloc(max_json_size);
2078 unsigned char *src = (unsigned char *)s;
2079 unsigned char *dst = (unsigned char *)json;
2080 char *escaped[256] =
2093 if (escaped[*src] != NULL)
2095 char *esc = escaped[*src++];
2106 // only use the smallest possible string buffer size
2107 json = checked_realloc(json, strlen(json) + 1);
2113 // ----------------------------------------------------------------------------
2114 // functions to translate key identifiers between different format
2115 // ----------------------------------------------------------------------------
2117 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2118 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2119 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2120 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2122 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2131 // return and escape keys
2132 { KSYM_Return, "XK_Return", "return" },
2133 { KSYM_Escape, "XK_Escape", "escape" },
2135 // normal cursor keys
2136 { KSYM_Left, "XK_Left", "cursor left" },
2137 { KSYM_Right, "XK_Right", "cursor right" },
2138 { KSYM_Up, "XK_Up", "cursor up" },
2139 { KSYM_Down, "XK_Down", "cursor down" },
2141 // keypad cursor keys
2143 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2144 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2145 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2146 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2149 // other keypad keys
2150 #ifdef KSYM_KP_Enter
2151 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2152 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2153 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2154 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2155 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2156 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2160 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2161 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2162 { KSYM_Control_L, "XK_Control_L", "left control" },
2163 { KSYM_Control_R, "XK_Control_R", "right control" },
2164 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2165 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2166 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2167 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2168 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2169 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2171 // some special keys
2172 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2173 { KSYM_Delete, "XK_Delete", "delete" },
2174 { KSYM_Insert, "XK_Insert", "insert" },
2175 { KSYM_Tab, "XK_Tab", "tab" },
2176 { KSYM_Home, "XK_Home", "home" },
2177 { KSYM_End, "XK_End", "end" },
2178 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2179 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2181 { KSYM_Select, "XK_Select", "select" },
2182 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2183 { KSYM_Back, "XK_Back", "back" }, // back key
2184 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2185 #if defined(PLATFORM_ANDROID)
2186 { KSYM_Rewind, "XK_Rewind", "rewind" },
2187 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2190 // ASCII 0x20 to 0x40 keys (except numbers)
2191 { KSYM_space, "XK_space", "space" },
2192 { KSYM_exclam, "XK_exclam", "!" },
2193 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2194 { KSYM_numbersign, "XK_numbersign", "#" },
2195 { KSYM_dollar, "XK_dollar", "$" },
2196 { KSYM_percent, "XK_percent", "%" },
2197 { KSYM_ampersand, "XK_ampersand", "&" },
2198 { KSYM_apostrophe, "XK_apostrophe", "'" },
2199 { KSYM_parenleft, "XK_parenleft", "(" },
2200 { KSYM_parenright, "XK_parenright", ")" },
2201 { KSYM_asterisk, "XK_asterisk", "*" },
2202 { KSYM_plus, "XK_plus", "+" },
2203 { KSYM_comma, "XK_comma", "," },
2204 { KSYM_minus, "XK_minus", "-" },
2205 { KSYM_period, "XK_period", "." },
2206 { KSYM_slash, "XK_slash", "/" },
2207 { KSYM_colon, "XK_colon", ":" },
2208 { KSYM_semicolon, "XK_semicolon", ";" },
2209 { KSYM_less, "XK_less", "<" },
2210 { KSYM_equal, "XK_equal", "=" },
2211 { KSYM_greater, "XK_greater", ">" },
2212 { KSYM_question, "XK_question", "?" },
2213 { KSYM_at, "XK_at", "@" },
2216 { KSYM_bracketleft, "XK_bracketleft", "[" },
2217 { KSYM_backslash, "XK_backslash", "\\" },
2218 { KSYM_bracketright,"XK_bracketright", "]" },
2219 { KSYM_asciicircum, "XK_asciicircum", "^" },
2220 { KSYM_underscore, "XK_underscore", "_" },
2221 { KSYM_grave, "XK_grave", "grave" },
2222 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2223 { KSYM_braceleft, "XK_braceleft", "brace left" },
2224 { KSYM_bar, "XK_bar", "bar" },
2225 { KSYM_braceright, "XK_braceright", "brace right" },
2226 { KSYM_asciitilde, "XK_asciitilde", "~" },
2228 // special (non-ASCII) keys
2229 { KSYM_degree, "XK_degree", "degree" },
2230 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2231 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2232 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2233 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2234 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2235 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2236 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2238 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2239 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2240 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2241 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2242 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2243 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2244 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2245 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2246 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2248 // other keys (for reverse mapping only)
2249 { KSYM_space, "XK_space", " " },
2251 // keypad keys are not in numerical order in SDL2
2252 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2253 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2254 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2255 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2256 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2257 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2258 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2259 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2260 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2261 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2263 // end-of-array identifier
2269 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2271 static char name_buffer[30];
2274 if (key >= KSYM_A && key <= KSYM_Z)
2275 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2276 else if (key >= KSYM_a && key <= KSYM_z)
2277 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2278 else if (key >= KSYM_0 && key <= KSYM_9)
2279 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2280 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2281 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2282 else if (key == KSYM_UNDEFINED)
2283 strcpy(name_buffer, "(undefined)");
2290 if (key == translate_key[i].key)
2292 strcpy(name_buffer, translate_key[i].name);
2296 while (translate_key[++i].name);
2298 if (!translate_key[i].name)
2299 strcpy(name_buffer, "(unknown)");
2302 *name = name_buffer;
2304 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2306 static char name_buffer[30];
2309 if (key >= KSYM_A && key <= KSYM_Z)
2310 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2311 else if (key >= KSYM_a && key <= KSYM_z)
2312 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2313 else if (key >= KSYM_0 && key <= KSYM_9)
2314 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2315 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2316 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2317 else if (key == KSYM_UNDEFINED)
2318 strcpy(name_buffer, "[undefined]");
2325 if (key == translate_key[i].key)
2327 strcpy(name_buffer, translate_key[i].x11name);
2331 while (translate_key[++i].x11name);
2333 if (!translate_key[i].x11name)
2334 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2337 *x11name = name_buffer;
2339 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2341 Key key = KSYM_UNDEFINED;
2342 char *name_ptr = *name;
2344 if (strlen(*name) == 1)
2346 char c = name_ptr[0];
2348 if (c >= 'A' && c <= 'Z')
2349 key = KSYM_A + (Key)(c - 'A');
2350 else if (c >= 'a' && c <= 'z')
2351 key = KSYM_a + (Key)(c - 'a');
2352 else if (c >= '0' && c <= '9')
2353 key = KSYM_0 + (Key)(c - '0');
2356 if (key == KSYM_UNDEFINED)
2362 if (strEqual(translate_key[i].name, *name))
2364 key = translate_key[i].key;
2368 while (translate_key[++i].x11name);
2371 if (key == KSYM_UNDEFINED)
2372 Warn("getKeyFromKeyName(): not completely implemented");
2376 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2378 Key key = KSYM_UNDEFINED;
2379 char *name_ptr = *x11name;
2381 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2383 char c = name_ptr[3];
2385 if (c >= 'A' && c <= 'Z')
2386 key = KSYM_A + (Key)(c - 'A');
2387 else if (c >= 'a' && c <= 'z')
2388 key = KSYM_a + (Key)(c - 'a');
2389 else if (c >= '0' && c <= '9')
2390 key = KSYM_0 + (Key)(c - '0');
2392 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2394 char c1 = name_ptr[4];
2395 char c2 = name_ptr[5];
2398 if ((c1 >= '0' && c1 <= '9') &&
2399 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2400 d = atoi(&name_ptr[4]);
2402 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2403 key = KSYM_F1 + (Key)(d - 1);
2405 else if (strPrefix(name_ptr, "XK_"))
2411 if (strEqual(name_ptr, translate_key[i].x11name))
2413 key = translate_key[i].key;
2417 while (translate_key[++i].x11name);
2419 else if (strPrefix(name_ptr, "0x"))
2421 unsigned int value = 0;
2427 char c = *name_ptr++;
2430 if (c >= '0' && c <= '9')
2432 else if (c >= 'a' && c <= 'f')
2433 d = (int)(c - 'a' + 10);
2434 else if (c >= 'A' && c <= 'F')
2435 d = (int)(c - 'A' + 10);
2443 value = value * 16 + d;
2454 char *getKeyNameFromKey(Key key)
2458 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2462 char *getX11KeyNameFromKey(Key key)
2466 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2470 Key getKeyFromKeyName(char *name)
2474 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2478 Key getKeyFromX11KeyName(char *x11name)
2482 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2486 char getCharFromKey(Key key)
2492 } translate_key_char[] =
2494 // special (non-ASCII) keys (ISO-8859-1)
2495 { KSYM_degree, CHAR_BYTE_DEGREE },
2496 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2497 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2498 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2499 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2500 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2501 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2502 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2504 // end-of-array identifier
2508 char *keyname = getKeyNameFromKey(key);
2511 if (strlen(keyname) == 1)
2513 else if (strEqual(keyname, "space"))
2521 if (key == translate_key_char[i].key)
2523 c = translate_key_char[i].key_char;
2528 while (translate_key_char[++i].key_char);
2534 char getValidConfigValueChar(char c)
2536 if (c == '#' || // used to mark comments
2537 c == '\\') // used to mark continued lines
2544 // ----------------------------------------------------------------------------
2545 // functions to translate string identifiers to integer or boolean value
2546 // ----------------------------------------------------------------------------
2548 int get_integer_from_string(char *s)
2550 // check for the most common case first
2551 if (s[0] >= '0' && s[0] <= '9')
2554 char *s_lower = getStringToLower(s);
2557 if (strEqual(s_lower, "false") ||
2558 strEqual(s_lower, "no") ||
2559 strEqual(s_lower, "off"))
2561 else if (strEqual(s_lower, "true") ||
2562 strEqual(s_lower, "yes") ||
2563 strEqual(s_lower, "on"))
2573 boolean get_boolean_from_string(char *s)
2575 char *s_lower = getStringToLower(s);
2576 boolean result = FALSE;
2578 if (strEqual(s_lower, "true") ||
2579 strEqual(s_lower, "yes") ||
2580 strEqual(s_lower, "on") ||
2581 get_integer_from_string(s) == 1)
2589 int get_switch3_from_string(char *s)
2591 char *s_lower = getStringToLower(s);
2594 if (strEqual(s_lower, "true") ||
2595 strEqual(s_lower, "yes") ||
2596 strEqual(s_lower, "on") ||
2597 get_integer_from_string(s) == 1)
2599 else if (strEqual(s_lower, "auto"))
2607 int get_player_nr_from_string(char *s)
2609 static char *player_text[] =
2619 char *s_lower = getStringToLower(s);
2623 for (i = 0; player_text[i] != NULL; i++)
2624 if (strEqual(s_lower, player_text[i]))
2633 // ----------------------------------------------------------------------------
2634 // functions for generic lists
2635 // ----------------------------------------------------------------------------
2637 ListNode *newListNode(void)
2639 return checked_calloc(sizeof(ListNode));
2642 void addNodeToList(ListNode **node_first, char *key, void *content)
2644 ListNode *node_new = newListNode();
2646 node_new->key = getStringCopy(key);
2647 node_new->content = content;
2648 node_new->next = *node_first;
2651 (*node_first)->prev = node_new;
2653 *node_first = node_new;
2656 void deleteNodeFromList(ListNode **node_first, char *key,
2657 void (*destructor_function)(void *))
2659 if (node_first == NULL || *node_first == NULL)
2662 if (strEqual((*node_first)->key, key))
2664 // after first recursion, (*node_first)->prev->next == *node_first,
2665 // so *node_first would be overwritten with (*node_first)->next
2666 // => use a copy of *node_first (and later of (*node_first)->next)
2667 ListNode *node = *node_first;
2668 ListNode *node_next = node->next;
2670 checked_free(node->key);
2672 if (destructor_function)
2673 destructor_function(node->content);
2676 node->prev->next = node->next;
2679 node->next->prev = node->prev;
2683 // after removing node, set list pointer to next valid list node
2684 // (this is important if the first node of the list was deleted)
2685 *node_first = node_next;
2689 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2693 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2695 if (node_first == NULL)
2698 if (strEqual(node_first->key, key))
2701 return getNodeFromKey(node_first->next, key);
2704 int getNumNodes(ListNode *node_first)
2706 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2710 static void dumpList(ListNode *node_first)
2712 ListNode *node = node_first;
2716 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2717 ((struct ListNodeInfo *)node->content)->num_references);
2721 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2726 // ----------------------------------------------------------------------------
2727 // functions for file handling
2728 // ----------------------------------------------------------------------------
2730 #define MAX_BUFFER_SIZE 4096
2732 File *openFile(char *filename, char *mode)
2734 File *file = checked_calloc(sizeof(File));
2736 file->file = fopen(filename, mode);
2738 if (file->file != NULL)
2740 file->filename = getStringCopy(filename);
2745 #if defined(PLATFORM_ANDROID)
2746 file->asset_file = SDL_RWFromFile(filename, mode);
2748 if (file->asset_file != NULL)
2750 file->file_is_asset = TRUE;
2751 file->filename = getStringCopy(filename);
2762 int closeFile(File *file)
2769 #if defined(PLATFORM_ANDROID)
2770 if (file->asset_file)
2771 result = SDL_RWclose(file->asset_file);
2775 result = fclose(file->file);
2777 checked_free(file->filename);
2783 int checkEndOfFile(File *file)
2785 #if defined(PLATFORM_ANDROID)
2786 if (file->file_is_asset)
2787 return file->end_of_file;
2790 return feof(file->file);
2793 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2795 #if defined(PLATFORM_ANDROID)
2796 if (file->file_is_asset)
2798 if (file->end_of_file)
2801 size_t num_items_read =
2802 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2804 if (num_items_read < num_items)
2805 file->end_of_file = TRUE;
2807 return num_items_read;
2811 return fread(buffer, item_size, num_items, file->file);
2814 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2816 return fwrite(buffer, item_size, num_items, file->file);
2819 int seekFile(File *file, long offset, int whence)
2821 #if defined(PLATFORM_ANDROID)
2822 if (file->file_is_asset)
2824 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2825 whence == SEEK_CUR ? RW_SEEK_CUR :
2826 whence == SEEK_END ? RW_SEEK_END : 0);
2828 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2832 return fseek(file->file, offset, whence);
2835 int getByteFromFile(File *file)
2837 #if defined(PLATFORM_ANDROID)
2838 if (file->file_is_asset)
2840 if (file->end_of_file)
2844 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2846 if (num_bytes_read < 1)
2847 file->end_of_file = TRUE;
2849 return (file->end_of_file ? EOF : (int)c);
2853 return fgetc(file->file);
2856 char *getStringFromFile(File *file, char *line, int size)
2858 #if defined(PLATFORM_ANDROID)
2859 if (file->file_is_asset)
2861 if (file->end_of_file)
2864 char *line_ptr = line;
2865 int num_bytes_read = 0;
2867 while (num_bytes_read < size - 1 &&
2868 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2869 *line_ptr++ != '\n')
2874 if (strlen(line) == 0)
2876 file->end_of_file = TRUE;
2885 return fgets(line, size, file->file);
2888 int copyFile(char *filename_from, char *filename_to)
2890 File *file_from, *file_to;
2892 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2897 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2899 closeFile(file_from);
2904 while (!checkEndOfFile(file_from))
2906 byte buffer[MAX_BUFFER_SIZE];
2907 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2909 writeFile(file_to, buffer, 1, bytes_read);
2912 closeFile(file_from);
2918 boolean touchFile(char *filename)
2922 if (!(file = fopen(filename, MODE_WRITE)))
2924 Warn("cannot touch file '%s'", filename);
2935 // ----------------------------------------------------------------------------
2936 // functions for directory handling
2937 // ----------------------------------------------------------------------------
2939 Directory *openDirectory(char *dir_name)
2941 Directory *dir = checked_calloc(sizeof(Directory));
2943 dir->dir = opendir(dir_name);
2945 if (dir->dir != NULL)
2947 dir->filename = getStringCopy(dir_name);
2952 #if defined(PLATFORM_ANDROID)
2953 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2955 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2957 checked_free(asset_toc_filename);
2959 if (dir->asset_toc_file != NULL)
2961 dir->directory_is_asset = TRUE;
2962 dir->filename = getStringCopy(dir_name);
2973 int closeDirectory(Directory *dir)
2980 #if defined(PLATFORM_ANDROID)
2981 if (dir->asset_toc_file)
2982 result = SDL_RWclose(dir->asset_toc_file);
2986 result = closedir(dir->dir);
2989 freeDirectoryEntry(dir->dir_entry);
2991 checked_free(dir->filename);
2997 DirectoryEntry *readDirectory(Directory *dir)
3000 freeDirectoryEntry(dir->dir_entry);
3002 dir->dir_entry = NULL;
3004 #if defined(PLATFORM_ANDROID)
3005 if (dir->directory_is_asset)
3007 char line[MAX_LINE_LEN];
3008 char *line_ptr = line;
3009 int num_bytes_read = 0;
3011 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3012 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3021 if (strlen(line) == 0)
3024 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3026 dir->dir_entry->is_directory = FALSE;
3027 if (line[strlen(line) - 1] == '/')
3029 dir->dir_entry->is_directory = TRUE;
3031 line[strlen(line) - 1] = '\0';
3034 dir->dir_entry->basename = getStringCopy(line);
3035 dir->dir_entry->filename = getPath2(dir->filename, line);
3037 return dir->dir_entry;
3041 struct dirent *dir_entry = readdir(dir->dir);
3043 if (dir_entry == NULL)
3046 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3048 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3049 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3051 struct stat file_status;
3053 dir->dir_entry->is_directory =
3054 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3055 S_ISDIR(file_status.st_mode));
3057 return dir->dir_entry;
3060 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3062 if (dir_entry == NULL)
3065 checked_free(dir_entry->basename);
3066 checked_free(dir_entry->filename);
3067 checked_free(dir_entry);
3071 // ----------------------------------------------------------------------------
3072 // functions for checking files and filenames
3073 // ----------------------------------------------------------------------------
3075 boolean directoryExists(char *dir_name)
3077 if (dir_name == NULL)
3080 struct stat file_status;
3081 boolean success = (stat(dir_name, &file_status) == 0 &&
3082 S_ISDIR(file_status.st_mode));
3084 #if defined(PLATFORM_ANDROID)
3087 // this might be an asset directory; check by trying to open toc file
3088 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3089 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3091 checked_free(asset_toc_filename);
3093 success = (file != NULL);
3103 boolean fileExists(char *filename)
3105 if (filename == NULL)
3108 boolean success = (access(filename, F_OK) == 0);
3110 #if defined(PLATFORM_ANDROID)
3113 // this might be an asset file; check by trying to open it
3114 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3116 success = (file != NULL);
3127 static boolean fileHasPrefix(char *basename, char *prefix)
3129 static char *basename_lower = NULL;
3130 int basename_length, prefix_length;
3132 checked_free(basename_lower);
3134 if (basename == NULL || prefix == NULL)
3137 basename_lower = getStringToLower(basename);
3138 basename_length = strlen(basename_lower);
3139 prefix_length = strlen(prefix);
3141 if (basename_length > prefix_length + 1 &&
3142 basename_lower[prefix_length] == '.' &&
3143 strncmp(basename_lower, prefix, prefix_length) == 0)
3150 static boolean fileHasSuffix(char *basename, char *suffix)
3152 static char *basename_lower = NULL;
3153 int basename_length, suffix_length;
3155 checked_free(basename_lower);
3157 if (basename == NULL || suffix == NULL)
3160 basename_lower = getStringToLower(basename);
3161 basename_length = strlen(basename_lower);
3162 suffix_length = strlen(suffix);
3164 if (basename_length > suffix_length + 1 &&
3165 basename_lower[basename_length - suffix_length - 1] == '.' &&
3166 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3172 static boolean FileCouldBeArtwork(char *filename)
3174 char *basename = getBaseNamePtr(filename);
3176 return (!strEqual(basename, ".") &&
3177 !strEqual(basename, "..") &&
3178 !fileHasSuffix(basename, "txt") &&
3179 !fileHasSuffix(basename, "conf") &&
3180 !directoryExists(filename));
3183 boolean FileIsGraphic(char *filename)
3185 return FileCouldBeArtwork(filename);
3188 boolean FileIsSound(char *filename)
3190 return FileCouldBeArtwork(filename);
3193 boolean FileIsMusic(char *filename)
3195 return FileCouldBeArtwork(filename);
3198 boolean FileIsArtworkType(char *filename, int type)
3200 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3201 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3202 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3208 // ----------------------------------------------------------------------------
3209 // functions for loading artwork configuration information
3210 // ----------------------------------------------------------------------------
3212 char *get_mapped_token(char *token)
3214 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3215 static char *map_token_prefix[][2] =
3217 { "char_procent", "char_percent" },
3218 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3219 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3220 { "bd_butterfly_left", "bd_butterfly.left" },
3221 { "bd_butterfly_right", "bd_butterfly.right" },
3222 { "bd_butterfly_up", "bd_butterfly.up" },
3223 { "bd_butterfly_down", "bd_butterfly.down" },
3224 { "bd_firefly_left", "bd_firefly.left" },
3225 { "bd_firefly_right", "bd_firefly.right" },
3226 { "bd_firefly_up", "bd_firefly.up" },
3227 { "bd_firefly_down", "bd_firefly.down" },
3233 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3235 int len_token_prefix = strlen(map_token_prefix[i][0]);
3237 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3238 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3241 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3242 char *gfx_substring = ".gfx";
3243 char *gfx_prefix = "gfx.";
3244 if (strstr(token, gfx_substring) != NULL)
3246 char *token_prefix = getStringCopy(token);
3247 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3248 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3251 // cut off token string at ".gfx" substring position
3252 *token_gfx_pos = '\0';
3254 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3255 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3259 return mapped_token;
3265 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3268 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3269 static struct ConfigTypeInfo prefix_list[] =
3271 { "global.anim_1" },
3272 { "global.anim_2" },
3273 { "global.anim_3" },
3274 { "global.anim_4" },
3275 { "global.anim_5" },
3276 { "global.anim_6" },
3277 { "global.anim_7" },
3278 { "global.anim_8" },
3279 { "global.anim_9" },
3280 { "global.anim_10" },
3281 { "global.anim_11" },
3282 { "global.anim_12" },
3283 { "global.anim_13" },
3284 { "global.anim_14" },
3285 { "global.anim_15" },
3286 { "global.anim_16" },
3287 { "global.anim_17" },
3288 { "global.anim_18" },
3289 { "global.anim_19" },
3290 { "global.anim_20" },
3291 { "global.anim_21" },
3292 { "global.anim_22" },
3293 { "global.anim_23" },
3294 { "global.anim_24" },
3295 { "global.anim_25" },
3296 { "global.anim_26" },
3297 { "global.anim_27" },
3298 { "global.anim_28" },
3299 { "global.anim_29" },
3300 { "global.anim_30" },
3301 { "global.anim_31" },
3302 { "global.anim_32" },
3306 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3307 boolean prefix_found = FALSE;
3311 // search for prefix to check if base token has to be created
3312 for (i = 0; prefix_list[i].token != NULL; i++)
3313 if (strPrefix(token, prefix_list[i].token))
3314 prefix_found = TRUE;
3319 // search for suffix (parameter) to determine base token length
3320 for (i = 0; suffix_list[i].token != NULL; i++)
3321 if (strSuffix(token, suffix_list[i].token))
3322 len_suffix = strlen(suffix_list[i].token);
3324 return getStringCopyN(token, strlen(token) - len_suffix);
3327 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3328 struct ListNodeInfo ***, int *);
3330 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3331 struct ConfigTypeInfo *suffix_list,
3332 char **ignore_tokens,
3333 int num_file_list_entries)
3335 SetupFileHash *ignore_tokens_hash;
3336 struct FileInfo *file_list;
3337 int num_file_list_entries_found = 0;
3338 int num_suffix_list_entries = 0;
3342 // create hash from list of tokens to be ignored (for quick access)
3343 ignore_tokens_hash = newSetupFileHash();
3344 for (i = 0; ignore_tokens[i] != NULL; i++)
3345 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3347 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3349 for (i = 0; suffix_list[i].token != NULL; i++)
3350 num_suffix_list_entries++;
3352 // always start with reliable default values
3353 for (i = 0; i < num_file_list_entries; i++)
3355 file_list[i].token = NULL;
3357 file_list[i].default_filename = NULL;
3358 file_list[i].filename = NULL;
3360 if (num_suffix_list_entries > 0)
3362 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3364 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3365 file_list[i].parameter = checked_calloc(parameter_array_size);
3367 for (j = 0; j < num_suffix_list_entries; j++)
3369 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3370 setString(&file_list[i].parameter[j], suffix_list[j].value);
3373 file_list[i].redefined = FALSE;
3374 file_list[i].fallback_to_default = FALSE;
3375 file_list[i].default_is_cloned = FALSE;
3381 for (i = 0; config_list[i].token != NULL; i++)
3383 int len_config_token = strlen(config_list[i].token);
3384 boolean is_file_entry = TRUE;
3386 for (j = 0; suffix_list[j].token != NULL; j++)
3388 int len_suffix = strlen(suffix_list[j].token);
3390 if (len_suffix < len_config_token &&
3391 strEqual(&config_list[i].token[len_config_token - len_suffix],
3392 suffix_list[j].token))
3394 setString(&file_list[list_pos].default_parameter[j],
3395 config_list[i].value);
3397 is_file_entry = FALSE;
3403 // the following tokens are no file definitions, but other config tokens
3404 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3405 is_file_entry = FALSE;
3412 if (list_pos >= num_file_list_entries)
3415 file_list[list_pos].token = config_list[i].token;
3416 file_list[list_pos].default_filename = config_list[i].value;
3419 if (strSuffix(config_list[i].token, ".clone_from"))
3420 file_list[list_pos].default_is_cloned = TRUE;
3423 num_file_list_entries_found = list_pos + 1;
3424 if (num_file_list_entries_found != num_file_list_entries)
3427 Error("inconsistant config list information:");
3428 Error("- should be: %d (according to 'src/conf_xxx.h')",
3429 num_file_list_entries);
3430 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3431 num_file_list_entries_found);
3436 freeSetupFileHash(ignore_tokens_hash);
3441 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3443 int len_token = strlen(token);
3444 int len_suffix = strlen(suffix);
3446 if (start_pos < 0) // compare suffix from end of string
3447 start_pos += len_token;
3449 if (start_pos < 0 || start_pos + len_suffix > len_token)
3452 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3455 if (token[start_pos + len_suffix] == '\0')
3458 if (token[start_pos + len_suffix] == '.')
3464 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3466 static void read_token_parameters(SetupFileHash *setup_file_hash,
3467 struct ConfigTypeInfo *suffix_list,
3468 struct FileInfo *file_list_entry)
3470 // check for config token that is the base token without any suffixes
3471 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3472 char *known_token_value = KNOWN_TOKEN_VALUE;
3475 if (filename != NULL)
3477 setString(&file_list_entry->filename, filename);
3479 // when file definition found, set all parameters to default values
3480 for (i = 0; suffix_list[i].token != NULL; i++)
3481 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3483 file_list_entry->redefined = TRUE;
3485 // mark config file token as well known from default config
3486 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3489 // check for config tokens that can be build by base token and suffixes
3490 for (i = 0; suffix_list[i].token != NULL; i++)
3492 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3493 char *value = getHashEntry(setup_file_hash, token);
3497 setString(&file_list_entry->parameter[i], value);
3499 // mark config file token as well known from default config
3500 setHashEntry(setup_file_hash, token, known_token_value);
3507 static void add_dynamic_file_list_entry(struct FileInfo **list,
3508 int *num_list_entries,
3509 SetupFileHash *extra_file_hash,
3510 struct ConfigTypeInfo *suffix_list,
3511 int num_suffix_list_entries,
3514 struct FileInfo *new_list_entry;
3515 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3517 (*num_list_entries)++;
3518 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3519 new_list_entry = &(*list)[*num_list_entries - 1];
3521 new_list_entry->token = getStringCopy(token);
3522 new_list_entry->default_filename = NULL;
3523 new_list_entry->filename = NULL;
3524 new_list_entry->parameter = checked_calloc(parameter_array_size);
3526 new_list_entry->redefined = FALSE;
3527 new_list_entry->fallback_to_default = FALSE;
3528 new_list_entry->default_is_cloned = FALSE;
3530 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3533 static void add_property_mapping(struct PropertyMapping **list,
3534 int *num_list_entries,
3535 int base_index, int ext1_index,
3536 int ext2_index, int ext3_index,
3539 struct PropertyMapping *new_list_entry;
3541 (*num_list_entries)++;
3542 *list = checked_realloc(*list,
3543 *num_list_entries * sizeof(struct PropertyMapping));
3544 new_list_entry = &(*list)[*num_list_entries - 1];
3546 new_list_entry->base_index = base_index;
3547 new_list_entry->ext1_index = ext1_index;
3548 new_list_entry->ext2_index = ext2_index;
3549 new_list_entry->ext3_index = ext3_index;
3551 new_list_entry->artwork_index = artwork_index;
3554 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3557 struct FileInfo *file_list = artwork_info->file_list;
3558 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3559 char **base_prefixes = artwork_info->base_prefixes;
3560 char **ext1_suffixes = artwork_info->ext1_suffixes;
3561 char **ext2_suffixes = artwork_info->ext2_suffixes;
3562 char **ext3_suffixes = artwork_info->ext3_suffixes;
3563 char **ignore_tokens = artwork_info->ignore_tokens;
3564 int num_file_list_entries = artwork_info->num_file_list_entries;
3565 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3566 int num_base_prefixes = artwork_info->num_base_prefixes;
3567 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3568 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3569 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3570 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3571 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3572 SetupFileHash *extra_file_hash, *empty_file_hash;
3573 char *known_token_value = KNOWN_TOKEN_VALUE;
3574 char *base_token_value = UNDEFINED_FILENAME;
3577 if (filename == NULL)
3580 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3583 // separate valid (defined) from empty (undefined) config token values
3584 valid_file_hash = newSetupFileHash();
3585 empty_file_hash = newSetupFileHash();
3586 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3588 char *value = HASH_ITERATION_VALUE(itr);
3590 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3591 HASH_ITERATION_TOKEN(itr), value);
3593 END_HASH_ITERATION(setup_file_hash, itr)
3595 // at this point, we do not need the setup file hash anymore -- free it
3596 freeSetupFileHash(setup_file_hash);
3598 // prevent changing hash while iterating over it by using a temporary copy
3599 valid_file_hash_tmp = newSetupFileHash();
3600 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3602 setHashEntry(valid_file_hash_tmp,
3603 HASH_ITERATION_TOKEN(itr),
3604 HASH_ITERATION_VALUE(itr));
3606 END_HASH_ITERATION(valid_file_hash, itr)
3608 // (iterate over same temporary hash, as modifications are independent)
3610 // map deprecated to current tokens (using prefix match and replace)
3611 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3613 char *token = HASH_ITERATION_TOKEN(itr);
3614 char *mapped_token = get_mapped_token(token);
3616 if (mapped_token != NULL)
3618 char *value = HASH_ITERATION_VALUE(itr);
3621 setHashEntry(valid_file_hash, mapped_token, value);
3623 // ignore old token (by setting it to "known" keyword)
3624 setHashEntry(valid_file_hash, token, known_token_value);
3629 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3631 // add special base tokens (using prefix match and replace)
3632 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3634 char *token = HASH_ITERATION_TOKEN(itr);
3635 char *base_token = get_special_base_token(artwork_info, token);
3637 if (base_token != NULL)
3639 // add base token only if it does not already exist
3640 if (getHashEntry(valid_file_hash, base_token) == NULL)
3641 setHashEntry(valid_file_hash, base_token, base_token_value);
3646 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3648 // free temporary hash used for iteration
3649 freeSetupFileHash(valid_file_hash_tmp);
3651 // read parameters for all known config file tokens
3652 for (i = 0; i < num_file_list_entries; i++)
3653 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3655 // set all tokens that can be ignored here to "known" keyword
3656 for (i = 0; i < num_ignore_tokens; i++)
3657 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3659 // copy all unknown config file tokens to extra config hash
3660 extra_file_hash = newSetupFileHash();
3661 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3663 char *value = HASH_ITERATION_VALUE(itr);
3665 if (!strEqual(value, known_token_value))
3666 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3668 END_HASH_ITERATION(valid_file_hash, itr)
3670 // at this point, we do not need the valid file hash anymore -- free it
3671 freeSetupFileHash(valid_file_hash);
3673 // now try to determine valid, dynamically defined config tokens
3675 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3677 struct FileInfo **dynamic_file_list =
3678 &artwork_info->dynamic_file_list;
3679 int *num_dynamic_file_list_entries =
3680 &artwork_info->num_dynamic_file_list_entries;
3681 struct PropertyMapping **property_mapping =
3682 &artwork_info->property_mapping;
3683 int *num_property_mapping_entries =
3684 &artwork_info->num_property_mapping_entries;
3685 int current_summarized_file_list_entry =
3686 artwork_info->num_file_list_entries +
3687 artwork_info->num_dynamic_file_list_entries;
3688 char *token = HASH_ITERATION_TOKEN(itr);
3689 int len_token = strlen(token);
3691 boolean base_prefix_found = FALSE;
3692 boolean parameter_suffix_found = FALSE;
3694 // skip all parameter definitions (handled by read_token_parameters())
3695 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3697 int len_suffix = strlen(suffix_list[i].token);
3699 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3700 parameter_suffix_found = TRUE;
3703 if (parameter_suffix_found)
3706 // ---------- step 0: search for matching base prefix ----------
3709 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3711 char *base_prefix = base_prefixes[i];
3712 int len_base_prefix = strlen(base_prefix);
3713 boolean ext1_suffix_found = FALSE;
3714 boolean ext2_suffix_found = FALSE;
3715 boolean ext3_suffix_found = FALSE;
3716 boolean exact_match = FALSE;
3717 int base_index = -1;
3718 int ext1_index = -1;
3719 int ext2_index = -1;
3720 int ext3_index = -1;
3722 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3724 if (!base_prefix_found)
3729 if (start_pos + len_base_prefix == len_token) // exact match
3733 add_dynamic_file_list_entry(dynamic_file_list,
3734 num_dynamic_file_list_entries,
3737 num_suffix_list_entries,
3739 add_property_mapping(property_mapping,
3740 num_property_mapping_entries,
3741 base_index, -1, -1, -1,
3742 current_summarized_file_list_entry);
3746 // ---------- step 1: search for matching first suffix ----------
3748 start_pos += len_base_prefix;
3749 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3751 char *ext1_suffix = ext1_suffixes[j];
3752 int len_ext1_suffix = strlen(ext1_suffix);
3754 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3756 if (!ext1_suffix_found)
3761 if (start_pos + len_ext1_suffix == len_token) // exact match
3765 add_dynamic_file_list_entry(dynamic_file_list,
3766 num_dynamic_file_list_entries,
3769 num_suffix_list_entries,
3771 add_property_mapping(property_mapping,
3772 num_property_mapping_entries,
3773 base_index, ext1_index, -1, -1,
3774 current_summarized_file_list_entry);
3778 start_pos += len_ext1_suffix;
3784 // ---------- step 2: search for matching second suffix ----------
3786 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3788 char *ext2_suffix = ext2_suffixes[k];
3789 int len_ext2_suffix = strlen(ext2_suffix);
3791 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3793 if (!ext2_suffix_found)
3798 if (start_pos + len_ext2_suffix == len_token) // exact match
3802 add_dynamic_file_list_entry(dynamic_file_list,
3803 num_dynamic_file_list_entries,
3806 num_suffix_list_entries,
3808 add_property_mapping(property_mapping,
3809 num_property_mapping_entries,
3810 base_index, ext1_index, ext2_index, -1,
3811 current_summarized_file_list_entry);
3815 start_pos += len_ext2_suffix;
3821 // ---------- step 3: search for matching third suffix ----------
3823 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3825 char *ext3_suffix = ext3_suffixes[l];
3826 int len_ext3_suffix = strlen(ext3_suffix);
3828 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3830 if (!ext3_suffix_found)
3835 if (start_pos + len_ext3_suffix == len_token) // exact match
3839 add_dynamic_file_list_entry(dynamic_file_list,
3840 num_dynamic_file_list_entries,
3843 num_suffix_list_entries,
3845 add_property_mapping(property_mapping,
3846 num_property_mapping_entries,
3847 base_index, ext1_index, ext2_index, ext3_index,
3848 current_summarized_file_list_entry);
3854 END_HASH_ITERATION(extra_file_hash, itr)
3856 if (artwork_info->num_dynamic_file_list_entries > 0)
3858 artwork_info->dynamic_artwork_list =
3859 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3860 artwork_info->sizeof_artwork_list_entry);
3863 if (options.verbose && IS_PARENT_PROCESS())
3865 SetupFileList *setup_file_list, *list;
3866 boolean dynamic_tokens_found = FALSE;
3867 boolean unknown_tokens_found = FALSE;
3868 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3870 // list may be NULL for empty artwork config files
3871 setup_file_list = loadSetupFileList(filename);
3873 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3875 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3876 dynamic_tokens_found = TRUE;
3878 unknown_tokens_found = TRUE;
3880 END_HASH_ITERATION(extra_file_hash, itr)
3882 if (options.debug && dynamic_tokens_found)
3884 Debug("config", "---");
3885 Debug("config", "dynamic token(s) found in config file:");
3886 Debug("config", "- config file: '%s'", filename);
3888 for (list = setup_file_list; list != NULL; list = list->next)
3890 char *value = getHashEntry(extra_file_hash, list->token);
3892 if (value != NULL && strEqual(value, known_token_value))
3893 Debug("config", "- dynamic token: '%s'", list->token);
3896 Debug("config", "---");
3899 if (unknown_tokens_found)
3902 Warn("unknown token(s) found in config file:");
3903 Warn("- config file: '%s'", filename);
3905 for (list = setup_file_list; list != NULL; list = list->next)
3907 char *value = getHashEntry(extra_file_hash, list->token);
3909 if (value != NULL && !strEqual(value, known_token_value))
3910 Warn("- dynamic token: '%s'", list->token);
3916 if (undefined_values_found)
3919 Warn("undefined values found in config file:");
3920 Warn("- config file: '%s'", filename);
3922 for (list = setup_file_list; list != NULL; list = list->next)
3924 char *value = getHashEntry(empty_file_hash, list->token);
3927 Warn("- undefined value for token: '%s'", list->token);
3933 freeSetupFileList(setup_file_list);
3936 freeSetupFileHash(extra_file_hash);
3937 freeSetupFileHash(empty_file_hash);
3940 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3942 struct FileInfo *file_list = artwork_info->file_list;
3943 int num_file_list_entries = artwork_info->num_file_list_entries;
3944 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3945 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3948 DrawInitTextHead("Loading artwork config");
3949 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
3951 // always start with reliable default values
3952 for (i = 0; i < num_file_list_entries; i++)
3954 setString(&file_list[i].filename, file_list[i].default_filename);
3956 for (j = 0; j < num_suffix_list_entries; j++)
3957 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3959 file_list[i].redefined = FALSE;
3960 file_list[i].fallback_to_default = FALSE;
3963 // free previous dynamic artwork file array
3964 if (artwork_info->dynamic_file_list != NULL)
3966 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3968 free(artwork_info->dynamic_file_list[i].token);
3969 free(artwork_info->dynamic_file_list[i].filename);
3970 free(artwork_info->dynamic_file_list[i].parameter);
3973 free(artwork_info->dynamic_file_list);
3974 artwork_info->dynamic_file_list = NULL;
3976 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3977 &artwork_info->num_dynamic_file_list_entries);
3980 // free previous property mapping
3981 if (artwork_info->property_mapping != NULL)
3983 free(artwork_info->property_mapping);
3985 artwork_info->property_mapping = NULL;
3986 artwork_info->num_property_mapping_entries = 0;
3989 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3991 // first look for special artwork configured in level series config
3992 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3994 if (fileExists(filename_base))
3995 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3998 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4000 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4001 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4004 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4005 struct ListNodeInfo **listnode)
4009 char *filename = (*listnode)->source_filename;
4011 if (--(*listnode)->num_references <= 0)
4012 deleteNodeFromList(&artwork_info->content_list, filename,
4013 artwork_info->free_artwork);
4019 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4020 struct ListNodeInfo **listnode,
4021 struct FileInfo *file_list_entry)
4031 char *basename = file_list_entry->filename;
4032 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4034 // mark all images from non-default graphics directory as "redefined"
4035 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4036 !strPrefix(filename, options.graphics_directory))
4037 file_list_entry->redefined = TRUE;
4039 if (filename == NULL)
4041 Warn("cannot find artwork file '%s'", basename);
4043 basename = file_list_entry->default_filename;
4045 // fail for cloned default artwork that has no default filename defined
4046 if (file_list_entry->default_is_cloned &&
4047 strEqual(basename, UNDEFINED_FILENAME))
4049 void (*error_func)(char *, ...) = Warn;
4051 // we can get away without sounds and music, but not without graphics
4052 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4055 error_func("token '%s' was cloned and has no default filename",
4056 file_list_entry->token);
4061 // dynamic artwork has no default filename / skip empty default artwork
4062 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4065 file_list_entry->fallback_to_default = TRUE;
4067 Warn("trying default artwork file '%s'", basename);
4069 filename = getCustomArtworkFilename(basename, artwork_info->type);
4071 if (filename == NULL)
4073 void (*error_func)(char *, ...) = Warn;
4075 // we can get away without sounds and music, but not without graphics
4076 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4079 error_func("cannot find default artwork file '%s'", basename);
4085 // check if the old and the new artwork file are the same
4086 if (*listnode && strEqual((*listnode)->source_filename, filename))
4088 // The old and new artwork are the same (have the same filename and path).
4089 // This usually means that this artwork does not exist in this artwork set
4090 // and a fallback to the existing artwork is done.
4095 // delete existing artwork file entry
4096 deleteArtworkListEntry(artwork_info, listnode);
4098 // check if the new artwork file already exists in the list of artwork
4099 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4101 *listnode = (struct ListNodeInfo *)node->content;
4102 (*listnode)->num_references++;
4107 DrawInitTextHead(init_text[artwork_info->type]);
4108 DrawInitTextItem(basename);
4110 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4112 // add new artwork file entry to the list of artwork files
4113 (*listnode)->num_references = 1;
4114 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4119 void (*error_func)(char *, ...) = Warn;
4121 // we can get away without sounds and music, but not without graphics
4122 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4125 error_func("cannot load artwork file '%s'", basename);
4131 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4132 struct ListNodeInfo **listnode,
4133 struct FileInfo *file_list_entry)
4135 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4137 deleteArtworkListEntry(artwork_info, listnode);
4142 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4145 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4147 struct FileInfo *file_list = artwork_info->file_list;
4148 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4149 int num_file_list_entries = artwork_info->num_file_list_entries;
4150 int num_dynamic_file_list_entries =
4151 artwork_info->num_dynamic_file_list_entries;
4154 print_timestamp_init("ReloadCustomArtworkList");
4156 for (i = 0; i < num_file_list_entries; i++)
4157 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4160 for (i = 0; i < num_dynamic_file_list_entries; i++)
4161 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4162 &dynamic_file_list[i]);
4164 print_timestamp_done("ReloadCustomArtworkList");
4167 dumpList(artwork_info->content_list);
4171 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4172 struct ListNodeInfo ***list,
4173 int *num_list_entries)
4180 for (i = 0; i < *num_list_entries; i++)
4181 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4185 *num_list_entries = 0;
4188 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4190 if (artwork_info == NULL)
4193 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4194 &artwork_info->num_file_list_entries);
4196 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4197 &artwork_info->num_dynamic_file_list_entries);
4201 // ----------------------------------------------------------------------------
4202 // functions only needed for non-Unix (non-command-line) systems
4203 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4204 // (now also added for Windows, to create files in user data directory)
4205 // ----------------------------------------------------------------------------
4207 char *getLogBasename(char *basename)
4209 return getStringCat2(basename, ".log");
4212 char *getLogFilename(char *basename)
4214 return getPath2(getMainUserGameDataDir(), basename);
4217 void OpenLogFile(void)
4219 InitMainUserDataDirectory();
4221 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4223 program.log_file = program.log_file_default; // reset to default
4225 Warn("cannot open file '%s' for writing: %s",
4226 program.log_filename, strerror(errno));
4229 // output should be unbuffered so it is not truncated in a crash
4230 setbuf(program.log_file, NULL);
4233 void CloseLogFile(void)
4235 if (program.log_file != program.log_file_default)
4236 fclose(program.log_file);
4239 void DumpLogFile(void)
4241 FILE *log_file = fopen(program.log_filename, MODE_READ);
4243 if (log_file == NULL)
4246 while (!feof(log_file))
4247 fputc(fgetc(log_file), stdout);
4252 void NotifyUserAboutErrorFile(void)
4254 #if defined(PLATFORM_WINDOWS)
4255 char *title_text = getStringCat2(program.program_title, " Error Message");
4256 char *error_text = getStringCat2("The program was aborted due to an error; "
4257 "for details, see the following error file:"
4259 program.log_filename);
4261 MessageBox(NULL, error_text, title_text, MB_OK);
4266 // ----------------------------------------------------------------------------
4267 // the following is only for debugging purpose and normally not used
4268 // ----------------------------------------------------------------------------
4272 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4273 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4275 #define DEBUG_NUM_TIMESTAMPS 10
4276 #define DEBUG_TIME_IN_MICROSECONDS 0
4278 #if DEBUG_TIME_IN_MICROSECONDS
4279 static double Counter_Microseconds(void)
4281 static struct timeval base_time = { 0, 0 };
4282 struct timeval current_time;
4285 gettimeofday(¤t_time, NULL);
4287 // reset base time in case of wrap-around
4288 if (current_time.tv_sec < base_time.tv_sec)
4289 base_time = current_time;
4292 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4293 ((double)(current_time.tv_usec - base_time.tv_usec));
4295 return counter; // return microseconds since last init
4299 static char *debug_print_timestamp_get_padding(int padding_size)
4301 static char *padding = NULL;
4302 int max_padding_size = 100;
4304 if (padding == NULL)
4306 padding = checked_calloc(max_padding_size + 1);
4307 memset(padding, ' ', max_padding_size);
4310 return &padding[MAX(0, max_padding_size - padding_size)];
4313 void debug_print_timestamp(int counter_nr, char *message)
4315 int indent_size = 8;
4316 int padding_size = 40;
4317 float timestamp_interval;
4320 Fail("debugging: invalid negative counter");
4321 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4322 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4324 #if DEBUG_TIME_IN_MICROSECONDS
4325 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4328 counter[counter_nr][0] = Counter_Microseconds();
4330 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4333 counter[counter_nr][0] = Counter();
4336 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4337 counter[counter_nr][1] = counter[counter_nr][0];
4340 Debug("time:init", "%s%s%s %.3f %s",
4341 debug_print_timestamp_get_padding(counter_nr * indent_size),
4343 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4344 timestamp_interval / 1000,
4349 static void debug_print_parent_only(char *format, ...)
4351 if (!IS_PARENT_PROCESS())
4358 va_start(ap, format);
4359 vprintf(format, ap);
4369 static void print_timestamp_ext(char *message, char *mode)
4371 #if DEBUG_PRINT_INIT_TIMESTAMPS
4372 static char *debug_message = NULL;
4373 static char *last_message = NULL;
4374 static int counter_nr = 0;
4375 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4377 checked_free(debug_message);
4378 debug_message = getStringCat3(mode, " ", message);
4380 if (strEqual(mode, "INIT"))
4382 debug_print_timestamp(counter_nr, NULL);
4384 if (counter_nr + 1 < max_depth)
4385 debug_print_timestamp(counter_nr, debug_message);
4389 debug_print_timestamp(counter_nr, NULL);
4391 else if (strEqual(mode, "DONE"))
4395 if (counter_nr + 1 < max_depth ||
4396 (counter_nr == 0 && max_depth == 1))
4398 last_message = message;
4400 if (counter_nr == 0 && max_depth == 1)
4402 checked_free(debug_message);
4403 debug_message = getStringCat3("TIME", " ", message);
4406 debug_print_timestamp(counter_nr, debug_message);
4409 else if (!strEqual(mode, "TIME") ||
4410 !strEqual(message, last_message))
4412 if (counter_nr < max_depth)
4413 debug_print_timestamp(counter_nr, debug_message);
4418 void print_timestamp_init(char *message)
4420 print_timestamp_ext(message, "INIT");
4423 void print_timestamp_time(char *message)
4425 print_timestamp_ext(message, "TIME");
4428 void print_timestamp_done(char *message)
4430 print_timestamp_ext(message, "DONE");