1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter() // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter() // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToLower(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = tolower(*s++);
1235 void setString(char **old_value, const char *new_value)
1237 checked_free(*old_value);
1239 *old_value = getStringCopy(new_value);
1242 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1244 const char *s_ptr, *s_last = s;
1245 byte separator_table[256] = { FALSE };
1247 char **tokens = NULL;
1252 if (separators == NULL)
1256 max_tokens = INT_MAX;
1258 // if string is empty, return empty array
1261 tokens = checked_malloc(sizeof(char *));
1267 // initialize separator table for all characters in separators string
1268 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1269 separator_table[*(byte *)s_ptr] = TRUE;
1271 // count number of tokens in string
1272 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1273 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1276 // allocate array for determined number of tokens
1277 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1279 // copy all but last separated sub-strings to array
1280 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1282 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1284 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1289 // copy last separated sub-string to array
1290 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1293 tokens[num_tokens] = NULL;
1298 void freeStringArray(char **s_array)
1302 if (s_array == NULL)
1305 for (i = 0; s_array[i] != NULL; i++)
1306 checked_free(s_array[i]);
1308 checked_free(s_array);
1311 boolean strEqual(const char *s1, const char *s2)
1313 return (s1 == NULL && s2 == NULL ? TRUE :
1314 s1 == NULL && s2 != NULL ? FALSE :
1315 s1 != NULL && s2 == NULL ? FALSE :
1316 strcmp(s1, s2) == 0);
1319 boolean strEqualN(const char *s1, const char *s2, int n)
1321 return (s1 == NULL && s2 == NULL ? TRUE :
1322 s1 == NULL && s2 != NULL ? FALSE :
1323 s1 != NULL && s2 == NULL ? FALSE :
1324 strncmp(s1, s2, n) == 0);
1327 boolean strEqualCase(const char *s1, const char *s2)
1329 return (s1 == NULL && s2 == NULL ? TRUE :
1330 s1 == NULL && s2 != NULL ? FALSE :
1331 s1 != NULL && s2 == NULL ? FALSE :
1332 strcasecmp(s1, s2) == 0);
1335 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1337 return (s1 == NULL && s2 == NULL ? TRUE :
1338 s1 == NULL && s2 != NULL ? FALSE :
1339 s1 != NULL && s2 == NULL ? FALSE :
1340 strncasecmp(s1, s2, n) == 0);
1343 boolean strPrefix(const char *s, const char *prefix)
1345 return (s == NULL && prefix == NULL ? TRUE :
1346 s == NULL && prefix != NULL ? FALSE :
1347 s != NULL && prefix == NULL ? FALSE :
1348 strncmp(s, prefix, strlen(prefix)) == 0);
1351 boolean strSuffix(const char *s, const char *suffix)
1353 return (s == NULL && suffix == NULL ? TRUE :
1354 s == NULL && suffix != NULL ? FALSE :
1355 s != NULL && suffix == NULL ? FALSE :
1356 strlen(s) < strlen(suffix) ? FALSE :
1357 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1360 boolean strPrefixLower(const char *s, const char *prefix)
1362 char *s_lower = getStringToLower(s);
1363 boolean match = strPrefix(s_lower, prefix);
1370 boolean strSuffixLower(const char *s, const char *suffix)
1372 char *s_lower = getStringToLower(s);
1373 boolean match = strSuffix(s_lower, suffix);
1380 boolean isURL(const char *s)
1382 while (*s && *s >= 'a' && *s <= 'z')
1385 return strPrefix(s, "://");
1389 // ----------------------------------------------------------------------------
1390 // command line option handling functions
1391 // ----------------------------------------------------------------------------
1393 void GetOptions(int argc, char *argv[],
1394 void (*print_usage_function)(void),
1395 void (*print_version_function)(void))
1397 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1398 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1399 char **options_left = &argvplus[1];
1401 // replace original "argv" with null-terminated array of string pointers
1403 argvplus[argc] = argv[argc];
1405 // initialize global program options
1406 options.server_host = NULL;
1407 options.server_port = 0;
1409 options.base_directory = base_path;
1411 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1412 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1413 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1414 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1415 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1416 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1418 options.execute_command = NULL;
1419 options.tape_log_filename = NULL;
1420 options.special_flags = NULL;
1421 options.debug_mode = NULL;
1422 options.player_name = NULL;
1423 options.identifier = NULL;
1424 options.level_nr = NULL;
1426 options.display_nr = 0;
1428 options.mytapes = FALSE;
1429 options.serveronly = FALSE;
1430 options.network = FALSE;
1431 options.verbose = FALSE;
1432 options.debug = FALSE;
1435 options.verbose = TRUE;
1437 #if !defined(PLATFORM_UNIX)
1438 if (*options_left == NULL) // no options given -- enable verbose mode
1439 options.verbose = TRUE;
1444 #if defined(PLATFORM_ANDROID)
1445 options.debug = TRUE;
1449 while (*options_left)
1451 char option_str[MAX_OPTION_LEN];
1452 char *option = options_left[0];
1453 char *next_option = options_left[1];
1454 char *option_arg = NULL;
1455 int option_len = strlen(option);
1457 if (option_len >= MAX_OPTION_LEN)
1458 FailWithHelp("unrecognized option '%s'", option);
1460 strcpy(option_str, option); // copy argument into buffer
1461 option = option_str;
1463 if (strEqual(option, "--")) // stop scanning arguments
1466 if (strPrefix(option, "--")) // treat '--' like '-'
1469 option_arg = strchr(option, '=');
1470 if (option_arg == NULL) // no '=' in option
1471 option_arg = next_option;
1474 *option_arg++ = '\0'; // cut argument from option
1475 if (*option_arg == '\0') // no argument after '='
1476 FailWithHelp("option '%s' has invalid argument", option_str);
1479 option_len = strlen(option);
1481 if (strEqual(option, "-"))
1483 FailWithHelp("unrecognized option '%s'", option);
1485 else if (strncmp(option, "-help", option_len) == 0)
1487 print_usage_function();
1491 else if (strncmp(option, "-basepath", option_len) == 0)
1493 if (option_arg == NULL)
1494 FailWithHelp("option '%s' requires an argument", option_str);
1496 options.base_directory = base_path = getStringCopy(option_arg);
1497 if (option_arg == next_option)
1500 // adjust paths for sub-directories in base directory accordingly
1501 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1502 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1503 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1504 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1505 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1506 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1508 else if (strncmp(option, "-levels", option_len) == 0)
1510 if (option_arg == NULL)
1511 FailWithHelp("option '%s' requires an argument", option_str);
1513 options.level_directory = getStringCopy(option_arg);
1514 if (option_arg == next_option)
1517 else if (strncmp(option, "-graphics", option_len) == 0)
1519 if (option_arg == NULL)
1520 FailWithHelp("option '%s' requires an argument", option_str);
1522 options.graphics_directory = getStringCopy(option_arg);
1523 if (option_arg == next_option)
1526 else if (strncmp(option, "-sounds", option_len) == 0)
1528 if (option_arg == NULL)
1529 FailWithHelp("option '%s' requires an argument", option_str);
1531 options.sounds_directory = getStringCopy(option_arg);
1532 if (option_arg == next_option)
1535 else if (strncmp(option, "-music", option_len) == 0)
1537 if (option_arg == NULL)
1538 FailWithHelp("option '%s' requires an argument", option_str);
1540 options.music_directory = getStringCopy(option_arg);
1541 if (option_arg == next_option)
1544 else if (strncmp(option, "-mytapes", option_len) == 0)
1546 options.mytapes = TRUE;
1548 else if (strncmp(option, "-network", option_len) == 0)
1550 options.network = TRUE;
1552 else if (strncmp(option, "-serveronly", option_len) == 0)
1554 options.serveronly = TRUE;
1556 else if (strncmp(option, "-debug", option_len) == 0)
1558 options.debug = TRUE;
1560 // optionally, debug output can be limited to a specific debug mode
1561 if (option_arg != next_option)
1562 options.debug_mode = getStringCopy(option_arg);
1564 else if (strncmp(option, "-player-name", option_len) == 0)
1566 if (option_arg == NULL)
1567 FailWithHelp("option '%s' requires an argument", option_str);
1569 options.player_name = getStringCopy(option_arg);
1570 if (option_arg == next_option)
1573 else if (strncmp(option, "-identifier", option_len) == 0)
1575 if (option_arg == NULL)
1576 FailWithHelp("option '%s' requires an argument", option_str);
1578 options.identifier = getStringCopy(option_arg);
1579 if (option_arg == next_option)
1582 else if (strncmp(option, "-level-nr", option_len) == 0)
1584 if (option_arg == NULL)
1585 FailWithHelp("option '%s' requires an argument", option_str);
1587 options.level_nr = getStringCopy(option_arg);
1588 if (option_arg == next_option)
1591 else if (strncmp(option, "-verbose", option_len) == 0)
1593 options.verbose = TRUE;
1595 else if (strncmp(option, "-version", option_len) == 0 ||
1596 strncmp(option, "-V", option_len) == 0)
1598 print_version_function();
1602 else if (strPrefix(option, "-D"))
1604 options.special_flags = getStringCopy(&option[2]);
1606 else if (strncmp(option, "-execute", option_len) == 0)
1608 if (option_arg == NULL)
1609 FailWithHelp("option '%s' requires an argument", option_str);
1611 options.execute_command = getStringCopy(option_arg);
1612 if (option_arg == next_option)
1615 // when doing batch processing, always enable verbose mode (warnings)
1616 options.verbose = TRUE;
1618 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1620 if (option_arg == NULL)
1621 FailWithHelp("option '%s' requires an argument", option_str);
1623 options.tape_log_filename = getStringCopy(option_arg);
1624 if (option_arg == next_option)
1627 else if (strncmp(option, "-display", option_len) == 0)
1629 if (option_arg == NULL)
1630 FailWithHelp("option '%s' requires an argument", option_str);
1632 if (option_arg == next_option)
1635 int display_nr = atoi(option_arg);
1638 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1639 options.display_nr = display_nr;
1641 options.display_nr =
1642 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1644 if (display_nr != options.display_nr)
1645 Warn("invalid display %d -- using display %d",
1646 display_nr, options.display_nr);
1649 #if defined(PLATFORM_MAC)
1650 else if (strPrefix(option, "-psn"))
1652 // ignore process serial number when launched via GUI on Mac OS X
1655 else if (*option == '-')
1657 FailWithHelp("unrecognized option '%s'", option_str);
1659 else if (options.server_host == NULL)
1661 options.server_host = *options_left;
1663 else if (options.server_port == 0)
1665 options.server_port = atoi(*options_left);
1666 if (options.server_port < 1024)
1667 FailWithHelp("bad port number '%d'", options.server_port);
1670 FailWithHelp("too many arguments");
1677 // ----------------------------------------------------------------------------
1678 // checked memory allocation and freeing functions
1679 // ----------------------------------------------------------------------------
1681 void *checked_malloc(unsigned int size)
1688 Fail("cannot allocate %d bytes -- out of memory", size);
1693 void *checked_calloc(unsigned int size)
1697 ptr = calloc(1, size);
1700 Fail("cannot allocate %d bytes -- out of memory", size);
1705 void *checked_realloc(void *ptr, unsigned int size)
1707 ptr = realloc(ptr, size);
1710 Fail("cannot allocate %d bytes -- out of memory", size);
1715 void checked_free(void *ptr)
1717 if (ptr != NULL) // this check should be done by free() anyway
1721 void clear_mem(void *ptr, unsigned int size)
1723 #if defined(PLATFORM_WINDOWS)
1724 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1725 char *cptr = (char *)ptr;
1730 memset(ptr, 0, size);
1735 // ----------------------------------------------------------------------------
1736 // various helper functions
1737 // ----------------------------------------------------------------------------
1739 void swap_numbers(int *i1, int *i2)
1747 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1759 int get_number_of_bits(int bits)
1762 Counting bits set, Brian Kernighan's way
1764 Brian Kernighan's method goes through as many iterations as there are set
1765 bits. So if we have a 32-bit word with only the high bit set, then it will
1766 only go once through the loop.
1768 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1769 and Dennis M. Ritchie) mentions this in exercise 2-9.
1770 First published by Peter Wegner in CACM 3 (1960), 322.
1777 bits &= bits - 1; // clear the least significant bit set
1784 /* the "put" variants of the following file access functions check for the file
1785 pointer being != NULL and return the number of bytes they have or would have
1786 written; this allows for chunk writing functions to first determine the size
1787 of the (not yet written) chunk, write the correct chunk size and finally
1788 write the chunk itself */
1790 int getFile8BitInteger(File *file)
1792 return getByteFromFile(file);
1795 int putFile8BitInteger(FILE *file, int value)
1803 int getFile16BitInteger(File *file, int byte_order)
1805 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1806 return ((getByteFromFile(file) << 8) |
1807 (getByteFromFile(file) << 0));
1808 else // BYTE_ORDER_LITTLE_ENDIAN
1809 return ((getByteFromFile(file) << 0) |
1810 (getByteFromFile(file) << 8));
1813 int putFile16BitInteger(FILE *file, int value, int byte_order)
1817 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1819 fputc((value >> 8) & 0xff, file);
1820 fputc((value >> 0) & 0xff, file);
1822 else // BYTE_ORDER_LITTLE_ENDIAN
1824 fputc((value >> 0) & 0xff, file);
1825 fputc((value >> 8) & 0xff, file);
1832 int getFile32BitInteger(File *file, int byte_order)
1834 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1835 return ((getByteFromFile(file) << 24) |
1836 (getByteFromFile(file) << 16) |
1837 (getByteFromFile(file) << 8) |
1838 (getByteFromFile(file) << 0));
1839 else // BYTE_ORDER_LITTLE_ENDIAN
1840 return ((getByteFromFile(file) << 0) |
1841 (getByteFromFile(file) << 8) |
1842 (getByteFromFile(file) << 16) |
1843 (getByteFromFile(file) << 24));
1846 int putFile32BitInteger(FILE *file, int value, int byte_order)
1850 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1852 fputc((value >> 24) & 0xff, file);
1853 fputc((value >> 16) & 0xff, file);
1854 fputc((value >> 8) & 0xff, file);
1855 fputc((value >> 0) & 0xff, file);
1857 else // BYTE_ORDER_LITTLE_ENDIAN
1859 fputc((value >> 0) & 0xff, file);
1860 fputc((value >> 8) & 0xff, file);
1861 fputc((value >> 16) & 0xff, file);
1862 fputc((value >> 24) & 0xff, file);
1869 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1872 const int chunk_name_length = 4;
1875 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1878 if (chunk_size != NULL)
1881 *chunk_size = getFile32BitInteger(file, byte_order);
1884 return (checkEndOfFile(file) ? FALSE : TRUE);
1887 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1894 fputs(chunk_name, file);
1896 num_bytes += strlen(chunk_name);
1898 if (chunk_size >= 0)
1902 putFile32BitInteger(file, chunk_size, byte_order);
1910 int getFileVersion(File *file)
1912 int version_super = getByteFromFile(file);
1913 int version_major = getByteFromFile(file);
1914 int version_minor = getByteFromFile(file);
1915 int version_patch = getByteFromFile(file);
1917 return VERSION_IDENT(version_super, version_major, version_minor,
1921 int putFileVersion(FILE *file, int version)
1925 int version_super = VERSION_SUPER(version);
1926 int version_major = VERSION_MAJOR(version);
1927 int version_minor = VERSION_MINOR(version);
1928 int version_patch = VERSION_PATCH(version);
1930 fputc(version_super, file);
1931 fputc(version_major, file);
1932 fputc(version_minor, file);
1933 fputc(version_patch, file);
1939 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1943 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1944 buffer[i] = getByteFromFile(file);
1947 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1951 for (i = 0; i < bytes; i++)
1952 fputc(buffer[i], file);
1955 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1957 while (bytes-- && !checkEndOfFile(file))
1958 getByteFromFile(file);
1961 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1968 // ----------------------------------------------------------------------------
1969 // functions to convert between ISO-8859-1 and UTF-8
1970 // ----------------------------------------------------------------------------
1972 char *getUTF8FromLatin1(char *latin1)
1974 int max_utf8_size = 2 * strlen(latin1) + 1;
1975 char *utf8 = checked_calloc(max_utf8_size);
1976 unsigned char *src = (unsigned char *)latin1;
1977 unsigned char *dst = (unsigned char *)utf8;
1981 if (*src < 128) // pure 7-bit ASCII
1985 else if (*src >= 160) // non-ASCII characters
1987 *dst++ = 194 + (*src >= 192);
1988 *dst++ = 128 + (*src & 63);
1990 else // undefined in ISO-8859-1
1998 // only use the smallest possible string buffer size
1999 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2004 char *getLatin1FromUTF8(char *utf8)
2006 int max_latin1_size = strlen(utf8) + 1;
2007 char *latin1 = checked_calloc(max_latin1_size);
2008 unsigned char *src = (unsigned char *)utf8;
2009 unsigned char *dst = (unsigned char *)latin1;
2013 if (*src < 128) // pure 7-bit ASCII
2017 else if (src[0] == 194 &&
2018 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2023 else if (src[0] == 195 &&
2024 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2026 *dst++ = src[1] + 64;
2030 // all other UTF-8 characters are undefined in ISO-8859-1
2032 else if (src[0] >= 192 && src[0] < 224 &&
2033 src[1] >= 128 && src[1] < 192)
2038 else if (src[0] >= 224 && src[0] < 240 &&
2039 src[1] >= 128 && src[1] < 192 &&
2040 src[2] >= 128 && src[2] < 192)
2045 else if (src[0] >= 240 && src[0] < 248 &&
2046 src[1] >= 128 && src[1] < 192 &&
2047 src[2] >= 128 && src[2] < 192 &&
2048 src[3] >= 128 && src[3] < 192)
2053 else if (src[0] >= 248 && src[0] < 252 &&
2054 src[1] >= 128 && src[1] < 192 &&
2055 src[2] >= 128 && src[2] < 192 &&
2056 src[3] >= 128 && src[3] < 192 &&
2057 src[4] >= 128 && src[4] < 192)
2062 else if (src[0] >= 252 && src[0] < 254 &&
2063 src[1] >= 128 && src[1] < 192 &&
2064 src[2] >= 128 && src[2] < 192 &&
2065 src[3] >= 128 && src[3] < 192 &&
2066 src[4] >= 128 && src[4] < 192 &&
2067 src[5] >= 128 && src[5] < 192)
2079 // only use the smallest possible string buffer size
2080 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2085 int getTextEncoding(char *text)
2087 unsigned char *src = (unsigned char *)text;
2088 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2093 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2099 else if (src[0] >= 192 && src[0] < 224 &&
2100 src[1] >= 128 && src[1] < 192)
2104 else if (src[0] >= 224 && src[0] < 240 &&
2105 src[1] >= 128 && src[1] < 192 &&
2106 src[2] >= 128 && src[2] < 192)
2110 else if (src[0] >= 240 && src[0] < 248 &&
2111 src[1] >= 128 && src[1] < 192 &&
2112 src[2] >= 128 && src[2] < 192 &&
2113 src[3] >= 128 && src[3] < 192)
2117 else if (src[0] >= 248 && src[0] < 252 &&
2118 src[1] >= 128 && src[1] < 192 &&
2119 src[2] >= 128 && src[2] < 192 &&
2120 src[3] >= 128 && src[3] < 192 &&
2121 src[4] >= 128 && src[4] < 192)
2125 else if (src[0] >= 252 && src[0] < 254 &&
2126 src[1] >= 128 && src[1] < 192 &&
2127 src[2] >= 128 && src[2] < 192 &&
2128 src[3] >= 128 && src[3] < 192 &&
2129 src[4] >= 128 && src[4] < 192 &&
2130 src[5] >= 128 && src[5] < 192)
2136 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2144 // ----------------------------------------------------------------------------
2145 // functions for JSON handling
2146 // ----------------------------------------------------------------------------
2148 char *getEscapedJSON(char *s)
2150 int max_json_size = 2 * strlen(s) + 1;
2151 char *json = checked_calloc(max_json_size);
2152 unsigned char *src = (unsigned char *)s;
2153 unsigned char *dst = (unsigned char *)json;
2154 char *escaped[256] =
2167 if (escaped[*src] != NULL)
2169 char *esc = escaped[*src++];
2180 // only use the smallest possible string buffer size
2181 json = checked_realloc(json, strlen(json) + 1);
2187 // ----------------------------------------------------------------------------
2188 // functions to translate key identifiers between different format
2189 // ----------------------------------------------------------------------------
2191 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2192 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2193 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2194 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2196 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2205 // return and escape keys
2206 { KSYM_Return, "XK_Return", "return" },
2207 { KSYM_Escape, "XK_Escape", "escape" },
2209 // normal cursor keys
2210 { KSYM_Left, "XK_Left", "cursor left" },
2211 { KSYM_Right, "XK_Right", "cursor right" },
2212 { KSYM_Up, "XK_Up", "cursor up" },
2213 { KSYM_Down, "XK_Down", "cursor down" },
2215 // keypad cursor keys
2217 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2218 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2219 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2220 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2223 // other keypad keys
2224 #ifdef KSYM_KP_Enter
2225 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2226 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2227 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2228 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2229 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2230 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2234 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2235 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2236 { KSYM_Control_L, "XK_Control_L", "left control" },
2237 { KSYM_Control_R, "XK_Control_R", "right control" },
2238 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2239 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2240 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2241 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2242 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2243 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2245 // some special keys
2246 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2247 { KSYM_Delete, "XK_Delete", "delete" },
2248 { KSYM_Insert, "XK_Insert", "insert" },
2249 { KSYM_Tab, "XK_Tab", "tab" },
2250 { KSYM_Home, "XK_Home", "home" },
2251 { KSYM_End, "XK_End", "end" },
2252 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2253 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2255 { KSYM_Select, "XK_Select", "select" },
2256 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2257 { KSYM_Back, "XK_Back", "back" }, // back key
2258 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2259 #if defined(PLATFORM_ANDROID)
2260 { KSYM_Rewind, "XK_Rewind", "rewind" },
2261 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2264 // ASCII 0x20 to 0x40 keys (except numbers)
2265 { KSYM_space, "XK_space", "space" },
2266 { KSYM_exclam, "XK_exclam", "!" },
2267 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2268 { KSYM_numbersign, "XK_numbersign", "#" },
2269 { KSYM_dollar, "XK_dollar", "$" },
2270 { KSYM_percent, "XK_percent", "%" },
2271 { KSYM_ampersand, "XK_ampersand", "&" },
2272 { KSYM_apostrophe, "XK_apostrophe", "'" },
2273 { KSYM_parenleft, "XK_parenleft", "(" },
2274 { KSYM_parenright, "XK_parenright", ")" },
2275 { KSYM_asterisk, "XK_asterisk", "*" },
2276 { KSYM_plus, "XK_plus", "+" },
2277 { KSYM_comma, "XK_comma", "," },
2278 { KSYM_minus, "XK_minus", "-" },
2279 { KSYM_period, "XK_period", "." },
2280 { KSYM_slash, "XK_slash", "/" },
2281 { KSYM_colon, "XK_colon", ":" },
2282 { KSYM_semicolon, "XK_semicolon", ";" },
2283 { KSYM_less, "XK_less", "<" },
2284 { KSYM_equal, "XK_equal", "=" },
2285 { KSYM_greater, "XK_greater", ">" },
2286 { KSYM_question, "XK_question", "?" },
2287 { KSYM_at, "XK_at", "@" },
2290 { KSYM_bracketleft, "XK_bracketleft", "[" },
2291 { KSYM_backslash, "XK_backslash", "\\" },
2292 { KSYM_bracketright,"XK_bracketright", "]" },
2293 { KSYM_asciicircum, "XK_asciicircum", "^" },
2294 { KSYM_underscore, "XK_underscore", "_" },
2295 { KSYM_grave, "XK_grave", "grave" },
2296 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2297 { KSYM_braceleft, "XK_braceleft", "brace left" },
2298 { KSYM_bar, "XK_bar", "bar" },
2299 { KSYM_braceright, "XK_braceright", "brace right" },
2300 { KSYM_asciitilde, "XK_asciitilde", "~" },
2302 // special (non-ASCII) keys
2303 { KSYM_degree, "XK_degree", "degree" },
2304 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2305 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2306 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2307 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2308 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2309 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2310 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2312 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2313 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2314 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2315 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2316 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2317 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2318 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2319 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2320 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2322 // other keys (for reverse mapping only)
2323 { KSYM_space, "XK_space", " " },
2325 // keypad keys are not in numerical order in SDL2
2326 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2327 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2328 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2329 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2330 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2331 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2332 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2333 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2334 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2335 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2337 // end-of-array identifier
2343 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2345 static char name_buffer[30];
2348 if (key >= KSYM_A && key <= KSYM_Z)
2349 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2350 else if (key >= KSYM_a && key <= KSYM_z)
2351 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2352 else if (key >= KSYM_0 && key <= KSYM_9)
2353 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2354 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2355 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2356 else if (key == KSYM_UNDEFINED)
2357 strcpy(name_buffer, "(undefined)");
2364 if (key == translate_key[i].key)
2366 strcpy(name_buffer, translate_key[i].name);
2370 while (translate_key[++i].name);
2372 if (!translate_key[i].name)
2373 strcpy(name_buffer, "(unknown)");
2376 *name = name_buffer;
2378 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2380 static char name_buffer[30];
2383 if (key >= KSYM_A && key <= KSYM_Z)
2384 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2385 else if (key >= KSYM_a && key <= KSYM_z)
2386 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2387 else if (key >= KSYM_0 && key <= KSYM_9)
2388 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2389 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2390 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2391 else if (key == KSYM_UNDEFINED)
2392 strcpy(name_buffer, "[undefined]");
2399 if (key == translate_key[i].key)
2401 strcpy(name_buffer, translate_key[i].x11name);
2405 while (translate_key[++i].x11name);
2407 if (!translate_key[i].x11name)
2408 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2411 *x11name = name_buffer;
2413 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2415 Key key = KSYM_UNDEFINED;
2416 char *name_ptr = *name;
2418 if (strlen(*name) == 1)
2420 char c = name_ptr[0];
2422 if (c >= 'A' && c <= 'Z')
2423 key = KSYM_A + (Key)(c - 'A');
2424 else if (c >= 'a' && c <= 'z')
2425 key = KSYM_a + (Key)(c - 'a');
2426 else if (c >= '0' && c <= '9')
2427 key = KSYM_0 + (Key)(c - '0');
2430 if (key == KSYM_UNDEFINED)
2436 if (strEqual(translate_key[i].name, *name))
2438 key = translate_key[i].key;
2442 while (translate_key[++i].x11name);
2445 if (key == KSYM_UNDEFINED)
2446 Warn("getKeyFromKeyName(): not completely implemented");
2450 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2452 Key key = KSYM_UNDEFINED;
2453 char *name_ptr = *x11name;
2455 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2457 char c = name_ptr[3];
2459 if (c >= 'A' && c <= 'Z')
2460 key = KSYM_A + (Key)(c - 'A');
2461 else if (c >= 'a' && c <= 'z')
2462 key = KSYM_a + (Key)(c - 'a');
2463 else if (c >= '0' && c <= '9')
2464 key = KSYM_0 + (Key)(c - '0');
2466 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2468 char c1 = name_ptr[4];
2469 char c2 = name_ptr[5];
2472 if ((c1 >= '0' && c1 <= '9') &&
2473 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2474 d = atoi(&name_ptr[4]);
2476 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2477 key = KSYM_F1 + (Key)(d - 1);
2479 else if (strPrefix(name_ptr, "XK_"))
2485 if (strEqual(name_ptr, translate_key[i].x11name))
2487 key = translate_key[i].key;
2491 while (translate_key[++i].x11name);
2493 else if (strPrefix(name_ptr, "0x"))
2495 unsigned int value = 0;
2501 char c = *name_ptr++;
2504 if (c >= '0' && c <= '9')
2506 else if (c >= 'a' && c <= 'f')
2507 d = (int)(c - 'a' + 10);
2508 else if (c >= 'A' && c <= 'F')
2509 d = (int)(c - 'A' + 10);
2517 value = value * 16 + d;
2528 char *getKeyNameFromKey(Key key)
2532 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2536 char *getX11KeyNameFromKey(Key key)
2540 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2544 Key getKeyFromKeyName(char *name)
2548 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2552 Key getKeyFromX11KeyName(char *x11name)
2556 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2560 char getCharFromKey(Key key)
2566 } translate_key_char[] =
2568 // special (non-ASCII) keys (ISO-8859-1)
2569 { KSYM_degree, CHAR_BYTE_DEGREE },
2570 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2571 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2572 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2573 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2574 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2575 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2576 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2578 // end-of-array identifier
2582 char *keyname = getKeyNameFromKey(key);
2585 if (strlen(keyname) == 1)
2587 else if (strEqual(keyname, "space"))
2595 if (key == translate_key_char[i].key)
2597 c = translate_key_char[i].key_char;
2602 while (translate_key_char[++i].key_char);
2608 char getValidConfigValueChar(char c)
2610 if (c == '#' || // used to mark comments
2611 c == '\\') // used to mark continued lines
2618 // ----------------------------------------------------------------------------
2619 // functions to translate string identifiers to integer or boolean value
2620 // ----------------------------------------------------------------------------
2622 int get_integer_from_string(char *s)
2624 // check for the most common case first
2625 if (s[0] >= '0' && s[0] <= '9')
2628 char *s_lower = getStringToLower(s);
2631 if (strEqual(s_lower, "false") ||
2632 strEqual(s_lower, "no") ||
2633 strEqual(s_lower, "off"))
2635 else if (strEqual(s_lower, "true") ||
2636 strEqual(s_lower, "yes") ||
2637 strEqual(s_lower, "on"))
2647 boolean get_boolean_from_string(char *s)
2649 char *s_lower = getStringToLower(s);
2650 boolean result = FALSE;
2652 if (strEqual(s_lower, "true") ||
2653 strEqual(s_lower, "yes") ||
2654 strEqual(s_lower, "on") ||
2655 get_integer_from_string(s) == 1)
2663 int get_switch3_from_string(char *s)
2665 char *s_lower = getStringToLower(s);
2668 if (strEqual(s_lower, "true") ||
2669 strEqual(s_lower, "yes") ||
2670 strEqual(s_lower, "on") ||
2671 get_integer_from_string(s) == 1)
2673 else if (strEqual(s_lower, "auto"))
2681 int get_player_nr_from_string(char *s)
2683 static char *player_text[] =
2693 char *s_lower = getStringToLower(s);
2697 for (i = 0; player_text[i] != NULL; i++)
2698 if (strEqual(s_lower, player_text[i]))
2707 // ----------------------------------------------------------------------------
2708 // functions for generic lists
2709 // ----------------------------------------------------------------------------
2711 ListNode *newListNode(void)
2713 return checked_calloc(sizeof(ListNode));
2716 void addNodeToList(ListNode **node_first, char *key, void *content)
2718 ListNode *node_new = newListNode();
2720 node_new->key = getStringCopy(key);
2721 node_new->content = content;
2722 node_new->next = *node_first;
2725 (*node_first)->prev = node_new;
2727 *node_first = node_new;
2730 void deleteNodeFromList(ListNode **node_first, char *key,
2731 void (*destructor_function)(void *))
2733 if (node_first == NULL || *node_first == NULL)
2736 if (strEqual((*node_first)->key, key))
2738 // after first recursion, (*node_first)->prev->next == *node_first,
2739 // so *node_first would be overwritten with (*node_first)->next
2740 // => use a copy of *node_first (and later of (*node_first)->next)
2741 ListNode *node = *node_first;
2742 ListNode *node_next = node->next;
2744 checked_free(node->key);
2746 if (destructor_function)
2747 destructor_function(node->content);
2750 node->prev->next = node->next;
2753 node->next->prev = node->prev;
2757 // after removing node, set list pointer to next valid list node
2758 // (this is important if the first node of the list was deleted)
2759 *node_first = node_next;
2763 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2767 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2769 if (node_first == NULL)
2772 if (strEqual(node_first->key, key))
2775 return getNodeFromKey(node_first->next, key);
2778 int getNumNodes(ListNode *node_first)
2780 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2784 static void dumpList(ListNode *node_first)
2786 ListNode *node = node_first;
2790 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2791 ((struct ListNodeInfo *)node->content)->num_references);
2795 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2800 // ----------------------------------------------------------------------------
2801 // functions for file handling
2802 // ----------------------------------------------------------------------------
2804 #define MAX_BUFFER_SIZE 4096
2806 File *openFile(char *filename, char *mode)
2808 File *file = checked_calloc(sizeof(File));
2810 file->file = fopen(filename, mode);
2812 if (file->file != NULL)
2814 file->filename = getStringCopy(filename);
2819 #if defined(PLATFORM_ANDROID)
2820 file->asset_file = SDL_RWFromFile(filename, mode);
2822 if (file->asset_file != NULL)
2824 file->file_is_asset = TRUE;
2825 file->filename = getStringCopy(filename);
2836 int closeFile(File *file)
2843 #if defined(PLATFORM_ANDROID)
2844 if (file->asset_file)
2845 result = SDL_RWclose(file->asset_file);
2849 result = fclose(file->file);
2851 checked_free(file->filename);
2857 int checkEndOfFile(File *file)
2859 #if defined(PLATFORM_ANDROID)
2860 if (file->file_is_asset)
2861 return file->end_of_file;
2864 return feof(file->file);
2867 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2869 #if defined(PLATFORM_ANDROID)
2870 if (file->file_is_asset)
2872 if (file->end_of_file)
2875 size_t num_items_read =
2876 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2878 if (num_items_read < num_items)
2879 file->end_of_file = TRUE;
2881 return num_items_read;
2885 return fread(buffer, item_size, num_items, file->file);
2888 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2890 return fwrite(buffer, item_size, num_items, file->file);
2893 int seekFile(File *file, long offset, int whence)
2895 #if defined(PLATFORM_ANDROID)
2896 if (file->file_is_asset)
2898 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2899 whence == SEEK_CUR ? RW_SEEK_CUR :
2900 whence == SEEK_END ? RW_SEEK_END : 0);
2902 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2906 return fseek(file->file, offset, whence);
2909 int getByteFromFile(File *file)
2911 #if defined(PLATFORM_ANDROID)
2912 if (file->file_is_asset)
2914 if (file->end_of_file)
2918 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2920 if (num_bytes_read < 1)
2921 file->end_of_file = TRUE;
2923 return (file->end_of_file ? EOF : (int)c);
2927 return fgetc(file->file);
2930 char *getStringFromFile(File *file, char *line, int size)
2932 #if defined(PLATFORM_ANDROID)
2933 if (file->file_is_asset)
2935 if (file->end_of_file)
2938 char *line_ptr = line;
2939 int num_bytes_read = 0;
2941 while (num_bytes_read < size - 1 &&
2942 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2943 *line_ptr++ != '\n')
2948 if (strlen(line) == 0)
2950 file->end_of_file = TRUE;
2959 return fgets(line, size, file->file);
2962 int copyFile(char *filename_from, char *filename_to)
2964 File *file_from, *file_to;
2966 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2971 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2973 closeFile(file_from);
2978 while (!checkEndOfFile(file_from))
2980 byte buffer[MAX_BUFFER_SIZE];
2981 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2983 writeFile(file_to, buffer, 1, bytes_read);
2986 closeFile(file_from);
2992 boolean touchFile(char *filename)
2996 if (!(file = fopen(filename, MODE_WRITE)))
2998 Warn("cannot touch file '%s'", filename);
3009 // ----------------------------------------------------------------------------
3010 // functions for directory handling
3011 // ----------------------------------------------------------------------------
3013 Directory *openDirectory(char *dir_name)
3015 Directory *dir = checked_calloc(sizeof(Directory));
3017 dir->dir = opendir(dir_name);
3019 if (dir->dir != NULL)
3021 dir->filename = getStringCopy(dir_name);
3026 #if defined(PLATFORM_ANDROID)
3027 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3029 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3031 checked_free(asset_toc_filename);
3033 if (dir->asset_toc_file != NULL)
3035 dir->directory_is_asset = TRUE;
3036 dir->filename = getStringCopy(dir_name);
3047 int closeDirectory(Directory *dir)
3054 #if defined(PLATFORM_ANDROID)
3055 if (dir->asset_toc_file)
3056 result = SDL_RWclose(dir->asset_toc_file);
3060 result = closedir(dir->dir);
3063 freeDirectoryEntry(dir->dir_entry);
3065 checked_free(dir->filename);
3071 DirectoryEntry *readDirectory(Directory *dir)
3074 freeDirectoryEntry(dir->dir_entry);
3076 dir->dir_entry = NULL;
3078 #if defined(PLATFORM_ANDROID)
3079 if (dir->directory_is_asset)
3081 char line[MAX_LINE_LEN];
3082 char *line_ptr = line;
3083 int num_bytes_read = 0;
3085 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3086 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3095 if (strlen(line) == 0)
3098 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3100 dir->dir_entry->is_directory = FALSE;
3101 if (line[strlen(line) - 1] == '/')
3103 dir->dir_entry->is_directory = TRUE;
3105 line[strlen(line) - 1] = '\0';
3108 dir->dir_entry->basename = getStringCopy(line);
3109 dir->dir_entry->filename = getPath2(dir->filename, line);
3111 return dir->dir_entry;
3115 struct dirent *dir_entry = readdir(dir->dir);
3117 if (dir_entry == NULL)
3120 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3122 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3123 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3125 struct stat file_status;
3127 dir->dir_entry->is_directory =
3128 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3129 S_ISDIR(file_status.st_mode));
3131 return dir->dir_entry;
3134 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3136 if (dir_entry == NULL)
3139 checked_free(dir_entry->basename);
3140 checked_free(dir_entry->filename);
3141 checked_free(dir_entry);
3145 // ----------------------------------------------------------------------------
3146 // functions for checking files and filenames
3147 // ----------------------------------------------------------------------------
3149 boolean directoryExists(const char *dir_name)
3151 if (dir_name == NULL)
3154 struct stat file_status;
3155 boolean success = (stat(dir_name, &file_status) == 0 &&
3156 S_ISDIR(file_status.st_mode));
3158 #if defined(PLATFORM_ANDROID)
3161 // this might be an asset directory; check by trying to open toc file
3162 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3163 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3165 checked_free(asset_toc_filename);
3167 success = (file != NULL);
3177 boolean fileExists(const char *filename)
3179 if (filename == NULL)
3182 boolean success = (access(filename, F_OK) == 0);
3184 #if defined(PLATFORM_ANDROID)
3187 // this might be an asset file; check by trying to open it
3188 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3190 success = (file != NULL);
3201 static boolean fileHasPrefix(const char *basename, const char *prefix)
3203 static char *basename_lower = NULL;
3204 int basename_length, prefix_length;
3206 checked_free(basename_lower);
3208 if (basename == NULL || prefix == NULL)
3211 basename_lower = getStringToLower(basename);
3212 basename_length = strlen(basename_lower);
3213 prefix_length = strlen(prefix);
3215 if (basename_length > prefix_length + 1 &&
3216 basename_lower[prefix_length] == '.' &&
3217 strncmp(basename_lower, prefix, prefix_length) == 0)
3224 static boolean fileHasSuffix(const char *basename, const char *suffix)
3226 static char *basename_lower = NULL;
3227 int basename_length, suffix_length;
3229 checked_free(basename_lower);
3231 if (basename == NULL || suffix == NULL)
3234 basename_lower = getStringToLower(basename);
3235 basename_length = strlen(basename_lower);
3236 suffix_length = strlen(suffix);
3238 if (basename_length > suffix_length + 1 &&
3239 basename_lower[basename_length - suffix_length - 1] == '.' &&
3240 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3246 static boolean FileCouldBeArtwork(char *filename)
3248 char *basename = getBaseNamePtr(filename);
3250 return (!strEqual(basename, ".") &&
3251 !strEqual(basename, "..") &&
3252 !fileHasSuffix(basename, "txt") &&
3253 !fileHasSuffix(basename, "conf") &&
3254 !directoryExists(filename));
3257 boolean FileIsGraphic(char *filename)
3259 return FileCouldBeArtwork(filename);
3262 boolean FileIsSound(char *filename)
3264 return FileCouldBeArtwork(filename);
3267 boolean FileIsMusic(char *filename)
3269 return FileCouldBeArtwork(filename);
3272 boolean FileIsArtworkType(char *filename, int type)
3274 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3275 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3276 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3282 // ----------------------------------------------------------------------------
3283 // functions for loading artwork configuration information
3284 // ----------------------------------------------------------------------------
3286 char *get_mapped_token(char *token)
3288 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3289 static char *map_token_prefix[][2] =
3291 { "char_procent", "char_percent" },
3292 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3293 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3294 { "bd_butterfly_left", "bd_butterfly.left" },
3295 { "bd_butterfly_right", "bd_butterfly.right" },
3296 { "bd_butterfly_up", "bd_butterfly.up" },
3297 { "bd_butterfly_down", "bd_butterfly.down" },
3298 { "bd_firefly_left", "bd_firefly.left" },
3299 { "bd_firefly_right", "bd_firefly.right" },
3300 { "bd_firefly_up", "bd_firefly.up" },
3301 { "bd_firefly_down", "bd_firefly.down" },
3307 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3309 int len_token_prefix = strlen(map_token_prefix[i][0]);
3311 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3312 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3315 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3316 char *gfx_substring = ".gfx";
3317 char *gfx_prefix = "gfx.";
3318 if (strstr(token, gfx_substring) != NULL)
3320 char *token_prefix = getStringCopy(token);
3321 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3322 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3325 // cut off token string at ".gfx" substring position
3326 *token_gfx_pos = '\0';
3328 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3329 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3333 return mapped_token;
3339 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3342 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3343 static struct ConfigTypeInfo prefix_list[] =
3345 { "global.anim_1" },
3346 { "global.anim_2" },
3347 { "global.anim_3" },
3348 { "global.anim_4" },
3349 { "global.anim_5" },
3350 { "global.anim_6" },
3351 { "global.anim_7" },
3352 { "global.anim_8" },
3353 { "global.anim_9" },
3354 { "global.anim_10" },
3355 { "global.anim_11" },
3356 { "global.anim_12" },
3357 { "global.anim_13" },
3358 { "global.anim_14" },
3359 { "global.anim_15" },
3360 { "global.anim_16" },
3361 { "global.anim_17" },
3362 { "global.anim_18" },
3363 { "global.anim_19" },
3364 { "global.anim_20" },
3365 { "global.anim_21" },
3366 { "global.anim_22" },
3367 { "global.anim_23" },
3368 { "global.anim_24" },
3369 { "global.anim_25" },
3370 { "global.anim_26" },
3371 { "global.anim_27" },
3372 { "global.anim_28" },
3373 { "global.anim_29" },
3374 { "global.anim_30" },
3375 { "global.anim_31" },
3376 { "global.anim_32" },
3380 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3381 boolean prefix_found = FALSE;
3385 // search for prefix to check if base token has to be created
3386 for (i = 0; prefix_list[i].token != NULL; i++)
3387 if (strPrefix(token, prefix_list[i].token))
3388 prefix_found = TRUE;
3393 // search for suffix (parameter) to determine base token length
3394 for (i = 0; suffix_list[i].token != NULL; i++)
3395 if (strSuffix(token, suffix_list[i].token))
3396 len_suffix = strlen(suffix_list[i].token);
3398 return getStringCopyN(token, strlen(token) - len_suffix);
3401 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3402 struct ListNodeInfo ***, int *);
3404 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3405 struct ConfigTypeInfo *suffix_list,
3406 char **ignore_tokens,
3407 int num_file_list_entries)
3409 SetupFileHash *ignore_tokens_hash;
3410 struct FileInfo *file_list;
3411 int num_file_list_entries_found = 0;
3412 int num_suffix_list_entries = 0;
3416 // create hash from list of tokens to be ignored (for quick access)
3417 ignore_tokens_hash = newSetupFileHash();
3418 for (i = 0; ignore_tokens[i] != NULL; i++)
3419 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3421 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3423 for (i = 0; suffix_list[i].token != NULL; i++)
3424 num_suffix_list_entries++;
3426 // always start with reliable default values
3427 for (i = 0; i < num_file_list_entries; i++)
3429 file_list[i].token = NULL;
3431 file_list[i].default_filename = NULL;
3432 file_list[i].filename = NULL;
3434 if (num_suffix_list_entries > 0)
3436 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3438 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3439 file_list[i].parameter = checked_calloc(parameter_array_size);
3441 for (j = 0; j < num_suffix_list_entries; j++)
3443 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3444 setString(&file_list[i].parameter[j], suffix_list[j].value);
3447 file_list[i].redefined = FALSE;
3448 file_list[i].fallback_to_default = FALSE;
3449 file_list[i].default_is_cloned = FALSE;
3455 for (i = 0; config_list[i].token != NULL; i++)
3457 int len_config_token = strlen(config_list[i].token);
3458 boolean is_file_entry = TRUE;
3460 for (j = 0; suffix_list[j].token != NULL; j++)
3462 int len_suffix = strlen(suffix_list[j].token);
3464 if (len_suffix < len_config_token &&
3465 strEqual(&config_list[i].token[len_config_token - len_suffix],
3466 suffix_list[j].token))
3468 setString(&file_list[list_pos].default_parameter[j],
3469 config_list[i].value);
3471 is_file_entry = FALSE;
3477 // the following tokens are no file definitions, but other config tokens
3478 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3479 is_file_entry = FALSE;
3486 if (list_pos >= num_file_list_entries)
3489 file_list[list_pos].token = config_list[i].token;
3490 file_list[list_pos].default_filename = config_list[i].value;
3493 if (strSuffix(config_list[i].token, ".clone_from"))
3494 file_list[list_pos].default_is_cloned = TRUE;
3497 num_file_list_entries_found = list_pos + 1;
3498 if (num_file_list_entries_found != num_file_list_entries)
3501 Error("inconsistant config list information:");
3502 Error("- should be: %d (according to 'src/conf_xxx.h')",
3503 num_file_list_entries);
3504 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3505 num_file_list_entries_found);
3510 freeSetupFileHash(ignore_tokens_hash);
3515 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3517 int len_token = strlen(token);
3518 int len_suffix = strlen(suffix);
3520 if (start_pos < 0) // compare suffix from end of string
3521 start_pos += len_token;
3523 if (start_pos < 0 || start_pos + len_suffix > len_token)
3526 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3529 if (token[start_pos + len_suffix] == '\0')
3532 if (token[start_pos + len_suffix] == '.')
3538 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3540 static void read_token_parameters(SetupFileHash *setup_file_hash,
3541 struct ConfigTypeInfo *suffix_list,
3542 struct FileInfo *file_list_entry)
3544 // check for config token that is the base token without any suffixes
3545 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3546 char *known_token_value = KNOWN_TOKEN_VALUE;
3549 if (filename != NULL)
3551 setString(&file_list_entry->filename, filename);
3553 // when file definition found, set all parameters to default values
3554 for (i = 0; suffix_list[i].token != NULL; i++)
3555 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3557 file_list_entry->redefined = TRUE;
3559 // mark config file token as well known from default config
3560 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3563 // check for config tokens that can be build by base token and suffixes
3564 for (i = 0; suffix_list[i].token != NULL; i++)
3566 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3567 char *value = getHashEntry(setup_file_hash, token);
3571 setString(&file_list_entry->parameter[i], value);
3573 // mark config file token as well known from default config
3574 setHashEntry(setup_file_hash, token, known_token_value);
3581 static void add_dynamic_file_list_entry(struct FileInfo **list,
3582 int *num_list_entries,
3583 SetupFileHash *extra_file_hash,
3584 struct ConfigTypeInfo *suffix_list,
3585 int num_suffix_list_entries,
3588 struct FileInfo *new_list_entry;
3589 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3591 (*num_list_entries)++;
3592 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3593 new_list_entry = &(*list)[*num_list_entries - 1];
3595 new_list_entry->token = getStringCopy(token);
3596 new_list_entry->default_filename = NULL;
3597 new_list_entry->filename = NULL;
3598 new_list_entry->parameter = checked_calloc(parameter_array_size);
3600 new_list_entry->redefined = FALSE;
3601 new_list_entry->fallback_to_default = FALSE;
3602 new_list_entry->default_is_cloned = FALSE;
3604 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3607 static void add_property_mapping(struct PropertyMapping **list,
3608 int *num_list_entries,
3609 int base_index, int ext1_index,
3610 int ext2_index, int ext3_index,
3613 struct PropertyMapping *new_list_entry;
3615 (*num_list_entries)++;
3616 *list = checked_realloc(*list,
3617 *num_list_entries * sizeof(struct PropertyMapping));
3618 new_list_entry = &(*list)[*num_list_entries - 1];
3620 new_list_entry->base_index = base_index;
3621 new_list_entry->ext1_index = ext1_index;
3622 new_list_entry->ext2_index = ext2_index;
3623 new_list_entry->ext3_index = ext3_index;
3625 new_list_entry->artwork_index = artwork_index;
3628 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3631 struct FileInfo *file_list = artwork_info->file_list;
3632 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3633 char **base_prefixes = artwork_info->base_prefixes;
3634 char **ext1_suffixes = artwork_info->ext1_suffixes;
3635 char **ext2_suffixes = artwork_info->ext2_suffixes;
3636 char **ext3_suffixes = artwork_info->ext3_suffixes;
3637 char **ignore_tokens = artwork_info->ignore_tokens;
3638 int num_file_list_entries = artwork_info->num_file_list_entries;
3639 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3640 int num_base_prefixes = artwork_info->num_base_prefixes;
3641 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3642 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3643 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3644 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3645 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3646 SetupFileHash *extra_file_hash, *empty_file_hash;
3647 char *known_token_value = KNOWN_TOKEN_VALUE;
3648 char *base_token_value = UNDEFINED_FILENAME;
3651 if (filename == NULL)
3654 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3657 // separate valid (defined) from empty (undefined) config token values
3658 valid_file_hash = newSetupFileHash();
3659 empty_file_hash = newSetupFileHash();
3660 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3662 char *value = HASH_ITERATION_VALUE(itr);
3664 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3665 HASH_ITERATION_TOKEN(itr), value);
3667 END_HASH_ITERATION(setup_file_hash, itr)
3669 // at this point, we do not need the setup file hash anymore -- free it
3670 freeSetupFileHash(setup_file_hash);
3672 // prevent changing hash while iterating over it by using a temporary copy
3673 valid_file_hash_tmp = newSetupFileHash();
3674 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3676 setHashEntry(valid_file_hash_tmp,
3677 HASH_ITERATION_TOKEN(itr),
3678 HASH_ITERATION_VALUE(itr));
3680 END_HASH_ITERATION(valid_file_hash, itr)
3682 // (iterate over same temporary hash, as modifications are independent)
3684 // map deprecated to current tokens (using prefix match and replace)
3685 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3687 char *token = HASH_ITERATION_TOKEN(itr);
3688 char *mapped_token = get_mapped_token(token);
3690 if (mapped_token != NULL)
3692 char *value = HASH_ITERATION_VALUE(itr);
3695 setHashEntry(valid_file_hash, mapped_token, value);
3697 // ignore old token (by setting it to "known" keyword)
3698 setHashEntry(valid_file_hash, token, known_token_value);
3703 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3705 // add special base tokens (using prefix match and replace)
3706 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3708 char *token = HASH_ITERATION_TOKEN(itr);
3709 char *base_token = get_special_base_token(artwork_info, token);
3711 if (base_token != NULL)
3713 // add base token only if it does not already exist
3714 if (getHashEntry(valid_file_hash, base_token) == NULL)
3715 setHashEntry(valid_file_hash, base_token, base_token_value);
3720 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3722 // free temporary hash used for iteration
3723 freeSetupFileHash(valid_file_hash_tmp);
3725 // read parameters for all known config file tokens
3726 for (i = 0; i < num_file_list_entries; i++)
3727 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3729 // set all tokens that can be ignored here to "known" keyword
3730 for (i = 0; i < num_ignore_tokens; i++)
3731 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3733 // copy all unknown config file tokens to extra config hash
3734 extra_file_hash = newSetupFileHash();
3735 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3737 char *value = HASH_ITERATION_VALUE(itr);
3739 if (!strEqual(value, known_token_value))
3740 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3742 END_HASH_ITERATION(valid_file_hash, itr)
3744 // at this point, we do not need the valid file hash anymore -- free it
3745 freeSetupFileHash(valid_file_hash);
3747 // now try to determine valid, dynamically defined config tokens
3749 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3751 struct FileInfo **dynamic_file_list =
3752 &artwork_info->dynamic_file_list;
3753 int *num_dynamic_file_list_entries =
3754 &artwork_info->num_dynamic_file_list_entries;
3755 struct PropertyMapping **property_mapping =
3756 &artwork_info->property_mapping;
3757 int *num_property_mapping_entries =
3758 &artwork_info->num_property_mapping_entries;
3759 int current_summarized_file_list_entry =
3760 artwork_info->num_file_list_entries +
3761 artwork_info->num_dynamic_file_list_entries;
3762 char *token = HASH_ITERATION_TOKEN(itr);
3763 int len_token = strlen(token);
3765 boolean base_prefix_found = FALSE;
3766 boolean parameter_suffix_found = FALSE;
3768 // skip all parameter definitions (handled by read_token_parameters())
3769 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3771 int len_suffix = strlen(suffix_list[i].token);
3773 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3774 parameter_suffix_found = TRUE;
3777 if (parameter_suffix_found)
3780 // ---------- step 0: search for matching base prefix ----------
3783 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3785 char *base_prefix = base_prefixes[i];
3786 int len_base_prefix = strlen(base_prefix);
3787 boolean ext1_suffix_found = FALSE;
3788 boolean ext2_suffix_found = FALSE;
3789 boolean ext3_suffix_found = FALSE;
3790 boolean exact_match = FALSE;
3791 int base_index = -1;
3792 int ext1_index = -1;
3793 int ext2_index = -1;
3794 int ext3_index = -1;
3796 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3798 if (!base_prefix_found)
3803 if (start_pos + len_base_prefix == len_token) // exact match
3807 add_dynamic_file_list_entry(dynamic_file_list,
3808 num_dynamic_file_list_entries,
3811 num_suffix_list_entries,
3813 add_property_mapping(property_mapping,
3814 num_property_mapping_entries,
3815 base_index, -1, -1, -1,
3816 current_summarized_file_list_entry);
3820 // ---------- step 1: search for matching first suffix ----------
3822 start_pos += len_base_prefix;
3823 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3825 char *ext1_suffix = ext1_suffixes[j];
3826 int len_ext1_suffix = strlen(ext1_suffix);
3828 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3830 if (!ext1_suffix_found)
3835 if (start_pos + len_ext1_suffix == len_token) // exact match
3839 add_dynamic_file_list_entry(dynamic_file_list,
3840 num_dynamic_file_list_entries,
3843 num_suffix_list_entries,
3845 add_property_mapping(property_mapping,
3846 num_property_mapping_entries,
3847 base_index, ext1_index, -1, -1,
3848 current_summarized_file_list_entry);
3852 start_pos += len_ext1_suffix;
3858 // ---------- step 2: search for matching second suffix ----------
3860 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3862 char *ext2_suffix = ext2_suffixes[k];
3863 int len_ext2_suffix = strlen(ext2_suffix);
3865 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3867 if (!ext2_suffix_found)
3872 if (start_pos + len_ext2_suffix == len_token) // exact match
3876 add_dynamic_file_list_entry(dynamic_file_list,
3877 num_dynamic_file_list_entries,
3880 num_suffix_list_entries,
3882 add_property_mapping(property_mapping,
3883 num_property_mapping_entries,
3884 base_index, ext1_index, ext2_index, -1,
3885 current_summarized_file_list_entry);
3889 start_pos += len_ext2_suffix;
3895 // ---------- step 3: search for matching third suffix ----------
3897 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3899 char *ext3_suffix = ext3_suffixes[l];
3900 int len_ext3_suffix = strlen(ext3_suffix);
3902 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3904 if (!ext3_suffix_found)
3909 if (start_pos + len_ext3_suffix == len_token) // exact match
3913 add_dynamic_file_list_entry(dynamic_file_list,
3914 num_dynamic_file_list_entries,
3917 num_suffix_list_entries,
3919 add_property_mapping(property_mapping,
3920 num_property_mapping_entries,
3921 base_index, ext1_index, ext2_index, ext3_index,
3922 current_summarized_file_list_entry);
3928 END_HASH_ITERATION(extra_file_hash, itr)
3930 if (artwork_info->num_dynamic_file_list_entries > 0)
3932 artwork_info->dynamic_artwork_list =
3933 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3934 artwork_info->sizeof_artwork_list_entry);
3937 if (options.verbose && IS_PARENT_PROCESS())
3939 SetupFileList *setup_file_list, *list;
3940 boolean dynamic_tokens_found = FALSE;
3941 boolean unknown_tokens_found = FALSE;
3942 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3944 // list may be NULL for empty artwork config files
3945 setup_file_list = loadSetupFileList(filename);
3947 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3949 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3950 dynamic_tokens_found = TRUE;
3952 unknown_tokens_found = TRUE;
3954 END_HASH_ITERATION(extra_file_hash, itr)
3956 if (options.debug && dynamic_tokens_found)
3958 Debug("config", "---");
3959 Debug("config", "dynamic token(s) found in config file:");
3960 Debug("config", "- config file: '%s'", filename);
3962 for (list = setup_file_list; list != NULL; list = list->next)
3964 char *value = getHashEntry(extra_file_hash, list->token);
3966 if (value != NULL && strEqual(value, known_token_value))
3967 Debug("config", "- dynamic token: '%s'", list->token);
3970 Debug("config", "---");
3973 if (unknown_tokens_found)
3976 Warn("unknown token(s) found in config file:");
3977 Warn("- config file: '%s'", filename);
3979 for (list = setup_file_list; list != NULL; list = list->next)
3981 char *value = getHashEntry(extra_file_hash, list->token);
3983 if (value != NULL && !strEqual(value, known_token_value))
3984 Warn("- dynamic token: '%s'", list->token);
3990 if (undefined_values_found)
3993 Warn("undefined values found in config file:");
3994 Warn("- config file: '%s'", filename);
3996 for (list = setup_file_list; list != NULL; list = list->next)
3998 char *value = getHashEntry(empty_file_hash, list->token);
4001 Warn("- undefined value for token: '%s'", list->token);
4007 freeSetupFileList(setup_file_list);
4010 freeSetupFileHash(extra_file_hash);
4011 freeSetupFileHash(empty_file_hash);
4014 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4016 struct FileInfo *file_list = artwork_info->file_list;
4017 int num_file_list_entries = artwork_info->num_file_list_entries;
4018 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4019 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4022 DrawInitTextHead("Loading artwork config");
4023 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4025 // always start with reliable default values
4026 for (i = 0; i < num_file_list_entries; i++)
4028 setString(&file_list[i].filename, file_list[i].default_filename);
4030 for (j = 0; j < num_suffix_list_entries; j++)
4031 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4033 file_list[i].redefined = FALSE;
4034 file_list[i].fallback_to_default = FALSE;
4037 // free previous dynamic artwork file array
4038 if (artwork_info->dynamic_file_list != NULL)
4040 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4042 free(artwork_info->dynamic_file_list[i].token);
4043 free(artwork_info->dynamic_file_list[i].filename);
4044 free(artwork_info->dynamic_file_list[i].parameter);
4047 free(artwork_info->dynamic_file_list);
4048 artwork_info->dynamic_file_list = NULL;
4050 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4051 &artwork_info->num_dynamic_file_list_entries);
4054 // free previous property mapping
4055 if (artwork_info->property_mapping != NULL)
4057 free(artwork_info->property_mapping);
4059 artwork_info->property_mapping = NULL;
4060 artwork_info->num_property_mapping_entries = 0;
4063 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4065 // first look for special artwork configured in level series config
4066 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4068 if (fileExists(filename_base))
4069 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4072 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4074 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4075 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4078 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4079 struct ListNodeInfo **listnode)
4083 char *filename = (*listnode)->source_filename;
4085 if (--(*listnode)->num_references <= 0)
4086 deleteNodeFromList(&artwork_info->content_list, filename,
4087 artwork_info->free_artwork);
4093 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4094 struct ListNodeInfo **listnode,
4095 struct FileInfo *file_list_entry)
4105 char *basename = file_list_entry->filename;
4106 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4108 // mark all images from non-default graphics directory as "redefined"
4109 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4110 !strPrefix(filename, options.graphics_directory))
4111 file_list_entry->redefined = TRUE;
4113 if (filename == NULL)
4115 Warn("cannot find artwork file '%s'", basename);
4117 basename = file_list_entry->default_filename;
4119 // fail for cloned default artwork that has no default filename defined
4120 if (file_list_entry->default_is_cloned &&
4121 strEqual(basename, UNDEFINED_FILENAME))
4123 void (*error_func)(char *, ...) = Warn;
4125 // we can get away without sounds and music, but not without graphics
4126 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4129 error_func("token '%s' was cloned and has no default filename",
4130 file_list_entry->token);
4135 // dynamic artwork has no default filename / skip empty default artwork
4136 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4139 file_list_entry->fallback_to_default = TRUE;
4141 Warn("trying default artwork file '%s'", basename);
4143 filename = getCustomArtworkFilename(basename, artwork_info->type);
4145 if (filename == NULL)
4147 void (*error_func)(char *, ...) = Warn;
4149 // we can get away without sounds and music, but not without graphics
4150 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4153 error_func("cannot find default artwork file '%s'", basename);
4159 // check if the old and the new artwork file are the same
4160 if (*listnode && strEqual((*listnode)->source_filename, filename))
4162 // The old and new artwork are the same (have the same filename and path).
4163 // This usually means that this artwork does not exist in this artwork set
4164 // and a fallback to the existing artwork is done.
4169 // delete existing artwork file entry
4170 deleteArtworkListEntry(artwork_info, listnode);
4172 // check if the new artwork file already exists in the list of artwork
4173 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4175 *listnode = (struct ListNodeInfo *)node->content;
4176 (*listnode)->num_references++;
4181 DrawInitTextHead(init_text[artwork_info->type]);
4182 DrawInitTextItem(basename);
4184 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4186 // add new artwork file entry to the list of artwork files
4187 (*listnode)->num_references = 1;
4188 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4193 void (*error_func)(char *, ...) = Warn;
4195 // we can get away without sounds and music, but not without graphics
4196 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4199 error_func("cannot load artwork file '%s'", basename);
4205 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4206 struct ListNodeInfo **listnode,
4207 struct FileInfo *file_list_entry)
4209 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4211 deleteArtworkListEntry(artwork_info, listnode);
4216 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4219 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4221 struct FileInfo *file_list = artwork_info->file_list;
4222 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4223 int num_file_list_entries = artwork_info->num_file_list_entries;
4224 int num_dynamic_file_list_entries =
4225 artwork_info->num_dynamic_file_list_entries;
4228 print_timestamp_init("ReloadCustomArtworkList");
4230 for (i = 0; i < num_file_list_entries; i++)
4231 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4234 for (i = 0; i < num_dynamic_file_list_entries; i++)
4235 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4236 &dynamic_file_list[i]);
4238 print_timestamp_done("ReloadCustomArtworkList");
4241 dumpList(artwork_info->content_list);
4245 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4246 struct ListNodeInfo ***list,
4247 int *num_list_entries)
4254 for (i = 0; i < *num_list_entries; i++)
4255 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4259 *num_list_entries = 0;
4262 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4264 if (artwork_info == NULL)
4267 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4268 &artwork_info->num_file_list_entries);
4270 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4271 &artwork_info->num_dynamic_file_list_entries);
4275 // ----------------------------------------------------------------------------
4276 // functions only needed for non-Unix (non-command-line) systems
4277 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4278 // (now also added for Windows, to create files in user data directory)
4279 // ----------------------------------------------------------------------------
4281 char *getLogBasename(char *basename)
4283 return getStringCat2(basename, ".log");
4286 char *getLogFilename(char *basename)
4288 return getPath2(getMainUserGameDataDir(), basename);
4291 void OpenLogFile(void)
4293 InitMainUserDataDirectory();
4295 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4297 program.log_file = program.log_file_default; // reset to default
4299 Warn("cannot open file '%s' for writing: %s",
4300 program.log_filename, strerror(errno));
4303 // output should be unbuffered so it is not truncated in a crash
4304 setbuf(program.log_file, NULL);
4307 void CloseLogFile(void)
4309 if (program.log_file != program.log_file_default)
4310 fclose(program.log_file);
4313 void DumpLogFile(void)
4315 FILE *log_file = fopen(program.log_filename, MODE_READ);
4317 if (log_file == NULL)
4320 while (!feof(log_file))
4321 fputc(fgetc(log_file), stdout);
4326 void NotifyUserAboutErrorFile(void)
4328 #if defined(PLATFORM_WINDOWS)
4329 char *title_text = getStringCat2(program.program_title, " Error Message");
4330 char *error_text = getStringCat2("The program was aborted due to an error; "
4331 "for details, see the following error file:"
4333 program.log_filename);
4335 MessageBox(NULL, error_text, title_text, MB_OK);
4340 // ----------------------------------------------------------------------------
4341 // the following is only for debugging purpose and normally not used
4342 // ----------------------------------------------------------------------------
4346 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4347 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4349 #define DEBUG_NUM_TIMESTAMPS 10
4350 #define DEBUG_TIME_IN_MICROSECONDS 0
4352 #if DEBUG_TIME_IN_MICROSECONDS
4353 static double Counter_Microseconds(void)
4355 static struct timeval base_time = { 0, 0 };
4356 struct timeval current_time;
4359 gettimeofday(¤t_time, NULL);
4361 // reset base time in case of wrap-around
4362 if (current_time.tv_sec < base_time.tv_sec)
4363 base_time = current_time;
4366 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4367 ((double)(current_time.tv_usec - base_time.tv_usec));
4369 return counter; // return microseconds since last init
4373 static char *debug_print_timestamp_get_padding(int padding_size)
4375 static char *padding = NULL;
4376 int max_padding_size = 100;
4378 if (padding == NULL)
4380 padding = checked_calloc(max_padding_size + 1);
4381 memset(padding, ' ', max_padding_size);
4384 return &padding[MAX(0, max_padding_size - padding_size)];
4387 void debug_print_timestamp(int counter_nr, char *message)
4389 int indent_size = 8;
4390 int padding_size = 40;
4391 float timestamp_interval;
4394 Fail("debugging: invalid negative counter");
4395 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4396 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4398 #if DEBUG_TIME_IN_MICROSECONDS
4399 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4402 counter[counter_nr][0] = Counter_Microseconds();
4404 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4407 counter[counter_nr][0] = Counter();
4410 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4411 counter[counter_nr][1] = counter[counter_nr][0];
4414 Debug("time:init", "%s%s%s %.3f %s",
4415 debug_print_timestamp_get_padding(counter_nr * indent_size),
4417 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4418 timestamp_interval / 1000,
4423 static void debug_print_parent_only(char *format, ...)
4425 if (!IS_PARENT_PROCESS())
4432 va_start(ap, format);
4433 vprintf(format, ap);
4443 static void print_timestamp_ext(char *message, char *mode)
4445 #if DEBUG_PRINT_INIT_TIMESTAMPS
4446 static char *debug_message = NULL;
4447 static char *last_message = NULL;
4448 static int counter_nr = 0;
4449 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4451 checked_free(debug_message);
4452 debug_message = getStringCat3(mode, " ", message);
4454 if (strEqual(mode, "INIT"))
4456 debug_print_timestamp(counter_nr, NULL);
4458 if (counter_nr + 1 < max_depth)
4459 debug_print_timestamp(counter_nr, debug_message);
4463 debug_print_timestamp(counter_nr, NULL);
4465 else if (strEqual(mode, "DONE"))
4469 if (counter_nr + 1 < max_depth ||
4470 (counter_nr == 0 && max_depth == 1))
4472 last_message = message;
4474 if (counter_nr == 0 && max_depth == 1)
4476 checked_free(debug_message);
4477 debug_message = getStringCat3("TIME", " ", message);
4480 debug_print_timestamp(counter_nr, debug_message);
4483 else if (!strEqual(mode, "TIME") ||
4484 !strEqual(message, last_message))
4486 if (counter_nr < max_depth)
4487 debug_print_timestamp(counter_nr, debug_message);
4492 void print_timestamp_init(char *message)
4494 print_timestamp_ext(message, "INIT");
4497 void print_timestamp_time(char *message)
4499 print_timestamp_ext(message, "TIME");
4502 void print_timestamp_done(char *message)
4504 print_timestamp_ext(message, "DONE");