1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter() // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter() // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToLower(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = tolower(*s++);
1235 void setString(char **old_value, const char *new_value)
1237 checked_free(*old_value);
1239 *old_value = getStringCopy(new_value);
1242 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1244 const char *s_ptr, *s_last = s;
1245 byte separator_table[256] = { FALSE };
1247 char **tokens = NULL;
1252 if (separators == NULL)
1256 max_tokens = INT_MAX;
1258 // if string is empty, return empty array
1261 tokens = checked_malloc(sizeof(char *));
1267 // initialize separator table for all characters in separators string
1268 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1269 separator_table[*(byte *)s_ptr] = TRUE;
1271 // count number of tokens in string
1272 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1273 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1276 // allocate array for determined number of tokens
1277 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1279 // copy all but last separated sub-strings to array
1280 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1282 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1284 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1289 // copy last separated sub-string to array
1290 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1293 tokens[num_tokens] = NULL;
1298 int getStringArrayLength(char **s_array)
1300 int num_strings = 0;
1302 if (s_array == NULL)
1305 while (s_array[num_strings] != NULL)
1311 void freeStringArray(char **s_array)
1315 if (s_array == NULL)
1318 for (i = 0; s_array[i] != NULL; i++)
1319 checked_free(s_array[i]);
1321 checked_free(s_array);
1324 boolean strEqual(const char *s1, const char *s2)
1326 return (s1 == NULL && s2 == NULL ? TRUE :
1327 s1 == NULL && s2 != NULL ? FALSE :
1328 s1 != NULL && s2 == NULL ? FALSE :
1329 strcmp(s1, s2) == 0);
1332 boolean strEqualN(const char *s1, const char *s2, int n)
1334 return (s1 == NULL && s2 == NULL ? TRUE :
1335 s1 == NULL && s2 != NULL ? FALSE :
1336 s1 != NULL && s2 == NULL ? FALSE :
1337 strncmp(s1, s2, n) == 0);
1340 boolean strEqualCase(const char *s1, const char *s2)
1342 return (s1 == NULL && s2 == NULL ? TRUE :
1343 s1 == NULL && s2 != NULL ? FALSE :
1344 s1 != NULL && s2 == NULL ? FALSE :
1345 strcasecmp(s1, s2) == 0);
1348 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1350 return (s1 == NULL && s2 == NULL ? TRUE :
1351 s1 == NULL && s2 != NULL ? FALSE :
1352 s1 != NULL && s2 == NULL ? FALSE :
1353 strncasecmp(s1, s2, n) == 0);
1356 boolean strPrefix(const char *s, const char *prefix)
1358 return (s == NULL && prefix == NULL ? TRUE :
1359 s == NULL && prefix != NULL ? FALSE :
1360 s != NULL && prefix == NULL ? FALSE :
1361 strncmp(s, prefix, strlen(prefix)) == 0);
1364 boolean strSuffix(const char *s, const char *suffix)
1366 return (s == NULL && suffix == NULL ? TRUE :
1367 s == NULL && suffix != NULL ? FALSE :
1368 s != NULL && suffix == NULL ? FALSE :
1369 strlen(s) < strlen(suffix) ? FALSE :
1370 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1373 boolean strPrefixLower(const char *s, const char *prefix)
1375 char *s_lower = getStringToLower(s);
1376 boolean match = strPrefix(s_lower, prefix);
1383 boolean strSuffixLower(const char *s, const char *suffix)
1385 char *s_lower = getStringToLower(s);
1386 boolean match = strSuffix(s_lower, suffix);
1393 boolean isURL(const char *s)
1395 while (*s && *s >= 'a' && *s <= 'z')
1398 return strPrefix(s, "://");
1402 // ----------------------------------------------------------------------------
1403 // command line option handling functions
1404 // ----------------------------------------------------------------------------
1406 void GetOptions(int argc, char *argv[],
1407 void (*print_usage_function)(void),
1408 void (*print_version_function)(void))
1410 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1411 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1412 char **options_left = &argvplus[1];
1414 // replace original "argv" with null-terminated array of string pointers
1416 argvplus[argc] = argv[argc];
1418 // initialize global program options
1419 options.server_host = NULL;
1420 options.server_port = 0;
1422 options.base_directory = base_path;
1424 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1425 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1426 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1427 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1428 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1429 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1431 options.execute_command = NULL;
1432 options.tape_log_filename = NULL;
1433 options.special_flags = NULL;
1434 options.debug_mode = NULL;
1435 options.player_name = NULL;
1436 options.identifier = NULL;
1437 options.level_nr = NULL;
1439 options.display_nr = 0;
1441 options.mytapes = FALSE;
1442 options.serveronly = FALSE;
1443 options.network = FALSE;
1444 options.verbose = FALSE;
1445 options.debug = FALSE;
1448 options.verbose = TRUE;
1450 #if !defined(PLATFORM_UNIX)
1451 if (*options_left == NULL) // no options given -- enable verbose mode
1452 options.verbose = TRUE;
1457 #if defined(PLATFORM_ANDROID)
1458 options.debug = TRUE;
1462 while (*options_left)
1464 char option_str[MAX_OPTION_LEN];
1465 char *option = options_left[0];
1466 char *next_option = options_left[1];
1467 char *option_arg = NULL;
1468 int option_len = strlen(option);
1470 if (option_len >= MAX_OPTION_LEN)
1471 FailWithHelp("unrecognized option '%s'", option);
1473 strcpy(option_str, option); // copy argument into buffer
1474 option = option_str;
1476 if (strEqual(option, "--")) // stop scanning arguments
1479 if (strPrefix(option, "--")) // treat '--' like '-'
1482 option_arg = strchr(option, '=');
1483 if (option_arg == NULL) // no '=' in option
1484 option_arg = next_option;
1487 *option_arg++ = '\0'; // cut argument from option
1488 if (*option_arg == '\0') // no argument after '='
1489 FailWithHelp("option '%s' has invalid argument", option_str);
1492 option_len = strlen(option);
1494 if (strEqual(option, "-"))
1496 FailWithHelp("unrecognized option '%s'", option);
1498 else if (strncmp(option, "-help", option_len) == 0)
1500 print_usage_function();
1504 else if (strncmp(option, "-basepath", option_len) == 0)
1506 if (option_arg == NULL)
1507 FailWithHelp("option '%s' requires an argument", option_str);
1509 options.base_directory = base_path = getStringCopy(option_arg);
1510 if (option_arg == next_option)
1513 // adjust paths for sub-directories in base directory accordingly
1514 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1515 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1516 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1517 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1518 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1519 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1521 else if (strncmp(option, "-levels", option_len) == 0)
1523 if (option_arg == NULL)
1524 FailWithHelp("option '%s' requires an argument", option_str);
1526 options.level_directory = getStringCopy(option_arg);
1527 if (option_arg == next_option)
1530 else if (strncmp(option, "-graphics", option_len) == 0)
1532 if (option_arg == NULL)
1533 FailWithHelp("option '%s' requires an argument", option_str);
1535 options.graphics_directory = getStringCopy(option_arg);
1536 if (option_arg == next_option)
1539 else if (strncmp(option, "-sounds", option_len) == 0)
1541 if (option_arg == NULL)
1542 FailWithHelp("option '%s' requires an argument", option_str);
1544 options.sounds_directory = getStringCopy(option_arg);
1545 if (option_arg == next_option)
1548 else if (strncmp(option, "-music", option_len) == 0)
1550 if (option_arg == NULL)
1551 FailWithHelp("option '%s' requires an argument", option_str);
1553 options.music_directory = getStringCopy(option_arg);
1554 if (option_arg == next_option)
1557 else if (strncmp(option, "-mytapes", option_len) == 0)
1559 options.mytapes = TRUE;
1561 else if (strncmp(option, "-network", option_len) == 0)
1563 options.network = TRUE;
1565 else if (strncmp(option, "-serveronly", option_len) == 0)
1567 options.serveronly = TRUE;
1569 else if (strncmp(option, "-debug", option_len) == 0)
1571 options.debug = TRUE;
1573 // optionally, debug output can be limited to a specific debug mode
1574 if (option_arg != next_option)
1575 options.debug_mode = getStringCopy(option_arg);
1577 else if (strncmp(option, "-player-name", option_len) == 0)
1579 if (option_arg == NULL)
1580 FailWithHelp("option '%s' requires an argument", option_str);
1582 options.player_name = getStringCopy(option_arg);
1583 if (option_arg == next_option)
1586 else if (strncmp(option, "-identifier", option_len) == 0)
1588 if (option_arg == NULL)
1589 FailWithHelp("option '%s' requires an argument", option_str);
1591 options.identifier = getStringCopy(option_arg);
1592 if (option_arg == next_option)
1595 else if (strncmp(option, "-level-nr", option_len) == 0)
1597 if (option_arg == NULL)
1598 FailWithHelp("option '%s' requires an argument", option_str);
1600 options.level_nr = getStringCopy(option_arg);
1601 if (option_arg == next_option)
1604 else if (strncmp(option, "-verbose", option_len) == 0)
1606 options.verbose = TRUE;
1608 else if (strncmp(option, "-version", option_len) == 0 ||
1609 strncmp(option, "-V", option_len) == 0)
1611 print_version_function();
1615 else if (strPrefix(option, "-D"))
1617 options.special_flags = getStringCopy(&option[2]);
1619 else if (strncmp(option, "-execute", option_len) == 0)
1621 if (option_arg == NULL)
1622 FailWithHelp("option '%s' requires an argument", option_str);
1624 options.execute_command = getStringCopy(option_arg);
1625 if (option_arg == next_option)
1628 // when doing batch processing, always enable verbose mode (warnings)
1629 options.verbose = TRUE;
1631 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1633 if (option_arg == NULL)
1634 FailWithHelp("option '%s' requires an argument", option_str);
1636 options.tape_log_filename = getStringCopy(option_arg);
1637 if (option_arg == next_option)
1640 else if (strncmp(option, "-display", option_len) == 0)
1642 if (option_arg == NULL)
1643 FailWithHelp("option '%s' requires an argument", option_str);
1645 if (option_arg == next_option)
1648 int display_nr = atoi(option_arg);
1651 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1652 options.display_nr = display_nr;
1654 options.display_nr =
1655 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1657 if (display_nr != options.display_nr)
1658 Warn("invalid display %d -- using display %d",
1659 display_nr, options.display_nr);
1662 #if defined(PLATFORM_MAC)
1663 else if (strPrefix(option, "-psn"))
1665 // ignore process serial number when launched via GUI on Mac OS X
1668 else if (*option == '-')
1670 FailWithHelp("unrecognized option '%s'", option_str);
1672 else if (options.server_host == NULL)
1674 options.server_host = *options_left;
1676 else if (options.server_port == 0)
1678 options.server_port = atoi(*options_left);
1679 if (options.server_port < 1024)
1680 FailWithHelp("bad port number '%d'", options.server_port);
1683 FailWithHelp("too many arguments");
1690 // ----------------------------------------------------------------------------
1691 // checked memory allocation and freeing functions
1692 // ----------------------------------------------------------------------------
1694 void *checked_malloc(unsigned int size)
1701 Fail("cannot allocate %d bytes -- out of memory", size);
1706 void *checked_calloc(unsigned int size)
1710 ptr = calloc(1, size);
1713 Fail("cannot allocate %d bytes -- out of memory", size);
1718 void *checked_realloc(void *ptr, unsigned int size)
1720 ptr = realloc(ptr, size);
1723 Fail("cannot allocate %d bytes -- out of memory", size);
1728 void checked_free(void *ptr)
1730 if (ptr != NULL) // this check should be done by free() anyway
1734 void clear_mem(void *ptr, unsigned int size)
1736 #if defined(PLATFORM_WINDOWS)
1737 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1738 char *cptr = (char *)ptr;
1743 memset(ptr, 0, size);
1748 // ----------------------------------------------------------------------------
1749 // various helper functions
1750 // ----------------------------------------------------------------------------
1752 void swap_numbers(int *i1, int *i2)
1760 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1772 int get_number_of_bits(int bits)
1775 Counting bits set, Brian Kernighan's way
1777 Brian Kernighan's method goes through as many iterations as there are set
1778 bits. So if we have a 32-bit word with only the high bit set, then it will
1779 only go once through the loop.
1781 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1782 and Dennis M. Ritchie) mentions this in exercise 2-9.
1783 First published by Peter Wegner in CACM 3 (1960), 322.
1790 bits &= bits - 1; // clear the least significant bit set
1797 /* the "put" variants of the following file access functions check for the file
1798 pointer being != NULL and return the number of bytes they have or would have
1799 written; this allows for chunk writing functions to first determine the size
1800 of the (not yet written) chunk, write the correct chunk size and finally
1801 write the chunk itself */
1803 int getFile8BitInteger(File *file)
1805 return getByteFromFile(file);
1808 int putFile8BitInteger(FILE *file, int value)
1816 int getFile16BitInteger(File *file, int byte_order)
1818 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1819 return ((getByteFromFile(file) << 8) |
1820 (getByteFromFile(file) << 0));
1821 else // BYTE_ORDER_LITTLE_ENDIAN
1822 return ((getByteFromFile(file) << 0) |
1823 (getByteFromFile(file) << 8));
1826 int putFile16BitInteger(FILE *file, int value, int byte_order)
1830 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1832 fputc((value >> 8) & 0xff, file);
1833 fputc((value >> 0) & 0xff, file);
1835 else // BYTE_ORDER_LITTLE_ENDIAN
1837 fputc((value >> 0) & 0xff, file);
1838 fputc((value >> 8) & 0xff, file);
1845 int getFile32BitInteger(File *file, int byte_order)
1847 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1848 return ((getByteFromFile(file) << 24) |
1849 (getByteFromFile(file) << 16) |
1850 (getByteFromFile(file) << 8) |
1851 (getByteFromFile(file) << 0));
1852 else // BYTE_ORDER_LITTLE_ENDIAN
1853 return ((getByteFromFile(file) << 0) |
1854 (getByteFromFile(file) << 8) |
1855 (getByteFromFile(file) << 16) |
1856 (getByteFromFile(file) << 24));
1859 int putFile32BitInteger(FILE *file, int value, int byte_order)
1863 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1865 fputc((value >> 24) & 0xff, file);
1866 fputc((value >> 16) & 0xff, file);
1867 fputc((value >> 8) & 0xff, file);
1868 fputc((value >> 0) & 0xff, file);
1870 else // BYTE_ORDER_LITTLE_ENDIAN
1872 fputc((value >> 0) & 0xff, file);
1873 fputc((value >> 8) & 0xff, file);
1874 fputc((value >> 16) & 0xff, file);
1875 fputc((value >> 24) & 0xff, file);
1882 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1885 const int chunk_name_length = 4;
1888 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1891 if (chunk_size != NULL)
1894 *chunk_size = getFile32BitInteger(file, byte_order);
1897 return (checkEndOfFile(file) ? FALSE : TRUE);
1900 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1907 fputs(chunk_name, file);
1909 num_bytes += strlen(chunk_name);
1911 if (chunk_size >= 0)
1915 putFile32BitInteger(file, chunk_size, byte_order);
1923 int getFileVersion(File *file)
1925 int version_super = getByteFromFile(file);
1926 int version_major = getByteFromFile(file);
1927 int version_minor = getByteFromFile(file);
1928 int version_patch = getByteFromFile(file);
1930 return VERSION_IDENT(version_super, version_major, version_minor,
1934 int putFileVersion(FILE *file, int version)
1938 int version_super = VERSION_SUPER(version);
1939 int version_major = VERSION_MAJOR(version);
1940 int version_minor = VERSION_MINOR(version);
1941 int version_patch = VERSION_PATCH(version);
1943 fputc(version_super, file);
1944 fputc(version_major, file);
1945 fputc(version_minor, file);
1946 fputc(version_patch, file);
1952 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1956 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1957 buffer[i] = getByteFromFile(file);
1960 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1964 for (i = 0; i < bytes; i++)
1965 fputc(buffer[i], file);
1968 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1970 while (bytes-- && !checkEndOfFile(file))
1971 getByteFromFile(file);
1974 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1981 // ----------------------------------------------------------------------------
1982 // functions to convert between ISO-8859-1 and UTF-8
1983 // ----------------------------------------------------------------------------
1985 char *getUTF8FromLatin1(char *latin1)
1987 int max_utf8_size = 2 * strlen(latin1) + 1;
1988 char *utf8 = checked_calloc(max_utf8_size);
1989 unsigned char *src = (unsigned char *)latin1;
1990 unsigned char *dst = (unsigned char *)utf8;
1994 if (*src < 128) // pure 7-bit ASCII
1998 else if (*src >= 160) // non-ASCII characters
2000 *dst++ = 194 + (*src >= 192);
2001 *dst++ = 128 + (*src & 63);
2003 else // undefined in ISO-8859-1
2011 // only use the smallest possible string buffer size
2012 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2017 char *getLatin1FromUTF8(char *utf8)
2019 int max_latin1_size = strlen(utf8) + 1;
2020 char *latin1 = checked_calloc(max_latin1_size);
2021 unsigned char *src = (unsigned char *)utf8;
2022 unsigned char *dst = (unsigned char *)latin1;
2026 if (*src < 128) // pure 7-bit ASCII
2030 else if (src[0] == 194 &&
2031 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2036 else if (src[0] == 195 &&
2037 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2039 *dst++ = src[1] + 64;
2043 // all other UTF-8 characters are undefined in ISO-8859-1
2045 else if (src[0] >= 192 && src[0] < 224 &&
2046 src[1] >= 128 && src[1] < 192)
2051 else if (src[0] >= 224 && src[0] < 240 &&
2052 src[1] >= 128 && src[1] < 192 &&
2053 src[2] >= 128 && src[2] < 192)
2058 else if (src[0] >= 240 && src[0] < 248 &&
2059 src[1] >= 128 && src[1] < 192 &&
2060 src[2] >= 128 && src[2] < 192 &&
2061 src[3] >= 128 && src[3] < 192)
2066 else if (src[0] >= 248 && src[0] < 252 &&
2067 src[1] >= 128 && src[1] < 192 &&
2068 src[2] >= 128 && src[2] < 192 &&
2069 src[3] >= 128 && src[3] < 192 &&
2070 src[4] >= 128 && src[4] < 192)
2075 else if (src[0] >= 252 && src[0] < 254 &&
2076 src[1] >= 128 && src[1] < 192 &&
2077 src[2] >= 128 && src[2] < 192 &&
2078 src[3] >= 128 && src[3] < 192 &&
2079 src[4] >= 128 && src[4] < 192 &&
2080 src[5] >= 128 && src[5] < 192)
2092 // only use the smallest possible string buffer size
2093 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2098 int getTextEncoding(char *text)
2100 unsigned char *src = (unsigned char *)text;
2101 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2106 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2112 else if (src[0] >= 192 && src[0] < 224 &&
2113 src[1] >= 128 && src[1] < 192)
2117 else if (src[0] >= 224 && src[0] < 240 &&
2118 src[1] >= 128 && src[1] < 192 &&
2119 src[2] >= 128 && src[2] < 192)
2123 else if (src[0] >= 240 && src[0] < 248 &&
2124 src[1] >= 128 && src[1] < 192 &&
2125 src[2] >= 128 && src[2] < 192 &&
2126 src[3] >= 128 && src[3] < 192)
2130 else if (src[0] >= 248 && src[0] < 252 &&
2131 src[1] >= 128 && src[1] < 192 &&
2132 src[2] >= 128 && src[2] < 192 &&
2133 src[3] >= 128 && src[3] < 192 &&
2134 src[4] >= 128 && src[4] < 192)
2138 else if (src[0] >= 252 && src[0] < 254 &&
2139 src[1] >= 128 && src[1] < 192 &&
2140 src[2] >= 128 && src[2] < 192 &&
2141 src[3] >= 128 && src[3] < 192 &&
2142 src[4] >= 128 && src[4] < 192 &&
2143 src[5] >= 128 && src[5] < 192)
2149 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2157 // ----------------------------------------------------------------------------
2158 // functions for JSON handling
2159 // ----------------------------------------------------------------------------
2161 char *getEscapedJSON(char *s)
2163 int max_json_size = 2 * strlen(s) + 1;
2164 char *json = checked_calloc(max_json_size);
2165 unsigned char *src = (unsigned char *)s;
2166 unsigned char *dst = (unsigned char *)json;
2167 char *escaped[256] =
2180 if (escaped[*src] != NULL)
2182 char *esc = escaped[*src++];
2193 // only use the smallest possible string buffer size
2194 json = checked_realloc(json, strlen(json) + 1);
2200 // ----------------------------------------------------------------------------
2201 // functions to translate key identifiers between different format
2202 // ----------------------------------------------------------------------------
2204 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2205 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2206 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2207 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2209 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2218 // return and escape keys
2219 { KSYM_Return, "XK_Return", "return" },
2220 { KSYM_Escape, "XK_Escape", "escape" },
2222 // normal cursor keys
2223 { KSYM_Left, "XK_Left", "cursor left" },
2224 { KSYM_Right, "XK_Right", "cursor right" },
2225 { KSYM_Up, "XK_Up", "cursor up" },
2226 { KSYM_Down, "XK_Down", "cursor down" },
2228 // keypad cursor keys
2230 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2231 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2232 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2233 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2236 // other keypad keys
2237 #ifdef KSYM_KP_Enter
2238 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2239 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2240 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2241 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2242 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2243 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2247 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2248 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2249 { KSYM_Control_L, "XK_Control_L", "left control" },
2250 { KSYM_Control_R, "XK_Control_R", "right control" },
2251 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2252 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2253 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2254 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2255 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2256 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2258 // some special keys
2259 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2260 { KSYM_Delete, "XK_Delete", "delete" },
2261 { KSYM_Insert, "XK_Insert", "insert" },
2262 { KSYM_Tab, "XK_Tab", "tab" },
2263 { KSYM_Home, "XK_Home", "home" },
2264 { KSYM_End, "XK_End", "end" },
2265 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2266 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2268 { KSYM_Select, "XK_Select", "select" },
2269 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2270 { KSYM_Back, "XK_Back", "back" }, // back key
2271 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2272 #if defined(PLATFORM_ANDROID)
2273 { KSYM_Rewind, "XK_Rewind", "rewind" },
2274 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2277 // ASCII 0x20 to 0x40 keys (except numbers)
2278 { KSYM_space, "XK_space", "space" },
2279 { KSYM_exclam, "XK_exclam", "!" },
2280 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2281 { KSYM_numbersign, "XK_numbersign", "#" },
2282 { KSYM_dollar, "XK_dollar", "$" },
2283 { KSYM_percent, "XK_percent", "%" },
2284 { KSYM_ampersand, "XK_ampersand", "&" },
2285 { KSYM_apostrophe, "XK_apostrophe", "'" },
2286 { KSYM_parenleft, "XK_parenleft", "(" },
2287 { KSYM_parenright, "XK_parenright", ")" },
2288 { KSYM_asterisk, "XK_asterisk", "*" },
2289 { KSYM_plus, "XK_plus", "+" },
2290 { KSYM_comma, "XK_comma", "," },
2291 { KSYM_minus, "XK_minus", "-" },
2292 { KSYM_period, "XK_period", "." },
2293 { KSYM_slash, "XK_slash", "/" },
2294 { KSYM_colon, "XK_colon", ":" },
2295 { KSYM_semicolon, "XK_semicolon", ";" },
2296 { KSYM_less, "XK_less", "<" },
2297 { KSYM_equal, "XK_equal", "=" },
2298 { KSYM_greater, "XK_greater", ">" },
2299 { KSYM_question, "XK_question", "?" },
2300 { KSYM_at, "XK_at", "@" },
2303 { KSYM_bracketleft, "XK_bracketleft", "[" },
2304 { KSYM_backslash, "XK_backslash", "\\" },
2305 { KSYM_bracketright,"XK_bracketright", "]" },
2306 { KSYM_asciicircum, "XK_asciicircum", "^" },
2307 { KSYM_underscore, "XK_underscore", "_" },
2308 { KSYM_grave, "XK_grave", "grave" },
2309 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2310 { KSYM_braceleft, "XK_braceleft", "brace left" },
2311 { KSYM_bar, "XK_bar", "bar" },
2312 { KSYM_braceright, "XK_braceright", "brace right" },
2313 { KSYM_asciitilde, "XK_asciitilde", "~" },
2315 // special (non-ASCII) keys
2316 { KSYM_degree, "XK_degree", "degree" },
2317 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2318 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2319 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2320 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2321 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2322 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2323 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2325 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2326 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2327 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2328 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2329 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2330 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2331 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2332 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2333 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2335 // other keys (for reverse mapping only)
2336 { KSYM_space, "XK_space", " " },
2338 // keypad keys are not in numerical order in SDL2
2339 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2340 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2341 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2342 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2343 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2344 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2345 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2346 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2347 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2348 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2350 // end-of-array identifier
2356 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2358 static char name_buffer[30];
2361 if (key >= KSYM_A && key <= KSYM_Z)
2362 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2363 else if (key >= KSYM_a && key <= KSYM_z)
2364 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2365 else if (key >= KSYM_0 && key <= KSYM_9)
2366 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2367 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2368 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2369 else if (key == KSYM_UNDEFINED)
2370 strcpy(name_buffer, "(undefined)");
2377 if (key == translate_key[i].key)
2379 strcpy(name_buffer, translate_key[i].name);
2383 while (translate_key[++i].name);
2385 if (!translate_key[i].name)
2386 strcpy(name_buffer, "(unknown)");
2389 *name = name_buffer;
2391 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2393 static char name_buffer[30];
2396 if (key >= KSYM_A && key <= KSYM_Z)
2397 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2398 else if (key >= KSYM_a && key <= KSYM_z)
2399 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2400 else if (key >= KSYM_0 && key <= KSYM_9)
2401 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2402 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2403 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2404 else if (key == KSYM_UNDEFINED)
2405 strcpy(name_buffer, "[undefined]");
2412 if (key == translate_key[i].key)
2414 strcpy(name_buffer, translate_key[i].x11name);
2418 while (translate_key[++i].x11name);
2420 if (!translate_key[i].x11name)
2421 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2424 *x11name = name_buffer;
2426 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2428 Key key = KSYM_UNDEFINED;
2429 char *name_ptr = *name;
2431 if (strlen(*name) == 1)
2433 char c = name_ptr[0];
2435 if (c >= 'A' && c <= 'Z')
2436 key = KSYM_A + (Key)(c - 'A');
2437 else if (c >= 'a' && c <= 'z')
2438 key = KSYM_a + (Key)(c - 'a');
2439 else if (c >= '0' && c <= '9')
2440 key = KSYM_0 + (Key)(c - '0');
2443 if (key == KSYM_UNDEFINED)
2449 if (strEqual(translate_key[i].name, *name))
2451 key = translate_key[i].key;
2455 while (translate_key[++i].x11name);
2458 if (key == KSYM_UNDEFINED)
2459 Warn("getKeyFromKeyName(): not completely implemented");
2463 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2465 Key key = KSYM_UNDEFINED;
2466 char *name_ptr = *x11name;
2468 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2470 char c = name_ptr[3];
2472 if (c >= 'A' && c <= 'Z')
2473 key = KSYM_A + (Key)(c - 'A');
2474 else if (c >= 'a' && c <= 'z')
2475 key = KSYM_a + (Key)(c - 'a');
2476 else if (c >= '0' && c <= '9')
2477 key = KSYM_0 + (Key)(c - '0');
2479 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2481 char c1 = name_ptr[4];
2482 char c2 = name_ptr[5];
2485 if ((c1 >= '0' && c1 <= '9') &&
2486 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2487 d = atoi(&name_ptr[4]);
2489 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2490 key = KSYM_F1 + (Key)(d - 1);
2492 else if (strPrefix(name_ptr, "XK_"))
2498 if (strEqual(name_ptr, translate_key[i].x11name))
2500 key = translate_key[i].key;
2504 while (translate_key[++i].x11name);
2506 else if (strPrefix(name_ptr, "0x"))
2508 unsigned int value = 0;
2514 char c = *name_ptr++;
2517 if (c >= '0' && c <= '9')
2519 else if (c >= 'a' && c <= 'f')
2520 d = (int)(c - 'a' + 10);
2521 else if (c >= 'A' && c <= 'F')
2522 d = (int)(c - 'A' + 10);
2530 value = value * 16 + d;
2541 char *getKeyNameFromKey(Key key)
2545 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2549 char *getX11KeyNameFromKey(Key key)
2553 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2557 Key getKeyFromKeyName(char *name)
2561 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2565 Key getKeyFromX11KeyName(char *x11name)
2569 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2573 char getCharFromKey(Key key)
2579 } translate_key_char[] =
2581 // special (non-ASCII) keys (ISO-8859-1)
2582 { KSYM_degree, CHAR_BYTE_DEGREE },
2583 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2584 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2585 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2586 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2587 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2588 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2589 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2591 // end-of-array identifier
2595 char *keyname = getKeyNameFromKey(key);
2598 if (strlen(keyname) == 1)
2600 else if (strEqual(keyname, "space"))
2608 if (key == translate_key_char[i].key)
2610 c = translate_key_char[i].key_char;
2615 while (translate_key_char[++i].key_char);
2621 char getValidConfigValueChar(char c)
2623 if (c == '#' || // used to mark comments
2624 c == '\\') // used to mark continued lines
2631 // ----------------------------------------------------------------------------
2632 // functions to translate string identifiers to integer or boolean value
2633 // ----------------------------------------------------------------------------
2635 int get_integer_from_string(char *s)
2637 // check for the most common case first
2638 if (s[0] >= '0' && s[0] <= '9')
2641 char *s_lower = getStringToLower(s);
2644 if (strEqual(s_lower, "false") ||
2645 strEqual(s_lower, "no") ||
2646 strEqual(s_lower, "off"))
2648 else if (strEqual(s_lower, "true") ||
2649 strEqual(s_lower, "yes") ||
2650 strEqual(s_lower, "on"))
2660 boolean get_boolean_from_string(char *s)
2662 char *s_lower = getStringToLower(s);
2663 boolean result = FALSE;
2665 if (strEqual(s_lower, "true") ||
2666 strEqual(s_lower, "yes") ||
2667 strEqual(s_lower, "on") ||
2668 get_integer_from_string(s) == 1)
2676 int get_switch3_from_string(char *s)
2678 char *s_lower = getStringToLower(s);
2681 if (strEqual(s_lower, "true") ||
2682 strEqual(s_lower, "yes") ||
2683 strEqual(s_lower, "on") ||
2684 get_integer_from_string(s) == 1)
2686 else if (strEqual(s_lower, "auto"))
2694 int get_player_nr_from_string(char *s)
2696 static char *player_text[] =
2706 char *s_lower = getStringToLower(s);
2710 for (i = 0; player_text[i] != NULL; i++)
2711 if (strEqual(s_lower, player_text[i]))
2720 // ----------------------------------------------------------------------------
2721 // functions for generic lists
2722 // ----------------------------------------------------------------------------
2724 ListNode *newListNode(void)
2726 return checked_calloc(sizeof(ListNode));
2729 void addNodeToList(ListNode **node_first, char *key, void *content)
2731 ListNode *node_new = newListNode();
2733 node_new->key = getStringCopy(key);
2734 node_new->content = content;
2735 node_new->next = *node_first;
2738 (*node_first)->prev = node_new;
2740 *node_first = node_new;
2743 void deleteNodeFromList(ListNode **node_first, char *key,
2744 void (*destructor_function)(void *))
2746 if (node_first == NULL || *node_first == NULL)
2749 if (strEqual((*node_first)->key, key))
2751 // after first recursion, (*node_first)->prev->next == *node_first,
2752 // so *node_first would be overwritten with (*node_first)->next
2753 // => use a copy of *node_first (and later of (*node_first)->next)
2754 ListNode *node = *node_first;
2755 ListNode *node_next = node->next;
2757 checked_free(node->key);
2759 if (destructor_function)
2760 destructor_function(node->content);
2763 node->prev->next = node->next;
2766 node->next->prev = node->prev;
2770 // after removing node, set list pointer to next valid list node
2771 // (this is important if the first node of the list was deleted)
2772 *node_first = node_next;
2776 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2780 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2782 if (node_first == NULL)
2785 if (strEqual(node_first->key, key))
2788 return getNodeFromKey(node_first->next, key);
2791 int getNumNodes(ListNode *node_first)
2793 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2797 static void dumpList(ListNode *node_first)
2799 ListNode *node = node_first;
2803 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2804 ((struct ListNodeInfo *)node->content)->num_references);
2808 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2813 // ----------------------------------------------------------------------------
2814 // functions for file handling
2815 // ----------------------------------------------------------------------------
2817 #define MAX_BUFFER_SIZE 4096
2819 File *openFile(char *filename, char *mode)
2821 File *file = checked_calloc(sizeof(File));
2823 file->file = fopen(filename, mode);
2825 if (file->file != NULL)
2827 file->filename = getStringCopy(filename);
2832 #if defined(PLATFORM_ANDROID)
2833 file->asset_file = SDL_RWFromFile(filename, mode);
2835 if (file->asset_file != NULL)
2837 file->file_is_asset = TRUE;
2838 file->filename = getStringCopy(filename);
2849 int closeFile(File *file)
2856 #if defined(PLATFORM_ANDROID)
2857 if (file->asset_file)
2858 result = SDL_RWclose(file->asset_file);
2862 result = fclose(file->file);
2864 checked_free(file->filename);
2870 int checkEndOfFile(File *file)
2872 #if defined(PLATFORM_ANDROID)
2873 if (file->file_is_asset)
2874 return file->end_of_file;
2877 return feof(file->file);
2880 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2882 #if defined(PLATFORM_ANDROID)
2883 if (file->file_is_asset)
2885 if (file->end_of_file)
2888 size_t num_items_read =
2889 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2891 if (num_items_read < num_items)
2892 file->end_of_file = TRUE;
2894 return num_items_read;
2898 return fread(buffer, item_size, num_items, file->file);
2901 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2903 return fwrite(buffer, item_size, num_items, file->file);
2906 int seekFile(File *file, long offset, int whence)
2908 #if defined(PLATFORM_ANDROID)
2909 if (file->file_is_asset)
2911 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2912 whence == SEEK_CUR ? RW_SEEK_CUR :
2913 whence == SEEK_END ? RW_SEEK_END : 0);
2915 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2919 return fseek(file->file, offset, whence);
2922 int getByteFromFile(File *file)
2924 #if defined(PLATFORM_ANDROID)
2925 if (file->file_is_asset)
2927 if (file->end_of_file)
2931 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2933 if (num_bytes_read < 1)
2934 file->end_of_file = TRUE;
2936 return (file->end_of_file ? EOF : (int)c);
2940 return fgetc(file->file);
2943 char *getStringFromFile(File *file, char *line, int size)
2945 #if defined(PLATFORM_ANDROID)
2946 if (file->file_is_asset)
2948 if (file->end_of_file)
2951 char *line_ptr = line;
2952 int num_bytes_read = 0;
2954 while (num_bytes_read < size - 1 &&
2955 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2956 *line_ptr++ != '\n')
2961 if (strlen(line) == 0)
2963 file->end_of_file = TRUE;
2972 return fgets(line, size, file->file);
2975 int copyFile(char *filename_from, char *filename_to)
2977 File *file_from, *file_to;
2979 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2984 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2986 closeFile(file_from);
2991 while (!checkEndOfFile(file_from))
2993 byte buffer[MAX_BUFFER_SIZE];
2994 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2996 writeFile(file_to, buffer, 1, bytes_read);
2999 closeFile(file_from);
3005 boolean touchFile(char *filename)
3009 if (!(file = fopen(filename, MODE_WRITE)))
3011 Warn("cannot touch file '%s'", filename);
3022 // ----------------------------------------------------------------------------
3023 // functions for directory handling
3024 // ----------------------------------------------------------------------------
3026 Directory *openDirectory(char *dir_name)
3028 Directory *dir = checked_calloc(sizeof(Directory));
3030 dir->dir = opendir(dir_name);
3032 if (dir->dir != NULL)
3034 dir->filename = getStringCopy(dir_name);
3039 #if defined(PLATFORM_ANDROID)
3040 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3042 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3044 checked_free(asset_toc_filename);
3046 if (dir->asset_toc_file != NULL)
3048 dir->directory_is_asset = TRUE;
3049 dir->filename = getStringCopy(dir_name);
3060 int closeDirectory(Directory *dir)
3067 #if defined(PLATFORM_ANDROID)
3068 if (dir->asset_toc_file)
3069 result = SDL_RWclose(dir->asset_toc_file);
3073 result = closedir(dir->dir);
3076 freeDirectoryEntry(dir->dir_entry);
3078 checked_free(dir->filename);
3084 DirectoryEntry *readDirectory(Directory *dir)
3087 freeDirectoryEntry(dir->dir_entry);
3089 dir->dir_entry = NULL;
3091 #if defined(PLATFORM_ANDROID)
3092 if (dir->directory_is_asset)
3094 char line[MAX_LINE_LEN];
3095 char *line_ptr = line;
3096 int num_bytes_read = 0;
3098 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3099 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3108 if (strlen(line) == 0)
3111 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3113 dir->dir_entry->is_directory = FALSE;
3114 if (line[strlen(line) - 1] == '/')
3116 dir->dir_entry->is_directory = TRUE;
3118 line[strlen(line) - 1] = '\0';
3121 dir->dir_entry->basename = getStringCopy(line);
3122 dir->dir_entry->filename = getPath2(dir->filename, line);
3124 return dir->dir_entry;
3128 struct dirent *dir_entry = readdir(dir->dir);
3130 if (dir_entry == NULL)
3133 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3135 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3136 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3138 struct stat file_status;
3140 dir->dir_entry->is_directory =
3141 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3142 S_ISDIR(file_status.st_mode));
3144 return dir->dir_entry;
3147 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3149 if (dir_entry == NULL)
3152 checked_free(dir_entry->basename);
3153 checked_free(dir_entry->filename);
3154 checked_free(dir_entry);
3158 // ----------------------------------------------------------------------------
3159 // functions for checking files and filenames
3160 // ----------------------------------------------------------------------------
3162 boolean directoryExists(const char *dir_name)
3164 if (dir_name == NULL)
3167 struct stat file_status;
3168 boolean success = (stat(dir_name, &file_status) == 0 &&
3169 S_ISDIR(file_status.st_mode));
3171 #if defined(PLATFORM_ANDROID)
3174 // this might be an asset directory; check by trying to open toc file
3175 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3176 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3178 checked_free(asset_toc_filename);
3180 success = (file != NULL);
3190 boolean fileExists(const char *filename)
3192 if (filename == NULL)
3195 boolean success = (access(filename, F_OK) == 0);
3197 #if defined(PLATFORM_ANDROID)
3200 // this might be an asset file; check by trying to open it
3201 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3203 success = (file != NULL);
3214 static boolean fileHasPrefix(const char *basename, const char *prefix)
3216 static char *basename_lower = NULL;
3217 int basename_length, prefix_length;
3219 checked_free(basename_lower);
3221 if (basename == NULL || prefix == NULL)
3224 basename_lower = getStringToLower(basename);
3225 basename_length = strlen(basename_lower);
3226 prefix_length = strlen(prefix);
3228 if (basename_length > prefix_length + 1 &&
3229 basename_lower[prefix_length] == '.' &&
3230 strncmp(basename_lower, prefix, prefix_length) == 0)
3237 static boolean fileHasSuffix(const char *basename, const char *suffix)
3239 static char *basename_lower = NULL;
3240 int basename_length, suffix_length;
3242 checked_free(basename_lower);
3244 if (basename == NULL || suffix == NULL)
3247 basename_lower = getStringToLower(basename);
3248 basename_length = strlen(basename_lower);
3249 suffix_length = strlen(suffix);
3251 if (basename_length > suffix_length + 1 &&
3252 basename_lower[basename_length - suffix_length - 1] == '.' &&
3253 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3259 static boolean FileCouldBeArtwork(char *filename)
3261 char *basename = getBaseNamePtr(filename);
3263 return (!strEqual(basename, ".") &&
3264 !strEqual(basename, "..") &&
3265 !fileHasSuffix(basename, "txt") &&
3266 !fileHasSuffix(basename, "conf") &&
3267 !directoryExists(filename));
3270 boolean FileIsGraphic(char *filename)
3272 return FileCouldBeArtwork(filename);
3275 boolean FileIsSound(char *filename)
3277 return FileCouldBeArtwork(filename);
3280 boolean FileIsMusic(char *filename)
3282 return FileCouldBeArtwork(filename);
3285 boolean FileIsArtworkType(char *filename, int type)
3287 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3288 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3289 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3295 // ----------------------------------------------------------------------------
3296 // functions for loading artwork configuration information
3297 // ----------------------------------------------------------------------------
3299 char *get_mapped_token(char *token)
3301 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3302 static char *map_token_prefix[][2] =
3304 { "char_procent", "char_percent" },
3305 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3306 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3307 { "bd_butterfly_left", "bd_butterfly.left" },
3308 { "bd_butterfly_right", "bd_butterfly.right" },
3309 { "bd_butterfly_up", "bd_butterfly.up" },
3310 { "bd_butterfly_down", "bd_butterfly.down" },
3311 { "bd_firefly_left", "bd_firefly.left" },
3312 { "bd_firefly_right", "bd_firefly.right" },
3313 { "bd_firefly_up", "bd_firefly.up" },
3314 { "bd_firefly_down", "bd_firefly.down" },
3320 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3322 int len_token_prefix = strlen(map_token_prefix[i][0]);
3324 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3325 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3328 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3329 char *gfx_substring = ".gfx";
3330 char *gfx_prefix = "gfx.";
3331 if (strstr(token, gfx_substring) != NULL)
3333 char *token_prefix = getStringCopy(token);
3334 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3335 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3338 // cut off token string at ".gfx" substring position
3339 *token_gfx_pos = '\0';
3341 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3342 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3346 return mapped_token;
3352 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3355 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3356 static struct ConfigTypeInfo prefix_list[] =
3358 { "global.anim_1" },
3359 { "global.anim_2" },
3360 { "global.anim_3" },
3361 { "global.anim_4" },
3362 { "global.anim_5" },
3363 { "global.anim_6" },
3364 { "global.anim_7" },
3365 { "global.anim_8" },
3366 { "global.anim_9" },
3367 { "global.anim_10" },
3368 { "global.anim_11" },
3369 { "global.anim_12" },
3370 { "global.anim_13" },
3371 { "global.anim_14" },
3372 { "global.anim_15" },
3373 { "global.anim_16" },
3374 { "global.anim_17" },
3375 { "global.anim_18" },
3376 { "global.anim_19" },
3377 { "global.anim_20" },
3378 { "global.anim_21" },
3379 { "global.anim_22" },
3380 { "global.anim_23" },
3381 { "global.anim_24" },
3382 { "global.anim_25" },
3383 { "global.anim_26" },
3384 { "global.anim_27" },
3385 { "global.anim_28" },
3386 { "global.anim_29" },
3387 { "global.anim_30" },
3388 { "global.anim_31" },
3389 { "global.anim_32" },
3393 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3394 boolean prefix_found = FALSE;
3398 // search for prefix to check if base token has to be created
3399 for (i = 0; prefix_list[i].token != NULL; i++)
3400 if (strPrefix(token, prefix_list[i].token))
3401 prefix_found = TRUE;
3406 // search for suffix (parameter) to determine base token length
3407 for (i = 0; suffix_list[i].token != NULL; i++)
3408 if (strSuffix(token, suffix_list[i].token))
3409 len_suffix = strlen(suffix_list[i].token);
3411 return getStringCopyN(token, strlen(token) - len_suffix);
3414 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3415 struct ListNodeInfo ***, int *);
3417 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3418 struct ConfigTypeInfo *suffix_list,
3419 char **ignore_tokens,
3420 int num_file_list_entries)
3422 SetupFileHash *ignore_tokens_hash;
3423 struct FileInfo *file_list;
3424 int num_file_list_entries_found = 0;
3425 int num_suffix_list_entries = 0;
3429 // create hash from list of tokens to be ignored (for quick access)
3430 ignore_tokens_hash = newSetupFileHash();
3431 for (i = 0; ignore_tokens[i] != NULL; i++)
3432 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3434 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3436 for (i = 0; suffix_list[i].token != NULL; i++)
3437 num_suffix_list_entries++;
3439 // always start with reliable default values
3440 for (i = 0; i < num_file_list_entries; i++)
3442 file_list[i].token = NULL;
3444 file_list[i].default_filename = NULL;
3445 file_list[i].filename = NULL;
3447 if (num_suffix_list_entries > 0)
3449 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3451 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3452 file_list[i].parameter = checked_calloc(parameter_array_size);
3454 for (j = 0; j < num_suffix_list_entries; j++)
3456 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3457 setString(&file_list[i].parameter[j], suffix_list[j].value);
3460 file_list[i].redefined = FALSE;
3461 file_list[i].fallback_to_default = FALSE;
3462 file_list[i].default_is_cloned = FALSE;
3468 for (i = 0; config_list[i].token != NULL; i++)
3470 int len_config_token = strlen(config_list[i].token);
3471 boolean is_file_entry = TRUE;
3473 for (j = 0; suffix_list[j].token != NULL; j++)
3475 int len_suffix = strlen(suffix_list[j].token);
3477 if (len_suffix < len_config_token &&
3478 strEqual(&config_list[i].token[len_config_token - len_suffix],
3479 suffix_list[j].token))
3481 setString(&file_list[list_pos].default_parameter[j],
3482 config_list[i].value);
3484 is_file_entry = FALSE;
3490 // the following tokens are no file definitions, but other config tokens
3491 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3492 is_file_entry = FALSE;
3499 if (list_pos >= num_file_list_entries)
3502 file_list[list_pos].token = config_list[i].token;
3503 file_list[list_pos].default_filename = config_list[i].value;
3506 if (strSuffix(config_list[i].token, ".clone_from"))
3507 file_list[list_pos].default_is_cloned = TRUE;
3510 num_file_list_entries_found = list_pos + 1;
3511 if (num_file_list_entries_found != num_file_list_entries)
3514 Error("inconsistant config list information:");
3515 Error("- should be: %d (according to 'src/conf_xxx.h')",
3516 num_file_list_entries);
3517 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3518 num_file_list_entries_found);
3523 freeSetupFileHash(ignore_tokens_hash);
3528 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3530 int len_token = strlen(token);
3531 int len_suffix = strlen(suffix);
3533 if (start_pos < 0) // compare suffix from end of string
3534 start_pos += len_token;
3536 if (start_pos < 0 || start_pos + len_suffix > len_token)
3539 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3542 if (token[start_pos + len_suffix] == '\0')
3545 if (token[start_pos + len_suffix] == '.')
3551 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3553 static void read_token_parameters(SetupFileHash *setup_file_hash,
3554 struct ConfigTypeInfo *suffix_list,
3555 struct FileInfo *file_list_entry)
3557 // check for config token that is the base token without any suffixes
3558 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3559 char *known_token_value = KNOWN_TOKEN_VALUE;
3562 if (filename != NULL)
3564 setString(&file_list_entry->filename, filename);
3566 // when file definition found, set all parameters to default values
3567 for (i = 0; suffix_list[i].token != NULL; i++)
3568 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3570 file_list_entry->redefined = TRUE;
3572 // mark config file token as well known from default config
3573 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3576 // check for config tokens that can be build by base token and suffixes
3577 for (i = 0; suffix_list[i].token != NULL; i++)
3579 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3580 char *value = getHashEntry(setup_file_hash, token);
3584 setString(&file_list_entry->parameter[i], value);
3586 // mark config file token as well known from default config
3587 setHashEntry(setup_file_hash, token, known_token_value);
3594 static void add_dynamic_file_list_entry(struct FileInfo **list,
3595 int *num_list_entries,
3596 SetupFileHash *extra_file_hash,
3597 struct ConfigTypeInfo *suffix_list,
3598 int num_suffix_list_entries,
3601 struct FileInfo *new_list_entry;
3602 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3604 (*num_list_entries)++;
3605 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3606 new_list_entry = &(*list)[*num_list_entries - 1];
3608 new_list_entry->token = getStringCopy(token);
3609 new_list_entry->default_filename = NULL;
3610 new_list_entry->filename = NULL;
3611 new_list_entry->parameter = checked_calloc(parameter_array_size);
3613 new_list_entry->redefined = FALSE;
3614 new_list_entry->fallback_to_default = FALSE;
3615 new_list_entry->default_is_cloned = FALSE;
3617 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3620 static void add_property_mapping(struct PropertyMapping **list,
3621 int *num_list_entries,
3622 int base_index, int ext1_index,
3623 int ext2_index, int ext3_index,
3626 struct PropertyMapping *new_list_entry;
3628 (*num_list_entries)++;
3629 *list = checked_realloc(*list,
3630 *num_list_entries * sizeof(struct PropertyMapping));
3631 new_list_entry = &(*list)[*num_list_entries - 1];
3633 new_list_entry->base_index = base_index;
3634 new_list_entry->ext1_index = ext1_index;
3635 new_list_entry->ext2_index = ext2_index;
3636 new_list_entry->ext3_index = ext3_index;
3638 new_list_entry->artwork_index = artwork_index;
3641 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3644 struct FileInfo *file_list = artwork_info->file_list;
3645 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3646 char **base_prefixes = artwork_info->base_prefixes;
3647 char **ext1_suffixes = artwork_info->ext1_suffixes;
3648 char **ext2_suffixes = artwork_info->ext2_suffixes;
3649 char **ext3_suffixes = artwork_info->ext3_suffixes;
3650 char **ignore_tokens = artwork_info->ignore_tokens;
3651 int num_file_list_entries = artwork_info->num_file_list_entries;
3652 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3653 int num_base_prefixes = artwork_info->num_base_prefixes;
3654 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3655 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3656 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3657 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3658 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3659 SetupFileHash *extra_file_hash, *empty_file_hash;
3660 char *known_token_value = KNOWN_TOKEN_VALUE;
3661 char *base_token_value = UNDEFINED_FILENAME;
3664 if (filename == NULL)
3667 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3670 // separate valid (defined) from empty (undefined) config token values
3671 valid_file_hash = newSetupFileHash();
3672 empty_file_hash = newSetupFileHash();
3673 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3675 char *value = HASH_ITERATION_VALUE(itr);
3677 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3678 HASH_ITERATION_TOKEN(itr), value);
3680 END_HASH_ITERATION(setup_file_hash, itr)
3682 // at this point, we do not need the setup file hash anymore -- free it
3683 freeSetupFileHash(setup_file_hash);
3685 // prevent changing hash while iterating over it by using a temporary copy
3686 valid_file_hash_tmp = newSetupFileHash();
3687 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3689 setHashEntry(valid_file_hash_tmp,
3690 HASH_ITERATION_TOKEN(itr),
3691 HASH_ITERATION_VALUE(itr));
3693 END_HASH_ITERATION(valid_file_hash, itr)
3695 // (iterate over same temporary hash, as modifications are independent)
3697 // map deprecated to current tokens (using prefix match and replace)
3698 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3700 char *token = HASH_ITERATION_TOKEN(itr);
3701 char *mapped_token = get_mapped_token(token);
3703 if (mapped_token != NULL)
3705 char *value = HASH_ITERATION_VALUE(itr);
3708 setHashEntry(valid_file_hash, mapped_token, value);
3710 // ignore old token (by setting it to "known" keyword)
3711 setHashEntry(valid_file_hash, token, known_token_value);
3716 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3718 // add special base tokens (using prefix match and replace)
3719 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3721 char *token = HASH_ITERATION_TOKEN(itr);
3722 char *base_token = get_special_base_token(artwork_info, token);
3724 if (base_token != NULL)
3726 // add base token only if it does not already exist
3727 if (getHashEntry(valid_file_hash, base_token) == NULL)
3728 setHashEntry(valid_file_hash, base_token, base_token_value);
3733 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3735 // free temporary hash used for iteration
3736 freeSetupFileHash(valid_file_hash_tmp);
3738 // read parameters for all known config file tokens
3739 for (i = 0; i < num_file_list_entries; i++)
3740 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3742 // set all tokens that can be ignored here to "known" keyword
3743 for (i = 0; i < num_ignore_tokens; i++)
3744 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3746 // copy all unknown config file tokens to extra config hash
3747 extra_file_hash = newSetupFileHash();
3748 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3750 char *value = HASH_ITERATION_VALUE(itr);
3752 if (!strEqual(value, known_token_value))
3753 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3755 END_HASH_ITERATION(valid_file_hash, itr)
3757 // at this point, we do not need the valid file hash anymore -- free it
3758 freeSetupFileHash(valid_file_hash);
3760 // now try to determine valid, dynamically defined config tokens
3762 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3764 struct FileInfo **dynamic_file_list =
3765 &artwork_info->dynamic_file_list;
3766 int *num_dynamic_file_list_entries =
3767 &artwork_info->num_dynamic_file_list_entries;
3768 struct PropertyMapping **property_mapping =
3769 &artwork_info->property_mapping;
3770 int *num_property_mapping_entries =
3771 &artwork_info->num_property_mapping_entries;
3772 int current_summarized_file_list_entry =
3773 artwork_info->num_file_list_entries +
3774 artwork_info->num_dynamic_file_list_entries;
3775 char *token = HASH_ITERATION_TOKEN(itr);
3776 int len_token = strlen(token);
3778 boolean base_prefix_found = FALSE;
3779 boolean parameter_suffix_found = FALSE;
3781 // skip all parameter definitions (handled by read_token_parameters())
3782 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3784 int len_suffix = strlen(suffix_list[i].token);
3786 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3787 parameter_suffix_found = TRUE;
3790 if (parameter_suffix_found)
3793 // ---------- step 0: search for matching base prefix ----------
3796 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3798 char *base_prefix = base_prefixes[i];
3799 int len_base_prefix = strlen(base_prefix);
3800 boolean ext1_suffix_found = FALSE;
3801 boolean ext2_suffix_found = FALSE;
3802 boolean ext3_suffix_found = FALSE;
3803 boolean exact_match = FALSE;
3804 int base_index = -1;
3805 int ext1_index = -1;
3806 int ext2_index = -1;
3807 int ext3_index = -1;
3809 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3811 if (!base_prefix_found)
3816 if (start_pos + len_base_prefix == len_token) // exact match
3820 add_dynamic_file_list_entry(dynamic_file_list,
3821 num_dynamic_file_list_entries,
3824 num_suffix_list_entries,
3826 add_property_mapping(property_mapping,
3827 num_property_mapping_entries,
3828 base_index, -1, -1, -1,
3829 current_summarized_file_list_entry);
3833 // ---------- step 1: search for matching first suffix ----------
3835 start_pos += len_base_prefix;
3836 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3838 char *ext1_suffix = ext1_suffixes[j];
3839 int len_ext1_suffix = strlen(ext1_suffix);
3841 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3843 if (!ext1_suffix_found)
3848 if (start_pos + len_ext1_suffix == len_token) // exact match
3852 add_dynamic_file_list_entry(dynamic_file_list,
3853 num_dynamic_file_list_entries,
3856 num_suffix_list_entries,
3858 add_property_mapping(property_mapping,
3859 num_property_mapping_entries,
3860 base_index, ext1_index, -1, -1,
3861 current_summarized_file_list_entry);
3865 start_pos += len_ext1_suffix;
3871 // ---------- step 2: search for matching second suffix ----------
3873 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3875 char *ext2_suffix = ext2_suffixes[k];
3876 int len_ext2_suffix = strlen(ext2_suffix);
3878 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3880 if (!ext2_suffix_found)
3885 if (start_pos + len_ext2_suffix == len_token) // exact match
3889 add_dynamic_file_list_entry(dynamic_file_list,
3890 num_dynamic_file_list_entries,
3893 num_suffix_list_entries,
3895 add_property_mapping(property_mapping,
3896 num_property_mapping_entries,
3897 base_index, ext1_index, ext2_index, -1,
3898 current_summarized_file_list_entry);
3902 start_pos += len_ext2_suffix;
3908 // ---------- step 3: search for matching third suffix ----------
3910 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3912 char *ext3_suffix = ext3_suffixes[l];
3913 int len_ext3_suffix = strlen(ext3_suffix);
3915 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3917 if (!ext3_suffix_found)
3922 if (start_pos + len_ext3_suffix == len_token) // exact match
3926 add_dynamic_file_list_entry(dynamic_file_list,
3927 num_dynamic_file_list_entries,
3930 num_suffix_list_entries,
3932 add_property_mapping(property_mapping,
3933 num_property_mapping_entries,
3934 base_index, ext1_index, ext2_index, ext3_index,
3935 current_summarized_file_list_entry);
3941 END_HASH_ITERATION(extra_file_hash, itr)
3943 if (artwork_info->num_dynamic_file_list_entries > 0)
3945 artwork_info->dynamic_artwork_list =
3946 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3947 artwork_info->sizeof_artwork_list_entry);
3950 if (options.verbose && IS_PARENT_PROCESS())
3952 SetupFileList *setup_file_list, *list;
3953 boolean dynamic_tokens_found = FALSE;
3954 boolean unknown_tokens_found = FALSE;
3955 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3957 // list may be NULL for empty artwork config files
3958 setup_file_list = loadSetupFileList(filename);
3960 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3962 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3963 dynamic_tokens_found = TRUE;
3965 unknown_tokens_found = TRUE;
3967 END_HASH_ITERATION(extra_file_hash, itr)
3969 if (options.debug && dynamic_tokens_found)
3971 Debug("config", "---");
3972 Debug("config", "dynamic token(s) found in config file:");
3973 Debug("config", "- config file: '%s'", filename);
3975 for (list = setup_file_list; list != NULL; list = list->next)
3977 char *value = getHashEntry(extra_file_hash, list->token);
3979 if (value != NULL && strEqual(value, known_token_value))
3980 Debug("config", "- dynamic token: '%s'", list->token);
3983 Debug("config", "---");
3986 if (unknown_tokens_found)
3989 Warn("unknown token(s) found in config file:");
3990 Warn("- config file: '%s'", filename);
3992 for (list = setup_file_list; list != NULL; list = list->next)
3994 char *value = getHashEntry(extra_file_hash, list->token);
3996 if (value != NULL && !strEqual(value, known_token_value))
3997 Warn("- dynamic token: '%s'", list->token);
4003 if (undefined_values_found)
4006 Warn("undefined values found in config file:");
4007 Warn("- config file: '%s'", filename);
4009 for (list = setup_file_list; list != NULL; list = list->next)
4011 char *value = getHashEntry(empty_file_hash, list->token);
4014 Warn("- undefined value for token: '%s'", list->token);
4020 freeSetupFileList(setup_file_list);
4023 freeSetupFileHash(extra_file_hash);
4024 freeSetupFileHash(empty_file_hash);
4027 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4029 struct FileInfo *file_list = artwork_info->file_list;
4030 int num_file_list_entries = artwork_info->num_file_list_entries;
4031 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4032 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4035 DrawInitTextHead("Loading artwork config");
4036 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4038 // always start with reliable default values
4039 for (i = 0; i < num_file_list_entries; i++)
4041 setString(&file_list[i].filename, file_list[i].default_filename);
4043 for (j = 0; j < num_suffix_list_entries; j++)
4044 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4046 file_list[i].redefined = FALSE;
4047 file_list[i].fallback_to_default = FALSE;
4050 // free previous dynamic artwork file array
4051 if (artwork_info->dynamic_file_list != NULL)
4053 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4055 free(artwork_info->dynamic_file_list[i].token);
4056 free(artwork_info->dynamic_file_list[i].filename);
4057 free(artwork_info->dynamic_file_list[i].parameter);
4060 free(artwork_info->dynamic_file_list);
4061 artwork_info->dynamic_file_list = NULL;
4063 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4064 &artwork_info->num_dynamic_file_list_entries);
4067 // free previous property mapping
4068 if (artwork_info->property_mapping != NULL)
4070 free(artwork_info->property_mapping);
4072 artwork_info->property_mapping = NULL;
4073 artwork_info->num_property_mapping_entries = 0;
4076 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4078 // first look for special artwork configured in level series config
4079 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4081 if (fileExists(filename_base))
4082 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4085 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4087 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4088 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4091 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4092 struct ListNodeInfo **listnode)
4096 char *filename = (*listnode)->source_filename;
4098 if (--(*listnode)->num_references <= 0)
4099 deleteNodeFromList(&artwork_info->content_list, filename,
4100 artwork_info->free_artwork);
4106 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4107 struct ListNodeInfo **listnode,
4108 struct FileInfo *file_list_entry)
4118 char *basename = file_list_entry->filename;
4119 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4121 // mark all images from non-default graphics directory as "redefined"
4122 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4123 !strPrefix(filename, options.graphics_directory))
4124 file_list_entry->redefined = TRUE;
4126 if (filename == NULL)
4128 Warn("cannot find artwork file '%s'", basename);
4130 basename = file_list_entry->default_filename;
4132 // fail for cloned default artwork that has no default filename defined
4133 if (file_list_entry->default_is_cloned &&
4134 strEqual(basename, UNDEFINED_FILENAME))
4136 void (*error_func)(char *, ...) = Warn;
4138 // we can get away without sounds and music, but not without graphics
4139 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4142 error_func("token '%s' was cloned and has no default filename",
4143 file_list_entry->token);
4148 // dynamic artwork has no default filename / skip empty default artwork
4149 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4152 file_list_entry->fallback_to_default = TRUE;
4154 Warn("trying default artwork file '%s'", basename);
4156 filename = getCustomArtworkFilename(basename, artwork_info->type);
4158 if (filename == NULL)
4160 void (*error_func)(char *, ...) = Warn;
4162 // we can get away without sounds and music, but not without graphics
4163 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4166 error_func("cannot find default artwork file '%s'", basename);
4172 // check if the old and the new artwork file are the same
4173 if (*listnode && strEqual((*listnode)->source_filename, filename))
4175 // The old and new artwork are the same (have the same filename and path).
4176 // This usually means that this artwork does not exist in this artwork set
4177 // and a fallback to the existing artwork is done.
4182 // delete existing artwork file entry
4183 deleteArtworkListEntry(artwork_info, listnode);
4185 // check if the new artwork file already exists in the list of artwork
4186 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4188 *listnode = (struct ListNodeInfo *)node->content;
4189 (*listnode)->num_references++;
4194 DrawInitTextHead(init_text[artwork_info->type]);
4195 DrawInitTextItem(basename);
4197 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4199 // add new artwork file entry to the list of artwork files
4200 (*listnode)->num_references = 1;
4201 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4206 void (*error_func)(char *, ...) = Warn;
4208 // we can get away without sounds and music, but not without graphics
4209 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4212 error_func("cannot load artwork file '%s'", basename);
4218 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4219 struct ListNodeInfo **listnode,
4220 struct FileInfo *file_list_entry)
4222 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4224 deleteArtworkListEntry(artwork_info, listnode);
4229 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4232 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4234 struct FileInfo *file_list = artwork_info->file_list;
4235 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4236 int num_file_list_entries = artwork_info->num_file_list_entries;
4237 int num_dynamic_file_list_entries =
4238 artwork_info->num_dynamic_file_list_entries;
4241 print_timestamp_init("ReloadCustomArtworkList");
4243 for (i = 0; i < num_file_list_entries; i++)
4244 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4247 for (i = 0; i < num_dynamic_file_list_entries; i++)
4248 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4249 &dynamic_file_list[i]);
4251 print_timestamp_done("ReloadCustomArtworkList");
4254 dumpList(artwork_info->content_list);
4258 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4259 struct ListNodeInfo ***list,
4260 int *num_list_entries)
4267 for (i = 0; i < *num_list_entries; i++)
4268 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4272 *num_list_entries = 0;
4275 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4277 if (artwork_info == NULL)
4280 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4281 &artwork_info->num_file_list_entries);
4283 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4284 &artwork_info->num_dynamic_file_list_entries);
4288 // ----------------------------------------------------------------------------
4289 // functions only needed for non-Unix (non-command-line) systems
4290 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4291 // (now also added for Windows, to create files in user data directory)
4292 // ----------------------------------------------------------------------------
4294 char *getLogBasename(char *basename)
4296 return getStringCat2(basename, ".log");
4299 char *getLogFilename(char *basename)
4301 return getPath2(getMainUserGameDataDir(), basename);
4304 void OpenLogFile(void)
4306 InitMainUserDataDirectory();
4308 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4310 program.log_file = program.log_file_default; // reset to default
4312 Warn("cannot open file '%s' for writing: %s",
4313 program.log_filename, strerror(errno));
4316 // output should be unbuffered so it is not truncated in a crash
4317 setbuf(program.log_file, NULL);
4320 void CloseLogFile(void)
4322 if (program.log_file != program.log_file_default)
4323 fclose(program.log_file);
4326 void DumpLogFile(void)
4328 FILE *log_file = fopen(program.log_filename, MODE_READ);
4330 if (log_file == NULL)
4333 while (!feof(log_file))
4334 fputc(fgetc(log_file), stdout);
4339 void NotifyUserAboutErrorFile(void)
4341 #if defined(PLATFORM_WINDOWS)
4342 char *title_text = getStringCat2(program.program_title, " Error Message");
4343 char *error_text = getStringCat2("The program was aborted due to an error; "
4344 "for details, see the following error file:"
4346 program.log_filename);
4348 MessageBox(NULL, error_text, title_text, MB_OK);
4353 // ----------------------------------------------------------------------------
4354 // the following is only for debugging purpose and normally not used
4355 // ----------------------------------------------------------------------------
4359 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4360 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4362 #define DEBUG_NUM_TIMESTAMPS 10
4363 #define DEBUG_TIME_IN_MICROSECONDS 0
4365 #if DEBUG_TIME_IN_MICROSECONDS
4366 static double Counter_Microseconds(void)
4368 static struct timeval base_time = { 0, 0 };
4369 struct timeval current_time;
4372 gettimeofday(¤t_time, NULL);
4374 // reset base time in case of wrap-around
4375 if (current_time.tv_sec < base_time.tv_sec)
4376 base_time = current_time;
4379 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4380 ((double)(current_time.tv_usec - base_time.tv_usec));
4382 return counter; // return microseconds since last init
4386 static char *debug_print_timestamp_get_padding(int padding_size)
4388 static char *padding = NULL;
4389 int max_padding_size = 100;
4391 if (padding == NULL)
4393 padding = checked_calloc(max_padding_size + 1);
4394 memset(padding, ' ', max_padding_size);
4397 return &padding[MAX(0, max_padding_size - padding_size)];
4400 void debug_print_timestamp(int counter_nr, char *message)
4402 int indent_size = 8;
4403 int padding_size = 40;
4404 float timestamp_interval;
4407 Fail("debugging: invalid negative counter");
4408 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4409 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4411 #if DEBUG_TIME_IN_MICROSECONDS
4412 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4415 counter[counter_nr][0] = Counter_Microseconds();
4417 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4420 counter[counter_nr][0] = Counter();
4423 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4424 counter[counter_nr][1] = counter[counter_nr][0];
4427 Debug("time:init", "%s%s%s %.3f %s",
4428 debug_print_timestamp_get_padding(counter_nr * indent_size),
4430 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4431 timestamp_interval / 1000,
4436 static void debug_print_parent_only(char *format, ...)
4438 if (!IS_PARENT_PROCESS())
4445 va_start(ap, format);
4446 vprintf(format, ap);
4456 static void print_timestamp_ext(char *message, char *mode)
4458 #if DEBUG_PRINT_INIT_TIMESTAMPS
4459 static char *debug_message = NULL;
4460 static char *last_message = NULL;
4461 static int counter_nr = 0;
4462 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4464 checked_free(debug_message);
4465 debug_message = getStringCat3(mode, " ", message);
4467 if (strEqual(mode, "INIT"))
4469 debug_print_timestamp(counter_nr, NULL);
4471 if (counter_nr + 1 < max_depth)
4472 debug_print_timestamp(counter_nr, debug_message);
4476 debug_print_timestamp(counter_nr, NULL);
4478 else if (strEqual(mode, "DONE"))
4482 if (counter_nr + 1 < max_depth ||
4483 (counter_nr == 0 && max_depth == 1))
4485 last_message = message;
4487 if (counter_nr == 0 && max_depth == 1)
4489 checked_free(debug_message);
4490 debug_message = getStringCat3("TIME", " ", message);
4493 debug_print_timestamp(counter_nr, debug_message);
4496 else if (!strEqual(mode, "TIME") ||
4497 !strEqual(message, last_message))
4499 if (counter_nr < max_depth)
4500 debug_print_timestamp(counter_nr, debug_message);
4505 void print_timestamp_init(char *message)
4507 print_timestamp_ext(message, "INIT");
4510 void print_timestamp_time(char *message)
4512 print_timestamp_ext(message, "TIME");
4515 void print_timestamp_done(char *message)
4517 print_timestamp_ext(message, "DONE");