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 string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToUpper(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = toupper(*s++);
1235 char *getStringToLower(const char *s)
1237 char *s_copy = checked_malloc(strlen(s) + 1);
1238 char *s_ptr = s_copy;
1241 *s_ptr++ = tolower(*s++);
1247 void setString(char **old_value, const char *new_value)
1249 checked_free(*old_value);
1251 *old_value = getStringCopy(new_value);
1254 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1256 const char *s_ptr, *s_last = s;
1257 byte separator_table[256] = { FALSE };
1259 char **tokens = NULL;
1264 if (separators == NULL)
1268 max_tokens = INT_MAX;
1270 // if string is empty, return empty array
1273 tokens = checked_malloc(sizeof(char *));
1279 // initialize separator table for all characters in separators string
1280 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1281 separator_table[*(byte *)s_ptr] = TRUE;
1283 // count number of tokens in string
1284 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1285 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1288 // allocate array for determined number of tokens
1289 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1291 // copy all but last separated sub-strings to array
1292 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1294 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1296 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1301 // copy last separated sub-string to array
1302 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1305 tokens[num_tokens] = NULL;
1310 int getStringArrayLength(char **s_array)
1312 int num_strings = 0;
1314 if (s_array == NULL)
1317 while (s_array[num_strings] != NULL)
1323 void freeStringArray(char **s_array)
1327 if (s_array == NULL)
1330 for (i = 0; s_array[i] != NULL; i++)
1331 checked_free(s_array[i]);
1333 checked_free(s_array);
1336 char *getUnescapedString(const char *s)
1338 const char *s_ptr = s;
1339 const char *octal_ptr;
1341 char *s_unescaped_ptr;
1346 s_unescaped = checked_malloc(strlen(s) + 1);
1347 s_unescaped_ptr = s_unescaped;
1349 while (*s_ptr != '\0')
1358 Warn("getUnescapedString: trailing \\");
1369 *s_unescaped_ptr = 0;
1372 while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7')
1374 *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0');
1383 *s_unescaped_ptr++ = '\b';
1387 *s_unescaped_ptr++ = '\f';
1391 *s_unescaped_ptr++ = '\n';
1395 *s_unescaped_ptr++ = '\r';
1399 *s_unescaped_ptr++ = '\t';
1403 *s_unescaped_ptr++ = '\v';
1407 /* also handles \" and \\ */
1408 *s_unescaped_ptr++ = *s_ptr;
1414 *s_unescaped_ptr++ = *s_ptr;
1421 *s_unescaped_ptr = '\0';
1426 char *chugString(char *s)
1433 for (start = (char *)s; *start && isspace(*start); start++)
1436 memmove(s, start, strlen(start) + 1);
1441 char *chompString(char *s)
1446 int len = strlen(s);
1450 if (isspace(s[len]))
1459 char *stripString(char *s)
1461 return chugString(chompString(s));
1464 boolean strEqual(const char *s1, const char *s2)
1466 return (s1 == NULL && s2 == NULL ? TRUE :
1467 s1 == NULL && s2 != NULL ? FALSE :
1468 s1 != NULL && s2 == NULL ? FALSE :
1469 strcmp(s1, s2) == 0);
1472 boolean strEqualN(const char *s1, const char *s2, int n)
1474 return (s1 == NULL && s2 == NULL ? TRUE :
1475 s1 == NULL && s2 != NULL ? FALSE :
1476 s1 != NULL && s2 == NULL ? FALSE :
1477 strncmp(s1, s2, n) == 0);
1480 boolean strEqualCase(const char *s1, const char *s2)
1482 return (s1 == NULL && s2 == NULL ? TRUE :
1483 s1 == NULL && s2 != NULL ? FALSE :
1484 s1 != NULL && s2 == NULL ? FALSE :
1485 strcasecmp(s1, s2) == 0);
1488 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1490 return (s1 == NULL && s2 == NULL ? TRUE :
1491 s1 == NULL && s2 != NULL ? FALSE :
1492 s1 != NULL && s2 == NULL ? FALSE :
1493 strncasecmp(s1, s2, n) == 0);
1496 boolean strPrefix(const char *s, const char *prefix)
1498 return (s == NULL && prefix == NULL ? TRUE :
1499 s == NULL && prefix != NULL ? FALSE :
1500 s != NULL && prefix == NULL ? FALSE :
1501 strncmp(s, prefix, strlen(prefix)) == 0);
1504 boolean strSuffix(const char *s, const char *suffix)
1506 return (s == NULL && suffix == NULL ? TRUE :
1507 s == NULL && suffix != NULL ? FALSE :
1508 s != NULL && suffix == NULL ? FALSE :
1509 strlen(s) < strlen(suffix) ? FALSE :
1510 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1513 boolean strPrefixLower(const char *s, const char *prefix)
1515 char *s_lower = getStringToLower(s);
1516 boolean match = strPrefix(s_lower, prefix);
1523 boolean strSuffixLower(const char *s, const char *suffix)
1525 char *s_lower = getStringToLower(s);
1526 boolean match = strSuffix(s_lower, suffix);
1533 boolean isURL(const char *s)
1535 while (*s && *s >= 'a' && *s <= 'z')
1538 return strPrefix(s, "://");
1542 // ----------------------------------------------------------------------------
1543 // command line option handling functions
1544 // ----------------------------------------------------------------------------
1546 void GetOptions(int argc, char *argv[],
1547 void (*print_usage_function)(void),
1548 void (*print_version_function)(void))
1550 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1551 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1552 char **options_left = &argvplus[1];
1554 // replace original "argv" with null-terminated array of string pointers
1556 argvplus[argc] = argv[argc];
1558 // initialize global program options
1559 options.server_host = NULL;
1560 options.server_port = 0;
1562 options.base_directory = base_path;
1564 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1565 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1566 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1567 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1568 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1569 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1571 options.execute_command = NULL;
1572 options.tape_log_filename = NULL;
1573 options.special_flags = NULL;
1574 options.debug_mode = NULL;
1575 options.player_name = NULL;
1576 options.identifier = NULL;
1577 options.level_nr = NULL;
1579 options.display_nr = 0;
1581 options.mytapes = FALSE;
1582 options.serveronly = FALSE;
1583 options.network = FALSE;
1584 options.verbose = FALSE;
1585 options.debug = FALSE;
1588 options.verbose = TRUE;
1590 #if !defined(PLATFORM_UNIX)
1591 if (*options_left == NULL) // no options given -- enable verbose mode
1592 options.verbose = TRUE;
1597 #if defined(PLATFORM_ANDROID)
1598 options.debug = TRUE;
1602 while (*options_left)
1604 char option_str[MAX_OPTION_LEN];
1605 char *option = options_left[0];
1606 char *next_option = options_left[1];
1607 char *option_arg = NULL;
1608 int option_len = strlen(option);
1610 if (option_len >= MAX_OPTION_LEN)
1611 FailWithHelp("unrecognized option '%s'", option);
1613 strcpy(option_str, option); // copy argument into buffer
1614 option = option_str;
1616 if (strEqual(option, "--")) // stop scanning arguments
1619 if (strPrefix(option, "--")) // treat '--' like '-'
1622 option_arg = strchr(option, '=');
1623 if (option_arg == NULL) // no '=' in option
1624 option_arg = next_option;
1627 *option_arg++ = '\0'; // cut argument from option
1628 if (*option_arg == '\0') // no argument after '='
1629 FailWithHelp("option '%s' has invalid argument", option_str);
1632 option_len = strlen(option);
1634 if (strEqual(option, "-"))
1636 FailWithHelp("unrecognized option '%s'", option);
1638 else if (strncmp(option, "-help", option_len) == 0)
1640 print_usage_function();
1644 else if (strncmp(option, "-basepath", option_len) == 0)
1646 if (option_arg == NULL)
1647 FailWithHelp("option '%s' requires an argument", option_str);
1649 options.base_directory = base_path = getStringCopy(option_arg);
1650 if (option_arg == next_option)
1653 // adjust paths for sub-directories in base directory accordingly
1654 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1655 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1656 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1657 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1658 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1659 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1661 else if (strncmp(option, "-levels", option_len) == 0)
1663 if (option_arg == NULL)
1664 FailWithHelp("option '%s' requires an argument", option_str);
1666 options.level_directory = getStringCopy(option_arg);
1667 if (option_arg == next_option)
1670 else if (strncmp(option, "-graphics", option_len) == 0)
1672 if (option_arg == NULL)
1673 FailWithHelp("option '%s' requires an argument", option_str);
1675 options.graphics_directory = getStringCopy(option_arg);
1676 if (option_arg == next_option)
1679 else if (strncmp(option, "-sounds", option_len) == 0)
1681 if (option_arg == NULL)
1682 FailWithHelp("option '%s' requires an argument", option_str);
1684 options.sounds_directory = getStringCopy(option_arg);
1685 if (option_arg == next_option)
1688 else if (strncmp(option, "-music", option_len) == 0)
1690 if (option_arg == NULL)
1691 FailWithHelp("option '%s' requires an argument", option_str);
1693 options.music_directory = getStringCopy(option_arg);
1694 if (option_arg == next_option)
1697 else if (strncmp(option, "-mytapes", option_len) == 0)
1699 options.mytapes = TRUE;
1701 else if (strncmp(option, "-network", option_len) == 0)
1703 options.network = TRUE;
1705 else if (strncmp(option, "-serveronly", option_len) == 0)
1707 options.serveronly = TRUE;
1709 else if (strncmp(option, "-debug", option_len) == 0)
1711 options.debug = TRUE;
1713 // optionally, debug output can be limited to a specific debug mode
1714 if (option_arg != next_option)
1715 options.debug_mode = getStringCopy(option_arg);
1717 else if (strncmp(option, "-player-name", option_len) == 0)
1719 if (option_arg == NULL)
1720 FailWithHelp("option '%s' requires an argument", option_str);
1722 options.player_name = getStringCopy(option_arg);
1723 if (option_arg == next_option)
1726 else if (strncmp(option, "-identifier", option_len) == 0)
1728 if (option_arg == NULL)
1729 FailWithHelp("option '%s' requires an argument", option_str);
1731 options.identifier = getStringCopy(option_arg);
1732 if (option_arg == next_option)
1735 else if (strncmp(option, "-level-nr", option_len) == 0)
1737 if (option_arg == NULL)
1738 FailWithHelp("option '%s' requires an argument", option_str);
1740 options.level_nr = getStringCopy(option_arg);
1741 if (option_arg == next_option)
1744 else if (strncmp(option, "-verbose", option_len) == 0)
1746 options.verbose = TRUE;
1748 else if (strncmp(option, "-version", option_len) == 0 ||
1749 strncmp(option, "-V", option_len) == 0)
1751 print_version_function();
1755 else if (strPrefix(option, "-D"))
1757 options.special_flags = getStringCopy(&option[2]);
1759 else if (strncmp(option, "-execute", option_len) == 0)
1761 if (option_arg == NULL)
1762 FailWithHelp("option '%s' requires an argument", option_str);
1764 options.execute_command = getStringCopy(option_arg);
1765 if (option_arg == next_option)
1768 // when doing batch processing, always enable verbose mode (warnings)
1769 options.verbose = TRUE;
1771 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1773 if (option_arg == NULL)
1774 FailWithHelp("option '%s' requires an argument", option_str);
1776 options.tape_log_filename = getStringCopy(option_arg);
1777 if (option_arg == next_option)
1780 else if (strncmp(option, "-display", option_len) == 0)
1782 if (option_arg == NULL)
1783 FailWithHelp("option '%s' requires an argument", option_str);
1785 if (option_arg == next_option)
1788 int display_nr = atoi(option_arg);
1791 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1792 options.display_nr = display_nr;
1794 options.display_nr =
1795 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1797 if (display_nr != options.display_nr)
1798 Warn("invalid display %d -- using display %d",
1799 display_nr, options.display_nr);
1802 #if defined(PLATFORM_MAC)
1803 else if (strPrefix(option, "-psn"))
1805 // ignore process serial number when launched via GUI on Mac OS X
1808 else if (*option == '-')
1810 FailWithHelp("unrecognized option '%s'", option_str);
1812 else if (options.server_host == NULL)
1814 options.server_host = *options_left;
1816 else if (options.server_port == 0)
1818 options.server_port = atoi(*options_left);
1819 if (options.server_port < 1024)
1820 FailWithHelp("bad port number '%d'", options.server_port);
1823 FailWithHelp("too many arguments");
1830 // ----------------------------------------------------------------------------
1831 // checked memory allocation and freeing functions
1832 // ----------------------------------------------------------------------------
1834 void *checked_malloc(unsigned int size)
1841 Fail("cannot allocate %d bytes -- out of memory", size);
1846 void *checked_calloc(unsigned int size)
1850 ptr = calloc(1, size);
1853 Fail("cannot allocate %d bytes -- out of memory", size);
1858 void *checked_realloc(void *ptr, unsigned int size)
1860 ptr = realloc(ptr, size);
1863 Fail("cannot allocate %d bytes -- out of memory", size);
1868 void checked_free(void *ptr)
1870 if (ptr != NULL) // this check should be done by free() anyway
1874 void clear_mem(void *ptr, unsigned int size)
1876 #if defined(PLATFORM_WINDOWS)
1877 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1878 char *cptr = (char *)ptr;
1883 memset(ptr, 0, size);
1887 void *get_memcpy(const void *m, size_t size)
1894 m_copy = checked_malloc(size);
1895 memcpy(m_copy, m, size);
1901 // ----------------------------------------------------------------------------
1902 // various helper functions
1903 // ----------------------------------------------------------------------------
1905 void swap_numbers(int *i1, int *i2)
1913 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1925 int get_number_of_bits(int bits)
1928 Counting bits set, Brian Kernighan's way
1930 Brian Kernighan's method goes through as many iterations as there are set
1931 bits. So if we have a 32-bit word with only the high bit set, then it will
1932 only go once through the loop.
1934 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1935 and Dennis M. Ritchie) mentions this in exercise 2-9.
1936 First published by Peter Wegner in CACM 3 (1960), 322.
1943 bits &= bits - 1; // clear the least significant bit set
1950 /* the "put" variants of the following file access functions check for the file
1951 pointer being != NULL and return the number of bytes they have or would have
1952 written; this allows for chunk writing functions to first determine the size
1953 of the (not yet written) chunk, write the correct chunk size and finally
1954 write the chunk itself */
1956 int getFile8BitInteger(File *file)
1958 return getByteFromFile(file);
1961 int putFile8BitInteger(FILE *file, int value)
1969 int getFile16BitInteger(File *file, int byte_order)
1971 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1972 return ((getByteFromFile(file) << 8) |
1973 (getByteFromFile(file) << 0));
1974 else // BYTE_ORDER_LITTLE_ENDIAN
1975 return ((getByteFromFile(file) << 0) |
1976 (getByteFromFile(file) << 8));
1979 int putFile16BitInteger(FILE *file, int value, int byte_order)
1983 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1985 fputc((value >> 8) & 0xff, file);
1986 fputc((value >> 0) & 0xff, file);
1988 else // BYTE_ORDER_LITTLE_ENDIAN
1990 fputc((value >> 0) & 0xff, file);
1991 fputc((value >> 8) & 0xff, file);
1998 int getFile32BitInteger(File *file, int byte_order)
2000 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2001 return ((getByteFromFile(file) << 24) |
2002 (getByteFromFile(file) << 16) |
2003 (getByteFromFile(file) << 8) |
2004 (getByteFromFile(file) << 0));
2005 else // BYTE_ORDER_LITTLE_ENDIAN
2006 return ((getByteFromFile(file) << 0) |
2007 (getByteFromFile(file) << 8) |
2008 (getByteFromFile(file) << 16) |
2009 (getByteFromFile(file) << 24));
2012 int putFile32BitInteger(FILE *file, int value, int byte_order)
2016 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2018 fputc((value >> 24) & 0xff, file);
2019 fputc((value >> 16) & 0xff, file);
2020 fputc((value >> 8) & 0xff, file);
2021 fputc((value >> 0) & 0xff, file);
2023 else // BYTE_ORDER_LITTLE_ENDIAN
2025 fputc((value >> 0) & 0xff, file);
2026 fputc((value >> 8) & 0xff, file);
2027 fputc((value >> 16) & 0xff, file);
2028 fputc((value >> 24) & 0xff, file);
2035 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
2038 const int chunk_name_length = 4;
2041 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
2044 if (chunk_size != NULL)
2047 *chunk_size = getFile32BitInteger(file, byte_order);
2050 return (checkEndOfFile(file) ? FALSE : TRUE);
2053 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2060 fputs(chunk_name, file);
2062 num_bytes += strlen(chunk_name);
2064 if (chunk_size >= 0)
2068 putFile32BitInteger(file, chunk_size, byte_order);
2076 int getFileVersion(File *file)
2078 int version_super = getByteFromFile(file);
2079 int version_major = getByteFromFile(file);
2080 int version_minor = getByteFromFile(file);
2081 int version_patch = getByteFromFile(file);
2083 return VERSION_IDENT(version_super, version_major, version_minor,
2087 int putFileVersion(FILE *file, int version)
2091 int version_super = VERSION_SUPER(version);
2092 int version_major = VERSION_MAJOR(version);
2093 int version_minor = VERSION_MINOR(version);
2094 int version_patch = VERSION_PATCH(version);
2096 fputc(version_super, file);
2097 fputc(version_major, file);
2098 fputc(version_minor, file);
2099 fputc(version_patch, file);
2105 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2109 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2110 buffer[i] = getByteFromFile(file);
2113 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2117 for (i = 0; i < bytes; i++)
2118 fputc(buffer[i], file);
2121 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2123 while (bytes-- && !checkEndOfFile(file))
2124 getByteFromFile(file);
2127 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2134 // ----------------------------------------------------------------------------
2135 // functions to convert between ISO-8859-1 and UTF-8
2136 // ----------------------------------------------------------------------------
2138 char *getUTF8FromLatin1(char *latin1)
2140 int max_utf8_size = 2 * strlen(latin1) + 1;
2141 char *utf8 = checked_calloc(max_utf8_size);
2142 unsigned char *src = (unsigned char *)latin1;
2143 unsigned char *dst = (unsigned char *)utf8;
2147 if (*src < 128) // pure 7-bit ASCII
2151 else if (*src >= 160) // non-ASCII characters
2153 *dst++ = 194 + (*src >= 192);
2154 *dst++ = 128 + (*src & 63);
2156 else // undefined in ISO-8859-1
2164 // only use the smallest possible string buffer size
2165 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2170 char *getLatin1FromUTF8(char *utf8)
2172 int max_latin1_size = strlen(utf8) + 1;
2173 char *latin1 = checked_calloc(max_latin1_size);
2174 unsigned char *src = (unsigned char *)utf8;
2175 unsigned char *dst = (unsigned char *)latin1;
2179 if (*src < 128) // pure 7-bit ASCII
2183 else if (src[0] == 194 &&
2184 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2189 else if (src[0] == 195 &&
2190 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2192 *dst++ = src[1] + 64;
2196 // all other UTF-8 characters are undefined in ISO-8859-1
2198 else if (src[0] >= 192 && src[0] < 224 &&
2199 src[1] >= 128 && src[1] < 192)
2204 else if (src[0] >= 224 && src[0] < 240 &&
2205 src[1] >= 128 && src[1] < 192 &&
2206 src[2] >= 128 && src[2] < 192)
2211 else if (src[0] >= 240 && src[0] < 248 &&
2212 src[1] >= 128 && src[1] < 192 &&
2213 src[2] >= 128 && src[2] < 192 &&
2214 src[3] >= 128 && src[3] < 192)
2219 else if (src[0] >= 248 && src[0] < 252 &&
2220 src[1] >= 128 && src[1] < 192 &&
2221 src[2] >= 128 && src[2] < 192 &&
2222 src[3] >= 128 && src[3] < 192 &&
2223 src[4] >= 128 && src[4] < 192)
2228 else if (src[0] >= 252 && src[0] < 254 &&
2229 src[1] >= 128 && src[1] < 192 &&
2230 src[2] >= 128 && src[2] < 192 &&
2231 src[3] >= 128 && src[3] < 192 &&
2232 src[4] >= 128 && src[4] < 192 &&
2233 src[5] >= 128 && src[5] < 192)
2245 // only use the smallest possible string buffer size
2246 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2251 int getTextEncoding(char *text)
2253 unsigned char *src = (unsigned char *)text;
2254 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2259 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2265 else if (src[0] >= 192 && src[0] < 224 &&
2266 src[1] >= 128 && src[1] < 192)
2270 else if (src[0] >= 224 && src[0] < 240 &&
2271 src[1] >= 128 && src[1] < 192 &&
2272 src[2] >= 128 && src[2] < 192)
2276 else if (src[0] >= 240 && src[0] < 248 &&
2277 src[1] >= 128 && src[1] < 192 &&
2278 src[2] >= 128 && src[2] < 192 &&
2279 src[3] >= 128 && src[3] < 192)
2283 else if (src[0] >= 248 && src[0] < 252 &&
2284 src[1] >= 128 && src[1] < 192 &&
2285 src[2] >= 128 && src[2] < 192 &&
2286 src[3] >= 128 && src[3] < 192 &&
2287 src[4] >= 128 && src[4] < 192)
2291 else if (src[0] >= 252 && src[0] < 254 &&
2292 src[1] >= 128 && src[1] < 192 &&
2293 src[2] >= 128 && src[2] < 192 &&
2294 src[3] >= 128 && src[3] < 192 &&
2295 src[4] >= 128 && src[4] < 192 &&
2296 src[5] >= 128 && src[5] < 192)
2302 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2310 // ----------------------------------------------------------------------------
2311 // functions for JSON handling
2312 // ----------------------------------------------------------------------------
2314 char *getEscapedJSON(char *s)
2316 int max_json_size = 2 * strlen(s) + 1;
2317 char *json = checked_calloc(max_json_size);
2318 unsigned char *src = (unsigned char *)s;
2319 unsigned char *dst = (unsigned char *)json;
2320 char *escaped[256] =
2333 if (escaped[*src] != NULL)
2335 char *esc = escaped[*src++];
2346 // only use the smallest possible string buffer size
2347 json = checked_realloc(json, strlen(json) + 1);
2353 // ----------------------------------------------------------------------------
2354 // functions to translate key identifiers between different format
2355 // ----------------------------------------------------------------------------
2357 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2358 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2359 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2360 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2362 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2371 // return and escape keys
2372 { KSYM_Return, "XK_Return", "return" },
2373 { KSYM_Escape, "XK_Escape", "escape" },
2375 // normal cursor keys
2376 { KSYM_Left, "XK_Left", "cursor left" },
2377 { KSYM_Right, "XK_Right", "cursor right" },
2378 { KSYM_Up, "XK_Up", "cursor up" },
2379 { KSYM_Down, "XK_Down", "cursor down" },
2381 // keypad cursor keys
2383 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2384 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2385 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2386 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2389 // other keypad keys
2390 #ifdef KSYM_KP_Enter
2391 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2392 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2393 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2394 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2395 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2396 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2400 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2401 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2402 { KSYM_Control_L, "XK_Control_L", "left control" },
2403 { KSYM_Control_R, "XK_Control_R", "right control" },
2404 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2405 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2406 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2407 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2408 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2409 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2411 // some special keys
2412 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2413 { KSYM_Delete, "XK_Delete", "delete" },
2414 { KSYM_Insert, "XK_Insert", "insert" },
2415 { KSYM_Tab, "XK_Tab", "tab" },
2416 { KSYM_Home, "XK_Home", "home" },
2417 { KSYM_End, "XK_End", "end" },
2418 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2419 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2421 { KSYM_Select, "XK_Select", "select" },
2422 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2423 { KSYM_Back, "XK_Back", "back" }, // back key
2424 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2425 #if defined(PLATFORM_ANDROID)
2426 { KSYM_Rewind, "XK_Rewind", "rewind" },
2427 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2430 // ASCII 0x20 to 0x40 keys (except numbers)
2431 { KSYM_space, "XK_space", "space" },
2432 { KSYM_exclam, "XK_exclam", "!" },
2433 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2434 { KSYM_numbersign, "XK_numbersign", "#" },
2435 { KSYM_dollar, "XK_dollar", "$" },
2436 { KSYM_percent, "XK_percent", "%" },
2437 { KSYM_ampersand, "XK_ampersand", "&" },
2438 { KSYM_apostrophe, "XK_apostrophe", "'" },
2439 { KSYM_parenleft, "XK_parenleft", "(" },
2440 { KSYM_parenright, "XK_parenright", ")" },
2441 { KSYM_asterisk, "XK_asterisk", "*" },
2442 { KSYM_plus, "XK_plus", "+" },
2443 { KSYM_comma, "XK_comma", "," },
2444 { KSYM_minus, "XK_minus", "-" },
2445 { KSYM_period, "XK_period", "." },
2446 { KSYM_slash, "XK_slash", "/" },
2447 { KSYM_colon, "XK_colon", ":" },
2448 { KSYM_semicolon, "XK_semicolon", ";" },
2449 { KSYM_less, "XK_less", "<" },
2450 { KSYM_equal, "XK_equal", "=" },
2451 { KSYM_greater, "XK_greater", ">" },
2452 { KSYM_question, "XK_question", "?" },
2453 { KSYM_at, "XK_at", "@" },
2456 { KSYM_bracketleft, "XK_bracketleft", "[" },
2457 { KSYM_backslash, "XK_backslash", "\\" },
2458 { KSYM_bracketright,"XK_bracketright", "]" },
2459 { KSYM_asciicircum, "XK_asciicircum", "^" },
2460 { KSYM_underscore, "XK_underscore", "_" },
2461 { KSYM_grave, "XK_grave", "grave" },
2462 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2463 { KSYM_braceleft, "XK_braceleft", "brace left" },
2464 { KSYM_bar, "XK_bar", "bar" },
2465 { KSYM_braceright, "XK_braceright", "brace right" },
2466 { KSYM_asciitilde, "XK_asciitilde", "~" },
2468 // special (non-ASCII) keys
2469 { KSYM_degree, "XK_degree", "degree" },
2470 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2471 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2472 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2473 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2474 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2475 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2476 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2478 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2479 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2480 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2481 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2482 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2483 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2484 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2485 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2486 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2488 // other keys (for reverse mapping only)
2489 { KSYM_space, "XK_space", " " },
2491 // keypad keys are not in numerical order in SDL2
2492 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2493 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2494 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2495 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2496 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2497 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2498 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2499 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2500 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2501 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2503 // end-of-array identifier
2509 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2511 static char name_buffer[30];
2514 if (key >= KSYM_A && key <= KSYM_Z)
2515 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2516 else if (key >= KSYM_a && key <= KSYM_z)
2517 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2518 else if (key >= KSYM_0 && key <= KSYM_9)
2519 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2520 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2521 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2522 else if (key == KSYM_UNDEFINED)
2523 strcpy(name_buffer, "(undefined)");
2530 if (key == translate_key[i].key)
2532 strcpy(name_buffer, translate_key[i].name);
2536 while (translate_key[++i].name);
2538 if (!translate_key[i].name)
2539 strcpy(name_buffer, "(unknown)");
2542 *name = name_buffer;
2544 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2546 static char name_buffer[30];
2549 if (key >= KSYM_A && key <= KSYM_Z)
2550 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2551 else if (key >= KSYM_a && key <= KSYM_z)
2552 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2553 else if (key >= KSYM_0 && key <= KSYM_9)
2554 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2555 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2556 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2557 else if (key == KSYM_UNDEFINED)
2558 strcpy(name_buffer, "[undefined]");
2565 if (key == translate_key[i].key)
2567 strcpy(name_buffer, translate_key[i].x11name);
2571 while (translate_key[++i].x11name);
2573 if (!translate_key[i].x11name)
2574 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2577 *x11name = name_buffer;
2579 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2581 Key key = KSYM_UNDEFINED;
2582 char *name_ptr = *name;
2584 if (strlen(*name) == 1)
2586 char c = name_ptr[0];
2588 if (c >= 'A' && c <= 'Z')
2589 key = KSYM_A + (Key)(c - 'A');
2590 else if (c >= 'a' && c <= 'z')
2591 key = KSYM_a + (Key)(c - 'a');
2592 else if (c >= '0' && c <= '9')
2593 key = KSYM_0 + (Key)(c - '0');
2596 if (key == KSYM_UNDEFINED)
2602 if (strEqual(translate_key[i].name, *name))
2604 key = translate_key[i].key;
2608 while (translate_key[++i].x11name);
2611 if (key == KSYM_UNDEFINED)
2612 Warn("getKeyFromKeyName(): not completely implemented");
2616 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2618 Key key = KSYM_UNDEFINED;
2619 char *name_ptr = *x11name;
2621 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2623 char c = name_ptr[3];
2625 if (c >= 'A' && c <= 'Z')
2626 key = KSYM_A + (Key)(c - 'A');
2627 else if (c >= 'a' && c <= 'z')
2628 key = KSYM_a + (Key)(c - 'a');
2629 else if (c >= '0' && c <= '9')
2630 key = KSYM_0 + (Key)(c - '0');
2632 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2634 char c1 = name_ptr[4];
2635 char c2 = name_ptr[5];
2638 if ((c1 >= '0' && c1 <= '9') &&
2639 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2640 d = atoi(&name_ptr[4]);
2642 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2643 key = KSYM_F1 + (Key)(d - 1);
2645 else if (strPrefix(name_ptr, "XK_"))
2651 if (strEqual(name_ptr, translate_key[i].x11name))
2653 key = translate_key[i].key;
2657 while (translate_key[++i].x11name);
2659 else if (strPrefix(name_ptr, "0x"))
2661 unsigned int value = 0;
2667 char c = *name_ptr++;
2670 if (c >= '0' && c <= '9')
2672 else if (c >= 'a' && c <= 'f')
2673 d = (int)(c - 'a' + 10);
2674 else if (c >= 'A' && c <= 'F')
2675 d = (int)(c - 'A' + 10);
2683 value = value * 16 + d;
2694 char *getKeyNameFromKey(Key key)
2698 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2702 char *getX11KeyNameFromKey(Key key)
2706 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2710 Key getKeyFromKeyName(char *name)
2714 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2718 Key getKeyFromX11KeyName(char *x11name)
2722 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2726 char getCharFromKey(Key key)
2732 } translate_key_char[] =
2734 // special (non-ASCII) keys (ISO-8859-1)
2735 { KSYM_degree, CHAR_BYTE_DEGREE },
2736 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2737 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2738 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2739 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2740 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2741 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2742 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2744 // end-of-array identifier
2748 char *keyname = getKeyNameFromKey(key);
2751 if (strlen(keyname) == 1)
2753 else if (strEqual(keyname, "space"))
2761 if (key == translate_key_char[i].key)
2763 c = translate_key_char[i].key_char;
2768 while (translate_key_char[++i].key_char);
2774 char getValidConfigValueChar(char c)
2776 if (c == '#' || // used to mark comments
2777 c == '\\') // used to mark continued lines
2784 // ----------------------------------------------------------------------------
2785 // functions to translate string identifiers to integer or boolean value
2786 // ----------------------------------------------------------------------------
2788 int get_integer_from_string(char *s)
2790 // check for the most common case first
2791 if (s[0] >= '0' && s[0] <= '9')
2794 char *s_lower = getStringToLower(s);
2797 if (strEqual(s_lower, "false") ||
2798 strEqual(s_lower, "no") ||
2799 strEqual(s_lower, "off"))
2801 else if (strEqual(s_lower, "true") ||
2802 strEqual(s_lower, "yes") ||
2803 strEqual(s_lower, "on"))
2813 boolean get_boolean_from_string(char *s)
2815 char *s_lower = getStringToLower(s);
2816 boolean result = FALSE;
2818 if (strEqual(s_lower, "true") ||
2819 strEqual(s_lower, "yes") ||
2820 strEqual(s_lower, "on") ||
2821 get_integer_from_string(s) == 1)
2829 int get_switch3_from_string(char *s)
2831 char *s_lower = getStringToLower(s);
2834 if (strEqual(s_lower, "true") ||
2835 strEqual(s_lower, "yes") ||
2836 strEqual(s_lower, "on") ||
2837 get_integer_from_string(s) == 1)
2839 else if (strEqual(s_lower, "auto"))
2847 int get_player_nr_from_string(char *s)
2849 static char *player_text[] =
2859 char *s_lower = getStringToLower(s);
2863 for (i = 0; player_text[i] != NULL; i++)
2864 if (strEqual(s_lower, player_text[i]))
2873 // ----------------------------------------------------------------------------
2874 // functions for generic lists
2875 // ----------------------------------------------------------------------------
2877 ListNode *newListNode(void)
2879 return checked_calloc(sizeof(ListNode));
2882 void addNodeToList(ListNode **node_first, char *key, void *content)
2884 ListNode *node_new = newListNode();
2886 node_new->key = getStringCopy(key);
2887 node_new->content = content;
2888 node_new->next = *node_first;
2891 (*node_first)->prev = node_new;
2893 *node_first = node_new;
2896 void deleteNodeFromList(ListNode **node_first, char *key,
2897 void (*destructor_function)(void *))
2899 if (node_first == NULL || *node_first == NULL)
2902 if (strEqual((*node_first)->key, key))
2904 // after first recursion, (*node_first)->prev->next == *node_first,
2905 // so *node_first would be overwritten with (*node_first)->next
2906 // => use a copy of *node_first (and later of (*node_first)->next)
2907 ListNode *node = *node_first;
2908 ListNode *node_next = node->next;
2910 checked_free(node->key);
2912 if (destructor_function)
2913 destructor_function(node->content);
2916 node->prev->next = node->next;
2919 node->next->prev = node->prev;
2923 // after removing node, set list pointer to next valid list node
2924 // (this is important if the first node of the list was deleted)
2925 *node_first = node_next;
2929 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2933 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2935 if (node_first == NULL)
2938 if (strEqual(node_first->key, key))
2941 return getNodeFromKey(node_first->next, key);
2944 int getNumNodes(ListNode *node_first)
2946 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2950 static void dumpList(ListNode *node_first)
2952 ListNode *node = node_first;
2956 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2957 ((struct ListNodeInfo *)node->content)->num_references);
2961 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2966 // ----------------------------------------------------------------------------
2967 // functions for file handling
2968 // ----------------------------------------------------------------------------
2970 #define MAX_BUFFER_SIZE 4096
2972 File *openFile(char *filename, char *mode)
2974 File *file = checked_calloc(sizeof(File));
2976 file->file = fopen(filename, mode);
2978 if (file->file != NULL)
2980 file->filename = getStringCopy(filename);
2985 #if defined(PLATFORM_ANDROID)
2986 file->asset_file = SDL_RWFromFile(filename, mode);
2988 if (file->asset_file != NULL)
2990 file->file_is_asset = TRUE;
2991 file->filename = getStringCopy(filename);
3002 int closeFile(File *file)
3009 #if defined(PLATFORM_ANDROID)
3010 if (file->asset_file)
3011 result = SDL_RWclose(file->asset_file);
3015 result = fclose(file->file);
3017 checked_free(file->filename);
3023 int checkEndOfFile(File *file)
3025 #if defined(PLATFORM_ANDROID)
3026 if (file->file_is_asset)
3027 return file->end_of_file;
3030 return feof(file->file);
3033 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
3035 #if defined(PLATFORM_ANDROID)
3036 if (file->file_is_asset)
3038 if (file->end_of_file)
3041 size_t num_items_read =
3042 SDL_RWread(file->asset_file, buffer, item_size, num_items);
3044 if (num_items_read < num_items)
3045 file->end_of_file = TRUE;
3047 return num_items_read;
3051 return fread(buffer, item_size, num_items, file->file);
3054 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3056 return fwrite(buffer, item_size, num_items, file->file);
3059 int seekFile(File *file, long offset, int whence)
3061 #if defined(PLATFORM_ANDROID)
3062 if (file->file_is_asset)
3064 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3065 whence == SEEK_CUR ? RW_SEEK_CUR :
3066 whence == SEEK_END ? RW_SEEK_END : 0);
3068 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3072 return fseek(file->file, offset, whence);
3075 int getByteFromFile(File *file)
3077 #if defined(PLATFORM_ANDROID)
3078 if (file->file_is_asset)
3080 if (file->end_of_file)
3084 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3086 if (num_bytes_read < 1)
3087 file->end_of_file = TRUE;
3089 return (file->end_of_file ? EOF : (int)c);
3093 return fgetc(file->file);
3096 char *getStringFromFile(File *file, char *line, int size)
3098 #if defined(PLATFORM_ANDROID)
3099 if (file->file_is_asset)
3101 if (file->end_of_file)
3104 char *line_ptr = line;
3105 int num_bytes_read = 0;
3107 while (num_bytes_read < size - 1 &&
3108 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3109 *line_ptr++ != '\n')
3114 if (strlen(line) == 0)
3116 file->end_of_file = TRUE;
3125 return fgets(line, size, file->file);
3128 int copyFile(char *filename_from, char *filename_to)
3130 File *file_from, *file_to;
3132 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3137 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3139 closeFile(file_from);
3144 while (!checkEndOfFile(file_from))
3146 byte buffer[MAX_BUFFER_SIZE];
3147 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3149 writeFile(file_to, buffer, 1, bytes_read);
3152 closeFile(file_from);
3158 boolean touchFile(char *filename)
3162 if (!(file = fopen(filename, MODE_WRITE)))
3164 Warn("cannot touch file '%s'", filename);
3175 // ----------------------------------------------------------------------------
3176 // functions for directory handling
3177 // ----------------------------------------------------------------------------
3179 Directory *openDirectory(char *dir_name)
3181 Directory *dir = checked_calloc(sizeof(Directory));
3183 dir->dir = opendir(dir_name);
3185 if (dir->dir != NULL)
3187 dir->filename = getStringCopy(dir_name);
3192 #if defined(PLATFORM_ANDROID)
3193 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3195 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3197 checked_free(asset_toc_filename);
3199 if (dir->asset_toc_file != NULL)
3201 dir->directory_is_asset = TRUE;
3202 dir->filename = getStringCopy(dir_name);
3213 int closeDirectory(Directory *dir)
3220 #if defined(PLATFORM_ANDROID)
3221 if (dir->asset_toc_file)
3222 result = SDL_RWclose(dir->asset_toc_file);
3226 result = closedir(dir->dir);
3229 freeDirectoryEntry(dir->dir_entry);
3231 checked_free(dir->filename);
3237 DirectoryEntry *readDirectory(Directory *dir)
3240 freeDirectoryEntry(dir->dir_entry);
3242 dir->dir_entry = NULL;
3244 #if defined(PLATFORM_ANDROID)
3245 if (dir->directory_is_asset)
3247 char line[MAX_LINE_LEN];
3248 char *line_ptr = line;
3249 int num_bytes_read = 0;
3251 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3252 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3261 if (strlen(line) == 0)
3264 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3266 dir->dir_entry->is_directory = FALSE;
3267 if (line[strlen(line) - 1] == '/')
3269 dir->dir_entry->is_directory = TRUE;
3271 line[strlen(line) - 1] = '\0';
3274 dir->dir_entry->basename = getStringCopy(line);
3275 dir->dir_entry->filename = getPath2(dir->filename, line);
3277 return dir->dir_entry;
3281 struct dirent *dir_entry = readdir(dir->dir);
3283 if (dir_entry == NULL)
3286 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3288 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3289 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3291 struct stat file_status;
3293 dir->dir_entry->is_directory =
3294 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3295 S_ISDIR(file_status.st_mode));
3297 return dir->dir_entry;
3300 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3302 if (dir_entry == NULL)
3305 checked_free(dir_entry->basename);
3306 checked_free(dir_entry->filename);
3307 checked_free(dir_entry);
3311 // ----------------------------------------------------------------------------
3312 // functions for checking files and filenames
3313 // ----------------------------------------------------------------------------
3315 boolean directoryExists(const char *dir_name)
3317 if (dir_name == NULL)
3320 struct stat file_status;
3321 boolean success = (stat(dir_name, &file_status) == 0 &&
3322 S_ISDIR(file_status.st_mode));
3324 #if defined(PLATFORM_ANDROID)
3327 // this might be an asset directory; check by trying to open toc file
3328 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3329 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3331 checked_free(asset_toc_filename);
3333 success = (file != NULL);
3343 boolean fileExists(const char *filename)
3345 if (filename == NULL)
3348 boolean success = (access(filename, F_OK) == 0);
3350 #if defined(PLATFORM_ANDROID)
3353 // this might be an asset file; check by trying to open it
3354 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3356 success = (file != NULL);
3367 static boolean fileHasPrefix(const char *basename, const char *prefix)
3369 static char *basename_lower = NULL;
3370 int basename_length, prefix_length;
3372 checked_free(basename_lower);
3374 if (basename == NULL || prefix == NULL)
3377 basename_lower = getStringToLower(basename);
3378 basename_length = strlen(basename_lower);
3379 prefix_length = strlen(prefix);
3381 if (basename_length > prefix_length + 1 &&
3382 basename_lower[prefix_length] == '.' &&
3383 strncmp(basename_lower, prefix, prefix_length) == 0)
3390 static boolean fileHasSuffix(const char *basename, const char *suffix)
3392 static char *basename_lower = NULL;
3393 int basename_length, suffix_length;
3395 checked_free(basename_lower);
3397 if (basename == NULL || suffix == NULL)
3400 basename_lower = getStringToLower(basename);
3401 basename_length = strlen(basename_lower);
3402 suffix_length = strlen(suffix);
3404 if (basename_length > suffix_length + 1 &&
3405 basename_lower[basename_length - suffix_length - 1] == '.' &&
3406 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3412 static boolean FileCouldBeArtwork(char *filename)
3414 char *basename = getBaseNamePtr(filename);
3416 return (!strEqual(basename, ".") &&
3417 !strEqual(basename, "..") &&
3418 !fileHasSuffix(basename, "txt") &&
3419 !fileHasSuffix(basename, "conf") &&
3420 !directoryExists(filename));
3423 boolean FileIsGraphic(char *filename)
3425 return FileCouldBeArtwork(filename);
3428 boolean FileIsSound(char *filename)
3430 return FileCouldBeArtwork(filename);
3433 boolean FileIsMusic(char *filename)
3435 return FileCouldBeArtwork(filename);
3438 boolean FileIsArtworkType(char *filename, int type)
3440 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3441 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3442 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3448 // ----------------------------------------------------------------------------
3449 // functions for loading artwork configuration information
3450 // ----------------------------------------------------------------------------
3452 char *get_mapped_token(char *token)
3454 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3455 static char *map_token_prefix[][2] =
3457 { "char_procent", "char_percent" },
3458 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3459 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3460 { "bd_butterfly_left", "bd_butterfly.left" },
3461 { "bd_butterfly_right", "bd_butterfly.right" },
3462 { "bd_butterfly_up", "bd_butterfly.up" },
3463 { "bd_butterfly_down", "bd_butterfly.down" },
3464 { "bd_firefly_left", "bd_firefly.left" },
3465 { "bd_firefly_right", "bd_firefly.right" },
3466 { "bd_firefly_up", "bd_firefly.up" },
3467 { "bd_firefly_down", "bd_firefly.down" },
3473 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3475 int len_token_prefix = strlen(map_token_prefix[i][0]);
3477 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3478 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3481 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3482 char *gfx_substring = ".gfx";
3483 char *gfx_prefix = "gfx.";
3484 if (strstr(token, gfx_substring) != NULL)
3486 char *token_prefix = getStringCopy(token);
3487 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3488 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3491 // cut off token string at ".gfx" substring position
3492 *token_gfx_pos = '\0';
3494 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3495 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3499 return mapped_token;
3505 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3508 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3509 static struct ConfigTypeInfo prefix_list[] =
3511 { "global.anim_1" },
3512 { "global.anim_2" },
3513 { "global.anim_3" },
3514 { "global.anim_4" },
3515 { "global.anim_5" },
3516 { "global.anim_6" },
3517 { "global.anim_7" },
3518 { "global.anim_8" },
3519 { "global.anim_9" },
3520 { "global.anim_10" },
3521 { "global.anim_11" },
3522 { "global.anim_12" },
3523 { "global.anim_13" },
3524 { "global.anim_14" },
3525 { "global.anim_15" },
3526 { "global.anim_16" },
3527 { "global.anim_17" },
3528 { "global.anim_18" },
3529 { "global.anim_19" },
3530 { "global.anim_20" },
3531 { "global.anim_21" },
3532 { "global.anim_22" },
3533 { "global.anim_23" },
3534 { "global.anim_24" },
3535 { "global.anim_25" },
3536 { "global.anim_26" },
3537 { "global.anim_27" },
3538 { "global.anim_28" },
3539 { "global.anim_29" },
3540 { "global.anim_30" },
3541 { "global.anim_31" },
3542 { "global.anim_32" },
3546 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3547 boolean prefix_found = FALSE;
3551 // search for prefix to check if base token has to be created
3552 for (i = 0; prefix_list[i].token != NULL; i++)
3553 if (strPrefix(token, prefix_list[i].token))
3554 prefix_found = TRUE;
3559 // search for suffix (parameter) to determine base token length
3560 for (i = 0; suffix_list[i].token != NULL; i++)
3561 if (strSuffix(token, suffix_list[i].token))
3562 len_suffix = strlen(suffix_list[i].token);
3564 return getStringCopyN(token, strlen(token) - len_suffix);
3567 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3568 struct ListNodeInfo ***, int *);
3570 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3571 struct ConfigTypeInfo *suffix_list,
3572 char **ignore_tokens,
3573 int num_file_list_entries)
3575 SetupFileHash *ignore_tokens_hash;
3576 struct FileInfo *file_list;
3577 int num_file_list_entries_found = 0;
3578 int num_suffix_list_entries = 0;
3582 // create hash from list of tokens to be ignored (for quick access)
3583 ignore_tokens_hash = newSetupFileHash();
3584 for (i = 0; ignore_tokens[i] != NULL; i++)
3585 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3587 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3589 for (i = 0; suffix_list[i].token != NULL; i++)
3590 num_suffix_list_entries++;
3592 // always start with reliable default values
3593 for (i = 0; i < num_file_list_entries; i++)
3595 file_list[i].token = NULL;
3597 file_list[i].default_filename = NULL;
3598 file_list[i].filename = NULL;
3600 if (num_suffix_list_entries > 0)
3602 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3604 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3605 file_list[i].parameter = checked_calloc(parameter_array_size);
3607 for (j = 0; j < num_suffix_list_entries; j++)
3609 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3610 setString(&file_list[i].parameter[j], suffix_list[j].value);
3613 file_list[i].redefined = FALSE;
3614 file_list[i].fallback_to_default = FALSE;
3615 file_list[i].default_is_cloned = FALSE;
3621 for (i = 0; config_list[i].token != NULL; i++)
3623 int len_config_token = strlen(config_list[i].token);
3624 boolean is_file_entry = TRUE;
3626 for (j = 0; suffix_list[j].token != NULL; j++)
3628 int len_suffix = strlen(suffix_list[j].token);
3630 if (len_suffix < len_config_token &&
3631 strEqual(&config_list[i].token[len_config_token - len_suffix],
3632 suffix_list[j].token))
3634 setString(&file_list[list_pos].default_parameter[j],
3635 config_list[i].value);
3637 is_file_entry = FALSE;
3643 // the following tokens are no file definitions, but other config tokens
3644 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3645 is_file_entry = FALSE;
3652 if (list_pos >= num_file_list_entries)
3655 file_list[list_pos].token = config_list[i].token;
3656 file_list[list_pos].default_filename = config_list[i].value;
3659 if (strSuffix(config_list[i].token, ".clone_from"))
3660 file_list[list_pos].default_is_cloned = TRUE;
3663 num_file_list_entries_found = list_pos + 1;
3664 if (num_file_list_entries_found != num_file_list_entries)
3667 Error("inconsistant config list information:");
3668 Error("- should be: %d (according to 'src/conf_xxx.h')",
3669 num_file_list_entries);
3670 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3671 num_file_list_entries_found);
3676 freeSetupFileHash(ignore_tokens_hash);
3681 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3683 int len_token = strlen(token);
3684 int len_suffix = strlen(suffix);
3686 if (start_pos < 0) // compare suffix from end of string
3687 start_pos += len_token;
3689 if (start_pos < 0 || start_pos + len_suffix > len_token)
3692 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3695 if (token[start_pos + len_suffix] == '\0')
3698 if (token[start_pos + len_suffix] == '.')
3704 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3706 static void read_token_parameters(SetupFileHash *setup_file_hash,
3707 struct ConfigTypeInfo *suffix_list,
3708 struct FileInfo *file_list_entry)
3710 // check for config token that is the base token without any suffixes
3711 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3712 char *known_token_value = KNOWN_TOKEN_VALUE;
3715 if (filename != NULL)
3717 setString(&file_list_entry->filename, filename);
3719 // when file definition found, set all parameters to default values
3720 for (i = 0; suffix_list[i].token != NULL; i++)
3721 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3723 file_list_entry->redefined = TRUE;
3725 // mark config file token as well known from default config
3726 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3729 // check for config tokens that can be build by base token and suffixes
3730 for (i = 0; suffix_list[i].token != NULL; i++)
3732 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3733 char *value = getHashEntry(setup_file_hash, token);
3737 setString(&file_list_entry->parameter[i], value);
3739 // mark config file token as well known from default config
3740 setHashEntry(setup_file_hash, token, known_token_value);
3747 static void add_dynamic_file_list_entry(struct FileInfo **list,
3748 int *num_list_entries,
3749 SetupFileHash *extra_file_hash,
3750 struct ConfigTypeInfo *suffix_list,
3751 int num_suffix_list_entries,
3754 struct FileInfo *new_list_entry;
3755 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3757 (*num_list_entries)++;
3758 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3759 new_list_entry = &(*list)[*num_list_entries - 1];
3761 new_list_entry->token = getStringCopy(token);
3762 new_list_entry->default_filename = NULL;
3763 new_list_entry->filename = NULL;
3764 new_list_entry->parameter = checked_calloc(parameter_array_size);
3766 new_list_entry->redefined = FALSE;
3767 new_list_entry->fallback_to_default = FALSE;
3768 new_list_entry->default_is_cloned = FALSE;
3770 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3773 static void add_property_mapping(struct PropertyMapping **list,
3774 int *num_list_entries,
3775 int base_index, int ext1_index,
3776 int ext2_index, int ext3_index,
3779 struct PropertyMapping *new_list_entry;
3781 (*num_list_entries)++;
3782 *list = checked_realloc(*list,
3783 *num_list_entries * sizeof(struct PropertyMapping));
3784 new_list_entry = &(*list)[*num_list_entries - 1];
3786 new_list_entry->base_index = base_index;
3787 new_list_entry->ext1_index = ext1_index;
3788 new_list_entry->ext2_index = ext2_index;
3789 new_list_entry->ext3_index = ext3_index;
3791 new_list_entry->artwork_index = artwork_index;
3794 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3797 struct FileInfo *file_list = artwork_info->file_list;
3798 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3799 char **base_prefixes = artwork_info->base_prefixes;
3800 char **ext1_suffixes = artwork_info->ext1_suffixes;
3801 char **ext2_suffixes = artwork_info->ext2_suffixes;
3802 char **ext3_suffixes = artwork_info->ext3_suffixes;
3803 char **ignore_tokens = artwork_info->ignore_tokens;
3804 int num_file_list_entries = artwork_info->num_file_list_entries;
3805 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3806 int num_base_prefixes = artwork_info->num_base_prefixes;
3807 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3808 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3809 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3810 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3811 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3812 SetupFileHash *extra_file_hash, *empty_file_hash;
3813 char *known_token_value = KNOWN_TOKEN_VALUE;
3814 char *base_token_value = UNDEFINED_FILENAME;
3817 if (filename == NULL)
3820 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3823 // separate valid (defined) from empty (undefined) config token values
3824 valid_file_hash = newSetupFileHash();
3825 empty_file_hash = newSetupFileHash();
3826 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3828 char *value = HASH_ITERATION_VALUE(itr);
3830 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3831 HASH_ITERATION_TOKEN(itr), value);
3833 END_HASH_ITERATION(setup_file_hash, itr)
3835 // at this point, we do not need the setup file hash anymore -- free it
3836 freeSetupFileHash(setup_file_hash);
3838 // prevent changing hash while iterating over it by using a temporary copy
3839 valid_file_hash_tmp = newSetupFileHash();
3840 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3842 setHashEntry(valid_file_hash_tmp,
3843 HASH_ITERATION_TOKEN(itr),
3844 HASH_ITERATION_VALUE(itr));
3846 END_HASH_ITERATION(valid_file_hash, itr)
3848 // (iterate over same temporary hash, as modifications are independent)
3850 // map deprecated to current tokens (using prefix match and replace)
3851 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3853 char *token = HASH_ITERATION_TOKEN(itr);
3854 char *mapped_token = get_mapped_token(token);
3856 if (mapped_token != NULL)
3858 char *value = HASH_ITERATION_VALUE(itr);
3861 setHashEntry(valid_file_hash, mapped_token, value);
3863 // ignore old token (by setting it to "known" keyword)
3864 setHashEntry(valid_file_hash, token, known_token_value);
3869 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3871 // add special base tokens (using prefix match and replace)
3872 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3874 char *token = HASH_ITERATION_TOKEN(itr);
3875 char *base_token = get_special_base_token(artwork_info, token);
3877 if (base_token != NULL)
3879 // add base token only if it does not already exist
3880 if (getHashEntry(valid_file_hash, base_token) == NULL)
3881 setHashEntry(valid_file_hash, base_token, base_token_value);
3886 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3888 // free temporary hash used for iteration
3889 freeSetupFileHash(valid_file_hash_tmp);
3891 // read parameters for all known config file tokens
3892 for (i = 0; i < num_file_list_entries; i++)
3893 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3895 // set all tokens that can be ignored here to "known" keyword
3896 for (i = 0; i < num_ignore_tokens; i++)
3897 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3899 // copy all unknown config file tokens to extra config hash
3900 extra_file_hash = newSetupFileHash();
3901 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3903 char *value = HASH_ITERATION_VALUE(itr);
3905 if (!strEqual(value, known_token_value))
3906 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3908 END_HASH_ITERATION(valid_file_hash, itr)
3910 // at this point, we do not need the valid file hash anymore -- free it
3911 freeSetupFileHash(valid_file_hash);
3913 // now try to determine valid, dynamically defined config tokens
3915 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3917 struct FileInfo **dynamic_file_list =
3918 &artwork_info->dynamic_file_list;
3919 int *num_dynamic_file_list_entries =
3920 &artwork_info->num_dynamic_file_list_entries;
3921 struct PropertyMapping **property_mapping =
3922 &artwork_info->property_mapping;
3923 int *num_property_mapping_entries =
3924 &artwork_info->num_property_mapping_entries;
3925 int current_summarized_file_list_entry =
3926 artwork_info->num_file_list_entries +
3927 artwork_info->num_dynamic_file_list_entries;
3928 char *token = HASH_ITERATION_TOKEN(itr);
3929 int len_token = strlen(token);
3931 boolean base_prefix_found = FALSE;
3932 boolean parameter_suffix_found = FALSE;
3934 // skip all parameter definitions (handled by read_token_parameters())
3935 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3937 int len_suffix = strlen(suffix_list[i].token);
3939 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3940 parameter_suffix_found = TRUE;
3943 if (parameter_suffix_found)
3946 // ---------- step 0: search for matching base prefix ----------
3949 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3951 char *base_prefix = base_prefixes[i];
3952 int len_base_prefix = strlen(base_prefix);
3953 boolean ext1_suffix_found = FALSE;
3954 boolean ext2_suffix_found = FALSE;
3955 boolean ext3_suffix_found = FALSE;
3956 boolean exact_match = FALSE;
3957 int base_index = -1;
3958 int ext1_index = -1;
3959 int ext2_index = -1;
3960 int ext3_index = -1;
3962 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3964 if (!base_prefix_found)
3969 if (start_pos + len_base_prefix == len_token) // exact match
3973 add_dynamic_file_list_entry(dynamic_file_list,
3974 num_dynamic_file_list_entries,
3977 num_suffix_list_entries,
3979 add_property_mapping(property_mapping,
3980 num_property_mapping_entries,
3981 base_index, -1, -1, -1,
3982 current_summarized_file_list_entry);
3986 // ---------- step 1: search for matching first suffix ----------
3988 start_pos += len_base_prefix;
3989 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3991 char *ext1_suffix = ext1_suffixes[j];
3992 int len_ext1_suffix = strlen(ext1_suffix);
3994 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3996 if (!ext1_suffix_found)
4001 if (start_pos + len_ext1_suffix == len_token) // exact match
4005 add_dynamic_file_list_entry(dynamic_file_list,
4006 num_dynamic_file_list_entries,
4009 num_suffix_list_entries,
4011 add_property_mapping(property_mapping,
4012 num_property_mapping_entries,
4013 base_index, ext1_index, -1, -1,
4014 current_summarized_file_list_entry);
4018 start_pos += len_ext1_suffix;
4024 // ---------- step 2: search for matching second suffix ----------
4026 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
4028 char *ext2_suffix = ext2_suffixes[k];
4029 int len_ext2_suffix = strlen(ext2_suffix);
4031 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
4033 if (!ext2_suffix_found)
4038 if (start_pos + len_ext2_suffix == len_token) // exact match
4042 add_dynamic_file_list_entry(dynamic_file_list,
4043 num_dynamic_file_list_entries,
4046 num_suffix_list_entries,
4048 add_property_mapping(property_mapping,
4049 num_property_mapping_entries,
4050 base_index, ext1_index, ext2_index, -1,
4051 current_summarized_file_list_entry);
4055 start_pos += len_ext2_suffix;
4061 // ---------- step 3: search for matching third suffix ----------
4063 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4065 char *ext3_suffix = ext3_suffixes[l];
4066 int len_ext3_suffix = strlen(ext3_suffix);
4068 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4070 if (!ext3_suffix_found)
4075 if (start_pos + len_ext3_suffix == len_token) // exact match
4079 add_dynamic_file_list_entry(dynamic_file_list,
4080 num_dynamic_file_list_entries,
4083 num_suffix_list_entries,
4085 add_property_mapping(property_mapping,
4086 num_property_mapping_entries,
4087 base_index, ext1_index, ext2_index, ext3_index,
4088 current_summarized_file_list_entry);
4094 END_HASH_ITERATION(extra_file_hash, itr)
4096 if (artwork_info->num_dynamic_file_list_entries > 0)
4098 artwork_info->dynamic_artwork_list =
4099 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4100 artwork_info->sizeof_artwork_list_entry);
4103 if (options.verbose && IS_PARENT_PROCESS())
4105 SetupFileList *setup_file_list, *list;
4106 boolean dynamic_tokens_found = FALSE;
4107 boolean unknown_tokens_found = FALSE;
4108 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4110 // list may be NULL for empty artwork config files
4111 setup_file_list = loadSetupFileList(filename);
4113 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4115 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4116 dynamic_tokens_found = TRUE;
4118 unknown_tokens_found = TRUE;
4120 END_HASH_ITERATION(extra_file_hash, itr)
4122 if (options.debug && dynamic_tokens_found)
4124 Debug("config", "---");
4125 Debug("config", "dynamic token(s) found in config file:");
4126 Debug("config", "- config file: '%s'", filename);
4128 for (list = setup_file_list; list != NULL; list = list->next)
4130 char *value = getHashEntry(extra_file_hash, list->token);
4132 if (value != NULL && strEqual(value, known_token_value))
4133 Debug("config", "- dynamic token: '%s'", list->token);
4136 Debug("config", "---");
4139 if (unknown_tokens_found)
4142 Warn("unknown token(s) found in config file:");
4143 Warn("- config file: '%s'", filename);
4145 for (list = setup_file_list; list != NULL; list = list->next)
4147 char *value = getHashEntry(extra_file_hash, list->token);
4149 if (value != NULL && !strEqual(value, known_token_value))
4150 Warn("- dynamic token: '%s'", list->token);
4156 if (undefined_values_found)
4159 Warn("undefined values found in config file:");
4160 Warn("- config file: '%s'", filename);
4162 for (list = setup_file_list; list != NULL; list = list->next)
4164 char *value = getHashEntry(empty_file_hash, list->token);
4167 Warn("- undefined value for token: '%s'", list->token);
4173 freeSetupFileList(setup_file_list);
4176 freeSetupFileHash(extra_file_hash);
4177 freeSetupFileHash(empty_file_hash);
4180 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4182 struct FileInfo *file_list = artwork_info->file_list;
4183 int num_file_list_entries = artwork_info->num_file_list_entries;
4184 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4185 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4188 DrawInitTextHead("Loading artwork config");
4189 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4191 // always start with reliable default values
4192 for (i = 0; i < num_file_list_entries; i++)
4194 setString(&file_list[i].filename, file_list[i].default_filename);
4196 for (j = 0; j < num_suffix_list_entries; j++)
4197 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4199 file_list[i].redefined = FALSE;
4200 file_list[i].fallback_to_default = FALSE;
4203 // free previous dynamic artwork file array
4204 if (artwork_info->dynamic_file_list != NULL)
4206 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4208 free(artwork_info->dynamic_file_list[i].token);
4209 free(artwork_info->dynamic_file_list[i].filename);
4210 free(artwork_info->dynamic_file_list[i].parameter);
4213 free(artwork_info->dynamic_file_list);
4214 artwork_info->dynamic_file_list = NULL;
4216 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4217 &artwork_info->num_dynamic_file_list_entries);
4220 // free previous property mapping
4221 if (artwork_info->property_mapping != NULL)
4223 free(artwork_info->property_mapping);
4225 artwork_info->property_mapping = NULL;
4226 artwork_info->num_property_mapping_entries = 0;
4229 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4231 // first look for special artwork configured in level series config
4232 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4234 if (fileExists(filename_base))
4235 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4238 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4240 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4241 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4244 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4245 struct ListNodeInfo **listnode)
4249 char *filename = (*listnode)->source_filename;
4251 if (--(*listnode)->num_references <= 0)
4252 deleteNodeFromList(&artwork_info->content_list, filename,
4253 artwork_info->free_artwork);
4259 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4260 struct ListNodeInfo **listnode,
4261 struct FileInfo *file_list_entry)
4271 char *basename = file_list_entry->filename;
4272 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4274 // mark all images from non-default graphics directory as "redefined"
4275 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4276 !strPrefix(filename, options.graphics_directory))
4277 file_list_entry->redefined = TRUE;
4279 if (filename == NULL)
4281 Warn("cannot find artwork file '%s'", basename);
4283 basename = file_list_entry->default_filename;
4285 // fail for cloned default artwork that has no default filename defined
4286 if (file_list_entry->default_is_cloned &&
4287 strEqual(basename, UNDEFINED_FILENAME))
4289 void (*error_func)(char *, ...) = Warn;
4291 // we can get away without sounds and music, but not without graphics
4292 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4295 error_func("token '%s' was cloned and has no default filename",
4296 file_list_entry->token);
4301 // dynamic artwork has no default filename / skip empty default artwork
4302 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4305 file_list_entry->fallback_to_default = TRUE;
4307 Warn("trying default artwork file '%s'", basename);
4309 filename = getCustomArtworkFilename(basename, artwork_info->type);
4311 if (filename == NULL)
4313 void (*error_func)(char *, ...) = Warn;
4315 // we can get away without sounds and music, but not without graphics
4316 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4319 error_func("cannot find default artwork file '%s'", basename);
4325 // check if the old and the new artwork file are the same
4326 if (*listnode && strEqual((*listnode)->source_filename, filename))
4328 // The old and new artwork are the same (have the same filename and path).
4329 // This usually means that this artwork does not exist in this artwork set
4330 // and a fallback to the existing artwork is done.
4335 // delete existing artwork file entry
4336 deleteArtworkListEntry(artwork_info, listnode);
4338 // check if the new artwork file already exists in the list of artwork
4339 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4341 *listnode = (struct ListNodeInfo *)node->content;
4342 (*listnode)->num_references++;
4347 DrawInitTextHead(init_text[artwork_info->type]);
4348 DrawInitTextItem(basename);
4350 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4352 // add new artwork file entry to the list of artwork files
4353 (*listnode)->num_references = 1;
4354 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4359 void (*error_func)(char *, ...) = Warn;
4361 // we can get away without sounds and music, but not without graphics
4362 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4365 error_func("cannot load artwork file '%s'", basename);
4371 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4372 struct ListNodeInfo **listnode,
4373 struct FileInfo *file_list_entry)
4375 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4377 deleteArtworkListEntry(artwork_info, listnode);
4382 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4385 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4387 struct FileInfo *file_list = artwork_info->file_list;
4388 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4389 int num_file_list_entries = artwork_info->num_file_list_entries;
4390 int num_dynamic_file_list_entries =
4391 artwork_info->num_dynamic_file_list_entries;
4394 print_timestamp_init("ReloadCustomArtworkList");
4396 for (i = 0; i < num_file_list_entries; i++)
4397 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4400 for (i = 0; i < num_dynamic_file_list_entries; i++)
4401 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4402 &dynamic_file_list[i]);
4404 print_timestamp_done("ReloadCustomArtworkList");
4407 dumpList(artwork_info->content_list);
4411 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4412 struct ListNodeInfo ***list,
4413 int *num_list_entries)
4420 for (i = 0; i < *num_list_entries; i++)
4421 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4425 *num_list_entries = 0;
4428 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4430 if (artwork_info == NULL)
4433 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4434 &artwork_info->num_file_list_entries);
4436 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4437 &artwork_info->num_dynamic_file_list_entries);
4441 // ----------------------------------------------------------------------------
4442 // functions only needed for non-Unix (non-command-line) systems
4443 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4444 // (now also added for Windows, to create files in user data directory)
4445 // ----------------------------------------------------------------------------
4447 char *getLogBasename(char *basename)
4449 return getStringCat2(basename, ".log");
4452 char *getLogFilename(char *basename)
4454 return getPath2(getMainUserGameDataDir(), basename);
4457 void OpenLogFile(void)
4459 InitMainUserDataDirectory();
4461 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4463 program.log_file = program.log_file_default; // reset to default
4465 Warn("cannot open file '%s' for writing: %s",
4466 program.log_filename, strerror(errno));
4469 // output should be unbuffered so it is not truncated in a crash
4470 setbuf(program.log_file, NULL);
4473 void CloseLogFile(void)
4475 if (program.log_file != program.log_file_default)
4476 fclose(program.log_file);
4479 void DumpLogFile(void)
4481 FILE *log_file = fopen(program.log_filename, MODE_READ);
4483 if (log_file == NULL)
4486 while (!feof(log_file))
4487 fputc(fgetc(log_file), stdout);
4492 void NotifyUserAboutErrorFile(void)
4494 #if defined(PLATFORM_WINDOWS)
4495 char *title_text = getStringCat2(program.program_title, " Error Message");
4496 char *error_text = getStringCat2("The program was aborted due to an error; "
4497 "for details, see the following error file:"
4499 program.log_filename);
4501 MessageBox(NULL, error_text, title_text, MB_OK);
4506 // ----------------------------------------------------------------------------
4507 // the following is only for debugging purpose and normally not used
4508 // ----------------------------------------------------------------------------
4512 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4513 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4515 #define DEBUG_NUM_TIMESTAMPS 10
4516 #define DEBUG_TIME_IN_MICROSECONDS 0
4518 #if DEBUG_TIME_IN_MICROSECONDS
4519 static double Counter_Microseconds(void)
4521 static struct timeval base_time = { 0, 0 };
4522 struct timeval current_time;
4525 gettimeofday(¤t_time, NULL);
4527 // reset base time in case of wrap-around
4528 if (current_time.tv_sec < base_time.tv_sec)
4529 base_time = current_time;
4532 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4533 ((double)(current_time.tv_usec - base_time.tv_usec));
4535 return counter; // return microseconds since last init
4539 static char *debug_print_timestamp_get_padding(int padding_size)
4541 static char *padding = NULL;
4542 int max_padding_size = 100;
4544 if (padding == NULL)
4546 padding = checked_calloc(max_padding_size + 1);
4547 memset(padding, ' ', max_padding_size);
4550 return &padding[MAX(0, max_padding_size - padding_size)];
4553 void debug_print_timestamp(int counter_nr, char *message)
4555 int indent_size = 8;
4556 int padding_size = 40;
4557 float timestamp_interval;
4560 Fail("debugging: invalid negative counter");
4561 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4562 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4564 #if DEBUG_TIME_IN_MICROSECONDS
4565 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4568 counter[counter_nr][0] = Counter_Microseconds();
4570 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4573 counter[counter_nr][0] = Counter();
4576 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4577 counter[counter_nr][1] = counter[counter_nr][0];
4580 Debug("time:init", "%s%s%s %.3f %s",
4581 debug_print_timestamp_get_padding(counter_nr * indent_size),
4583 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4584 timestamp_interval / 1000,
4589 static void debug_print_parent_only(char *format, ...)
4591 if (!IS_PARENT_PROCESS())
4598 va_start(ap, format);
4599 vprintf(format, ap);
4609 static void print_timestamp_ext(char *message, char *mode)
4611 #if DEBUG_PRINT_INIT_TIMESTAMPS
4612 static char *debug_message = NULL;
4613 static char *last_message = NULL;
4614 static int counter_nr = 0;
4615 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4617 checked_free(debug_message);
4618 debug_message = getStringCat3(mode, " ", message);
4620 if (strEqual(mode, "INIT"))
4622 debug_print_timestamp(counter_nr, NULL);
4624 if (counter_nr + 1 < max_depth)
4625 debug_print_timestamp(counter_nr, debug_message);
4629 debug_print_timestamp(counter_nr, NULL);
4631 else if (strEqual(mode, "DONE"))
4635 if (counter_nr + 1 < max_depth ||
4636 (counter_nr == 0 && max_depth == 1))
4638 last_message = message;
4640 if (counter_nr == 0 && max_depth == 1)
4642 checked_free(debug_message);
4643 debug_message = getStringCat3("TIME", " ", message);
4646 debug_print_timestamp(counter_nr, debug_message);
4649 else if (!strEqual(mode, "TIME") ||
4650 !strEqual(message, last_message))
4652 if (counter_nr < max_depth)
4653 debug_print_timestamp(counter_nr, debug_message);
4658 void print_timestamp_init(char *message)
4660 print_timestamp_ext(message, "INIT");
4663 void print_timestamp_time(char *message)
4665 print_timestamp_ext(message, "TIME");
4668 void print_timestamp_done(char *message)
4670 print_timestamp_ext(message, "DONE");