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 char *chugString(char *s)
1451 for (start = (char *)s; *start && isspace(*start); start++)
1454 memmove(s, start, strlen(start) + 1);
1459 char *chompString(char *s)
1464 int len = strlen(s);
1468 if (isspace(s[len]))
1477 char *stripString(char *s)
1479 return chugString(chompString(s));
1482 boolean strEqual(const char *s1, const char *s2)
1484 return (s1 == NULL && s2 == NULL ? TRUE :
1485 s1 == NULL && s2 != NULL ? FALSE :
1486 s1 != NULL && s2 == NULL ? FALSE :
1487 strcmp(s1, s2) == 0);
1490 boolean strEqualN(const char *s1, const char *s2, int n)
1492 return (s1 == NULL && s2 == NULL ? TRUE :
1493 s1 == NULL && s2 != NULL ? FALSE :
1494 s1 != NULL && s2 == NULL ? FALSE :
1495 strncmp(s1, s2, n) == 0);
1498 boolean strEqualCase(const char *s1, const char *s2)
1500 return (s1 == NULL && s2 == NULL ? TRUE :
1501 s1 == NULL && s2 != NULL ? FALSE :
1502 s1 != NULL && s2 == NULL ? FALSE :
1503 strcasecmp(s1, s2) == 0);
1506 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1508 return (s1 == NULL && s2 == NULL ? TRUE :
1509 s1 == NULL && s2 != NULL ? FALSE :
1510 s1 != NULL && s2 == NULL ? FALSE :
1511 strncasecmp(s1, s2, n) == 0);
1514 boolean strPrefix(const char *s, const char *prefix)
1516 return (s == NULL && prefix == NULL ? TRUE :
1517 s == NULL && prefix != NULL ? FALSE :
1518 s != NULL && prefix == NULL ? FALSE :
1519 strncmp(s, prefix, strlen(prefix)) == 0);
1522 boolean strSuffix(const char *s, const char *suffix)
1524 return (s == NULL && suffix == NULL ? TRUE :
1525 s == NULL && suffix != NULL ? FALSE :
1526 s != NULL && suffix == NULL ? FALSE :
1527 strlen(s) < strlen(suffix) ? FALSE :
1528 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1531 boolean strPrefixLower(const char *s, const char *prefix)
1533 char *s_lower = getStringToLower(s);
1534 boolean match = strPrefix(s_lower, prefix);
1541 boolean strSuffixLower(const char *s, const char *suffix)
1543 char *s_lower = getStringToLower(s);
1544 boolean match = strSuffix(s_lower, suffix);
1551 boolean isURL(const char *s)
1553 while (*s && *s >= 'a' && *s <= 'z')
1556 return strPrefix(s, "://");
1560 // ----------------------------------------------------------------------------
1561 // command line option handling functions
1562 // ----------------------------------------------------------------------------
1564 void GetOptions(int argc, char *argv[],
1565 void (*print_usage_function)(void),
1566 void (*print_version_function)(void))
1568 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1569 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1570 char **options_left = &argvplus[1];
1572 // replace original "argv" with null-terminated array of string pointers
1574 argvplus[argc] = argv[argc];
1576 // initialize global program options
1577 options.server_host = NULL;
1578 options.server_port = 0;
1580 options.base_directory = base_path;
1582 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1583 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1584 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1585 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1586 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1587 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1589 options.execute_command = NULL;
1590 options.tape_log_filename = NULL;
1591 options.special_flags = NULL;
1592 options.debug_mode = NULL;
1593 options.player_name = NULL;
1594 options.identifier = NULL;
1595 options.level_nr = NULL;
1597 options.display_nr = 0;
1599 options.mytapes = FALSE;
1600 options.serveronly = FALSE;
1601 options.network = FALSE;
1602 options.verbose = FALSE;
1603 options.debug = FALSE;
1606 options.verbose = TRUE;
1608 #if !defined(PLATFORM_UNIX)
1609 if (*options_left == NULL) // no options given -- enable verbose mode
1610 options.verbose = TRUE;
1615 #if defined(PLATFORM_ANDROID)
1616 options.debug = TRUE;
1620 while (*options_left)
1622 char option_str[MAX_OPTION_LEN];
1623 char *option = options_left[0];
1624 char *next_option = options_left[1];
1625 char *option_arg = NULL;
1626 int option_len = strlen(option);
1628 if (option_len >= MAX_OPTION_LEN)
1629 FailWithHelp("unrecognized option '%s'", option);
1631 strcpy(option_str, option); // copy argument into buffer
1632 option = option_str;
1634 if (strEqual(option, "--")) // stop scanning arguments
1637 if (strPrefix(option, "--")) // treat '--' like '-'
1640 option_arg = strchr(option, '=');
1641 if (option_arg == NULL) // no '=' in option
1642 option_arg = next_option;
1645 *option_arg++ = '\0'; // cut argument from option
1646 if (*option_arg == '\0') // no argument after '='
1647 FailWithHelp("option '%s' has invalid argument", option_str);
1650 option_len = strlen(option);
1652 if (strEqual(option, "-"))
1654 FailWithHelp("unrecognized option '%s'", option);
1656 else if (strncmp(option, "-help", option_len) == 0)
1658 print_usage_function();
1662 else if (strncmp(option, "-basepath", option_len) == 0)
1664 if (option_arg == NULL)
1665 FailWithHelp("option '%s' requires an argument", option_str);
1667 options.base_directory = base_path = getStringCopy(option_arg);
1668 if (option_arg == next_option)
1671 // adjust paths for sub-directories in base directory accordingly
1672 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1673 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1674 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1675 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1676 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1677 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1679 else if (strncmp(option, "-levels", option_len) == 0)
1681 if (option_arg == NULL)
1682 FailWithHelp("option '%s' requires an argument", option_str);
1684 options.level_directory = getStringCopy(option_arg);
1685 if (option_arg == next_option)
1688 else if (strncmp(option, "-graphics", option_len) == 0)
1690 if (option_arg == NULL)
1691 FailWithHelp("option '%s' requires an argument", option_str);
1693 options.graphics_directory = getStringCopy(option_arg);
1694 if (option_arg == next_option)
1697 else if (strncmp(option, "-sounds", option_len) == 0)
1699 if (option_arg == NULL)
1700 FailWithHelp("option '%s' requires an argument", option_str);
1702 options.sounds_directory = getStringCopy(option_arg);
1703 if (option_arg == next_option)
1706 else if (strncmp(option, "-music", option_len) == 0)
1708 if (option_arg == NULL)
1709 FailWithHelp("option '%s' requires an argument", option_str);
1711 options.music_directory = getStringCopy(option_arg);
1712 if (option_arg == next_option)
1715 else if (strncmp(option, "-mytapes", option_len) == 0)
1717 options.mytapes = TRUE;
1719 else if (strncmp(option, "-network", option_len) == 0)
1721 options.network = TRUE;
1723 else if (strncmp(option, "-serveronly", option_len) == 0)
1725 options.serveronly = TRUE;
1727 else if (strncmp(option, "-debug", option_len) == 0)
1729 options.debug = TRUE;
1731 // optionally, debug output can be limited to a specific debug mode
1732 if (option_arg != next_option)
1733 options.debug_mode = getStringCopy(option_arg);
1735 else if (strncmp(option, "-player-name", option_len) == 0)
1737 if (option_arg == NULL)
1738 FailWithHelp("option '%s' requires an argument", option_str);
1740 options.player_name = getStringCopy(option_arg);
1741 if (option_arg == next_option)
1744 else if (strncmp(option, "-identifier", option_len) == 0)
1746 if (option_arg == NULL)
1747 FailWithHelp("option '%s' requires an argument", option_str);
1749 options.identifier = getStringCopy(option_arg);
1750 if (option_arg == next_option)
1753 else if (strncmp(option, "-level-nr", option_len) == 0)
1755 if (option_arg == NULL)
1756 FailWithHelp("option '%s' requires an argument", option_str);
1758 options.level_nr = getStringCopy(option_arg);
1759 if (option_arg == next_option)
1762 else if (strncmp(option, "-verbose", option_len) == 0)
1764 options.verbose = TRUE;
1766 else if (strncmp(option, "-version", option_len) == 0 ||
1767 strncmp(option, "-V", option_len) == 0)
1769 print_version_function();
1773 else if (strPrefix(option, "-D"))
1775 options.special_flags = getStringCopy(&option[2]);
1777 else if (strncmp(option, "-execute", option_len) == 0)
1779 if (option_arg == NULL)
1780 FailWithHelp("option '%s' requires an argument", option_str);
1782 options.execute_command = getStringCopy(option_arg);
1783 if (option_arg == next_option)
1786 // when doing batch processing, always enable verbose mode (warnings)
1787 options.verbose = TRUE;
1789 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1791 if (option_arg == NULL)
1792 FailWithHelp("option '%s' requires an argument", option_str);
1794 options.tape_log_filename = getStringCopy(option_arg);
1795 if (option_arg == next_option)
1798 else if (strncmp(option, "-display", option_len) == 0)
1800 if (option_arg == NULL)
1801 FailWithHelp("option '%s' requires an argument", option_str);
1803 if (option_arg == next_option)
1806 int display_nr = atoi(option_arg);
1809 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1810 options.display_nr = display_nr;
1812 options.display_nr =
1813 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1815 if (display_nr != options.display_nr)
1816 Warn("invalid display %d -- using display %d",
1817 display_nr, options.display_nr);
1820 #if defined(PLATFORM_MAC)
1821 else if (strPrefix(option, "-psn"))
1823 // ignore process serial number when launched via GUI on Mac OS X
1826 else if (*option == '-')
1828 FailWithHelp("unrecognized option '%s'", option_str);
1830 else if (options.server_host == NULL)
1832 options.server_host = *options_left;
1834 else if (options.server_port == 0)
1836 options.server_port = atoi(*options_left);
1837 if (options.server_port < 1024)
1838 FailWithHelp("bad port number '%d'", options.server_port);
1841 FailWithHelp("too many arguments");
1848 // ----------------------------------------------------------------------------
1849 // checked memory allocation and freeing functions
1850 // ----------------------------------------------------------------------------
1852 void *checked_malloc(unsigned int size)
1859 Fail("cannot allocate %d bytes -- out of memory", size);
1864 void *checked_calloc(unsigned int size)
1868 ptr = calloc(1, size);
1871 Fail("cannot allocate %d bytes -- out of memory", size);
1876 void *checked_realloc(void *ptr, unsigned int size)
1878 ptr = realloc(ptr, size);
1881 Fail("cannot allocate %d bytes -- out of memory", size);
1886 void checked_free(void *ptr)
1888 if (ptr != NULL) // this check should be done by free() anyway
1892 void clear_mem(void *ptr, unsigned int size)
1894 #if defined(PLATFORM_WINDOWS)
1895 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1896 char *cptr = (char *)ptr;
1901 memset(ptr, 0, size);
1906 // ----------------------------------------------------------------------------
1907 // various helper functions
1908 // ----------------------------------------------------------------------------
1910 void swap_numbers(int *i1, int *i2)
1918 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1930 int get_number_of_bits(int bits)
1933 Counting bits set, Brian Kernighan's way
1935 Brian Kernighan's method goes through as many iterations as there are set
1936 bits. So if we have a 32-bit word with only the high bit set, then it will
1937 only go once through the loop.
1939 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1940 and Dennis M. Ritchie) mentions this in exercise 2-9.
1941 First published by Peter Wegner in CACM 3 (1960), 322.
1948 bits &= bits - 1; // clear the least significant bit set
1955 /* the "put" variants of the following file access functions check for the file
1956 pointer being != NULL and return the number of bytes they have or would have
1957 written; this allows for chunk writing functions to first determine the size
1958 of the (not yet written) chunk, write the correct chunk size and finally
1959 write the chunk itself */
1961 int getFile8BitInteger(File *file)
1963 return getByteFromFile(file);
1966 int putFile8BitInteger(FILE *file, int value)
1974 int getFile16BitInteger(File *file, int byte_order)
1976 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1977 return ((getByteFromFile(file) << 8) |
1978 (getByteFromFile(file) << 0));
1979 else // BYTE_ORDER_LITTLE_ENDIAN
1980 return ((getByteFromFile(file) << 0) |
1981 (getByteFromFile(file) << 8));
1984 int putFile16BitInteger(FILE *file, int value, int byte_order)
1988 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1990 fputc((value >> 8) & 0xff, file);
1991 fputc((value >> 0) & 0xff, file);
1993 else // BYTE_ORDER_LITTLE_ENDIAN
1995 fputc((value >> 0) & 0xff, file);
1996 fputc((value >> 8) & 0xff, file);
2003 int getFile32BitInteger(File *file, int byte_order)
2005 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2006 return ((getByteFromFile(file) << 24) |
2007 (getByteFromFile(file) << 16) |
2008 (getByteFromFile(file) << 8) |
2009 (getByteFromFile(file) << 0));
2010 else // BYTE_ORDER_LITTLE_ENDIAN
2011 return ((getByteFromFile(file) << 0) |
2012 (getByteFromFile(file) << 8) |
2013 (getByteFromFile(file) << 16) |
2014 (getByteFromFile(file) << 24));
2017 int putFile32BitInteger(FILE *file, int value, int byte_order)
2021 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2023 fputc((value >> 24) & 0xff, file);
2024 fputc((value >> 16) & 0xff, file);
2025 fputc((value >> 8) & 0xff, file);
2026 fputc((value >> 0) & 0xff, file);
2028 else // BYTE_ORDER_LITTLE_ENDIAN
2030 fputc((value >> 0) & 0xff, file);
2031 fputc((value >> 8) & 0xff, file);
2032 fputc((value >> 16) & 0xff, file);
2033 fputc((value >> 24) & 0xff, file);
2040 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
2043 const int chunk_name_length = 4;
2046 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
2049 if (chunk_size != NULL)
2052 *chunk_size = getFile32BitInteger(file, byte_order);
2055 return (checkEndOfFile(file) ? FALSE : TRUE);
2058 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2065 fputs(chunk_name, file);
2067 num_bytes += strlen(chunk_name);
2069 if (chunk_size >= 0)
2073 putFile32BitInteger(file, chunk_size, byte_order);
2081 int getFileVersion(File *file)
2083 int version_super = getByteFromFile(file);
2084 int version_major = getByteFromFile(file);
2085 int version_minor = getByteFromFile(file);
2086 int version_patch = getByteFromFile(file);
2088 return VERSION_IDENT(version_super, version_major, version_minor,
2092 int putFileVersion(FILE *file, int version)
2096 int version_super = VERSION_SUPER(version);
2097 int version_major = VERSION_MAJOR(version);
2098 int version_minor = VERSION_MINOR(version);
2099 int version_patch = VERSION_PATCH(version);
2101 fputc(version_super, file);
2102 fputc(version_major, file);
2103 fputc(version_minor, file);
2104 fputc(version_patch, file);
2110 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2114 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2115 buffer[i] = getByteFromFile(file);
2118 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2122 for (i = 0; i < bytes; i++)
2123 fputc(buffer[i], file);
2126 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2128 while (bytes-- && !checkEndOfFile(file))
2129 getByteFromFile(file);
2132 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2139 // ----------------------------------------------------------------------------
2140 // functions to convert between ISO-8859-1 and UTF-8
2141 // ----------------------------------------------------------------------------
2143 char *getUTF8FromLatin1(char *latin1)
2145 int max_utf8_size = 2 * strlen(latin1) + 1;
2146 char *utf8 = checked_calloc(max_utf8_size);
2147 unsigned char *src = (unsigned char *)latin1;
2148 unsigned char *dst = (unsigned char *)utf8;
2152 if (*src < 128) // pure 7-bit ASCII
2156 else if (*src >= 160) // non-ASCII characters
2158 *dst++ = 194 + (*src >= 192);
2159 *dst++ = 128 + (*src & 63);
2161 else // undefined in ISO-8859-1
2169 // only use the smallest possible string buffer size
2170 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2175 char *getLatin1FromUTF8(char *utf8)
2177 int max_latin1_size = strlen(utf8) + 1;
2178 char *latin1 = checked_calloc(max_latin1_size);
2179 unsigned char *src = (unsigned char *)utf8;
2180 unsigned char *dst = (unsigned char *)latin1;
2184 if (*src < 128) // pure 7-bit ASCII
2188 else if (src[0] == 194 &&
2189 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2194 else if (src[0] == 195 &&
2195 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2197 *dst++ = src[1] + 64;
2201 // all other UTF-8 characters are undefined in ISO-8859-1
2203 else if (src[0] >= 192 && src[0] < 224 &&
2204 src[1] >= 128 && src[1] < 192)
2209 else if (src[0] >= 224 && src[0] < 240 &&
2210 src[1] >= 128 && src[1] < 192 &&
2211 src[2] >= 128 && src[2] < 192)
2216 else if (src[0] >= 240 && src[0] < 248 &&
2217 src[1] >= 128 && src[1] < 192 &&
2218 src[2] >= 128 && src[2] < 192 &&
2219 src[3] >= 128 && src[3] < 192)
2224 else if (src[0] >= 248 && src[0] < 252 &&
2225 src[1] >= 128 && src[1] < 192 &&
2226 src[2] >= 128 && src[2] < 192 &&
2227 src[3] >= 128 && src[3] < 192 &&
2228 src[4] >= 128 && src[4] < 192)
2233 else if (src[0] >= 252 && src[0] < 254 &&
2234 src[1] >= 128 && src[1] < 192 &&
2235 src[2] >= 128 && src[2] < 192 &&
2236 src[3] >= 128 && src[3] < 192 &&
2237 src[4] >= 128 && src[4] < 192 &&
2238 src[5] >= 128 && src[5] < 192)
2250 // only use the smallest possible string buffer size
2251 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2256 int getTextEncoding(char *text)
2258 unsigned char *src = (unsigned char *)text;
2259 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2264 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2270 else if (src[0] >= 192 && src[0] < 224 &&
2271 src[1] >= 128 && src[1] < 192)
2275 else if (src[0] >= 224 && src[0] < 240 &&
2276 src[1] >= 128 && src[1] < 192 &&
2277 src[2] >= 128 && src[2] < 192)
2281 else if (src[0] >= 240 && src[0] < 248 &&
2282 src[1] >= 128 && src[1] < 192 &&
2283 src[2] >= 128 && src[2] < 192 &&
2284 src[3] >= 128 && src[3] < 192)
2288 else if (src[0] >= 248 && src[0] < 252 &&
2289 src[1] >= 128 && src[1] < 192 &&
2290 src[2] >= 128 && src[2] < 192 &&
2291 src[3] >= 128 && src[3] < 192 &&
2292 src[4] >= 128 && src[4] < 192)
2296 else if (src[0] >= 252 && src[0] < 254 &&
2297 src[1] >= 128 && src[1] < 192 &&
2298 src[2] >= 128 && src[2] < 192 &&
2299 src[3] >= 128 && src[3] < 192 &&
2300 src[4] >= 128 && src[4] < 192 &&
2301 src[5] >= 128 && src[5] < 192)
2307 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2315 // ----------------------------------------------------------------------------
2316 // functions for JSON handling
2317 // ----------------------------------------------------------------------------
2319 char *getEscapedJSON(char *s)
2321 int max_json_size = 2 * strlen(s) + 1;
2322 char *json = checked_calloc(max_json_size);
2323 unsigned char *src = (unsigned char *)s;
2324 unsigned char *dst = (unsigned char *)json;
2325 char *escaped[256] =
2338 if (escaped[*src] != NULL)
2340 char *esc = escaped[*src++];
2351 // only use the smallest possible string buffer size
2352 json = checked_realloc(json, strlen(json) + 1);
2358 // ----------------------------------------------------------------------------
2359 // functions to translate key identifiers between different format
2360 // ----------------------------------------------------------------------------
2362 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2363 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2364 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2365 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2367 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2376 // return and escape keys
2377 { KSYM_Return, "XK_Return", "return" },
2378 { KSYM_Escape, "XK_Escape", "escape" },
2380 // normal cursor keys
2381 { KSYM_Left, "XK_Left", "cursor left" },
2382 { KSYM_Right, "XK_Right", "cursor right" },
2383 { KSYM_Up, "XK_Up", "cursor up" },
2384 { KSYM_Down, "XK_Down", "cursor down" },
2386 // keypad cursor keys
2388 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2389 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2390 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2391 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2394 // other keypad keys
2395 #ifdef KSYM_KP_Enter
2396 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2397 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2398 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2399 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2400 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2401 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2405 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2406 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2407 { KSYM_Control_L, "XK_Control_L", "left control" },
2408 { KSYM_Control_R, "XK_Control_R", "right control" },
2409 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2410 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2411 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2412 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2413 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2414 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2416 // some special keys
2417 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2418 { KSYM_Delete, "XK_Delete", "delete" },
2419 { KSYM_Insert, "XK_Insert", "insert" },
2420 { KSYM_Tab, "XK_Tab", "tab" },
2421 { KSYM_Home, "XK_Home", "home" },
2422 { KSYM_End, "XK_End", "end" },
2423 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2424 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2426 { KSYM_Select, "XK_Select", "select" },
2427 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2428 { KSYM_Back, "XK_Back", "back" }, // back key
2429 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2430 #if defined(PLATFORM_ANDROID)
2431 { KSYM_Rewind, "XK_Rewind", "rewind" },
2432 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2435 // ASCII 0x20 to 0x40 keys (except numbers)
2436 { KSYM_space, "XK_space", "space" },
2437 { KSYM_exclam, "XK_exclam", "!" },
2438 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2439 { KSYM_numbersign, "XK_numbersign", "#" },
2440 { KSYM_dollar, "XK_dollar", "$" },
2441 { KSYM_percent, "XK_percent", "%" },
2442 { KSYM_ampersand, "XK_ampersand", "&" },
2443 { KSYM_apostrophe, "XK_apostrophe", "'" },
2444 { KSYM_parenleft, "XK_parenleft", "(" },
2445 { KSYM_parenright, "XK_parenright", ")" },
2446 { KSYM_asterisk, "XK_asterisk", "*" },
2447 { KSYM_plus, "XK_plus", "+" },
2448 { KSYM_comma, "XK_comma", "," },
2449 { KSYM_minus, "XK_minus", "-" },
2450 { KSYM_period, "XK_period", "." },
2451 { KSYM_slash, "XK_slash", "/" },
2452 { KSYM_colon, "XK_colon", ":" },
2453 { KSYM_semicolon, "XK_semicolon", ";" },
2454 { KSYM_less, "XK_less", "<" },
2455 { KSYM_equal, "XK_equal", "=" },
2456 { KSYM_greater, "XK_greater", ">" },
2457 { KSYM_question, "XK_question", "?" },
2458 { KSYM_at, "XK_at", "@" },
2461 { KSYM_bracketleft, "XK_bracketleft", "[" },
2462 { KSYM_backslash, "XK_backslash", "\\" },
2463 { KSYM_bracketright,"XK_bracketright", "]" },
2464 { KSYM_asciicircum, "XK_asciicircum", "^" },
2465 { KSYM_underscore, "XK_underscore", "_" },
2466 { KSYM_grave, "XK_grave", "grave" },
2467 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2468 { KSYM_braceleft, "XK_braceleft", "brace left" },
2469 { KSYM_bar, "XK_bar", "bar" },
2470 { KSYM_braceright, "XK_braceright", "brace right" },
2471 { KSYM_asciitilde, "XK_asciitilde", "~" },
2473 // special (non-ASCII) keys
2474 { KSYM_degree, "XK_degree", "degree" },
2475 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2476 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2477 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2478 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2479 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2480 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2481 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2483 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2484 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2485 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2486 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2487 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2488 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2489 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2490 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2491 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2493 // other keys (for reverse mapping only)
2494 { KSYM_space, "XK_space", " " },
2496 // keypad keys are not in numerical order in SDL2
2497 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2498 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2499 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2500 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2501 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2502 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2503 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2504 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2505 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2506 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2508 // end-of-array identifier
2514 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2516 static char name_buffer[30];
2519 if (key >= KSYM_A && key <= KSYM_Z)
2520 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2521 else if (key >= KSYM_a && key <= KSYM_z)
2522 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2523 else if (key >= KSYM_0 && key <= KSYM_9)
2524 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2525 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2526 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2527 else if (key == KSYM_UNDEFINED)
2528 strcpy(name_buffer, "(undefined)");
2535 if (key == translate_key[i].key)
2537 strcpy(name_buffer, translate_key[i].name);
2541 while (translate_key[++i].name);
2543 if (!translate_key[i].name)
2544 strcpy(name_buffer, "(unknown)");
2547 *name = name_buffer;
2549 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2551 static char name_buffer[30];
2554 if (key >= KSYM_A && key <= KSYM_Z)
2555 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2556 else if (key >= KSYM_a && key <= KSYM_z)
2557 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2558 else if (key >= KSYM_0 && key <= KSYM_9)
2559 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2560 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2561 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2562 else if (key == KSYM_UNDEFINED)
2563 strcpy(name_buffer, "[undefined]");
2570 if (key == translate_key[i].key)
2572 strcpy(name_buffer, translate_key[i].x11name);
2576 while (translate_key[++i].x11name);
2578 if (!translate_key[i].x11name)
2579 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2582 *x11name = name_buffer;
2584 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2586 Key key = KSYM_UNDEFINED;
2587 char *name_ptr = *name;
2589 if (strlen(*name) == 1)
2591 char c = name_ptr[0];
2593 if (c >= 'A' && c <= 'Z')
2594 key = KSYM_A + (Key)(c - 'A');
2595 else if (c >= 'a' && c <= 'z')
2596 key = KSYM_a + (Key)(c - 'a');
2597 else if (c >= '0' && c <= '9')
2598 key = KSYM_0 + (Key)(c - '0');
2601 if (key == KSYM_UNDEFINED)
2607 if (strEqual(translate_key[i].name, *name))
2609 key = translate_key[i].key;
2613 while (translate_key[++i].x11name);
2616 if (key == KSYM_UNDEFINED)
2617 Warn("getKeyFromKeyName(): not completely implemented");
2621 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2623 Key key = KSYM_UNDEFINED;
2624 char *name_ptr = *x11name;
2626 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2628 char c = name_ptr[3];
2630 if (c >= 'A' && c <= 'Z')
2631 key = KSYM_A + (Key)(c - 'A');
2632 else if (c >= 'a' && c <= 'z')
2633 key = KSYM_a + (Key)(c - 'a');
2634 else if (c >= '0' && c <= '9')
2635 key = KSYM_0 + (Key)(c - '0');
2637 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2639 char c1 = name_ptr[4];
2640 char c2 = name_ptr[5];
2643 if ((c1 >= '0' && c1 <= '9') &&
2644 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2645 d = atoi(&name_ptr[4]);
2647 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2648 key = KSYM_F1 + (Key)(d - 1);
2650 else if (strPrefix(name_ptr, "XK_"))
2656 if (strEqual(name_ptr, translate_key[i].x11name))
2658 key = translate_key[i].key;
2662 while (translate_key[++i].x11name);
2664 else if (strPrefix(name_ptr, "0x"))
2666 unsigned int value = 0;
2672 char c = *name_ptr++;
2675 if (c >= '0' && c <= '9')
2677 else if (c >= 'a' && c <= 'f')
2678 d = (int)(c - 'a' + 10);
2679 else if (c >= 'A' && c <= 'F')
2680 d = (int)(c - 'A' + 10);
2688 value = value * 16 + d;
2699 char *getKeyNameFromKey(Key key)
2703 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2707 char *getX11KeyNameFromKey(Key key)
2711 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2715 Key getKeyFromKeyName(char *name)
2719 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2723 Key getKeyFromX11KeyName(char *x11name)
2727 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2731 char getCharFromKey(Key key)
2737 } translate_key_char[] =
2739 // special (non-ASCII) keys (ISO-8859-1)
2740 { KSYM_degree, CHAR_BYTE_DEGREE },
2741 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2742 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2743 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2744 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2745 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2746 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2747 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2749 // end-of-array identifier
2753 char *keyname = getKeyNameFromKey(key);
2756 if (strlen(keyname) == 1)
2758 else if (strEqual(keyname, "space"))
2766 if (key == translate_key_char[i].key)
2768 c = translate_key_char[i].key_char;
2773 while (translate_key_char[++i].key_char);
2779 char getValidConfigValueChar(char c)
2781 if (c == '#' || // used to mark comments
2782 c == '\\') // used to mark continued lines
2789 // ----------------------------------------------------------------------------
2790 // functions to translate string identifiers to integer or boolean value
2791 // ----------------------------------------------------------------------------
2793 int get_integer_from_string(char *s)
2795 // check for the most common case first
2796 if (s[0] >= '0' && s[0] <= '9')
2799 char *s_lower = getStringToLower(s);
2802 if (strEqual(s_lower, "false") ||
2803 strEqual(s_lower, "no") ||
2804 strEqual(s_lower, "off"))
2806 else if (strEqual(s_lower, "true") ||
2807 strEqual(s_lower, "yes") ||
2808 strEqual(s_lower, "on"))
2818 boolean get_boolean_from_string(char *s)
2820 char *s_lower = getStringToLower(s);
2821 boolean result = FALSE;
2823 if (strEqual(s_lower, "true") ||
2824 strEqual(s_lower, "yes") ||
2825 strEqual(s_lower, "on") ||
2826 get_integer_from_string(s) == 1)
2834 int get_switch3_from_string(char *s)
2836 char *s_lower = getStringToLower(s);
2839 if (strEqual(s_lower, "true") ||
2840 strEqual(s_lower, "yes") ||
2841 strEqual(s_lower, "on") ||
2842 get_integer_from_string(s) == 1)
2844 else if (strEqual(s_lower, "auto"))
2852 int get_player_nr_from_string(char *s)
2854 static char *player_text[] =
2864 char *s_lower = getStringToLower(s);
2868 for (i = 0; player_text[i] != NULL; i++)
2869 if (strEqual(s_lower, player_text[i]))
2878 // ----------------------------------------------------------------------------
2879 // functions for generic lists
2880 // ----------------------------------------------------------------------------
2882 ListNode *newListNode(void)
2884 return checked_calloc(sizeof(ListNode));
2887 void addNodeToList(ListNode **node_first, char *key, void *content)
2889 ListNode *node_new = newListNode();
2891 node_new->key = getStringCopy(key);
2892 node_new->content = content;
2893 node_new->next = *node_first;
2896 (*node_first)->prev = node_new;
2898 *node_first = node_new;
2901 void deleteNodeFromList(ListNode **node_first, char *key,
2902 void (*destructor_function)(void *))
2904 if (node_first == NULL || *node_first == NULL)
2907 if (strEqual((*node_first)->key, key))
2909 // after first recursion, (*node_first)->prev->next == *node_first,
2910 // so *node_first would be overwritten with (*node_first)->next
2911 // => use a copy of *node_first (and later of (*node_first)->next)
2912 ListNode *node = *node_first;
2913 ListNode *node_next = node->next;
2915 checked_free(node->key);
2917 if (destructor_function)
2918 destructor_function(node->content);
2921 node->prev->next = node->next;
2924 node->next->prev = node->prev;
2928 // after removing node, set list pointer to next valid list node
2929 // (this is important if the first node of the list was deleted)
2930 *node_first = node_next;
2934 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2938 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2940 if (node_first == NULL)
2943 if (strEqual(node_first->key, key))
2946 return getNodeFromKey(node_first->next, key);
2949 int getNumNodes(ListNode *node_first)
2951 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2955 static void dumpList(ListNode *node_first)
2957 ListNode *node = node_first;
2961 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2962 ((struct ListNodeInfo *)node->content)->num_references);
2966 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2971 // ----------------------------------------------------------------------------
2972 // functions for file handling
2973 // ----------------------------------------------------------------------------
2975 #define MAX_BUFFER_SIZE 4096
2977 File *openFile(char *filename, char *mode)
2979 File *file = checked_calloc(sizeof(File));
2981 file->file = fopen(filename, mode);
2983 if (file->file != NULL)
2985 file->filename = getStringCopy(filename);
2990 #if defined(PLATFORM_ANDROID)
2991 file->asset_file = SDL_RWFromFile(filename, mode);
2993 if (file->asset_file != NULL)
2995 file->file_is_asset = TRUE;
2996 file->filename = getStringCopy(filename);
3007 int closeFile(File *file)
3014 #if defined(PLATFORM_ANDROID)
3015 if (file->asset_file)
3016 result = SDL_RWclose(file->asset_file);
3020 result = fclose(file->file);
3022 checked_free(file->filename);
3028 int checkEndOfFile(File *file)
3030 #if defined(PLATFORM_ANDROID)
3031 if (file->file_is_asset)
3032 return file->end_of_file;
3035 return feof(file->file);
3038 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
3040 #if defined(PLATFORM_ANDROID)
3041 if (file->file_is_asset)
3043 if (file->end_of_file)
3046 size_t num_items_read =
3047 SDL_RWread(file->asset_file, buffer, item_size, num_items);
3049 if (num_items_read < num_items)
3050 file->end_of_file = TRUE;
3052 return num_items_read;
3056 return fread(buffer, item_size, num_items, file->file);
3059 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3061 return fwrite(buffer, item_size, num_items, file->file);
3064 int seekFile(File *file, long offset, int whence)
3066 #if defined(PLATFORM_ANDROID)
3067 if (file->file_is_asset)
3069 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3070 whence == SEEK_CUR ? RW_SEEK_CUR :
3071 whence == SEEK_END ? RW_SEEK_END : 0);
3073 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3077 return fseek(file->file, offset, whence);
3080 int getByteFromFile(File *file)
3082 #if defined(PLATFORM_ANDROID)
3083 if (file->file_is_asset)
3085 if (file->end_of_file)
3089 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3091 if (num_bytes_read < 1)
3092 file->end_of_file = TRUE;
3094 return (file->end_of_file ? EOF : (int)c);
3098 return fgetc(file->file);
3101 char *getStringFromFile(File *file, char *line, int size)
3103 #if defined(PLATFORM_ANDROID)
3104 if (file->file_is_asset)
3106 if (file->end_of_file)
3109 char *line_ptr = line;
3110 int num_bytes_read = 0;
3112 while (num_bytes_read < size - 1 &&
3113 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3114 *line_ptr++ != '\n')
3119 if (strlen(line) == 0)
3121 file->end_of_file = TRUE;
3130 return fgets(line, size, file->file);
3133 int copyFile(char *filename_from, char *filename_to)
3135 File *file_from, *file_to;
3137 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3142 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3144 closeFile(file_from);
3149 while (!checkEndOfFile(file_from))
3151 byte buffer[MAX_BUFFER_SIZE];
3152 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3154 writeFile(file_to, buffer, 1, bytes_read);
3157 closeFile(file_from);
3163 boolean touchFile(char *filename)
3167 if (!(file = fopen(filename, MODE_WRITE)))
3169 Warn("cannot touch file '%s'", filename);
3180 // ----------------------------------------------------------------------------
3181 // functions for directory handling
3182 // ----------------------------------------------------------------------------
3184 Directory *openDirectory(char *dir_name)
3186 Directory *dir = checked_calloc(sizeof(Directory));
3188 dir->dir = opendir(dir_name);
3190 if (dir->dir != NULL)
3192 dir->filename = getStringCopy(dir_name);
3197 #if defined(PLATFORM_ANDROID)
3198 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3200 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3202 checked_free(asset_toc_filename);
3204 if (dir->asset_toc_file != NULL)
3206 dir->directory_is_asset = TRUE;
3207 dir->filename = getStringCopy(dir_name);
3218 int closeDirectory(Directory *dir)
3225 #if defined(PLATFORM_ANDROID)
3226 if (dir->asset_toc_file)
3227 result = SDL_RWclose(dir->asset_toc_file);
3231 result = closedir(dir->dir);
3234 freeDirectoryEntry(dir->dir_entry);
3236 checked_free(dir->filename);
3242 DirectoryEntry *readDirectory(Directory *dir)
3245 freeDirectoryEntry(dir->dir_entry);
3247 dir->dir_entry = NULL;
3249 #if defined(PLATFORM_ANDROID)
3250 if (dir->directory_is_asset)
3252 char line[MAX_LINE_LEN];
3253 char *line_ptr = line;
3254 int num_bytes_read = 0;
3256 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3257 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3266 if (strlen(line) == 0)
3269 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3271 dir->dir_entry->is_directory = FALSE;
3272 if (line[strlen(line) - 1] == '/')
3274 dir->dir_entry->is_directory = TRUE;
3276 line[strlen(line) - 1] = '\0';
3279 dir->dir_entry->basename = getStringCopy(line);
3280 dir->dir_entry->filename = getPath2(dir->filename, line);
3282 return dir->dir_entry;
3286 struct dirent *dir_entry = readdir(dir->dir);
3288 if (dir_entry == NULL)
3291 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3293 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3294 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3296 struct stat file_status;
3298 dir->dir_entry->is_directory =
3299 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3300 S_ISDIR(file_status.st_mode));
3302 return dir->dir_entry;
3305 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3307 if (dir_entry == NULL)
3310 checked_free(dir_entry->basename);
3311 checked_free(dir_entry->filename);
3312 checked_free(dir_entry);
3316 // ----------------------------------------------------------------------------
3317 // functions for checking files and filenames
3318 // ----------------------------------------------------------------------------
3320 boolean directoryExists(const char *dir_name)
3322 if (dir_name == NULL)
3325 struct stat file_status;
3326 boolean success = (stat(dir_name, &file_status) == 0 &&
3327 S_ISDIR(file_status.st_mode));
3329 #if defined(PLATFORM_ANDROID)
3332 // this might be an asset directory; check by trying to open toc file
3333 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3334 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3336 checked_free(asset_toc_filename);
3338 success = (file != NULL);
3348 boolean fileExists(const char *filename)
3350 if (filename == NULL)
3353 boolean success = (access(filename, F_OK) == 0);
3355 #if defined(PLATFORM_ANDROID)
3358 // this might be an asset file; check by trying to open it
3359 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3361 success = (file != NULL);
3372 static boolean fileHasPrefix(const char *basename, const char *prefix)
3374 static char *basename_lower = NULL;
3375 int basename_length, prefix_length;
3377 checked_free(basename_lower);
3379 if (basename == NULL || prefix == NULL)
3382 basename_lower = getStringToLower(basename);
3383 basename_length = strlen(basename_lower);
3384 prefix_length = strlen(prefix);
3386 if (basename_length > prefix_length + 1 &&
3387 basename_lower[prefix_length] == '.' &&
3388 strncmp(basename_lower, prefix, prefix_length) == 0)
3395 static boolean fileHasSuffix(const char *basename, const char *suffix)
3397 static char *basename_lower = NULL;
3398 int basename_length, suffix_length;
3400 checked_free(basename_lower);
3402 if (basename == NULL || suffix == NULL)
3405 basename_lower = getStringToLower(basename);
3406 basename_length = strlen(basename_lower);
3407 suffix_length = strlen(suffix);
3409 if (basename_length > suffix_length + 1 &&
3410 basename_lower[basename_length - suffix_length - 1] == '.' &&
3411 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3417 static boolean FileCouldBeArtwork(char *filename)
3419 char *basename = getBaseNamePtr(filename);
3421 return (!strEqual(basename, ".") &&
3422 !strEqual(basename, "..") &&
3423 !fileHasSuffix(basename, "txt") &&
3424 !fileHasSuffix(basename, "conf") &&
3425 !directoryExists(filename));
3428 boolean FileIsGraphic(char *filename)
3430 return FileCouldBeArtwork(filename);
3433 boolean FileIsSound(char *filename)
3435 return FileCouldBeArtwork(filename);
3438 boolean FileIsMusic(char *filename)
3440 return FileCouldBeArtwork(filename);
3443 boolean FileIsArtworkType(char *filename, int type)
3445 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3446 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3447 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3453 // ----------------------------------------------------------------------------
3454 // functions for loading artwork configuration information
3455 // ----------------------------------------------------------------------------
3457 char *get_mapped_token(char *token)
3459 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3460 static char *map_token_prefix[][2] =
3462 { "char_procent", "char_percent" },
3463 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3464 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3465 { "bd_butterfly_left", "bd_butterfly.left" },
3466 { "bd_butterfly_right", "bd_butterfly.right" },
3467 { "bd_butterfly_up", "bd_butterfly.up" },
3468 { "bd_butterfly_down", "bd_butterfly.down" },
3469 { "bd_firefly_left", "bd_firefly.left" },
3470 { "bd_firefly_right", "bd_firefly.right" },
3471 { "bd_firefly_up", "bd_firefly.up" },
3472 { "bd_firefly_down", "bd_firefly.down" },
3478 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3480 int len_token_prefix = strlen(map_token_prefix[i][0]);
3482 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3483 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3486 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3487 char *gfx_substring = ".gfx";
3488 char *gfx_prefix = "gfx.";
3489 if (strstr(token, gfx_substring) != NULL)
3491 char *token_prefix = getStringCopy(token);
3492 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3493 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3496 // cut off token string at ".gfx" substring position
3497 *token_gfx_pos = '\0';
3499 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3500 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3504 return mapped_token;
3510 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3513 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3514 static struct ConfigTypeInfo prefix_list[] =
3516 { "global.anim_1" },
3517 { "global.anim_2" },
3518 { "global.anim_3" },
3519 { "global.anim_4" },
3520 { "global.anim_5" },
3521 { "global.anim_6" },
3522 { "global.anim_7" },
3523 { "global.anim_8" },
3524 { "global.anim_9" },
3525 { "global.anim_10" },
3526 { "global.anim_11" },
3527 { "global.anim_12" },
3528 { "global.anim_13" },
3529 { "global.anim_14" },
3530 { "global.anim_15" },
3531 { "global.anim_16" },
3532 { "global.anim_17" },
3533 { "global.anim_18" },
3534 { "global.anim_19" },
3535 { "global.anim_20" },
3536 { "global.anim_21" },
3537 { "global.anim_22" },
3538 { "global.anim_23" },
3539 { "global.anim_24" },
3540 { "global.anim_25" },
3541 { "global.anim_26" },
3542 { "global.anim_27" },
3543 { "global.anim_28" },
3544 { "global.anim_29" },
3545 { "global.anim_30" },
3546 { "global.anim_31" },
3547 { "global.anim_32" },
3551 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3552 boolean prefix_found = FALSE;
3556 // search for prefix to check if base token has to be created
3557 for (i = 0; prefix_list[i].token != NULL; i++)
3558 if (strPrefix(token, prefix_list[i].token))
3559 prefix_found = TRUE;
3564 // search for suffix (parameter) to determine base token length
3565 for (i = 0; suffix_list[i].token != NULL; i++)
3566 if (strSuffix(token, suffix_list[i].token))
3567 len_suffix = strlen(suffix_list[i].token);
3569 return getStringCopyN(token, strlen(token) - len_suffix);
3572 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3573 struct ListNodeInfo ***, int *);
3575 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3576 struct ConfigTypeInfo *suffix_list,
3577 char **ignore_tokens,
3578 int num_file_list_entries)
3580 SetupFileHash *ignore_tokens_hash;
3581 struct FileInfo *file_list;
3582 int num_file_list_entries_found = 0;
3583 int num_suffix_list_entries = 0;
3587 // create hash from list of tokens to be ignored (for quick access)
3588 ignore_tokens_hash = newSetupFileHash();
3589 for (i = 0; ignore_tokens[i] != NULL; i++)
3590 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3592 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3594 for (i = 0; suffix_list[i].token != NULL; i++)
3595 num_suffix_list_entries++;
3597 // always start with reliable default values
3598 for (i = 0; i < num_file_list_entries; i++)
3600 file_list[i].token = NULL;
3602 file_list[i].default_filename = NULL;
3603 file_list[i].filename = NULL;
3605 if (num_suffix_list_entries > 0)
3607 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3609 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3610 file_list[i].parameter = checked_calloc(parameter_array_size);
3612 for (j = 0; j < num_suffix_list_entries; j++)
3614 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3615 setString(&file_list[i].parameter[j], suffix_list[j].value);
3618 file_list[i].redefined = FALSE;
3619 file_list[i].fallback_to_default = FALSE;
3620 file_list[i].default_is_cloned = FALSE;
3626 for (i = 0; config_list[i].token != NULL; i++)
3628 int len_config_token = strlen(config_list[i].token);
3629 boolean is_file_entry = TRUE;
3631 for (j = 0; suffix_list[j].token != NULL; j++)
3633 int len_suffix = strlen(suffix_list[j].token);
3635 if (len_suffix < len_config_token &&
3636 strEqual(&config_list[i].token[len_config_token - len_suffix],
3637 suffix_list[j].token))
3639 setString(&file_list[list_pos].default_parameter[j],
3640 config_list[i].value);
3642 is_file_entry = FALSE;
3648 // the following tokens are no file definitions, but other config tokens
3649 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3650 is_file_entry = FALSE;
3657 if (list_pos >= num_file_list_entries)
3660 file_list[list_pos].token = config_list[i].token;
3661 file_list[list_pos].default_filename = config_list[i].value;
3664 if (strSuffix(config_list[i].token, ".clone_from"))
3665 file_list[list_pos].default_is_cloned = TRUE;
3668 num_file_list_entries_found = list_pos + 1;
3669 if (num_file_list_entries_found != num_file_list_entries)
3672 Error("inconsistant config list information:");
3673 Error("- should be: %d (according to 'src/conf_xxx.h')",
3674 num_file_list_entries);
3675 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3676 num_file_list_entries_found);
3681 freeSetupFileHash(ignore_tokens_hash);
3686 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3688 int len_token = strlen(token);
3689 int len_suffix = strlen(suffix);
3691 if (start_pos < 0) // compare suffix from end of string
3692 start_pos += len_token;
3694 if (start_pos < 0 || start_pos + len_suffix > len_token)
3697 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3700 if (token[start_pos + len_suffix] == '\0')
3703 if (token[start_pos + len_suffix] == '.')
3709 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3711 static void read_token_parameters(SetupFileHash *setup_file_hash,
3712 struct ConfigTypeInfo *suffix_list,
3713 struct FileInfo *file_list_entry)
3715 // check for config token that is the base token without any suffixes
3716 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3717 char *known_token_value = KNOWN_TOKEN_VALUE;
3720 if (filename != NULL)
3722 setString(&file_list_entry->filename, filename);
3724 // when file definition found, set all parameters to default values
3725 for (i = 0; suffix_list[i].token != NULL; i++)
3726 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3728 file_list_entry->redefined = TRUE;
3730 // mark config file token as well known from default config
3731 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3734 // check for config tokens that can be build by base token and suffixes
3735 for (i = 0; suffix_list[i].token != NULL; i++)
3737 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3738 char *value = getHashEntry(setup_file_hash, token);
3742 setString(&file_list_entry->parameter[i], value);
3744 // mark config file token as well known from default config
3745 setHashEntry(setup_file_hash, token, known_token_value);
3752 static void add_dynamic_file_list_entry(struct FileInfo **list,
3753 int *num_list_entries,
3754 SetupFileHash *extra_file_hash,
3755 struct ConfigTypeInfo *suffix_list,
3756 int num_suffix_list_entries,
3759 struct FileInfo *new_list_entry;
3760 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3762 (*num_list_entries)++;
3763 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3764 new_list_entry = &(*list)[*num_list_entries - 1];
3766 new_list_entry->token = getStringCopy(token);
3767 new_list_entry->default_filename = NULL;
3768 new_list_entry->filename = NULL;
3769 new_list_entry->parameter = checked_calloc(parameter_array_size);
3771 new_list_entry->redefined = FALSE;
3772 new_list_entry->fallback_to_default = FALSE;
3773 new_list_entry->default_is_cloned = FALSE;
3775 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3778 static void add_property_mapping(struct PropertyMapping **list,
3779 int *num_list_entries,
3780 int base_index, int ext1_index,
3781 int ext2_index, int ext3_index,
3784 struct PropertyMapping *new_list_entry;
3786 (*num_list_entries)++;
3787 *list = checked_realloc(*list,
3788 *num_list_entries * sizeof(struct PropertyMapping));
3789 new_list_entry = &(*list)[*num_list_entries - 1];
3791 new_list_entry->base_index = base_index;
3792 new_list_entry->ext1_index = ext1_index;
3793 new_list_entry->ext2_index = ext2_index;
3794 new_list_entry->ext3_index = ext3_index;
3796 new_list_entry->artwork_index = artwork_index;
3799 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3802 struct FileInfo *file_list = artwork_info->file_list;
3803 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3804 char **base_prefixes = artwork_info->base_prefixes;
3805 char **ext1_suffixes = artwork_info->ext1_suffixes;
3806 char **ext2_suffixes = artwork_info->ext2_suffixes;
3807 char **ext3_suffixes = artwork_info->ext3_suffixes;
3808 char **ignore_tokens = artwork_info->ignore_tokens;
3809 int num_file_list_entries = artwork_info->num_file_list_entries;
3810 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3811 int num_base_prefixes = artwork_info->num_base_prefixes;
3812 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3813 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3814 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3815 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3816 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3817 SetupFileHash *extra_file_hash, *empty_file_hash;
3818 char *known_token_value = KNOWN_TOKEN_VALUE;
3819 char *base_token_value = UNDEFINED_FILENAME;
3822 if (filename == NULL)
3825 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3828 // separate valid (defined) from empty (undefined) config token values
3829 valid_file_hash = newSetupFileHash();
3830 empty_file_hash = newSetupFileHash();
3831 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3833 char *value = HASH_ITERATION_VALUE(itr);
3835 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3836 HASH_ITERATION_TOKEN(itr), value);
3838 END_HASH_ITERATION(setup_file_hash, itr)
3840 // at this point, we do not need the setup file hash anymore -- free it
3841 freeSetupFileHash(setup_file_hash);
3843 // prevent changing hash while iterating over it by using a temporary copy
3844 valid_file_hash_tmp = newSetupFileHash();
3845 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3847 setHashEntry(valid_file_hash_tmp,
3848 HASH_ITERATION_TOKEN(itr),
3849 HASH_ITERATION_VALUE(itr));
3851 END_HASH_ITERATION(valid_file_hash, itr)
3853 // (iterate over same temporary hash, as modifications are independent)
3855 // map deprecated to current tokens (using prefix match and replace)
3856 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3858 char *token = HASH_ITERATION_TOKEN(itr);
3859 char *mapped_token = get_mapped_token(token);
3861 if (mapped_token != NULL)
3863 char *value = HASH_ITERATION_VALUE(itr);
3866 setHashEntry(valid_file_hash, mapped_token, value);
3868 // ignore old token (by setting it to "known" keyword)
3869 setHashEntry(valid_file_hash, token, known_token_value);
3874 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3876 // add special base tokens (using prefix match and replace)
3877 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3879 char *token = HASH_ITERATION_TOKEN(itr);
3880 char *base_token = get_special_base_token(artwork_info, token);
3882 if (base_token != NULL)
3884 // add base token only if it does not already exist
3885 if (getHashEntry(valid_file_hash, base_token) == NULL)
3886 setHashEntry(valid_file_hash, base_token, base_token_value);
3891 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3893 // free temporary hash used for iteration
3894 freeSetupFileHash(valid_file_hash_tmp);
3896 // read parameters for all known config file tokens
3897 for (i = 0; i < num_file_list_entries; i++)
3898 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3900 // set all tokens that can be ignored here to "known" keyword
3901 for (i = 0; i < num_ignore_tokens; i++)
3902 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3904 // copy all unknown config file tokens to extra config hash
3905 extra_file_hash = newSetupFileHash();
3906 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3908 char *value = HASH_ITERATION_VALUE(itr);
3910 if (!strEqual(value, known_token_value))
3911 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3913 END_HASH_ITERATION(valid_file_hash, itr)
3915 // at this point, we do not need the valid file hash anymore -- free it
3916 freeSetupFileHash(valid_file_hash);
3918 // now try to determine valid, dynamically defined config tokens
3920 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3922 struct FileInfo **dynamic_file_list =
3923 &artwork_info->dynamic_file_list;
3924 int *num_dynamic_file_list_entries =
3925 &artwork_info->num_dynamic_file_list_entries;
3926 struct PropertyMapping **property_mapping =
3927 &artwork_info->property_mapping;
3928 int *num_property_mapping_entries =
3929 &artwork_info->num_property_mapping_entries;
3930 int current_summarized_file_list_entry =
3931 artwork_info->num_file_list_entries +
3932 artwork_info->num_dynamic_file_list_entries;
3933 char *token = HASH_ITERATION_TOKEN(itr);
3934 int len_token = strlen(token);
3936 boolean base_prefix_found = FALSE;
3937 boolean parameter_suffix_found = FALSE;
3939 // skip all parameter definitions (handled by read_token_parameters())
3940 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3942 int len_suffix = strlen(suffix_list[i].token);
3944 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3945 parameter_suffix_found = TRUE;
3948 if (parameter_suffix_found)
3951 // ---------- step 0: search for matching base prefix ----------
3954 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3956 char *base_prefix = base_prefixes[i];
3957 int len_base_prefix = strlen(base_prefix);
3958 boolean ext1_suffix_found = FALSE;
3959 boolean ext2_suffix_found = FALSE;
3960 boolean ext3_suffix_found = FALSE;
3961 boolean exact_match = FALSE;
3962 int base_index = -1;
3963 int ext1_index = -1;
3964 int ext2_index = -1;
3965 int ext3_index = -1;
3967 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3969 if (!base_prefix_found)
3974 if (start_pos + len_base_prefix == len_token) // exact match
3978 add_dynamic_file_list_entry(dynamic_file_list,
3979 num_dynamic_file_list_entries,
3982 num_suffix_list_entries,
3984 add_property_mapping(property_mapping,
3985 num_property_mapping_entries,
3986 base_index, -1, -1, -1,
3987 current_summarized_file_list_entry);
3991 // ---------- step 1: search for matching first suffix ----------
3993 start_pos += len_base_prefix;
3994 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3996 char *ext1_suffix = ext1_suffixes[j];
3997 int len_ext1_suffix = strlen(ext1_suffix);
3999 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
4001 if (!ext1_suffix_found)
4006 if (start_pos + len_ext1_suffix == len_token) // exact match
4010 add_dynamic_file_list_entry(dynamic_file_list,
4011 num_dynamic_file_list_entries,
4014 num_suffix_list_entries,
4016 add_property_mapping(property_mapping,
4017 num_property_mapping_entries,
4018 base_index, ext1_index, -1, -1,
4019 current_summarized_file_list_entry);
4023 start_pos += len_ext1_suffix;
4029 // ---------- step 2: search for matching second suffix ----------
4031 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
4033 char *ext2_suffix = ext2_suffixes[k];
4034 int len_ext2_suffix = strlen(ext2_suffix);
4036 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
4038 if (!ext2_suffix_found)
4043 if (start_pos + len_ext2_suffix == len_token) // exact match
4047 add_dynamic_file_list_entry(dynamic_file_list,
4048 num_dynamic_file_list_entries,
4051 num_suffix_list_entries,
4053 add_property_mapping(property_mapping,
4054 num_property_mapping_entries,
4055 base_index, ext1_index, ext2_index, -1,
4056 current_summarized_file_list_entry);
4060 start_pos += len_ext2_suffix;
4066 // ---------- step 3: search for matching third suffix ----------
4068 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4070 char *ext3_suffix = ext3_suffixes[l];
4071 int len_ext3_suffix = strlen(ext3_suffix);
4073 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4075 if (!ext3_suffix_found)
4080 if (start_pos + len_ext3_suffix == len_token) // exact match
4084 add_dynamic_file_list_entry(dynamic_file_list,
4085 num_dynamic_file_list_entries,
4088 num_suffix_list_entries,
4090 add_property_mapping(property_mapping,
4091 num_property_mapping_entries,
4092 base_index, ext1_index, ext2_index, ext3_index,
4093 current_summarized_file_list_entry);
4099 END_HASH_ITERATION(extra_file_hash, itr)
4101 if (artwork_info->num_dynamic_file_list_entries > 0)
4103 artwork_info->dynamic_artwork_list =
4104 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4105 artwork_info->sizeof_artwork_list_entry);
4108 if (options.verbose && IS_PARENT_PROCESS())
4110 SetupFileList *setup_file_list, *list;
4111 boolean dynamic_tokens_found = FALSE;
4112 boolean unknown_tokens_found = FALSE;
4113 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4115 // list may be NULL for empty artwork config files
4116 setup_file_list = loadSetupFileList(filename);
4118 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4120 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4121 dynamic_tokens_found = TRUE;
4123 unknown_tokens_found = TRUE;
4125 END_HASH_ITERATION(extra_file_hash, itr)
4127 if (options.debug && dynamic_tokens_found)
4129 Debug("config", "---");
4130 Debug("config", "dynamic token(s) found in config file:");
4131 Debug("config", "- config file: '%s'", filename);
4133 for (list = setup_file_list; list != NULL; list = list->next)
4135 char *value = getHashEntry(extra_file_hash, list->token);
4137 if (value != NULL && strEqual(value, known_token_value))
4138 Debug("config", "- dynamic token: '%s'", list->token);
4141 Debug("config", "---");
4144 if (unknown_tokens_found)
4147 Warn("unknown token(s) found in config file:");
4148 Warn("- config file: '%s'", filename);
4150 for (list = setup_file_list; list != NULL; list = list->next)
4152 char *value = getHashEntry(extra_file_hash, list->token);
4154 if (value != NULL && !strEqual(value, known_token_value))
4155 Warn("- dynamic token: '%s'", list->token);
4161 if (undefined_values_found)
4164 Warn("undefined values found in config file:");
4165 Warn("- config file: '%s'", filename);
4167 for (list = setup_file_list; list != NULL; list = list->next)
4169 char *value = getHashEntry(empty_file_hash, list->token);
4172 Warn("- undefined value for token: '%s'", list->token);
4178 freeSetupFileList(setup_file_list);
4181 freeSetupFileHash(extra_file_hash);
4182 freeSetupFileHash(empty_file_hash);
4185 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4187 struct FileInfo *file_list = artwork_info->file_list;
4188 int num_file_list_entries = artwork_info->num_file_list_entries;
4189 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4190 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4193 DrawInitTextHead("Loading artwork config");
4194 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4196 // always start with reliable default values
4197 for (i = 0; i < num_file_list_entries; i++)
4199 setString(&file_list[i].filename, file_list[i].default_filename);
4201 for (j = 0; j < num_suffix_list_entries; j++)
4202 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4204 file_list[i].redefined = FALSE;
4205 file_list[i].fallback_to_default = FALSE;
4208 // free previous dynamic artwork file array
4209 if (artwork_info->dynamic_file_list != NULL)
4211 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4213 free(artwork_info->dynamic_file_list[i].token);
4214 free(artwork_info->dynamic_file_list[i].filename);
4215 free(artwork_info->dynamic_file_list[i].parameter);
4218 free(artwork_info->dynamic_file_list);
4219 artwork_info->dynamic_file_list = NULL;
4221 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4222 &artwork_info->num_dynamic_file_list_entries);
4225 // free previous property mapping
4226 if (artwork_info->property_mapping != NULL)
4228 free(artwork_info->property_mapping);
4230 artwork_info->property_mapping = NULL;
4231 artwork_info->num_property_mapping_entries = 0;
4234 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4236 // first look for special artwork configured in level series config
4237 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4239 if (fileExists(filename_base))
4240 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4243 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4245 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4246 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4249 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4250 struct ListNodeInfo **listnode)
4254 char *filename = (*listnode)->source_filename;
4256 if (--(*listnode)->num_references <= 0)
4257 deleteNodeFromList(&artwork_info->content_list, filename,
4258 artwork_info->free_artwork);
4264 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4265 struct ListNodeInfo **listnode,
4266 struct FileInfo *file_list_entry)
4276 char *basename = file_list_entry->filename;
4277 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4279 // mark all images from non-default graphics directory as "redefined"
4280 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4281 !strPrefix(filename, options.graphics_directory))
4282 file_list_entry->redefined = TRUE;
4284 if (filename == NULL)
4286 Warn("cannot find artwork file '%s'", basename);
4288 basename = file_list_entry->default_filename;
4290 // fail for cloned default artwork that has no default filename defined
4291 if (file_list_entry->default_is_cloned &&
4292 strEqual(basename, UNDEFINED_FILENAME))
4294 void (*error_func)(char *, ...) = Warn;
4296 // we can get away without sounds and music, but not without graphics
4297 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4300 error_func("token '%s' was cloned and has no default filename",
4301 file_list_entry->token);
4306 // dynamic artwork has no default filename / skip empty default artwork
4307 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4310 file_list_entry->fallback_to_default = TRUE;
4312 Warn("trying default artwork file '%s'", basename);
4314 filename = getCustomArtworkFilename(basename, artwork_info->type);
4316 if (filename == NULL)
4318 void (*error_func)(char *, ...) = Warn;
4320 // we can get away without sounds and music, but not without graphics
4321 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4324 error_func("cannot find default artwork file '%s'", basename);
4330 // check if the old and the new artwork file are the same
4331 if (*listnode && strEqual((*listnode)->source_filename, filename))
4333 // The old and new artwork are the same (have the same filename and path).
4334 // This usually means that this artwork does not exist in this artwork set
4335 // and a fallback to the existing artwork is done.
4340 // delete existing artwork file entry
4341 deleteArtworkListEntry(artwork_info, listnode);
4343 // check if the new artwork file already exists in the list of artwork
4344 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4346 *listnode = (struct ListNodeInfo *)node->content;
4347 (*listnode)->num_references++;
4352 DrawInitTextHead(init_text[artwork_info->type]);
4353 DrawInitTextItem(basename);
4355 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4357 // add new artwork file entry to the list of artwork files
4358 (*listnode)->num_references = 1;
4359 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4364 void (*error_func)(char *, ...) = Warn;
4366 // we can get away without sounds and music, but not without graphics
4367 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4370 error_func("cannot load artwork file '%s'", basename);
4376 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4377 struct ListNodeInfo **listnode,
4378 struct FileInfo *file_list_entry)
4380 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4382 deleteArtworkListEntry(artwork_info, listnode);
4387 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4390 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4392 struct FileInfo *file_list = artwork_info->file_list;
4393 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4394 int num_file_list_entries = artwork_info->num_file_list_entries;
4395 int num_dynamic_file_list_entries =
4396 artwork_info->num_dynamic_file_list_entries;
4399 print_timestamp_init("ReloadCustomArtworkList");
4401 for (i = 0; i < num_file_list_entries; i++)
4402 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4405 for (i = 0; i < num_dynamic_file_list_entries; i++)
4406 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4407 &dynamic_file_list[i]);
4409 print_timestamp_done("ReloadCustomArtworkList");
4412 dumpList(artwork_info->content_list);
4416 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4417 struct ListNodeInfo ***list,
4418 int *num_list_entries)
4425 for (i = 0; i < *num_list_entries; i++)
4426 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4430 *num_list_entries = 0;
4433 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4435 if (artwork_info == NULL)
4438 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4439 &artwork_info->num_file_list_entries);
4441 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4442 &artwork_info->num_dynamic_file_list_entries);
4446 // ----------------------------------------------------------------------------
4447 // functions only needed for non-Unix (non-command-line) systems
4448 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4449 // (now also added for Windows, to create files in user data directory)
4450 // ----------------------------------------------------------------------------
4452 char *getLogBasename(char *basename)
4454 return getStringCat2(basename, ".log");
4457 char *getLogFilename(char *basename)
4459 return getPath2(getMainUserGameDataDir(), basename);
4462 void OpenLogFile(void)
4464 InitMainUserDataDirectory();
4466 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4468 program.log_file = program.log_file_default; // reset to default
4470 Warn("cannot open file '%s' for writing: %s",
4471 program.log_filename, strerror(errno));
4474 // output should be unbuffered so it is not truncated in a crash
4475 setbuf(program.log_file, NULL);
4478 void CloseLogFile(void)
4480 if (program.log_file != program.log_file_default)
4481 fclose(program.log_file);
4484 void DumpLogFile(void)
4486 FILE *log_file = fopen(program.log_filename, MODE_READ);
4488 if (log_file == NULL)
4491 while (!feof(log_file))
4492 fputc(fgetc(log_file), stdout);
4497 void NotifyUserAboutErrorFile(void)
4499 #if defined(PLATFORM_WINDOWS)
4500 char *title_text = getStringCat2(program.program_title, " Error Message");
4501 char *error_text = getStringCat2("The program was aborted due to an error; "
4502 "for details, see the following error file:"
4504 program.log_filename);
4506 MessageBox(NULL, error_text, title_text, MB_OK);
4511 // ----------------------------------------------------------------------------
4512 // the following is only for debugging purpose and normally not used
4513 // ----------------------------------------------------------------------------
4517 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4518 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4520 #define DEBUG_NUM_TIMESTAMPS 10
4521 #define DEBUG_TIME_IN_MICROSECONDS 0
4523 #if DEBUG_TIME_IN_MICROSECONDS
4524 static double Counter_Microseconds(void)
4526 static struct timeval base_time = { 0, 0 };
4527 struct timeval current_time;
4530 gettimeofday(¤t_time, NULL);
4532 // reset base time in case of wrap-around
4533 if (current_time.tv_sec < base_time.tv_sec)
4534 base_time = current_time;
4537 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4538 ((double)(current_time.tv_usec - base_time.tv_usec));
4540 return counter; // return microseconds since last init
4544 static char *debug_print_timestamp_get_padding(int padding_size)
4546 static char *padding = NULL;
4547 int max_padding_size = 100;
4549 if (padding == NULL)
4551 padding = checked_calloc(max_padding_size + 1);
4552 memset(padding, ' ', max_padding_size);
4555 return &padding[MAX(0, max_padding_size - padding_size)];
4558 void debug_print_timestamp(int counter_nr, char *message)
4560 int indent_size = 8;
4561 int padding_size = 40;
4562 float timestamp_interval;
4565 Fail("debugging: invalid negative counter");
4566 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4567 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4569 #if DEBUG_TIME_IN_MICROSECONDS
4570 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4573 counter[counter_nr][0] = Counter_Microseconds();
4575 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4578 counter[counter_nr][0] = Counter();
4581 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4582 counter[counter_nr][1] = counter[counter_nr][0];
4585 Debug("time:init", "%s%s%s %.3f %s",
4586 debug_print_timestamp_get_padding(counter_nr * indent_size),
4588 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4589 timestamp_interval / 1000,
4594 static void debug_print_parent_only(char *format, ...)
4596 if (!IS_PARENT_PROCESS())
4603 va_start(ap, format);
4604 vprintf(format, ap);
4614 static void print_timestamp_ext(char *message, char *mode)
4616 #if DEBUG_PRINT_INIT_TIMESTAMPS
4617 static char *debug_message = NULL;
4618 static char *last_message = NULL;
4619 static int counter_nr = 0;
4620 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4622 checked_free(debug_message);
4623 debug_message = getStringCat3(mode, " ", message);
4625 if (strEqual(mode, "INIT"))
4627 debug_print_timestamp(counter_nr, NULL);
4629 if (counter_nr + 1 < max_depth)
4630 debug_print_timestamp(counter_nr, debug_message);
4634 debug_print_timestamp(counter_nr, NULL);
4636 else if (strEqual(mode, "DONE"))
4640 if (counter_nr + 1 < max_depth ||
4641 (counter_nr == 0 && max_depth == 1))
4643 last_message = message;
4645 if (counter_nr == 0 && max_depth == 1)
4647 checked_free(debug_message);
4648 debug_message = getStringCat3("TIME", " ", message);
4651 debug_print_timestamp(counter_nr, debug_message);
4654 else if (!strEqual(mode, "TIME") ||
4655 !strEqual(message, last_message))
4657 if (counter_nr < max_depth)
4658 debug_print_timestamp(counter_nr, debug_message);
4663 void print_timestamp_init(char *message)
4665 print_timestamp_ext(message, "INIT");
4668 void print_timestamp_time(char *message)
4670 print_timestamp_ext(message, "TIME");
4673 void print_timestamp_done(char *message)
4675 print_timestamp_ext(message, "DONE");