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(void) // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter(void) // 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 memory functions
1089 // ----------------------------------------------------------------------------
1091 void *getMemCopy(const void *m, size_t size)
1098 m_copy = checked_malloc(size);
1099 memcpy(m_copy, m, size);
1105 // ----------------------------------------------------------------------------
1106 // various string functions
1107 // ----------------------------------------------------------------------------
1109 char *getStringCat2WithSeparator(const char *s1,
1113 if (s1 == NULL || s2 == NULL || sep == NULL)
1116 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1119 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1121 return complete_string;
1124 char *getStringCat3WithSeparator(const char *s1,
1129 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1132 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1133 strlen(s2) + strlen(sep) +
1136 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1138 return complete_string;
1141 char *getStringCat2(const char *s1, const char *s2)
1143 return getStringCat2WithSeparator(s1, s2, "");
1146 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1148 return getStringCat3WithSeparator(s1, s2, s3, "");
1151 char *getPath2(const char *path1, const char *path2)
1153 #if defined(PLATFORM_ANDROID)
1154 // workaround for reading from assets directory -- skip "." subdirs in path
1155 if (strEqual(path1, "."))
1156 return getStringCopy(path2);
1157 else if (strEqual(path2, "."))
1158 return getStringCopy(path1);
1161 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1164 char *getPath3(const char *path1, const char *path2, const char *path3)
1166 #if defined(PLATFORM_ANDROID)
1167 // workaround for reading from assets directory -- skip "." subdirs in path
1168 if (strEqual(path1, "."))
1169 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1170 else if (strEqual(path2, "."))
1171 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1172 else if (strEqual(path3, "."))
1173 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1176 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1179 static char *getPngOrPcxIfNotExists(char *filename)
1181 // switch from PNG to PCX file and vice versa, if file does not exist
1182 // (backwards compatibility with PCX files used in previous versions)
1184 if (!fileExists(filename) && strSuffix(filename, ".png"))
1185 strcpy(&filename[strlen(filename) - 3], "pcx");
1186 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1187 strcpy(&filename[strlen(filename) - 3], "png");
1192 char *getImg2(const char *path1, const char *path2)
1194 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1197 char *getImg3(const char *path1, const char *path2, const char *path3)
1199 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1202 char *getStringCopy(const char *s)
1209 s_copy = checked_malloc(strlen(s) + 1);
1215 char *getStringCopyN(const char *s, int n)
1218 int s_len = MAX(0, n);
1223 s_copy = checked_malloc(s_len + 1);
1224 strncpy(s_copy, s, s_len);
1225 s_copy[s_len] = '\0';
1230 char *getStringCopyNStatic(const char *s, int n)
1232 static char *s_copy = NULL;
1234 checked_free(s_copy);
1236 s_copy = getStringCopyN(s, n);
1241 char *getStringToUpper(const char *s)
1243 char *s_copy = checked_malloc(strlen(s) + 1);
1244 char *s_ptr = s_copy;
1247 *s_ptr++ = toupper(*s++);
1253 char *getStringToLower(const char *s)
1255 char *s_copy = checked_malloc(strlen(s) + 1);
1256 char *s_ptr = s_copy;
1259 *s_ptr++ = tolower(*s++);
1265 void setString(char **old_value, const char *new_value)
1267 checked_free(*old_value);
1269 *old_value = getStringCopy(new_value);
1272 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1274 const char *s_ptr, *s_last = s;
1275 byte separator_table[256] = { FALSE };
1277 char **tokens = NULL;
1282 if (separators == NULL)
1286 max_tokens = INT_MAX;
1288 // if string is empty, return empty array
1291 tokens = checked_malloc(sizeof(char *));
1297 // initialize separator table for all characters in separators string
1298 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1299 separator_table[*(byte *)s_ptr] = TRUE;
1301 // count number of tokens in string
1302 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1303 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1306 // allocate array for determined number of tokens
1307 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1309 // copy all but last separated sub-strings to array
1310 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1312 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1314 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1319 // copy last separated sub-string to array
1320 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1323 tokens[num_tokens] = NULL;
1328 int getStringArrayLength(char **s_array)
1330 int num_strings = 0;
1332 if (s_array == NULL)
1335 while (s_array[num_strings] != NULL)
1341 void freeStringArray(char **s_array)
1345 if (s_array == NULL)
1348 for (i = 0; s_array[i] != NULL; i++)
1349 checked_free(s_array[i]);
1351 checked_free(s_array);
1354 char *getUnescapedString(const char *s)
1356 const char *s_ptr = s;
1357 const char *octal_ptr;
1359 char *s_unescaped_ptr;
1364 s_unescaped = checked_malloc(strlen(s) + 1);
1365 s_unescaped_ptr = s_unescaped;
1367 while (*s_ptr != '\0')
1376 Warn("getUnescapedString: trailing \\");
1387 *s_unescaped_ptr = 0;
1390 while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7')
1392 *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0');
1401 *s_unescaped_ptr++ = '\b';
1405 *s_unescaped_ptr++ = '\f';
1409 *s_unescaped_ptr++ = '\n';
1413 *s_unescaped_ptr++ = '\r';
1417 *s_unescaped_ptr++ = '\t';
1421 *s_unescaped_ptr++ = '\v';
1425 /* also handles \" and \\ */
1426 *s_unescaped_ptr++ = *s_ptr;
1432 *s_unescaped_ptr++ = *s_ptr;
1439 *s_unescaped_ptr = '\0';
1444 boolean strEqual(const char *s1, const char *s2)
1446 return (s1 == NULL && s2 == NULL ? TRUE :
1447 s1 == NULL && s2 != NULL ? FALSE :
1448 s1 != NULL && s2 == NULL ? FALSE :
1449 strcmp(s1, s2) == 0);
1452 boolean strEqualN(const char *s1, const char *s2, int n)
1454 return (s1 == NULL && s2 == NULL ? TRUE :
1455 s1 == NULL && s2 != NULL ? FALSE :
1456 s1 != NULL && s2 == NULL ? FALSE :
1457 strncmp(s1, s2, n) == 0);
1460 boolean strEqualCase(const char *s1, const char *s2)
1462 return (s1 == NULL && s2 == NULL ? TRUE :
1463 s1 == NULL && s2 != NULL ? FALSE :
1464 s1 != NULL && s2 == NULL ? FALSE :
1465 strcasecmp(s1, s2) == 0);
1468 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1470 return (s1 == NULL && s2 == NULL ? TRUE :
1471 s1 == NULL && s2 != NULL ? FALSE :
1472 s1 != NULL && s2 == NULL ? FALSE :
1473 strncasecmp(s1, s2, n) == 0);
1476 boolean strPrefix(const char *s, const char *prefix)
1478 return (s == NULL && prefix == NULL ? TRUE :
1479 s == NULL && prefix != NULL ? FALSE :
1480 s != NULL && prefix == NULL ? FALSE :
1481 strncmp(s, prefix, strlen(prefix)) == 0);
1484 boolean strSuffix(const char *s, const char *suffix)
1486 return (s == NULL && suffix == NULL ? TRUE :
1487 s == NULL && suffix != NULL ? FALSE :
1488 s != NULL && suffix == NULL ? FALSE :
1489 strlen(s) < strlen(suffix) ? FALSE :
1490 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1493 boolean strPrefixLower(const char *s, const char *prefix)
1495 char *s_lower = getStringToLower(s);
1496 boolean match = strPrefix(s_lower, prefix);
1503 boolean strSuffixLower(const char *s, const char *suffix)
1505 char *s_lower = getStringToLower(s);
1506 boolean match = strSuffix(s_lower, suffix);
1513 boolean isURL(const char *s)
1515 while (*s && *s >= 'a' && *s <= 'z')
1518 return strPrefix(s, "://");
1522 // ----------------------------------------------------------------------------
1523 // command line option handling functions
1524 // ----------------------------------------------------------------------------
1526 void GetOptions(int argc, char *argv[],
1527 void (*print_usage_function)(void),
1528 void (*print_version_function)(void))
1530 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1531 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1532 char **options_left = &argvplus[1];
1534 // replace original "argv" with null-terminated array of string pointers
1536 argvplus[argc] = argv[argc];
1538 // initialize global program options
1539 options.server_host = NULL;
1540 options.server_port = 0;
1542 options.base_directory = base_path;
1544 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1545 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1546 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1547 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1548 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1549 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1551 options.execute_command = NULL;
1552 options.tape_log_filename = NULL;
1553 options.special_flags = NULL;
1554 options.debug_mode = NULL;
1555 options.player_name = NULL;
1556 options.identifier = NULL;
1557 options.level_nr = NULL;
1559 options.display_nr = 0;
1561 options.mytapes = FALSE;
1562 options.serveronly = FALSE;
1563 options.network = FALSE;
1564 options.verbose = FALSE;
1565 options.debug = FALSE;
1568 options.verbose = TRUE;
1570 #if !defined(PLATFORM_UNIX)
1571 if (*options_left == NULL) // no options given -- enable verbose mode
1572 options.verbose = TRUE;
1577 #if defined(PLATFORM_ANDROID)
1578 options.debug = TRUE;
1582 while (*options_left)
1584 char option_str[MAX_OPTION_LEN];
1585 char *option = options_left[0];
1586 char *next_option = options_left[1];
1587 char *option_arg = NULL;
1588 int option_len = strlen(option);
1590 if (option_len >= MAX_OPTION_LEN)
1591 FailWithHelp("unrecognized option '%s'", option);
1593 strcpy(option_str, option); // copy argument into buffer
1594 option = option_str;
1596 if (strEqual(option, "--")) // stop scanning arguments
1599 if (strPrefix(option, "--")) // treat '--' like '-'
1602 option_arg = strchr(option, '=');
1603 if (option_arg == NULL) // no '=' in option
1604 option_arg = next_option;
1607 *option_arg++ = '\0'; // cut argument from option
1608 if (*option_arg == '\0') // no argument after '='
1609 FailWithHelp("option '%s' has invalid argument", option_str);
1612 option_len = strlen(option);
1614 if (strEqual(option, "-"))
1616 FailWithHelp("unrecognized option '%s'", option);
1618 else if (strncmp(option, "-help", option_len) == 0)
1620 print_usage_function();
1624 else if (strncmp(option, "-basepath", option_len) == 0)
1626 if (option_arg == NULL)
1627 FailWithHelp("option '%s' requires an argument", option_str);
1629 options.base_directory = base_path = getStringCopy(option_arg);
1630 if (option_arg == next_option)
1633 // adjust paths for sub-directories in base directory accordingly
1634 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1635 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1636 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1637 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1638 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1639 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1641 else if (strncmp(option, "-levels", option_len) == 0)
1643 if (option_arg == NULL)
1644 FailWithHelp("option '%s' requires an argument", option_str);
1646 options.level_directory = getStringCopy(option_arg);
1647 if (option_arg == next_option)
1650 else if (strncmp(option, "-graphics", option_len) == 0)
1652 if (option_arg == NULL)
1653 FailWithHelp("option '%s' requires an argument", option_str);
1655 options.graphics_directory = getStringCopy(option_arg);
1656 if (option_arg == next_option)
1659 else if (strncmp(option, "-sounds", option_len) == 0)
1661 if (option_arg == NULL)
1662 FailWithHelp("option '%s' requires an argument", option_str);
1664 options.sounds_directory = getStringCopy(option_arg);
1665 if (option_arg == next_option)
1668 else if (strncmp(option, "-music", option_len) == 0)
1670 if (option_arg == NULL)
1671 FailWithHelp("option '%s' requires an argument", option_str);
1673 options.music_directory = getStringCopy(option_arg);
1674 if (option_arg == next_option)
1677 else if (strncmp(option, "-mytapes", option_len) == 0)
1679 options.mytapes = TRUE;
1681 else if (strncmp(option, "-network", option_len) == 0)
1683 options.network = TRUE;
1685 else if (strncmp(option, "-serveronly", option_len) == 0)
1687 options.serveronly = TRUE;
1689 else if (strncmp(option, "-debug", option_len) == 0)
1691 options.debug = TRUE;
1693 // optionally, debug output can be limited to a specific debug mode
1694 if (option_arg != next_option)
1695 options.debug_mode = getStringCopy(option_arg);
1697 else if (strncmp(option, "-player-name", option_len) == 0)
1699 if (option_arg == NULL)
1700 FailWithHelp("option '%s' requires an argument", option_str);
1702 options.player_name = getStringCopy(option_arg);
1703 if (option_arg == next_option)
1706 else if (strncmp(option, "-identifier", option_len) == 0)
1708 if (option_arg == NULL)
1709 FailWithHelp("option '%s' requires an argument", option_str);
1711 options.identifier = getStringCopy(option_arg);
1712 if (option_arg == next_option)
1715 else if (strncmp(option, "-level-nr", option_len) == 0)
1717 if (option_arg == NULL)
1718 FailWithHelp("option '%s' requires an argument", option_str);
1720 options.level_nr = getStringCopy(option_arg);
1721 if (option_arg == next_option)
1724 else if (strncmp(option, "-verbose", option_len) == 0)
1726 options.verbose = TRUE;
1728 else if (strncmp(option, "-version", option_len) == 0 ||
1729 strncmp(option, "-V", option_len) == 0)
1731 print_version_function();
1735 else if (strPrefix(option, "-D"))
1737 options.special_flags = getStringCopy(&option[2]);
1739 else if (strncmp(option, "-execute", option_len) == 0)
1741 if (option_arg == NULL)
1742 FailWithHelp("option '%s' requires an argument", option_str);
1744 options.execute_command = getStringCopy(option_arg);
1745 if (option_arg == next_option)
1748 // when doing batch processing, always enable verbose mode (warnings)
1749 options.verbose = TRUE;
1751 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1753 if (option_arg == NULL)
1754 FailWithHelp("option '%s' requires an argument", option_str);
1756 options.tape_log_filename = getStringCopy(option_arg);
1757 if (option_arg == next_option)
1760 else if (strncmp(option, "-display", option_len) == 0)
1762 if (option_arg == NULL)
1763 FailWithHelp("option '%s' requires an argument", option_str);
1765 if (option_arg == next_option)
1768 int display_nr = atoi(option_arg);
1771 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1772 options.display_nr = display_nr;
1774 options.display_nr =
1775 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1777 if (display_nr != options.display_nr)
1778 Warn("invalid display %d -- using display %d",
1779 display_nr, options.display_nr);
1782 #if defined(PLATFORM_MAC)
1783 else if (strPrefix(option, "-psn"))
1785 // ignore process serial number when launched via GUI on Mac OS X
1788 else if (*option == '-')
1790 FailWithHelp("unrecognized option '%s'", option_str);
1792 else if (options.server_host == NULL)
1794 options.server_host = *options_left;
1796 else if (options.server_port == 0)
1798 options.server_port = atoi(*options_left);
1799 if (options.server_port < 1024)
1800 FailWithHelp("bad port number '%d'", options.server_port);
1803 FailWithHelp("too many arguments");
1810 // ----------------------------------------------------------------------------
1811 // checked memory allocation and freeing functions
1812 // ----------------------------------------------------------------------------
1814 void *checked_malloc(unsigned int size)
1821 Fail("cannot allocate %d bytes -- out of memory", size);
1826 void *checked_calloc(unsigned int size)
1830 ptr = calloc(1, size);
1833 Fail("cannot allocate %d bytes -- out of memory", size);
1838 void *checked_realloc(void *ptr, unsigned int size)
1840 ptr = realloc(ptr, size);
1843 Fail("cannot allocate %d bytes -- out of memory", size);
1848 void checked_free(void *ptr)
1850 if (ptr != NULL) // this check should be done by free() anyway
1854 void clear_mem(void *ptr, unsigned int size)
1856 #if defined(PLATFORM_WINDOWS)
1857 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1858 char *cptr = (char *)ptr;
1863 memset(ptr, 0, size);
1868 // ----------------------------------------------------------------------------
1869 // various helper functions
1870 // ----------------------------------------------------------------------------
1872 void swap_numbers(int *i1, int *i2)
1880 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1892 int get_number_of_bits(int bits)
1895 Counting bits set, Brian Kernighan's way
1897 Brian Kernighan's method goes through as many iterations as there are set
1898 bits. So if we have a 32-bit word with only the high bit set, then it will
1899 only go once through the loop.
1901 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1902 and Dennis M. Ritchie) mentions this in exercise 2-9.
1903 First published by Peter Wegner in CACM 3 (1960), 322.
1910 bits &= bits - 1; // clear the least significant bit set
1917 /* the "put" variants of the following file access functions check for the file
1918 pointer being != NULL and return the number of bytes they have or would have
1919 written; this allows for chunk writing functions to first determine the size
1920 of the (not yet written) chunk, write the correct chunk size and finally
1921 write the chunk itself */
1923 int getFile8BitInteger(File *file)
1925 return getByteFromFile(file);
1928 int putFile8BitInteger(FILE *file, int value)
1936 int getFile16BitInteger(File *file, int byte_order)
1938 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1939 return ((getByteFromFile(file) << 8) |
1940 (getByteFromFile(file) << 0));
1941 else // BYTE_ORDER_LITTLE_ENDIAN
1942 return ((getByteFromFile(file) << 0) |
1943 (getByteFromFile(file) << 8));
1946 int putFile16BitInteger(FILE *file, int value, int byte_order)
1950 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1952 fputc((value >> 8) & 0xff, file);
1953 fputc((value >> 0) & 0xff, file);
1955 else // BYTE_ORDER_LITTLE_ENDIAN
1957 fputc((value >> 0) & 0xff, file);
1958 fputc((value >> 8) & 0xff, file);
1965 int getFile32BitInteger(File *file, int byte_order)
1967 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1968 return ((getByteFromFile(file) << 24) |
1969 (getByteFromFile(file) << 16) |
1970 (getByteFromFile(file) << 8) |
1971 (getByteFromFile(file) << 0));
1972 else // BYTE_ORDER_LITTLE_ENDIAN
1973 return ((getByteFromFile(file) << 0) |
1974 (getByteFromFile(file) << 8) |
1975 (getByteFromFile(file) << 16) |
1976 (getByteFromFile(file) << 24));
1979 int putFile32BitInteger(FILE *file, int value, int byte_order)
1983 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1985 fputc((value >> 24) & 0xff, file);
1986 fputc((value >> 16) & 0xff, file);
1987 fputc((value >> 8) & 0xff, file);
1988 fputc((value >> 0) & 0xff, file);
1990 else // BYTE_ORDER_LITTLE_ENDIAN
1992 fputc((value >> 0) & 0xff, file);
1993 fputc((value >> 8) & 0xff, file);
1994 fputc((value >> 16) & 0xff, file);
1995 fputc((value >> 24) & 0xff, file);
2002 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
2005 const int chunk_name_length = 4;
2008 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
2011 if (chunk_size != NULL)
2014 *chunk_size = getFile32BitInteger(file, byte_order);
2017 return (checkEndOfFile(file) ? FALSE : TRUE);
2020 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2027 fputs(chunk_name, file);
2029 num_bytes += strlen(chunk_name);
2031 if (chunk_size >= 0)
2035 putFile32BitInteger(file, chunk_size, byte_order);
2043 int getFileVersion(File *file)
2045 int version_super = getByteFromFile(file);
2046 int version_major = getByteFromFile(file);
2047 int version_minor = getByteFromFile(file);
2048 int version_patch = getByteFromFile(file);
2050 return VERSION_IDENT(version_super, version_major, version_minor,
2054 int putFileVersion(FILE *file, int version)
2058 int version_super = VERSION_SUPER(version);
2059 int version_major = VERSION_MAJOR(version);
2060 int version_minor = VERSION_MINOR(version);
2061 int version_patch = VERSION_PATCH(version);
2063 fputc(version_super, file);
2064 fputc(version_major, file);
2065 fputc(version_minor, file);
2066 fputc(version_patch, file);
2072 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2076 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2077 buffer[i] = getByteFromFile(file);
2080 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2084 for (i = 0; i < bytes; i++)
2085 fputc(buffer[i], file);
2088 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2090 while (bytes-- && !checkEndOfFile(file))
2091 getByteFromFile(file);
2094 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2101 // ----------------------------------------------------------------------------
2102 // functions to convert between ISO-8859-1 and UTF-8
2103 // ----------------------------------------------------------------------------
2105 char *getUTF8FromLatin1(char *latin1)
2107 int max_utf8_size = 2 * strlen(latin1) + 1;
2108 char *utf8 = checked_calloc(max_utf8_size);
2109 unsigned char *src = (unsigned char *)latin1;
2110 unsigned char *dst = (unsigned char *)utf8;
2114 if (*src < 128) // pure 7-bit ASCII
2118 else if (*src >= 160) // non-ASCII characters
2120 *dst++ = 194 + (*src >= 192);
2121 *dst++ = 128 + (*src & 63);
2123 else // undefined in ISO-8859-1
2131 // only use the smallest possible string buffer size
2132 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2137 char *getLatin1FromUTF8(char *utf8)
2139 int max_latin1_size = strlen(utf8) + 1;
2140 char *latin1 = checked_calloc(max_latin1_size);
2141 unsigned char *src = (unsigned char *)utf8;
2142 unsigned char *dst = (unsigned char *)latin1;
2146 if (*src < 128) // pure 7-bit ASCII
2150 else if (src[0] == 194 &&
2151 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2156 else if (src[0] == 195 &&
2157 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2159 *dst++ = src[1] + 64;
2163 // all other UTF-8 characters are undefined in ISO-8859-1
2165 else if (src[0] >= 192 && src[0] < 224 &&
2166 src[1] >= 128 && src[1] < 192)
2171 else if (src[0] >= 224 && src[0] < 240 &&
2172 src[1] >= 128 && src[1] < 192 &&
2173 src[2] >= 128 && src[2] < 192)
2178 else if (src[0] >= 240 && src[0] < 248 &&
2179 src[1] >= 128 && src[1] < 192 &&
2180 src[2] >= 128 && src[2] < 192 &&
2181 src[3] >= 128 && src[3] < 192)
2186 else if (src[0] >= 248 && src[0] < 252 &&
2187 src[1] >= 128 && src[1] < 192 &&
2188 src[2] >= 128 && src[2] < 192 &&
2189 src[3] >= 128 && src[3] < 192 &&
2190 src[4] >= 128 && src[4] < 192)
2195 else if (src[0] >= 252 && src[0] < 254 &&
2196 src[1] >= 128 && src[1] < 192 &&
2197 src[2] >= 128 && src[2] < 192 &&
2198 src[3] >= 128 && src[3] < 192 &&
2199 src[4] >= 128 && src[4] < 192 &&
2200 src[5] >= 128 && src[5] < 192)
2212 // only use the smallest possible string buffer size
2213 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2218 int getTextEncoding(char *text)
2220 unsigned char *src = (unsigned char *)text;
2221 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2226 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2232 else if (src[0] >= 192 && src[0] < 224 &&
2233 src[1] >= 128 && src[1] < 192)
2237 else if (src[0] >= 224 && src[0] < 240 &&
2238 src[1] >= 128 && src[1] < 192 &&
2239 src[2] >= 128 && src[2] < 192)
2243 else if (src[0] >= 240 && src[0] < 248 &&
2244 src[1] >= 128 && src[1] < 192 &&
2245 src[2] >= 128 && src[2] < 192 &&
2246 src[3] >= 128 && src[3] < 192)
2250 else if (src[0] >= 248 && src[0] < 252 &&
2251 src[1] >= 128 && src[1] < 192 &&
2252 src[2] >= 128 && src[2] < 192 &&
2253 src[3] >= 128 && src[3] < 192 &&
2254 src[4] >= 128 && src[4] < 192)
2258 else if (src[0] >= 252 && src[0] < 254 &&
2259 src[1] >= 128 && src[1] < 192 &&
2260 src[2] >= 128 && src[2] < 192 &&
2261 src[3] >= 128 && src[3] < 192 &&
2262 src[4] >= 128 && src[4] < 192 &&
2263 src[5] >= 128 && src[5] < 192)
2269 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2277 // ----------------------------------------------------------------------------
2278 // functions for JSON handling
2279 // ----------------------------------------------------------------------------
2281 char *getEscapedJSON(char *s)
2283 int max_json_size = 2 * strlen(s) + 1;
2284 char *json = checked_calloc(max_json_size);
2285 unsigned char *src = (unsigned char *)s;
2286 unsigned char *dst = (unsigned char *)json;
2287 char *escaped[256] =
2300 if (escaped[*src] != NULL)
2302 char *esc = escaped[*src++];
2313 // only use the smallest possible string buffer size
2314 json = checked_realloc(json, strlen(json) + 1);
2320 // ----------------------------------------------------------------------------
2321 // functions to translate key identifiers between different format
2322 // ----------------------------------------------------------------------------
2324 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2325 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2326 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2327 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2329 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2338 // return and escape keys
2339 { KSYM_Return, "XK_Return", "return" },
2340 { KSYM_Escape, "XK_Escape", "escape" },
2342 // normal cursor keys
2343 { KSYM_Left, "XK_Left", "cursor left" },
2344 { KSYM_Right, "XK_Right", "cursor right" },
2345 { KSYM_Up, "XK_Up", "cursor up" },
2346 { KSYM_Down, "XK_Down", "cursor down" },
2348 // keypad cursor keys
2350 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2351 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2352 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2353 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2356 // other keypad keys
2357 #ifdef KSYM_KP_Enter
2358 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2359 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2360 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2361 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2362 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2363 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2367 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2368 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2369 { KSYM_Control_L, "XK_Control_L", "left control" },
2370 { KSYM_Control_R, "XK_Control_R", "right control" },
2371 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2372 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2373 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2374 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2375 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2376 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2378 // some special keys
2379 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2380 { KSYM_Delete, "XK_Delete", "delete" },
2381 { KSYM_Insert, "XK_Insert", "insert" },
2382 { KSYM_Tab, "XK_Tab", "tab" },
2383 { KSYM_Home, "XK_Home", "home" },
2384 { KSYM_End, "XK_End", "end" },
2385 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2386 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2388 { KSYM_Select, "XK_Select", "select" },
2389 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2390 { KSYM_Back, "XK_Back", "back" }, // back key
2391 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2392 #if defined(PLATFORM_ANDROID)
2393 { KSYM_Rewind, "XK_Rewind", "rewind" },
2394 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2397 // ASCII 0x20 to 0x40 keys (except numbers)
2398 { KSYM_space, "XK_space", "space" },
2399 { KSYM_exclam, "XK_exclam", "!" },
2400 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2401 { KSYM_numbersign, "XK_numbersign", "#" },
2402 { KSYM_dollar, "XK_dollar", "$" },
2403 { KSYM_percent, "XK_percent", "%" },
2404 { KSYM_ampersand, "XK_ampersand", "&" },
2405 { KSYM_apostrophe, "XK_apostrophe", "'" },
2406 { KSYM_parenleft, "XK_parenleft", "(" },
2407 { KSYM_parenright, "XK_parenright", ")" },
2408 { KSYM_asterisk, "XK_asterisk", "*" },
2409 { KSYM_plus, "XK_plus", "+" },
2410 { KSYM_comma, "XK_comma", "," },
2411 { KSYM_minus, "XK_minus", "-" },
2412 { KSYM_period, "XK_period", "." },
2413 { KSYM_slash, "XK_slash", "/" },
2414 { KSYM_colon, "XK_colon", ":" },
2415 { KSYM_semicolon, "XK_semicolon", ";" },
2416 { KSYM_less, "XK_less", "<" },
2417 { KSYM_equal, "XK_equal", "=" },
2418 { KSYM_greater, "XK_greater", ">" },
2419 { KSYM_question, "XK_question", "?" },
2420 { KSYM_at, "XK_at", "@" },
2423 { KSYM_bracketleft, "XK_bracketleft", "[" },
2424 { KSYM_backslash, "XK_backslash", "\\" },
2425 { KSYM_bracketright,"XK_bracketright", "]" },
2426 { KSYM_asciicircum, "XK_asciicircum", "^" },
2427 { KSYM_underscore, "XK_underscore", "_" },
2428 { KSYM_grave, "XK_grave", "grave" },
2429 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2430 { KSYM_braceleft, "XK_braceleft", "brace left" },
2431 { KSYM_bar, "XK_bar", "bar" },
2432 { KSYM_braceright, "XK_braceright", "brace right" },
2433 { KSYM_asciitilde, "XK_asciitilde", "~" },
2435 // special (non-ASCII) keys
2436 { KSYM_degree, "XK_degree", "degree" },
2437 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2438 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2439 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2440 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2441 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2442 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2443 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2445 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2446 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2447 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2448 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2449 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2450 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2451 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2452 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2453 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2455 // other keys (for reverse mapping only)
2456 { KSYM_space, "XK_space", " " },
2458 // keypad keys are not in numerical order in SDL2
2459 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2460 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2461 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2462 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2463 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2464 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2465 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2466 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2467 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2468 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2470 // end-of-array identifier
2476 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2478 static char name_buffer[30];
2481 if (key >= KSYM_A && key <= KSYM_Z)
2482 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2483 else if (key >= KSYM_a && key <= KSYM_z)
2484 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2485 else if (key >= KSYM_0 && key <= KSYM_9)
2486 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2487 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2488 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2489 else if (key == KSYM_UNDEFINED)
2490 strcpy(name_buffer, "(undefined)");
2497 if (key == translate_key[i].key)
2499 strcpy(name_buffer, translate_key[i].name);
2503 while (translate_key[++i].name);
2505 if (!translate_key[i].name)
2506 strcpy(name_buffer, "(unknown)");
2509 *name = name_buffer;
2511 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2513 static char name_buffer[30];
2516 if (key >= KSYM_A && key <= KSYM_Z)
2517 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2518 else if (key >= KSYM_a && key <= KSYM_z)
2519 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2520 else if (key >= KSYM_0 && key <= KSYM_9)
2521 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2522 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2523 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2524 else if (key == KSYM_UNDEFINED)
2525 strcpy(name_buffer, "[undefined]");
2532 if (key == translate_key[i].key)
2534 strcpy(name_buffer, translate_key[i].x11name);
2538 while (translate_key[++i].x11name);
2540 if (!translate_key[i].x11name)
2541 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2544 *x11name = name_buffer;
2546 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2548 Key key = KSYM_UNDEFINED;
2549 char *name_ptr = *name;
2551 if (strlen(*name) == 1)
2553 char c = name_ptr[0];
2555 if (c >= 'A' && c <= 'Z')
2556 key = KSYM_A + (Key)(c - 'A');
2557 else if (c >= 'a' && c <= 'z')
2558 key = KSYM_a + (Key)(c - 'a');
2559 else if (c >= '0' && c <= '9')
2560 key = KSYM_0 + (Key)(c - '0');
2563 if (key == KSYM_UNDEFINED)
2569 if (strEqual(translate_key[i].name, *name))
2571 key = translate_key[i].key;
2575 while (translate_key[++i].x11name);
2578 if (key == KSYM_UNDEFINED)
2579 Warn("getKeyFromKeyName(): not completely implemented");
2583 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2585 Key key = KSYM_UNDEFINED;
2586 char *name_ptr = *x11name;
2588 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2590 char c = name_ptr[3];
2592 if (c >= 'A' && c <= 'Z')
2593 key = KSYM_A + (Key)(c - 'A');
2594 else if (c >= 'a' && c <= 'z')
2595 key = KSYM_a + (Key)(c - 'a');
2596 else if (c >= '0' && c <= '9')
2597 key = KSYM_0 + (Key)(c - '0');
2599 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2601 char c1 = name_ptr[4];
2602 char c2 = name_ptr[5];
2605 if ((c1 >= '0' && c1 <= '9') &&
2606 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2607 d = atoi(&name_ptr[4]);
2609 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2610 key = KSYM_F1 + (Key)(d - 1);
2612 else if (strPrefix(name_ptr, "XK_"))
2618 if (strEqual(name_ptr, translate_key[i].x11name))
2620 key = translate_key[i].key;
2624 while (translate_key[++i].x11name);
2626 else if (strPrefix(name_ptr, "0x"))
2628 unsigned int value = 0;
2634 char c = *name_ptr++;
2637 if (c >= '0' && c <= '9')
2639 else if (c >= 'a' && c <= 'f')
2640 d = (int)(c - 'a' + 10);
2641 else if (c >= 'A' && c <= 'F')
2642 d = (int)(c - 'A' + 10);
2650 value = value * 16 + d;
2661 char *getKeyNameFromKey(Key key)
2665 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2669 char *getX11KeyNameFromKey(Key key)
2673 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2677 Key getKeyFromKeyName(char *name)
2681 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2685 Key getKeyFromX11KeyName(char *x11name)
2689 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2693 char getCharFromKey(Key key)
2699 } translate_key_char[] =
2701 // special (non-ASCII) keys (ISO-8859-1)
2702 { KSYM_degree, CHAR_BYTE_DEGREE },
2703 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2704 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2705 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2706 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2707 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2708 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2709 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2711 // end-of-array identifier
2715 char *keyname = getKeyNameFromKey(key);
2718 if (strlen(keyname) == 1)
2720 else if (strEqual(keyname, "space"))
2728 if (key == translate_key_char[i].key)
2730 c = translate_key_char[i].key_char;
2735 while (translate_key_char[++i].key_char);
2741 char getValidConfigValueChar(char c)
2743 if (c == '#' || // used to mark comments
2744 c == '\\') // used to mark continued lines
2751 // ----------------------------------------------------------------------------
2752 // functions to translate string identifiers to integer or boolean value
2753 // ----------------------------------------------------------------------------
2755 int get_integer_from_string(char *s)
2757 // check for the most common case first
2758 if (s[0] >= '0' && s[0] <= '9')
2761 char *s_lower = getStringToLower(s);
2764 if (strEqual(s_lower, "false") ||
2765 strEqual(s_lower, "no") ||
2766 strEqual(s_lower, "off"))
2768 else if (strEqual(s_lower, "true") ||
2769 strEqual(s_lower, "yes") ||
2770 strEqual(s_lower, "on"))
2780 boolean get_boolean_from_string(char *s)
2782 char *s_lower = getStringToLower(s);
2783 boolean result = FALSE;
2785 if (strEqual(s_lower, "true") ||
2786 strEqual(s_lower, "yes") ||
2787 strEqual(s_lower, "on") ||
2788 get_integer_from_string(s) == 1)
2796 int get_switch3_from_string(char *s)
2798 char *s_lower = getStringToLower(s);
2801 if (strEqual(s_lower, "true") ||
2802 strEqual(s_lower, "yes") ||
2803 strEqual(s_lower, "on") ||
2804 get_integer_from_string(s) == 1)
2806 else if (strEqual(s_lower, "auto"))
2814 int get_player_nr_from_string(char *s)
2816 static char *player_text[] =
2826 char *s_lower = getStringToLower(s);
2830 for (i = 0; player_text[i] != NULL; i++)
2831 if (strEqual(s_lower, player_text[i]))
2840 // ----------------------------------------------------------------------------
2841 // functions for generic lists
2842 // ----------------------------------------------------------------------------
2844 ListNode *newListNode(void)
2846 return checked_calloc(sizeof(ListNode));
2849 void addNodeToList(ListNode **node_first, char *key, void *content)
2851 ListNode *node_new = newListNode();
2853 node_new->key = getStringCopy(key);
2854 node_new->content = content;
2855 node_new->next = *node_first;
2858 (*node_first)->prev = node_new;
2860 *node_first = node_new;
2863 void deleteNodeFromList(ListNode **node_first, char *key,
2864 void (*destructor_function)(void *))
2866 if (node_first == NULL || *node_first == NULL)
2869 if (strEqual((*node_first)->key, key))
2871 // after first recursion, (*node_first)->prev->next == *node_first,
2872 // so *node_first would be overwritten with (*node_first)->next
2873 // => use a copy of *node_first (and later of (*node_first)->next)
2874 ListNode *node = *node_first;
2875 ListNode *node_next = node->next;
2877 checked_free(node->key);
2879 if (destructor_function)
2880 destructor_function(node->content);
2883 node->prev->next = node->next;
2886 node->next->prev = node->prev;
2890 // after removing node, set list pointer to next valid list node
2891 // (this is important if the first node of the list was deleted)
2892 *node_first = node_next;
2896 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2900 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2902 if (node_first == NULL)
2905 if (strEqual(node_first->key, key))
2908 return getNodeFromKey(node_first->next, key);
2911 int getNumNodes(ListNode *node_first)
2913 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2917 static void dumpList(ListNode *node_first)
2919 ListNode *node = node_first;
2923 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2924 ((struct ListNodeInfo *)node->content)->num_references);
2928 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2933 // ----------------------------------------------------------------------------
2934 // functions for file handling
2935 // ----------------------------------------------------------------------------
2937 #define MAX_BUFFER_SIZE 4096
2939 File *openFile(char *filename, char *mode)
2941 File *file = checked_calloc(sizeof(File));
2943 file->file = fopen(filename, mode);
2945 if (file->file != NULL)
2947 file->filename = getStringCopy(filename);
2952 #if defined(PLATFORM_ANDROID)
2953 file->asset_file = SDL_RWFromFile(filename, mode);
2955 if (file->asset_file != NULL)
2957 file->file_is_asset = TRUE;
2958 file->filename = getStringCopy(filename);
2969 int closeFile(File *file)
2976 #if defined(PLATFORM_ANDROID)
2977 if (file->asset_file)
2978 result = SDL_RWclose(file->asset_file);
2982 result = fclose(file->file);
2984 checked_free(file->filename);
2990 int checkEndOfFile(File *file)
2992 #if defined(PLATFORM_ANDROID)
2993 if (file->file_is_asset)
2994 return file->end_of_file;
2997 return feof(file->file);
3000 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
3002 #if defined(PLATFORM_ANDROID)
3003 if (file->file_is_asset)
3005 if (file->end_of_file)
3008 size_t num_items_read =
3009 SDL_RWread(file->asset_file, buffer, item_size, num_items);
3011 if (num_items_read < num_items)
3012 file->end_of_file = TRUE;
3014 return num_items_read;
3018 return fread(buffer, item_size, num_items, file->file);
3021 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3023 return fwrite(buffer, item_size, num_items, file->file);
3026 int seekFile(File *file, long offset, int whence)
3028 #if defined(PLATFORM_ANDROID)
3029 if (file->file_is_asset)
3031 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3032 whence == SEEK_CUR ? RW_SEEK_CUR :
3033 whence == SEEK_END ? RW_SEEK_END : 0);
3035 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3039 return fseek(file->file, offset, whence);
3042 int getByteFromFile(File *file)
3044 #if defined(PLATFORM_ANDROID)
3045 if (file->file_is_asset)
3047 if (file->end_of_file)
3051 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3053 if (num_bytes_read < 1)
3054 file->end_of_file = TRUE;
3056 return (file->end_of_file ? EOF : (int)c);
3060 return fgetc(file->file);
3063 char *getStringFromFile(File *file, char *line, int size)
3065 #if defined(PLATFORM_ANDROID)
3066 if (file->file_is_asset)
3068 if (file->end_of_file)
3071 char *line_ptr = line;
3072 int num_bytes_read = 0;
3074 while (num_bytes_read < size - 1 &&
3075 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3076 *line_ptr++ != '\n')
3081 if (strlen(line) == 0)
3083 file->end_of_file = TRUE;
3092 return fgets(line, size, file->file);
3095 int copyFile(char *filename_from, char *filename_to)
3097 File *file_from, *file_to;
3099 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3104 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3106 closeFile(file_from);
3111 while (!checkEndOfFile(file_from))
3113 byte buffer[MAX_BUFFER_SIZE];
3114 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3116 writeFile(file_to, buffer, 1, bytes_read);
3119 closeFile(file_from);
3125 boolean touchFile(char *filename)
3129 if (!(file = fopen(filename, MODE_WRITE)))
3131 Warn("cannot touch file '%s'", filename);
3142 // ----------------------------------------------------------------------------
3143 // functions for directory handling
3144 // ----------------------------------------------------------------------------
3146 Directory *openDirectory(char *dir_name)
3148 Directory *dir = checked_calloc(sizeof(Directory));
3150 dir->dir = opendir(dir_name);
3152 if (dir->dir != NULL)
3154 dir->filename = getStringCopy(dir_name);
3159 #if defined(PLATFORM_ANDROID)
3160 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3162 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3164 checked_free(asset_toc_filename);
3166 if (dir->asset_toc_file != NULL)
3168 dir->directory_is_asset = TRUE;
3169 dir->filename = getStringCopy(dir_name);
3180 int closeDirectory(Directory *dir)
3187 #if defined(PLATFORM_ANDROID)
3188 if (dir->asset_toc_file)
3189 result = SDL_RWclose(dir->asset_toc_file);
3193 result = closedir(dir->dir);
3196 freeDirectoryEntry(dir->dir_entry);
3198 checked_free(dir->filename);
3204 DirectoryEntry *readDirectory(Directory *dir)
3207 freeDirectoryEntry(dir->dir_entry);
3209 dir->dir_entry = NULL;
3211 #if defined(PLATFORM_ANDROID)
3212 if (dir->directory_is_asset)
3214 char line[MAX_LINE_LEN];
3215 char *line_ptr = line;
3216 int num_bytes_read = 0;
3218 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3219 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3228 if (strlen(line) == 0)
3231 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3233 dir->dir_entry->is_directory = FALSE;
3234 if (line[strlen(line) - 1] == '/')
3236 dir->dir_entry->is_directory = TRUE;
3238 line[strlen(line) - 1] = '\0';
3241 dir->dir_entry->basename = getStringCopy(line);
3242 dir->dir_entry->filename = getPath2(dir->filename, line);
3244 return dir->dir_entry;
3248 struct dirent *dir_entry = readdir(dir->dir);
3250 if (dir_entry == NULL)
3253 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3255 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3256 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3258 struct stat file_status;
3260 dir->dir_entry->is_directory =
3261 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3262 S_ISDIR(file_status.st_mode));
3264 return dir->dir_entry;
3267 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3269 if (dir_entry == NULL)
3272 checked_free(dir_entry->basename);
3273 checked_free(dir_entry->filename);
3274 checked_free(dir_entry);
3278 // ----------------------------------------------------------------------------
3279 // functions for checking files and filenames
3280 // ----------------------------------------------------------------------------
3282 boolean directoryExists(const char *dir_name)
3284 if (dir_name == NULL)
3287 struct stat file_status;
3288 boolean success = (stat(dir_name, &file_status) == 0 &&
3289 S_ISDIR(file_status.st_mode));
3291 #if defined(PLATFORM_ANDROID)
3294 // this might be an asset directory; check by trying to open toc file
3295 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3296 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3298 checked_free(asset_toc_filename);
3300 success = (file != NULL);
3310 boolean fileExists(const char *filename)
3312 if (filename == NULL)
3315 boolean success = (access(filename, F_OK) == 0);
3317 #if defined(PLATFORM_ANDROID)
3320 // this might be an asset file; check by trying to open it
3321 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3323 success = (file != NULL);
3334 static boolean fileHasPrefix(const char *basename, const char *prefix)
3336 static char *basename_lower = NULL;
3337 int basename_length, prefix_length;
3339 checked_free(basename_lower);
3341 if (basename == NULL || prefix == NULL)
3344 basename_lower = getStringToLower(basename);
3345 basename_length = strlen(basename_lower);
3346 prefix_length = strlen(prefix);
3348 if (basename_length > prefix_length + 1 &&
3349 basename_lower[prefix_length] == '.' &&
3350 strncmp(basename_lower, prefix, prefix_length) == 0)
3357 static boolean fileHasSuffix(const char *basename, const char *suffix)
3359 static char *basename_lower = NULL;
3360 int basename_length, suffix_length;
3362 checked_free(basename_lower);
3364 if (basename == NULL || suffix == NULL)
3367 basename_lower = getStringToLower(basename);
3368 basename_length = strlen(basename_lower);
3369 suffix_length = strlen(suffix);
3371 if (basename_length > suffix_length + 1 &&
3372 basename_lower[basename_length - suffix_length - 1] == '.' &&
3373 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3379 static boolean FileCouldBeArtwork(char *filename)
3381 char *basename = getBaseNamePtr(filename);
3383 return (!strEqual(basename, ".") &&
3384 !strEqual(basename, "..") &&
3385 !fileHasSuffix(basename, "txt") &&
3386 !fileHasSuffix(basename, "conf") &&
3387 !directoryExists(filename));
3390 boolean FileIsGraphic(char *filename)
3392 return FileCouldBeArtwork(filename);
3395 boolean FileIsSound(char *filename)
3397 return FileCouldBeArtwork(filename);
3400 boolean FileIsMusic(char *filename)
3402 return FileCouldBeArtwork(filename);
3405 boolean FileIsArtworkType(char *filename, int type)
3407 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3408 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3409 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3415 // ----------------------------------------------------------------------------
3416 // functions for loading artwork configuration information
3417 // ----------------------------------------------------------------------------
3419 char *get_mapped_token(char *token)
3421 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3422 static char *map_token_prefix[][2] =
3424 { "char_procent", "char_percent" },
3425 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3426 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3427 { "bd_butterfly_left", "bd_butterfly.left" },
3428 { "bd_butterfly_right", "bd_butterfly.right" },
3429 { "bd_butterfly_up", "bd_butterfly.up" },
3430 { "bd_butterfly_down", "bd_butterfly.down" },
3431 { "bd_firefly_left", "bd_firefly.left" },
3432 { "bd_firefly_right", "bd_firefly.right" },
3433 { "bd_firefly_up", "bd_firefly.up" },
3434 { "bd_firefly_down", "bd_firefly.down" },
3440 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3442 int len_token_prefix = strlen(map_token_prefix[i][0]);
3444 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3445 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3448 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3449 char *gfx_substring = ".gfx";
3450 char *gfx_prefix = "gfx.";
3451 if (strstr(token, gfx_substring) != NULL)
3453 char *token_prefix = getStringCopy(token);
3454 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3455 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3458 // cut off token string at ".gfx" substring position
3459 *token_gfx_pos = '\0';
3461 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3462 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3466 return mapped_token;
3472 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3475 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3476 static struct ConfigTypeInfo prefix_list[] =
3478 { "global.anim_1" },
3479 { "global.anim_2" },
3480 { "global.anim_3" },
3481 { "global.anim_4" },
3482 { "global.anim_5" },
3483 { "global.anim_6" },
3484 { "global.anim_7" },
3485 { "global.anim_8" },
3486 { "global.anim_9" },
3487 { "global.anim_10" },
3488 { "global.anim_11" },
3489 { "global.anim_12" },
3490 { "global.anim_13" },
3491 { "global.anim_14" },
3492 { "global.anim_15" },
3493 { "global.anim_16" },
3494 { "global.anim_17" },
3495 { "global.anim_18" },
3496 { "global.anim_19" },
3497 { "global.anim_20" },
3498 { "global.anim_21" },
3499 { "global.anim_22" },
3500 { "global.anim_23" },
3501 { "global.anim_24" },
3502 { "global.anim_25" },
3503 { "global.anim_26" },
3504 { "global.anim_27" },
3505 { "global.anim_28" },
3506 { "global.anim_29" },
3507 { "global.anim_30" },
3508 { "global.anim_31" },
3509 { "global.anim_32" },
3513 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3514 boolean prefix_found = FALSE;
3518 // search for prefix to check if base token has to be created
3519 for (i = 0; prefix_list[i].token != NULL; i++)
3520 if (strPrefix(token, prefix_list[i].token))
3521 prefix_found = TRUE;
3526 // search for suffix (parameter) to determine base token length
3527 for (i = 0; suffix_list[i].token != NULL; i++)
3528 if (strSuffix(token, suffix_list[i].token))
3529 len_suffix = strlen(suffix_list[i].token);
3531 return getStringCopyN(token, strlen(token) - len_suffix);
3534 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3535 struct ListNodeInfo ***, int *);
3537 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3538 struct ConfigTypeInfo *suffix_list,
3539 char **ignore_tokens,
3540 int num_file_list_entries)
3542 SetupFileHash *ignore_tokens_hash;
3543 struct FileInfo *file_list;
3544 int num_file_list_entries_found = 0;
3545 int num_suffix_list_entries = 0;
3549 // create hash from list of tokens to be ignored (for quick access)
3550 ignore_tokens_hash = newSetupFileHash();
3551 for (i = 0; ignore_tokens[i] != NULL; i++)
3552 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3554 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3556 for (i = 0; suffix_list[i].token != NULL; i++)
3557 num_suffix_list_entries++;
3559 // always start with reliable default values
3560 for (i = 0; i < num_file_list_entries; i++)
3562 file_list[i].token = NULL;
3564 file_list[i].default_filename = NULL;
3565 file_list[i].filename = NULL;
3567 if (num_suffix_list_entries > 0)
3569 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3571 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3572 file_list[i].parameter = checked_calloc(parameter_array_size);
3574 for (j = 0; j < num_suffix_list_entries; j++)
3576 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3577 setString(&file_list[i].parameter[j], suffix_list[j].value);
3580 file_list[i].redefined = FALSE;
3581 file_list[i].fallback_to_default = FALSE;
3582 file_list[i].default_is_cloned = FALSE;
3588 for (i = 0; config_list[i].token != NULL; i++)
3590 int len_config_token = strlen(config_list[i].token);
3591 boolean is_file_entry = TRUE;
3593 for (j = 0; suffix_list[j].token != NULL; j++)
3595 int len_suffix = strlen(suffix_list[j].token);
3597 if (len_suffix < len_config_token &&
3598 strEqual(&config_list[i].token[len_config_token - len_suffix],
3599 suffix_list[j].token))
3601 setString(&file_list[list_pos].default_parameter[j],
3602 config_list[i].value);
3604 is_file_entry = FALSE;
3610 // the following tokens are no file definitions, but other config tokens
3611 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3612 is_file_entry = FALSE;
3619 if (list_pos >= num_file_list_entries)
3622 file_list[list_pos].token = config_list[i].token;
3623 file_list[list_pos].default_filename = config_list[i].value;
3626 if (strSuffix(config_list[i].token, ".clone_from"))
3627 file_list[list_pos].default_is_cloned = TRUE;
3630 num_file_list_entries_found = list_pos + 1;
3631 if (num_file_list_entries_found != num_file_list_entries)
3634 Error("inconsistant config list information:");
3635 Error("- should be: %d (according to 'src/conf_xxx.h')",
3636 num_file_list_entries);
3637 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3638 num_file_list_entries_found);
3643 freeSetupFileHash(ignore_tokens_hash);
3648 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3650 int len_token = strlen(token);
3651 int len_suffix = strlen(suffix);
3653 if (start_pos < 0) // compare suffix from end of string
3654 start_pos += len_token;
3656 if (start_pos < 0 || start_pos + len_suffix > len_token)
3659 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3662 if (token[start_pos + len_suffix] == '\0')
3665 if (token[start_pos + len_suffix] == '.')
3671 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3673 static void read_token_parameters(SetupFileHash *setup_file_hash,
3674 struct ConfigTypeInfo *suffix_list,
3675 struct FileInfo *file_list_entry)
3677 // check for config token that is the base token without any suffixes
3678 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3679 char *known_token_value = KNOWN_TOKEN_VALUE;
3682 if (filename != NULL)
3684 setString(&file_list_entry->filename, filename);
3686 // when file definition found, set all parameters to default values
3687 for (i = 0; suffix_list[i].token != NULL; i++)
3688 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3690 file_list_entry->redefined = TRUE;
3692 // mark config file token as well known from default config
3693 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3696 // check for config tokens that can be build by base token and suffixes
3697 for (i = 0; suffix_list[i].token != NULL; i++)
3699 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3700 char *value = getHashEntry(setup_file_hash, token);
3704 setString(&file_list_entry->parameter[i], value);
3706 // mark config file token as well known from default config
3707 setHashEntry(setup_file_hash, token, known_token_value);
3714 static void add_dynamic_file_list_entry(struct FileInfo **list,
3715 int *num_list_entries,
3716 SetupFileHash *extra_file_hash,
3717 struct ConfigTypeInfo *suffix_list,
3718 int num_suffix_list_entries,
3721 struct FileInfo *new_list_entry;
3722 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3724 (*num_list_entries)++;
3725 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3726 new_list_entry = &(*list)[*num_list_entries - 1];
3728 new_list_entry->token = getStringCopy(token);
3729 new_list_entry->default_filename = NULL;
3730 new_list_entry->filename = NULL;
3731 new_list_entry->parameter = checked_calloc(parameter_array_size);
3733 new_list_entry->redefined = FALSE;
3734 new_list_entry->fallback_to_default = FALSE;
3735 new_list_entry->default_is_cloned = FALSE;
3737 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3740 static void add_property_mapping(struct PropertyMapping **list,
3741 int *num_list_entries,
3742 int base_index, int ext1_index,
3743 int ext2_index, int ext3_index,
3746 struct PropertyMapping *new_list_entry;
3748 (*num_list_entries)++;
3749 *list = checked_realloc(*list,
3750 *num_list_entries * sizeof(struct PropertyMapping));
3751 new_list_entry = &(*list)[*num_list_entries - 1];
3753 new_list_entry->base_index = base_index;
3754 new_list_entry->ext1_index = ext1_index;
3755 new_list_entry->ext2_index = ext2_index;
3756 new_list_entry->ext3_index = ext3_index;
3758 new_list_entry->artwork_index = artwork_index;
3761 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3764 struct FileInfo *file_list = artwork_info->file_list;
3765 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3766 char **base_prefixes = artwork_info->base_prefixes;
3767 char **ext1_suffixes = artwork_info->ext1_suffixes;
3768 char **ext2_suffixes = artwork_info->ext2_suffixes;
3769 char **ext3_suffixes = artwork_info->ext3_suffixes;
3770 char **ignore_tokens = artwork_info->ignore_tokens;
3771 int num_file_list_entries = artwork_info->num_file_list_entries;
3772 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3773 int num_base_prefixes = artwork_info->num_base_prefixes;
3774 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3775 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3776 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3777 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3778 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3779 SetupFileHash *extra_file_hash, *empty_file_hash;
3780 char *known_token_value = KNOWN_TOKEN_VALUE;
3781 char *base_token_value = UNDEFINED_FILENAME;
3784 if (filename == NULL)
3787 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3790 // separate valid (defined) from empty (undefined) config token values
3791 valid_file_hash = newSetupFileHash();
3792 empty_file_hash = newSetupFileHash();
3793 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3795 char *value = HASH_ITERATION_VALUE(itr);
3797 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3798 HASH_ITERATION_TOKEN(itr), value);
3800 END_HASH_ITERATION(setup_file_hash, itr)
3802 // at this point, we do not need the setup file hash anymore -- free it
3803 freeSetupFileHash(setup_file_hash);
3805 // prevent changing hash while iterating over it by using a temporary copy
3806 valid_file_hash_tmp = newSetupFileHash();
3807 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3809 setHashEntry(valid_file_hash_tmp,
3810 HASH_ITERATION_TOKEN(itr),
3811 HASH_ITERATION_VALUE(itr));
3813 END_HASH_ITERATION(valid_file_hash, itr)
3815 // (iterate over same temporary hash, as modifications are independent)
3817 // map deprecated to current tokens (using prefix match and replace)
3818 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3820 char *token = HASH_ITERATION_TOKEN(itr);
3821 char *mapped_token = get_mapped_token(token);
3823 if (mapped_token != NULL)
3825 char *value = HASH_ITERATION_VALUE(itr);
3828 setHashEntry(valid_file_hash, mapped_token, value);
3830 // ignore old token (by setting it to "known" keyword)
3831 setHashEntry(valid_file_hash, token, known_token_value);
3836 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3838 // add special base tokens (using prefix match and replace)
3839 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3841 char *token = HASH_ITERATION_TOKEN(itr);
3842 char *base_token = get_special_base_token(artwork_info, token);
3844 if (base_token != NULL)
3846 // add base token only if it does not already exist
3847 if (getHashEntry(valid_file_hash, base_token) == NULL)
3848 setHashEntry(valid_file_hash, base_token, base_token_value);
3853 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3855 // free temporary hash used for iteration
3856 freeSetupFileHash(valid_file_hash_tmp);
3858 // read parameters for all known config file tokens
3859 for (i = 0; i < num_file_list_entries; i++)
3860 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3862 // set all tokens that can be ignored here to "known" keyword
3863 for (i = 0; i < num_ignore_tokens; i++)
3864 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3866 // copy all unknown config file tokens to extra config hash
3867 extra_file_hash = newSetupFileHash();
3868 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3870 char *value = HASH_ITERATION_VALUE(itr);
3872 if (!strEqual(value, known_token_value))
3873 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3875 END_HASH_ITERATION(valid_file_hash, itr)
3877 // at this point, we do not need the valid file hash anymore -- free it
3878 freeSetupFileHash(valid_file_hash);
3880 // now try to determine valid, dynamically defined config tokens
3882 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3884 struct FileInfo **dynamic_file_list =
3885 &artwork_info->dynamic_file_list;
3886 int *num_dynamic_file_list_entries =
3887 &artwork_info->num_dynamic_file_list_entries;
3888 struct PropertyMapping **property_mapping =
3889 &artwork_info->property_mapping;
3890 int *num_property_mapping_entries =
3891 &artwork_info->num_property_mapping_entries;
3892 int current_summarized_file_list_entry =
3893 artwork_info->num_file_list_entries +
3894 artwork_info->num_dynamic_file_list_entries;
3895 char *token = HASH_ITERATION_TOKEN(itr);
3896 int len_token = strlen(token);
3898 boolean base_prefix_found = FALSE;
3899 boolean parameter_suffix_found = FALSE;
3901 // skip all parameter definitions (handled by read_token_parameters())
3902 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3904 int len_suffix = strlen(suffix_list[i].token);
3906 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3907 parameter_suffix_found = TRUE;
3910 if (parameter_suffix_found)
3913 // ---------- step 0: search for matching base prefix ----------
3916 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3918 char *base_prefix = base_prefixes[i];
3919 int len_base_prefix = strlen(base_prefix);
3920 boolean ext1_suffix_found = FALSE;
3921 boolean ext2_suffix_found = FALSE;
3922 boolean ext3_suffix_found = FALSE;
3923 boolean exact_match = FALSE;
3924 int base_index = -1;
3925 int ext1_index = -1;
3926 int ext2_index = -1;
3927 int ext3_index = -1;
3929 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3931 if (!base_prefix_found)
3936 if (start_pos + len_base_prefix == len_token) // exact match
3940 add_dynamic_file_list_entry(dynamic_file_list,
3941 num_dynamic_file_list_entries,
3944 num_suffix_list_entries,
3946 add_property_mapping(property_mapping,
3947 num_property_mapping_entries,
3948 base_index, -1, -1, -1,
3949 current_summarized_file_list_entry);
3953 // ---------- step 1: search for matching first suffix ----------
3955 start_pos += len_base_prefix;
3956 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3958 char *ext1_suffix = ext1_suffixes[j];
3959 int len_ext1_suffix = strlen(ext1_suffix);
3961 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3963 if (!ext1_suffix_found)
3968 if (start_pos + len_ext1_suffix == len_token) // exact match
3972 add_dynamic_file_list_entry(dynamic_file_list,
3973 num_dynamic_file_list_entries,
3976 num_suffix_list_entries,
3978 add_property_mapping(property_mapping,
3979 num_property_mapping_entries,
3980 base_index, ext1_index, -1, -1,
3981 current_summarized_file_list_entry);
3985 start_pos += len_ext1_suffix;
3991 // ---------- step 2: search for matching second suffix ----------
3993 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3995 char *ext2_suffix = ext2_suffixes[k];
3996 int len_ext2_suffix = strlen(ext2_suffix);
3998 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
4000 if (!ext2_suffix_found)
4005 if (start_pos + len_ext2_suffix == len_token) // exact match
4009 add_dynamic_file_list_entry(dynamic_file_list,
4010 num_dynamic_file_list_entries,
4013 num_suffix_list_entries,
4015 add_property_mapping(property_mapping,
4016 num_property_mapping_entries,
4017 base_index, ext1_index, ext2_index, -1,
4018 current_summarized_file_list_entry);
4022 start_pos += len_ext2_suffix;
4028 // ---------- step 3: search for matching third suffix ----------
4030 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4032 char *ext3_suffix = ext3_suffixes[l];
4033 int len_ext3_suffix = strlen(ext3_suffix);
4035 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4037 if (!ext3_suffix_found)
4042 if (start_pos + len_ext3_suffix == len_token) // exact match
4046 add_dynamic_file_list_entry(dynamic_file_list,
4047 num_dynamic_file_list_entries,
4050 num_suffix_list_entries,
4052 add_property_mapping(property_mapping,
4053 num_property_mapping_entries,
4054 base_index, ext1_index, ext2_index, ext3_index,
4055 current_summarized_file_list_entry);
4061 END_HASH_ITERATION(extra_file_hash, itr)
4063 if (artwork_info->num_dynamic_file_list_entries > 0)
4065 artwork_info->dynamic_artwork_list =
4066 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4067 artwork_info->sizeof_artwork_list_entry);
4070 if (options.verbose && IS_PARENT_PROCESS())
4072 SetupFileList *setup_file_list, *list;
4073 boolean dynamic_tokens_found = FALSE;
4074 boolean unknown_tokens_found = FALSE;
4075 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4077 // list may be NULL for empty artwork config files
4078 setup_file_list = loadSetupFileList(filename);
4080 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4082 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4083 dynamic_tokens_found = TRUE;
4085 unknown_tokens_found = TRUE;
4087 END_HASH_ITERATION(extra_file_hash, itr)
4089 if (options.debug && dynamic_tokens_found)
4091 Debug("config", "---");
4092 Debug("config", "dynamic token(s) found in config file:");
4093 Debug("config", "- config file: '%s'", filename);
4095 for (list = setup_file_list; list != NULL; list = list->next)
4097 char *value = getHashEntry(extra_file_hash, list->token);
4099 if (value != NULL && strEqual(value, known_token_value))
4100 Debug("config", "- dynamic token: '%s'", list->token);
4103 Debug("config", "---");
4106 if (unknown_tokens_found)
4109 Warn("unknown token(s) found in config file:");
4110 Warn("- config file: '%s'", filename);
4112 for (list = setup_file_list; list != NULL; list = list->next)
4114 char *value = getHashEntry(extra_file_hash, list->token);
4116 if (value != NULL && !strEqual(value, known_token_value))
4117 Warn("- dynamic token: '%s'", list->token);
4123 if (undefined_values_found)
4126 Warn("undefined values found in config file:");
4127 Warn("- config file: '%s'", filename);
4129 for (list = setup_file_list; list != NULL; list = list->next)
4131 char *value = getHashEntry(empty_file_hash, list->token);
4134 Warn("- undefined value for token: '%s'", list->token);
4140 freeSetupFileList(setup_file_list);
4143 freeSetupFileHash(extra_file_hash);
4144 freeSetupFileHash(empty_file_hash);
4147 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4149 struct FileInfo *file_list = artwork_info->file_list;
4150 int num_file_list_entries = artwork_info->num_file_list_entries;
4151 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4152 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4155 DrawInitTextHead("Loading artwork config");
4156 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4158 // always start with reliable default values
4159 for (i = 0; i < num_file_list_entries; i++)
4161 setString(&file_list[i].filename, file_list[i].default_filename);
4163 for (j = 0; j < num_suffix_list_entries; j++)
4164 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4166 file_list[i].redefined = FALSE;
4167 file_list[i].fallback_to_default = FALSE;
4170 // free previous dynamic artwork file array
4171 if (artwork_info->dynamic_file_list != NULL)
4173 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4175 free(artwork_info->dynamic_file_list[i].token);
4176 free(artwork_info->dynamic_file_list[i].filename);
4177 free(artwork_info->dynamic_file_list[i].parameter);
4180 free(artwork_info->dynamic_file_list);
4181 artwork_info->dynamic_file_list = NULL;
4183 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4184 &artwork_info->num_dynamic_file_list_entries);
4187 // free previous property mapping
4188 if (artwork_info->property_mapping != NULL)
4190 free(artwork_info->property_mapping);
4192 artwork_info->property_mapping = NULL;
4193 artwork_info->num_property_mapping_entries = 0;
4196 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4198 // first look for special artwork configured in level series config
4199 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4201 if (fileExists(filename_base))
4202 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4205 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4207 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4208 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4211 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4212 struct ListNodeInfo **listnode)
4216 char *filename = (*listnode)->source_filename;
4218 if (--(*listnode)->num_references <= 0)
4219 deleteNodeFromList(&artwork_info->content_list, filename,
4220 artwork_info->free_artwork);
4226 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4227 struct ListNodeInfo **listnode,
4228 struct FileInfo *file_list_entry)
4238 char *basename = file_list_entry->filename;
4239 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4241 // mark all images from non-default graphics directory as "redefined"
4242 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4243 !strPrefix(filename, options.graphics_directory))
4244 file_list_entry->redefined = TRUE;
4246 if (filename == NULL)
4248 Warn("cannot find artwork file '%s'", basename);
4250 basename = file_list_entry->default_filename;
4252 // fail for cloned default artwork that has no default filename defined
4253 if (file_list_entry->default_is_cloned &&
4254 strEqual(basename, UNDEFINED_FILENAME))
4256 void (*error_func)(char *, ...) = Warn;
4258 // we can get away without sounds and music, but not without graphics
4259 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4262 error_func("token '%s' was cloned and has no default filename",
4263 file_list_entry->token);
4268 // dynamic artwork has no default filename / skip empty default artwork
4269 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4272 file_list_entry->fallback_to_default = TRUE;
4274 Warn("trying default artwork file '%s'", basename);
4276 filename = getCustomArtworkFilename(basename, artwork_info->type);
4278 if (filename == NULL)
4280 void (*error_func)(char *, ...) = Warn;
4282 // we can get away without sounds and music, but not without graphics
4283 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4286 error_func("cannot find default artwork file '%s'", basename);
4292 // check if the old and the new artwork file are the same
4293 if (*listnode && strEqual((*listnode)->source_filename, filename))
4295 // The old and new artwork are the same (have the same filename and path).
4296 // This usually means that this artwork does not exist in this artwork set
4297 // and a fallback to the existing artwork is done.
4302 // delete existing artwork file entry
4303 deleteArtworkListEntry(artwork_info, listnode);
4305 // check if the new artwork file already exists in the list of artwork
4306 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4308 *listnode = (struct ListNodeInfo *)node->content;
4309 (*listnode)->num_references++;
4314 DrawInitTextHead(init_text[artwork_info->type]);
4315 DrawInitTextItem(basename);
4317 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4319 // add new artwork file entry to the list of artwork files
4320 (*listnode)->num_references = 1;
4321 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4326 void (*error_func)(char *, ...) = Warn;
4328 // we can get away without sounds and music, but not without graphics
4329 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4332 error_func("cannot load artwork file '%s'", basename);
4338 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4339 struct ListNodeInfo **listnode,
4340 struct FileInfo *file_list_entry)
4342 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4344 deleteArtworkListEntry(artwork_info, listnode);
4349 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4352 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4354 struct FileInfo *file_list = artwork_info->file_list;
4355 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4356 int num_file_list_entries = artwork_info->num_file_list_entries;
4357 int num_dynamic_file_list_entries =
4358 artwork_info->num_dynamic_file_list_entries;
4361 print_timestamp_init("ReloadCustomArtworkList");
4363 for (i = 0; i < num_file_list_entries; i++)
4364 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4367 for (i = 0; i < num_dynamic_file_list_entries; i++)
4368 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4369 &dynamic_file_list[i]);
4371 print_timestamp_done("ReloadCustomArtworkList");
4374 dumpList(artwork_info->content_list);
4378 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4379 struct ListNodeInfo ***list,
4380 int *num_list_entries)
4387 for (i = 0; i < *num_list_entries; i++)
4388 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4392 *num_list_entries = 0;
4395 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4397 if (artwork_info == NULL)
4400 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4401 &artwork_info->num_file_list_entries);
4403 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4404 &artwork_info->num_dynamic_file_list_entries);
4408 // ----------------------------------------------------------------------------
4409 // functions only needed for non-Unix (non-command-line) systems
4410 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4411 // (now also added for Windows, to create files in user data directory)
4412 // ----------------------------------------------------------------------------
4414 char *getLogBasename(char *basename)
4416 return getStringCat2(basename, ".log");
4419 char *getLogFilename(char *basename)
4421 return getPath2(getMainUserGameDataDir(), basename);
4424 void OpenLogFile(void)
4426 InitMainUserDataDirectory();
4428 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4430 program.log_file = program.log_file_default; // reset to default
4432 Warn("cannot open file '%s' for writing: %s",
4433 program.log_filename, strerror(errno));
4436 // output should be unbuffered so it is not truncated in a crash
4437 setbuf(program.log_file, NULL);
4440 void CloseLogFile(void)
4442 if (program.log_file != program.log_file_default)
4443 fclose(program.log_file);
4446 void DumpLogFile(void)
4448 FILE *log_file = fopen(program.log_filename, MODE_READ);
4450 if (log_file == NULL)
4453 while (!feof(log_file))
4454 fputc(fgetc(log_file), stdout);
4459 void NotifyUserAboutErrorFile(void)
4461 #if defined(PLATFORM_WINDOWS)
4462 char *title_text = getStringCat2(program.program_title, " Error Message");
4463 char *error_text = getStringCat2("The program was aborted due to an error; "
4464 "for details, see the following error file:"
4466 program.log_filename);
4468 MessageBox(NULL, error_text, title_text, MB_OK);
4473 // ----------------------------------------------------------------------------
4474 // the following is only for debugging purpose and normally not used
4475 // ----------------------------------------------------------------------------
4479 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4480 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4482 #define DEBUG_NUM_TIMESTAMPS 10
4483 #define DEBUG_TIME_IN_MICROSECONDS 0
4485 #if DEBUG_TIME_IN_MICROSECONDS
4486 static double Counter_Microseconds(void)
4488 static struct timeval base_time = { 0, 0 };
4489 struct timeval current_time;
4492 gettimeofday(¤t_time, NULL);
4494 // reset base time in case of wrap-around
4495 if (current_time.tv_sec < base_time.tv_sec)
4496 base_time = current_time;
4499 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4500 ((double)(current_time.tv_usec - base_time.tv_usec));
4502 return counter; // return microseconds since last init
4506 static char *debug_print_timestamp_get_padding(int padding_size)
4508 static char *padding = NULL;
4509 int max_padding_size = 100;
4511 if (padding == NULL)
4513 padding = checked_calloc(max_padding_size + 1);
4514 memset(padding, ' ', max_padding_size);
4517 return &padding[MAX(0, max_padding_size - padding_size)];
4520 void debug_print_timestamp(int counter_nr, char *message)
4522 int indent_size = 8;
4523 int padding_size = 40;
4524 float timestamp_interval;
4527 Fail("debugging: invalid negative counter");
4528 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4529 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4531 #if DEBUG_TIME_IN_MICROSECONDS
4532 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4535 counter[counter_nr][0] = Counter_Microseconds();
4537 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4540 counter[counter_nr][0] = Counter();
4543 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4544 counter[counter_nr][1] = counter[counter_nr][0];
4547 Debug("time:init", "%s%s%s %.3f %s",
4548 debug_print_timestamp_get_padding(counter_nr * indent_size),
4550 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4551 timestamp_interval / 1000,
4556 static void debug_print_parent_only(char *format, ...)
4558 if (!IS_PARENT_PROCESS())
4565 va_start(ap, format);
4566 vprintf(format, ap);
4576 static void print_timestamp_ext(char *message, char *mode)
4578 #if DEBUG_PRINT_INIT_TIMESTAMPS
4579 static char *debug_message = NULL;
4580 static char *last_message = NULL;
4581 static int counter_nr = 0;
4582 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4584 checked_free(debug_message);
4585 debug_message = getStringCat3(mode, " ", message);
4587 if (strEqual(mode, "INIT"))
4589 debug_print_timestamp(counter_nr, NULL);
4591 if (counter_nr + 1 < max_depth)
4592 debug_print_timestamp(counter_nr, debug_message);
4596 debug_print_timestamp(counter_nr, NULL);
4598 else if (strEqual(mode, "DONE"))
4602 if (counter_nr + 1 < max_depth ||
4603 (counter_nr == 0 && max_depth == 1))
4605 last_message = message;
4607 if (counter_nr == 0 && max_depth == 1)
4609 checked_free(debug_message);
4610 debug_message = getStringCat3("TIME", " ", message);
4613 debug_print_timestamp(counter_nr, debug_message);
4616 else if (!strEqual(mode, "TIME") ||
4617 !strEqual(message, last_message))
4619 if (counter_nr < max_depth)
4620 debug_print_timestamp(counter_nr, debug_message);
4625 void print_timestamp_init(char *message)
4627 print_timestamp_ext(message, "INIT");
4630 void print_timestamp_time(char *message)
4632 print_timestamp_ext(message, "TIME");
4635 void print_timestamp_done(char *message)
4637 print_timestamp_ext(message, "DONE");