1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter(void) // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter(void) // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToUpper(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = toupper(*s++);
1235 char *getStringToLower(const char *s)
1237 char *s_copy = checked_malloc(strlen(s) + 1);
1238 char *s_ptr = s_copy;
1241 *s_ptr++ = tolower(*s++);
1247 static char *getStringVPrint(char *format, va_list ap)
1249 char s[MAX_LINE_LEN];
1251 vsnprintf(s, MAX_LINE_LEN, format, ap); // may truncate output string
1253 return getStringCopy(s);
1256 char *getStringPrint(char *format, ...)
1261 va_start(ap, format);
1262 s = getStringVPrint(format, ap);
1268 void setStringPrint(char **s, char *format, ...)
1274 va_start(ap, format);
1275 *s = getStringVPrint(format, ap);
1279 void appendStringPrint(char **s_old, char *format, ...)
1284 va_start(ap, format);
1285 s_new = getStringVPrint(format, ap);
1288 char *s_combined = getStringCat2(*s_old, s_new);
1290 checked_free(*s_old);
1291 checked_free(s_new);
1293 *s_old = s_combined;
1296 void setString(char **old_value, const char *new_value)
1298 checked_free(*old_value);
1300 *old_value = getStringCopy(new_value);
1303 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1305 const char *s_ptr, *s_last = s;
1306 byte separator_table[256] = { FALSE };
1308 char **tokens = NULL;
1313 if (separators == NULL)
1317 max_tokens = INT_MAX;
1319 // if string is empty, return empty array
1322 tokens = checked_malloc(sizeof(char *));
1328 // initialize separator table for all characters in separators string
1329 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1330 separator_table[*(byte *)s_ptr] = TRUE;
1332 // count number of tokens in string
1333 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1334 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1337 // allocate array for determined number of tokens
1338 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1340 // copy all but last separated sub-strings to array
1341 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1343 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1345 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1350 // copy last separated sub-string to array
1351 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1354 tokens[num_tokens] = NULL;
1359 int getStringArrayLength(char **s_array)
1361 int num_strings = 0;
1363 if (s_array == NULL)
1366 while (s_array[num_strings] != NULL)
1372 void freeStringArray(char **s_array)
1376 if (s_array == NULL)
1379 for (i = 0; s_array[i] != NULL; i++)
1380 checked_free(s_array[i]);
1382 checked_free(s_array);
1385 char *getEscapedString(const char *s)
1387 const unsigned char *s_ptr = (unsigned char *)s;
1389 char *s_escaped_ptr;
1394 /* Each source byte needs maximally four target chars (\777) */
1395 s_escaped = checked_malloc(strlen(s) * 4 + 1);
1396 s_escaped_ptr = s_escaped;
1398 while (*s_ptr != '\0')
1403 *s_escaped_ptr++ = '\\';
1404 *s_escaped_ptr++ = 'b';
1408 *s_escaped_ptr++ = '\\';
1409 *s_escaped_ptr++ = 'f';
1413 *s_escaped_ptr++ = '\\';
1414 *s_escaped_ptr++ = 'n';
1418 *s_escaped_ptr++ = '\\';
1419 *s_escaped_ptr++ = 'r';
1423 *s_escaped_ptr++ = '\\';
1424 *s_escaped_ptr++ = 't';
1428 *s_escaped_ptr++ = '\\';
1429 *s_escaped_ptr++ = 'v';
1433 *s_escaped_ptr++ = '\\';
1434 *s_escaped_ptr++ = '\\';
1438 *s_escaped_ptr++ = '\\';
1439 *s_escaped_ptr++ = '"';
1443 if ((*s_ptr < ' ') || (*s_ptr >= 0177))
1445 *s_escaped_ptr++ = '\\';
1446 *s_escaped_ptr++ = '0' + (((*s_ptr) >> 6) & 07);
1447 *s_escaped_ptr++ = '0' + (((*s_ptr) >> 3) & 07);
1448 *s_escaped_ptr++ = '0' + ( (*s_ptr) & 07);
1452 *s_escaped_ptr++ = *s_ptr;
1460 *s_escaped_ptr = '\0';
1465 char *getUnescapedString(const char *s)
1467 const char *s_ptr = s;
1468 const char *octal_ptr;
1470 char *s_unescaped_ptr;
1475 s_unescaped = checked_malloc(strlen(s) + 1);
1476 s_unescaped_ptr = s_unescaped;
1478 while (*s_ptr != '\0')
1487 Warn("getUnescapedString: trailing \\");
1498 *s_unescaped_ptr = 0;
1501 while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7')
1503 *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0');
1512 *s_unescaped_ptr++ = '\b';
1516 *s_unescaped_ptr++ = '\f';
1520 *s_unescaped_ptr++ = '\n';
1524 *s_unescaped_ptr++ = '\r';
1528 *s_unescaped_ptr++ = '\t';
1532 *s_unescaped_ptr++ = '\v';
1536 /* also handles \" and \\ */
1537 *s_unescaped_ptr++ = *s_ptr;
1543 *s_unescaped_ptr++ = *s_ptr;
1550 *s_unescaped_ptr = '\0';
1555 char *chugString(char *s)
1562 for (start = (char *)s; *start && isspace(*start); start++)
1565 memmove(s, start, strlen(start) + 1);
1570 char *chompString(char *s)
1575 int len = strlen(s);
1579 if (isspace(s[len]))
1588 char *stripString(char *s)
1590 return chugString(chompString(s));
1593 boolean strEqual(const char *s1, const char *s2)
1595 return (s1 == NULL && s2 == NULL ? TRUE :
1596 s1 == NULL && s2 != NULL ? FALSE :
1597 s1 != NULL && s2 == NULL ? FALSE :
1598 strcmp(s1, s2) == 0);
1601 boolean strEqualN(const char *s1, const char *s2, int n)
1603 return (s1 == NULL && s2 == NULL ? TRUE :
1604 s1 == NULL && s2 != NULL ? FALSE :
1605 s1 != NULL && s2 == NULL ? FALSE :
1606 strncmp(s1, s2, n) == 0);
1609 boolean strEqualCase(const char *s1, const char *s2)
1611 return (s1 == NULL && s2 == NULL ? TRUE :
1612 s1 == NULL && s2 != NULL ? FALSE :
1613 s1 != NULL && s2 == NULL ? FALSE :
1614 strcasecmp(s1, s2) == 0);
1617 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1619 return (s1 == NULL && s2 == NULL ? TRUE :
1620 s1 == NULL && s2 != NULL ? FALSE :
1621 s1 != NULL && s2 == NULL ? FALSE :
1622 strncasecmp(s1, s2, n) == 0);
1625 boolean strPrefix(const char *s, const char *prefix)
1627 return (s == NULL && prefix == NULL ? TRUE :
1628 s == NULL && prefix != NULL ? FALSE :
1629 s != NULL && prefix == NULL ? FALSE :
1630 strncmp(s, prefix, strlen(prefix)) == 0);
1633 boolean strSuffix(const char *s, const char *suffix)
1635 return (s == NULL && suffix == NULL ? TRUE :
1636 s == NULL && suffix != NULL ? FALSE :
1637 s != NULL && suffix == NULL ? FALSE :
1638 strlen(s) < strlen(suffix) ? FALSE :
1639 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1642 boolean strPrefixLower(const char *s, const char *prefix)
1644 char *s_lower = getStringToLower(s);
1645 boolean match = strPrefix(s_lower, prefix);
1652 boolean strSuffixLower(const char *s, const char *suffix)
1654 char *s_lower = getStringToLower(s);
1655 boolean match = strSuffix(s_lower, suffix);
1662 boolean isURL(const char *s)
1664 while (*s && *s >= 'a' && *s <= 'z')
1667 return strPrefix(s, "://");
1671 // ----------------------------------------------------------------------------
1672 // command line option handling functions
1673 // ----------------------------------------------------------------------------
1675 void GetOptions(int argc, char *argv[],
1676 void (*print_usage_function)(void),
1677 void (*print_version_function)(void))
1679 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1680 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1681 char **options_left = &argvplus[1];
1683 // replace original "argv" with null-terminated array of string pointers
1685 argvplus[argc] = argv[argc];
1687 // initialize global program options
1688 options.server_host = NULL;
1689 options.server_port = 0;
1691 options.base_directory = base_path;
1693 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1694 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1695 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1696 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1697 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1698 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1700 options.execute_command = NULL;
1701 options.tape_log_filename = NULL;
1702 options.special_flags = NULL;
1703 options.debug_mode = NULL;
1704 options.player_name = NULL;
1705 options.identifier = NULL;
1706 options.level_nr = NULL;
1707 options.drop_file = NULL;
1709 options.display_nr = 0;
1711 options.mytapes = FALSE;
1712 options.serveronly = FALSE;
1713 options.network = FALSE;
1714 options.verbose = FALSE;
1715 options.debug = FALSE;
1718 options.verbose = TRUE;
1720 #if !defined(PLATFORM_UNIX)
1721 if (*options_left == NULL) // no options given -- enable verbose mode
1722 options.verbose = TRUE;
1727 #if defined(PLATFORM_ANDROID)
1728 options.debug = TRUE;
1732 while (*options_left)
1734 char option_str[MAX_OPTION_LEN];
1735 char *option = options_left[0];
1736 char *next_option = options_left[1];
1737 char *option_arg = NULL;
1738 int option_len = strlen(option);
1740 if (option_len >= MAX_OPTION_LEN)
1741 FailWithHelp("unrecognized option '%s'", option);
1743 strcpy(option_str, option); // copy argument into buffer
1744 option = option_str;
1746 if (strEqual(option, "--")) // stop scanning arguments
1749 if (strPrefix(option, "--")) // treat '--' like '-'
1752 option_arg = strchr(option, '=');
1753 if (option_arg == NULL) // no '=' in option
1754 option_arg = next_option;
1757 *option_arg++ = '\0'; // cut argument from option
1758 if (*option_arg == '\0') // no argument after '='
1759 FailWithHelp("option '%s' has invalid argument", option_str);
1762 option_len = strlen(option);
1764 if (strEqual(option, "-"))
1766 FailWithHelp("unrecognized option '%s'", option);
1768 else if (strncmp(option, "-help", option_len) == 0)
1770 print_usage_function();
1774 else if (strncmp(option, "-basepath", option_len) == 0)
1776 if (option_arg == NULL)
1777 FailWithHelp("option '%s' requires an argument", option_str);
1779 options.base_directory = base_path = getStringCopy(option_arg);
1780 if (option_arg == next_option)
1783 // adjust paths for sub-directories in base directory accordingly
1784 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1785 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1786 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1787 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1788 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1789 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1791 else if (strncmp(option, "-levels", option_len) == 0)
1793 if (option_arg == NULL)
1794 FailWithHelp("option '%s' requires an argument", option_str);
1796 options.level_directory = getStringCopy(option_arg);
1797 if (option_arg == next_option)
1800 else if (strncmp(option, "-graphics", option_len) == 0)
1802 if (option_arg == NULL)
1803 FailWithHelp("option '%s' requires an argument", option_str);
1805 options.graphics_directory = getStringCopy(option_arg);
1806 if (option_arg == next_option)
1809 else if (strncmp(option, "-sounds", option_len) == 0)
1811 if (option_arg == NULL)
1812 FailWithHelp("option '%s' requires an argument", option_str);
1814 options.sounds_directory = getStringCopy(option_arg);
1815 if (option_arg == next_option)
1818 else if (strncmp(option, "-music", option_len) == 0)
1820 if (option_arg == NULL)
1821 FailWithHelp("option '%s' requires an argument", option_str);
1823 options.music_directory = getStringCopy(option_arg);
1824 if (option_arg == next_option)
1827 else if (strncmp(option, "-mytapes", option_len) == 0)
1829 options.mytapes = TRUE;
1831 else if (strncmp(option, "-network", option_len) == 0)
1833 options.network = TRUE;
1835 else if (strncmp(option, "-serveronly", option_len) == 0)
1837 options.serveronly = TRUE;
1839 else if (strncmp(option, "-debug", option_len) == 0)
1841 options.debug = TRUE;
1843 // optionally, debug output can be limited to a specific debug mode
1844 if (option_arg != next_option)
1845 options.debug_mode = getStringCopy(option_arg);
1847 else if (strncmp(option, "-player-name", option_len) == 0)
1849 if (option_arg == NULL)
1850 FailWithHelp("option '%s' requires an argument", option_str);
1852 options.player_name = getStringCopy(option_arg);
1853 if (option_arg == next_option)
1856 else if (strncmp(option, "-identifier", option_len) == 0)
1858 if (option_arg == NULL)
1859 FailWithHelp("option '%s' requires an argument", option_str);
1861 options.identifier = getStringCopy(option_arg);
1862 if (option_arg == next_option)
1865 else if (strncmp(option, "-level-nr", option_len) == 0)
1867 if (option_arg == NULL)
1868 FailWithHelp("option '%s' requires an argument", option_str);
1870 options.level_nr = getStringCopy(option_arg);
1871 if (option_arg == next_option)
1874 else if (strncmp(option, "-drop-file", option_len) == 0)
1876 if (option_arg == NULL)
1877 FailWithHelp("option '%s' requires an argument", option_str);
1879 options.drop_file = getStringCopy(option_arg);
1880 if (option_arg == next_option)
1883 else if (strncmp(option, "-verbose", option_len) == 0)
1885 options.verbose = TRUE;
1887 else if (strncmp(option, "-version", option_len) == 0 ||
1888 strncmp(option, "-V", option_len) == 0)
1890 print_version_function();
1894 else if (strPrefix(option, "-D"))
1896 options.special_flags = getStringCopy(&option[2]);
1898 else if (strncmp(option, "-execute", option_len) == 0)
1900 if (option_arg == NULL)
1901 FailWithHelp("option '%s' requires an argument", option_str);
1903 options.execute_command = getStringCopy(option_arg);
1904 if (option_arg == next_option)
1907 // when doing batch processing, always enable verbose mode (warnings)
1908 options.verbose = TRUE;
1910 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1912 if (option_arg == NULL)
1913 FailWithHelp("option '%s' requires an argument", option_str);
1915 options.tape_log_filename = getStringCopy(option_arg);
1916 if (option_arg == next_option)
1919 else if (strncmp(option, "-display", option_len) == 0)
1921 if (option_arg == NULL)
1922 FailWithHelp("option '%s' requires an argument", option_str);
1924 if (option_arg == next_option)
1927 int display_nr = atoi(option_arg);
1930 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1931 options.display_nr = display_nr;
1933 options.display_nr =
1934 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1936 if (display_nr != options.display_nr)
1937 Warn("invalid display %d -- using display %d",
1938 display_nr, options.display_nr);
1941 #if defined(PLATFORM_MAC)
1942 else if (strPrefix(option, "-psn"))
1944 // ignore process serial number when launched via GUI on Mac OS X
1947 else if (*option == '-')
1949 FailWithHelp("unrecognized option '%s'", option_str);
1951 else if (options.server_host == NULL)
1953 options.server_host = *options_left;
1955 else if (options.server_port == 0)
1957 options.server_port = atoi(*options_left);
1958 if (options.server_port < 1024)
1959 FailWithHelp("bad port number '%d'", options.server_port);
1962 FailWithHelp("too many arguments");
1969 // ----------------------------------------------------------------------------
1970 // checked memory allocation and freeing functions
1971 // ----------------------------------------------------------------------------
1973 void *checked_malloc(unsigned int size)
1980 Fail("cannot allocate %d bytes -- out of memory", size);
1985 void *checked_calloc(unsigned int size)
1989 ptr = calloc(1, size);
1992 Fail("cannot allocate %d bytes -- out of memory", size);
1997 void *checked_realloc(void *ptr, unsigned int size)
1999 ptr = realloc(ptr, size);
2002 Fail("cannot allocate %d bytes -- out of memory", size);
2007 void checked_free(void *ptr)
2009 if (ptr != NULL) // this check should be done by free() anyway
2013 void clear_mem(void *ptr, unsigned int size)
2015 #if defined(PLATFORM_WINDOWS)
2016 // for unknown reason, memset() sometimes crashes when compiled with MinGW
2017 char *cptr = (char *)ptr;
2022 memset(ptr, 0, size);
2026 void *get_memcpy(const void *m, size_t size)
2033 m_copy = checked_malloc(size);
2034 memcpy(m_copy, m, size);
2040 // ----------------------------------------------------------------------------
2041 // various helper functions
2042 // ----------------------------------------------------------------------------
2044 void swap_numbers(int *i1, int *i2)
2052 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
2064 int get_number_of_bits(int bits)
2067 Counting bits set, Brian Kernighan's way
2069 Brian Kernighan's method goes through as many iterations as there are set
2070 bits. So if we have a 32-bit word with only the high bit set, then it will
2071 only go once through the loop.
2073 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
2074 and Dennis M. Ritchie) mentions this in exercise 2-9.
2075 First published by Peter Wegner in CACM 3 (1960), 322.
2082 bits &= bits - 1; // clear the least significant bit set
2089 /* the "put" variants of the following file access functions check for the file
2090 pointer being != NULL and return the number of bytes they have or would have
2091 written; this allows for chunk writing functions to first determine the size
2092 of the (not yet written) chunk, write the correct chunk size and finally
2093 write the chunk itself */
2095 int getFile8BitInteger(File *file)
2097 return getByteFromFile(file);
2100 int putFile8BitInteger(FILE *file, int value)
2108 int getFile16BitInteger(File *file, int byte_order)
2110 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2111 return ((getByteFromFile(file) << 8) |
2112 (getByteFromFile(file) << 0));
2113 else // BYTE_ORDER_LITTLE_ENDIAN
2114 return ((getByteFromFile(file) << 0) |
2115 (getByteFromFile(file) << 8));
2118 int putFile16BitInteger(FILE *file, int value, int byte_order)
2122 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2124 fputc((value >> 8) & 0xff, file);
2125 fputc((value >> 0) & 0xff, file);
2127 else // BYTE_ORDER_LITTLE_ENDIAN
2129 fputc((value >> 0) & 0xff, file);
2130 fputc((value >> 8) & 0xff, file);
2137 int getFile32BitInteger(File *file, int byte_order)
2139 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2140 return ((getByteFromFile(file) << 24) |
2141 (getByteFromFile(file) << 16) |
2142 (getByteFromFile(file) << 8) |
2143 (getByteFromFile(file) << 0));
2144 else // BYTE_ORDER_LITTLE_ENDIAN
2145 return ((getByteFromFile(file) << 0) |
2146 (getByteFromFile(file) << 8) |
2147 (getByteFromFile(file) << 16) |
2148 (getByteFromFile(file) << 24));
2151 int putFile32BitInteger(FILE *file, int value, int byte_order)
2155 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
2157 fputc((value >> 24) & 0xff, file);
2158 fputc((value >> 16) & 0xff, file);
2159 fputc((value >> 8) & 0xff, file);
2160 fputc((value >> 0) & 0xff, file);
2162 else // BYTE_ORDER_LITTLE_ENDIAN
2164 fputc((value >> 0) & 0xff, file);
2165 fputc((value >> 8) & 0xff, file);
2166 fputc((value >> 16) & 0xff, file);
2167 fputc((value >> 24) & 0xff, file);
2174 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
2177 const int chunk_name_length = 4;
2180 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
2183 if (chunk_size != NULL)
2186 *chunk_size = getFile32BitInteger(file, byte_order);
2189 return (checkEndOfFile(file) ? FALSE : TRUE);
2192 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2199 fputs(chunk_name, file);
2201 num_bytes += strlen(chunk_name);
2203 if (chunk_size >= 0)
2207 putFile32BitInteger(file, chunk_size, byte_order);
2215 int getFileVersion(File *file)
2217 int version_super = getByteFromFile(file);
2218 int version_major = getByteFromFile(file);
2219 int version_minor = getByteFromFile(file);
2220 int version_patch = getByteFromFile(file);
2222 return VERSION_IDENT(version_super, version_major, version_minor,
2226 int putFileVersion(FILE *file, int version)
2230 int version_super = VERSION_SUPER(version);
2231 int version_major = VERSION_MAJOR(version);
2232 int version_minor = VERSION_MINOR(version);
2233 int version_patch = VERSION_PATCH(version);
2235 fputc(version_super, file);
2236 fputc(version_major, file);
2237 fputc(version_minor, file);
2238 fputc(version_patch, file);
2244 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2248 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2249 buffer[i] = getByteFromFile(file);
2252 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2256 for (i = 0; i < bytes; i++)
2257 fputc(buffer[i], file);
2260 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2262 while (bytes-- && !checkEndOfFile(file))
2263 getByteFromFile(file);
2266 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2273 // ----------------------------------------------------------------------------
2274 // functions to convert between ISO-8859-1 and UTF-8
2275 // ----------------------------------------------------------------------------
2277 char *getUTF8FromLatin1(char *latin1)
2279 int max_utf8_size = 2 * strlen(latin1) + 1;
2280 char *utf8 = checked_calloc(max_utf8_size);
2281 unsigned char *src = (unsigned char *)latin1;
2282 unsigned char *dst = (unsigned char *)utf8;
2286 if (*src < 128) // pure 7-bit ASCII
2290 else if (*src >= 160) // non-ASCII characters
2292 *dst++ = 194 + (*src >= 192);
2293 *dst++ = 128 + (*src & 63);
2295 else // undefined in ISO-8859-1
2303 // only use the smallest possible string buffer size
2304 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2309 char *getLatin1FromUTF8(char *utf8)
2311 int max_latin1_size = strlen(utf8) + 1;
2312 char *latin1 = checked_calloc(max_latin1_size);
2313 unsigned char *src = (unsigned char *)utf8;
2314 unsigned char *dst = (unsigned char *)latin1;
2318 if (*src < 128) // pure 7-bit ASCII
2322 else if (src[0] == 194 &&
2323 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2328 else if (src[0] == 195 &&
2329 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2331 *dst++ = src[1] + 64;
2335 // all other UTF-8 characters are undefined in ISO-8859-1
2337 else if (src[0] >= 192 && src[0] < 224 &&
2338 src[1] >= 128 && src[1] < 192)
2343 else if (src[0] >= 224 && src[0] < 240 &&
2344 src[1] >= 128 && src[1] < 192 &&
2345 src[2] >= 128 && src[2] < 192)
2350 else if (src[0] >= 240 && src[0] < 248 &&
2351 src[1] >= 128 && src[1] < 192 &&
2352 src[2] >= 128 && src[2] < 192 &&
2353 src[3] >= 128 && src[3] < 192)
2358 else if (src[0] >= 248 && src[0] < 252 &&
2359 src[1] >= 128 && src[1] < 192 &&
2360 src[2] >= 128 && src[2] < 192 &&
2361 src[3] >= 128 && src[3] < 192 &&
2362 src[4] >= 128 && src[4] < 192)
2367 else if (src[0] >= 252 && src[0] < 254 &&
2368 src[1] >= 128 && src[1] < 192 &&
2369 src[2] >= 128 && src[2] < 192 &&
2370 src[3] >= 128 && src[3] < 192 &&
2371 src[4] >= 128 && src[4] < 192 &&
2372 src[5] >= 128 && src[5] < 192)
2384 // only use the smallest possible string buffer size
2385 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2390 int getTextEncoding(char *text)
2392 unsigned char *src = (unsigned char *)text;
2393 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2398 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2404 else if (src[0] >= 192 && src[0] < 224 &&
2405 src[1] >= 128 && src[1] < 192)
2409 else if (src[0] >= 224 && src[0] < 240 &&
2410 src[1] >= 128 && src[1] < 192 &&
2411 src[2] >= 128 && src[2] < 192)
2415 else if (src[0] >= 240 && src[0] < 248 &&
2416 src[1] >= 128 && src[1] < 192 &&
2417 src[2] >= 128 && src[2] < 192 &&
2418 src[3] >= 128 && src[3] < 192)
2422 else if (src[0] >= 248 && src[0] < 252 &&
2423 src[1] >= 128 && src[1] < 192 &&
2424 src[2] >= 128 && src[2] < 192 &&
2425 src[3] >= 128 && src[3] < 192 &&
2426 src[4] >= 128 && src[4] < 192)
2430 else if (src[0] >= 252 && src[0] < 254 &&
2431 src[1] >= 128 && src[1] < 192 &&
2432 src[2] >= 128 && src[2] < 192 &&
2433 src[3] >= 128 && src[3] < 192 &&
2434 src[4] >= 128 && src[4] < 192 &&
2435 src[5] >= 128 && src[5] < 192)
2441 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2449 // ----------------------------------------------------------------------------
2450 // functions for JSON handling
2451 // ----------------------------------------------------------------------------
2453 char *getEscapedJSON(char *s)
2455 int max_json_size = 2 * strlen(s) + 1;
2456 char *json = checked_calloc(max_json_size);
2457 unsigned char *src = (unsigned char *)s;
2458 unsigned char *dst = (unsigned char *)json;
2459 char *escaped[256] =
2472 if (escaped[*src] != NULL)
2474 char *esc = escaped[*src++];
2485 // only use the smallest possible string buffer size
2486 json = checked_realloc(json, strlen(json) + 1);
2492 // ----------------------------------------------------------------------------
2493 // functions to translate key identifiers between different format
2494 // ----------------------------------------------------------------------------
2496 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2497 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2498 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2499 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2501 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2510 // return and escape keys
2511 { KSYM_Return, "XK_Return", "return" },
2512 { KSYM_Escape, "XK_Escape", "escape" },
2514 // normal cursor keys
2515 { KSYM_Left, "XK_Left", "cursor left" },
2516 { KSYM_Right, "XK_Right", "cursor right" },
2517 { KSYM_Up, "XK_Up", "cursor up" },
2518 { KSYM_Down, "XK_Down", "cursor down" },
2520 // keypad cursor keys
2522 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2523 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2524 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2525 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2528 // other keypad keys
2529 #ifdef KSYM_KP_Enter
2530 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2531 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2532 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2533 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2534 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2535 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2539 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2540 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2541 { KSYM_Control_L, "XK_Control_L", "left control" },
2542 { KSYM_Control_R, "XK_Control_R", "right control" },
2543 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2544 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2545 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2546 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2547 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2548 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2550 // some special keys
2551 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2552 { KSYM_Delete, "XK_Delete", "delete" },
2553 { KSYM_Insert, "XK_Insert", "insert" },
2554 { KSYM_Tab, "XK_Tab", "tab" },
2555 { KSYM_Home, "XK_Home", "home" },
2556 { KSYM_End, "XK_End", "end" },
2557 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2558 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2560 { KSYM_Select, "XK_Select", "select" },
2561 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2562 { KSYM_Back, "XK_Back", "back" }, // back key
2563 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2564 #if defined(PLATFORM_ANDROID)
2565 { KSYM_Rewind, "XK_Rewind", "rewind" },
2566 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2569 // ASCII 0x20 to 0x40 keys (except numbers)
2570 { KSYM_space, "XK_space", "space" },
2571 { KSYM_exclam, "XK_exclam", "!" },
2572 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2573 { KSYM_numbersign, "XK_numbersign", "#" },
2574 { KSYM_dollar, "XK_dollar", "$" },
2575 { KSYM_percent, "XK_percent", "%" },
2576 { KSYM_ampersand, "XK_ampersand", "&" },
2577 { KSYM_apostrophe, "XK_apostrophe", "'" },
2578 { KSYM_parenleft, "XK_parenleft", "(" },
2579 { KSYM_parenright, "XK_parenright", ")" },
2580 { KSYM_asterisk, "XK_asterisk", "*" },
2581 { KSYM_plus, "XK_plus", "+" },
2582 { KSYM_comma, "XK_comma", "," },
2583 { KSYM_minus, "XK_minus", "-" },
2584 { KSYM_period, "XK_period", "." },
2585 { KSYM_slash, "XK_slash", "/" },
2586 { KSYM_colon, "XK_colon", ":" },
2587 { KSYM_semicolon, "XK_semicolon", ";" },
2588 { KSYM_less, "XK_less", "<" },
2589 { KSYM_equal, "XK_equal", "=" },
2590 { KSYM_greater, "XK_greater", ">" },
2591 { KSYM_question, "XK_question", "?" },
2592 { KSYM_at, "XK_at", "@" },
2595 { KSYM_bracketleft, "XK_bracketleft", "[" },
2596 { KSYM_backslash, "XK_backslash", "\\" },
2597 { KSYM_bracketright,"XK_bracketright", "]" },
2598 { KSYM_asciicircum, "XK_asciicircum", "^" },
2599 { KSYM_underscore, "XK_underscore", "_" },
2600 { KSYM_grave, "XK_grave", "grave" },
2601 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2602 { KSYM_braceleft, "XK_braceleft", "brace left" },
2603 { KSYM_bar, "XK_bar", "bar" },
2604 { KSYM_braceright, "XK_braceright", "brace right" },
2605 { KSYM_asciitilde, "XK_asciitilde", "~" },
2607 // special (non-ASCII) keys
2608 { KSYM_degree, "XK_degree", "degree" },
2609 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2610 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2611 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2612 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2613 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2614 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2615 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2617 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2618 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2619 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2620 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2621 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2622 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2623 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2624 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2625 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2627 // other keys (for reverse mapping only)
2628 { KSYM_space, "XK_space", " " },
2630 // keypad keys are not in numerical order in SDL2
2631 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2632 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2633 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2634 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2635 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2636 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2637 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2638 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2639 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2640 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2642 // end-of-array identifier
2648 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2650 static char name_buffer[30];
2653 if (key >= KSYM_A && key <= KSYM_Z)
2654 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2655 else if (key >= KSYM_a && key <= KSYM_z)
2656 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2657 else if (key >= KSYM_0 && key <= KSYM_9)
2658 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2659 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2660 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2661 else if (key == KSYM_UNDEFINED)
2662 strcpy(name_buffer, "(undefined)");
2669 if (key == translate_key[i].key)
2671 strcpy(name_buffer, translate_key[i].name);
2675 while (translate_key[++i].name);
2677 if (!translate_key[i].name)
2678 strcpy(name_buffer, "(unknown)");
2681 *name = name_buffer;
2683 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2685 static char name_buffer[30];
2688 if (key >= KSYM_A && key <= KSYM_Z)
2689 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2690 else if (key >= KSYM_a && key <= KSYM_z)
2691 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2692 else if (key >= KSYM_0 && key <= KSYM_9)
2693 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2694 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2695 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2696 else if (key == KSYM_UNDEFINED)
2697 strcpy(name_buffer, "[undefined]");
2704 if (key == translate_key[i].key)
2706 strcpy(name_buffer, translate_key[i].x11name);
2710 while (translate_key[++i].x11name);
2712 if (!translate_key[i].x11name)
2713 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2716 *x11name = name_buffer;
2718 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2720 Key key = KSYM_UNDEFINED;
2721 char *name_ptr = *name;
2723 if (strlen(*name) == 1)
2725 char c = name_ptr[0];
2727 if (c >= 'A' && c <= 'Z')
2728 key = KSYM_A + (Key)(c - 'A');
2729 else if (c >= 'a' && c <= 'z')
2730 key = KSYM_a + (Key)(c - 'a');
2731 else if (c >= '0' && c <= '9')
2732 key = KSYM_0 + (Key)(c - '0');
2735 if (key == KSYM_UNDEFINED)
2741 if (strEqual(translate_key[i].name, *name))
2743 key = translate_key[i].key;
2747 while (translate_key[++i].x11name);
2750 if (key == KSYM_UNDEFINED)
2751 Warn("getKeyFromKeyName(): not completely implemented");
2755 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2757 Key key = KSYM_UNDEFINED;
2758 char *name_ptr = *x11name;
2760 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2762 char c = name_ptr[3];
2764 if (c >= 'A' && c <= 'Z')
2765 key = KSYM_A + (Key)(c - 'A');
2766 else if (c >= 'a' && c <= 'z')
2767 key = KSYM_a + (Key)(c - 'a');
2768 else if (c >= '0' && c <= '9')
2769 key = KSYM_0 + (Key)(c - '0');
2771 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2773 char c1 = name_ptr[4];
2774 char c2 = name_ptr[5];
2777 if ((c1 >= '0' && c1 <= '9') &&
2778 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2779 d = atoi(&name_ptr[4]);
2781 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2782 key = KSYM_F1 + (Key)(d - 1);
2784 else if (strPrefix(name_ptr, "XK_"))
2790 if (strEqual(name_ptr, translate_key[i].x11name))
2792 key = translate_key[i].key;
2796 while (translate_key[++i].x11name);
2798 else if (strPrefix(name_ptr, "0x"))
2800 unsigned int value = 0;
2806 char c = *name_ptr++;
2809 if (c >= '0' && c <= '9')
2811 else if (c >= 'a' && c <= 'f')
2812 d = (int)(c - 'a' + 10);
2813 else if (c >= 'A' && c <= 'F')
2814 d = (int)(c - 'A' + 10);
2822 value = value * 16 + d;
2833 char *getKeyNameFromKey(Key key)
2837 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2841 char *getX11KeyNameFromKey(Key key)
2845 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2849 Key getKeyFromKeyName(char *name)
2853 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2857 Key getKeyFromX11KeyName(char *x11name)
2861 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2865 char getCharFromKey(Key key)
2871 } translate_key_char[] =
2873 // special (non-ASCII) keys (ISO-8859-1)
2874 { KSYM_degree, CHAR_BYTE_DEGREE },
2875 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2876 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2877 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2878 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2879 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2880 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2881 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2883 // end-of-array identifier
2887 char *keyname = getKeyNameFromKey(key);
2890 if (strlen(keyname) == 1)
2892 else if (strEqual(keyname, "space"))
2900 if (key == translate_key_char[i].key)
2902 c = translate_key_char[i].key_char;
2907 while (translate_key_char[++i].key_char);
2913 char getValidConfigValueChar(char c)
2915 if (c == '#' || // used to mark comments
2916 c == '\\') // used to mark continued lines
2923 // ----------------------------------------------------------------------------
2924 // functions to translate string identifiers to integer or boolean value
2925 // ----------------------------------------------------------------------------
2927 int get_integer_from_string(char *s)
2929 // check for the most common case first
2930 if (s[0] >= '0' && s[0] <= '9')
2933 char *s_lower = getStringToLower(s);
2936 if (strEqual(s_lower, "false") ||
2937 strEqual(s_lower, "no") ||
2938 strEqual(s_lower, "off"))
2940 else if (strEqual(s_lower, "true") ||
2941 strEqual(s_lower, "yes") ||
2942 strEqual(s_lower, "on"))
2952 boolean get_boolean_from_string(char *s)
2954 char *s_lower = getStringToLower(s);
2955 boolean result = FALSE;
2957 if (strEqual(s_lower, "true") ||
2958 strEqual(s_lower, "yes") ||
2959 strEqual(s_lower, "on") ||
2960 get_integer_from_string(s) == 1)
2968 int get_switch_3_state_from_string(char *s)
2970 char *s_lower = getStringToLower(s);
2973 if (strEqual(s_lower, "true") ||
2974 strEqual(s_lower, "yes") ||
2975 strEqual(s_lower, "on") ||
2976 get_integer_from_string(s) == 1)
2978 else if (strEqual(s_lower, "auto"))
2979 result = STATE_AUTO;
2980 else if (strEqual(s_lower, "ask"))
2988 int get_player_nr_from_string(char *s)
2990 static char *player_text[] =
3000 char *s_lower = getStringToLower(s);
3004 for (i = 0; player_text[i] != NULL; i++)
3005 if (strEqual(s_lower, player_text[i]))
3014 // ----------------------------------------------------------------------------
3015 // functions for generic lists
3016 // ----------------------------------------------------------------------------
3018 ListNode *newListNode(void)
3020 return checked_calloc(sizeof(ListNode));
3023 void addNodeToList(ListNode **node_first, char *key, void *content)
3025 ListNode *node_new = newListNode();
3027 node_new->key = getStringCopy(key);
3028 node_new->content = content;
3029 node_new->next = *node_first;
3032 (*node_first)->prev = node_new;
3034 *node_first = node_new;
3037 void deleteNodeFromList(ListNode **node_first, char *key,
3038 void (*destructor_function)(void *))
3040 if (node_first == NULL || *node_first == NULL)
3043 if (strEqual((*node_first)->key, key))
3045 // after first recursion, (*node_first)->prev->next == *node_first,
3046 // so *node_first would be overwritten with (*node_first)->next
3047 // => use a copy of *node_first (and later of (*node_first)->next)
3048 ListNode *node = *node_first;
3049 ListNode *node_next = node->next;
3051 checked_free(node->key);
3053 if (destructor_function)
3054 destructor_function(node->content);
3057 node->prev->next = node->next;
3060 node->next->prev = node->prev;
3064 // after removing node, set list pointer to next valid list node
3065 // (this is important if the first node of the list was deleted)
3066 *node_first = node_next;
3070 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
3074 ListNode *getNodeFromKey(ListNode *node_first, char *key)
3076 if (node_first == NULL)
3079 if (strEqual(node_first->key, key))
3082 return getNodeFromKey(node_first->next, key);
3085 int getNumNodes(ListNode *node_first)
3087 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
3091 static void dumpList(ListNode *node_first)
3093 ListNode *node = node_first;
3097 Debug("internal:dumpList", "['%s' (%d)]", node->key,
3098 ((struct ListNodeInfo *)node->content)->num_references);
3102 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
3107 // ----------------------------------------------------------------------------
3108 // functions for file handling
3109 // ----------------------------------------------------------------------------
3111 #define MAX_BUFFER_SIZE 4096
3113 File *openFile(const char *filename, const char *mode)
3115 File *file = checked_calloc(sizeof(File));
3117 file->file = fopen(filename, mode);
3119 if (file->file != NULL)
3121 file->filename = getStringCopy(filename);
3126 #if defined(PLATFORM_ANDROID)
3127 file->asset_file = SDL_RWFromFile(filename, mode);
3129 if (file->asset_file != NULL)
3131 file->file_is_asset = TRUE;
3132 file->filename = getStringCopy(filename);
3143 int closeFile(File *file)
3150 #if defined(PLATFORM_ANDROID)
3151 if (file->asset_file)
3152 result = SDL_RWclose(file->asset_file);
3156 result = fclose(file->file);
3158 checked_free(file->filename);
3164 int checkEndOfFile(File *file)
3166 #if defined(PLATFORM_ANDROID)
3167 if (file->file_is_asset)
3168 return file->end_of_file;
3171 return feof(file->file);
3174 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
3176 #if defined(PLATFORM_ANDROID)
3177 if (file->file_is_asset)
3179 if (file->end_of_file)
3182 size_t num_items_read =
3183 SDL_RWread(file->asset_file, buffer, item_size, num_items);
3185 if (num_items_read < num_items)
3186 file->end_of_file = TRUE;
3188 return num_items_read;
3192 return fread(buffer, item_size, num_items, file->file);
3195 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3197 return fwrite(buffer, item_size, num_items, file->file);
3200 int seekFile(File *file, long offset, int whence)
3202 #if defined(PLATFORM_ANDROID)
3203 if (file->file_is_asset)
3205 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3206 whence == SEEK_CUR ? RW_SEEK_CUR :
3207 whence == SEEK_END ? RW_SEEK_END : 0);
3209 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3213 return fseek(file->file, offset, whence);
3216 int getByteFromFile(File *file)
3218 #if defined(PLATFORM_ANDROID)
3219 if (file->file_is_asset)
3221 if (file->end_of_file)
3225 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3227 if (num_bytes_read < 1)
3228 file->end_of_file = TRUE;
3230 return (file->end_of_file ? EOF : (int)c);
3234 return fgetc(file->file);
3237 char *getStringFromFile(File *file, char *line, int size)
3239 #if defined(PLATFORM_ANDROID)
3240 if (file->file_is_asset)
3242 if (file->end_of_file)
3245 char *line_ptr = line;
3246 int num_bytes_read = 0;
3248 while (num_bytes_read < size - 1 &&
3249 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3250 *line_ptr++ != '\n')
3255 if (strlen(line) == 0)
3257 file->end_of_file = TRUE;
3266 return fgets(line, size, file->file);
3269 int copyFile(const char *filename_from, const char *filename_to)
3271 File *file_from, *file_to;
3273 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3278 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3280 closeFile(file_from);
3285 while (!checkEndOfFile(file_from))
3287 byte buffer[MAX_BUFFER_SIZE];
3288 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3290 writeFile(file_to, buffer, 1, bytes_read);
3293 closeFile(file_from);
3299 boolean touchFile(const char *filename)
3303 if (!(file = fopen(filename, MODE_WRITE)))
3305 Warn("cannot touch file '%s'", filename);
3316 // ----------------------------------------------------------------------------
3317 // functions for directory handling
3318 // ----------------------------------------------------------------------------
3320 Directory *openDirectory(char *dir_name)
3322 Directory *dir = checked_calloc(sizeof(Directory));
3324 dir->dir = opendir(dir_name);
3326 if (dir->dir != NULL)
3328 dir->filename = getStringCopy(dir_name);
3333 #if defined(PLATFORM_ANDROID)
3334 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3336 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3338 checked_free(asset_toc_filename);
3340 if (dir->asset_toc_file != NULL)
3342 dir->directory_is_asset = TRUE;
3343 dir->filename = getStringCopy(dir_name);
3354 int closeDirectory(Directory *dir)
3361 #if defined(PLATFORM_ANDROID)
3362 if (dir->asset_toc_file)
3363 result = SDL_RWclose(dir->asset_toc_file);
3367 result = closedir(dir->dir);
3370 freeDirectoryEntry(dir->dir_entry);
3372 checked_free(dir->filename);
3378 DirectoryEntry *readDirectory(Directory *dir)
3381 freeDirectoryEntry(dir->dir_entry);
3383 dir->dir_entry = NULL;
3385 #if defined(PLATFORM_ANDROID)
3386 if (dir->directory_is_asset)
3388 char line[MAX_LINE_LEN];
3389 char *line_ptr = line;
3390 int num_bytes_read = 0;
3392 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3393 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3402 if (strlen(line) == 0)
3405 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3407 dir->dir_entry->is_directory = FALSE;
3408 if (line[strlen(line) - 1] == '/')
3410 dir->dir_entry->is_directory = TRUE;
3412 line[strlen(line) - 1] = '\0';
3415 dir->dir_entry->basename = getStringCopy(line);
3416 dir->dir_entry->filename = getPath2(dir->filename, line);
3418 return dir->dir_entry;
3422 struct dirent *dir_entry = readdir(dir->dir);
3424 if (dir_entry == NULL)
3427 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3429 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3430 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3432 struct stat file_status;
3434 dir->dir_entry->is_directory =
3435 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3436 S_ISDIR(file_status.st_mode));
3438 return dir->dir_entry;
3441 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3443 if (dir_entry == NULL)
3446 checked_free(dir_entry->basename);
3447 checked_free(dir_entry->filename);
3448 checked_free(dir_entry);
3452 // ----------------------------------------------------------------------------
3453 // functions for checking files and filenames
3454 // ----------------------------------------------------------------------------
3456 boolean directoryExists(const char *dir_name)
3458 if (dir_name == NULL)
3461 struct stat file_status;
3462 boolean success = (stat(dir_name, &file_status) == 0 &&
3463 S_ISDIR(file_status.st_mode));
3465 #if defined(PLATFORM_ANDROID)
3468 // this might be an asset directory; check by trying to open toc file
3469 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3470 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3472 checked_free(asset_toc_filename);
3474 success = (file != NULL);
3484 boolean fileExists(const char *filename)
3486 if (filename == NULL)
3489 boolean success = (access(filename, F_OK) == 0);
3491 #if defined(PLATFORM_ANDROID)
3494 // this might be an asset file; check by trying to open it
3495 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3497 success = (file != NULL);
3508 static boolean fileHasPrefix(const char *basename, const char *prefix)
3510 static char *basename_lower = NULL;
3511 int basename_length, prefix_length;
3513 checked_free(basename_lower);
3515 if (basename == NULL || prefix == NULL)
3518 basename_lower = getStringToLower(basename);
3519 basename_length = strlen(basename_lower);
3520 prefix_length = strlen(prefix);
3522 if (basename_length > prefix_length + 1 &&
3523 basename_lower[prefix_length] == '.' &&
3524 strncmp(basename_lower, prefix, prefix_length) == 0)
3531 static boolean fileHasSuffix(const char *basename, const char *suffix)
3533 static char *basename_lower = NULL;
3534 int basename_length, suffix_length;
3536 checked_free(basename_lower);
3538 if (basename == NULL || suffix == NULL)
3541 basename_lower = getStringToLower(basename);
3542 basename_length = strlen(basename_lower);
3543 suffix_length = strlen(suffix);
3545 if (basename_length > suffix_length + 1 &&
3546 basename_lower[basename_length - suffix_length - 1] == '.' &&
3547 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3553 static boolean FileCouldBeArtwork(char *filename)
3555 char *basename = getBaseNamePtr(filename);
3557 return (!strEqual(basename, ".") &&
3558 !strEqual(basename, "..") &&
3559 !fileHasSuffix(basename, "txt") &&
3560 !fileHasSuffix(basename, "conf") &&
3561 !directoryExists(filename));
3564 boolean FileIsGraphic(char *filename)
3566 return FileCouldBeArtwork(filename);
3569 boolean FileIsSound(char *filename)
3571 return FileCouldBeArtwork(filename);
3574 boolean FileIsMusic(char *filename)
3576 return FileCouldBeArtwork(filename);
3579 boolean FileIsArtworkType(char *filename, int type)
3581 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3582 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3583 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3589 // ----------------------------------------------------------------------------
3590 // functions for loading artwork configuration information
3591 // ----------------------------------------------------------------------------
3593 char *get_mapped_token(char *token)
3595 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3596 static char *map_token_prefix[][2] =
3598 { "char_procent", "char_percent" },
3599 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3600 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3601 { "bd_butterfly_left", "bd_butterfly.left" },
3602 { "bd_butterfly_right", "bd_butterfly.right" },
3603 { "bd_butterfly_up", "bd_butterfly.up" },
3604 { "bd_butterfly_down", "bd_butterfly.down" },
3605 { "bd_firefly_left", "bd_firefly.left" },
3606 { "bd_firefly_right", "bd_firefly.right" },
3607 { "bd_firefly_up", "bd_firefly.up" },
3608 { "bd_firefly_down", "bd_firefly.down" },
3614 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3616 int len_token_prefix = strlen(map_token_prefix[i][0]);
3618 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3619 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3622 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3623 char *gfx_substring = ".gfx";
3624 char *gfx_prefix = "gfx.";
3625 if (strstr(token, gfx_substring) != NULL)
3627 char *token_prefix = getStringCopy(token);
3628 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3629 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3632 // cut off token string at ".gfx" substring position
3633 *token_gfx_pos = '\0';
3635 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3636 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3640 return mapped_token;
3646 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3649 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3650 static struct ConfigTypeInfo prefix_list[] =
3652 { "global.anim_1" },
3653 { "global.anim_2" },
3654 { "global.anim_3" },
3655 { "global.anim_4" },
3656 { "global.anim_5" },
3657 { "global.anim_6" },
3658 { "global.anim_7" },
3659 { "global.anim_8" },
3660 { "global.anim_9" },
3661 { "global.anim_10" },
3662 { "global.anim_11" },
3663 { "global.anim_12" },
3664 { "global.anim_13" },
3665 { "global.anim_14" },
3666 { "global.anim_15" },
3667 { "global.anim_16" },
3668 { "global.anim_17" },
3669 { "global.anim_18" },
3670 { "global.anim_19" },
3671 { "global.anim_20" },
3672 { "global.anim_21" },
3673 { "global.anim_22" },
3674 { "global.anim_23" },
3675 { "global.anim_24" },
3676 { "global.anim_25" },
3677 { "global.anim_26" },
3678 { "global.anim_27" },
3679 { "global.anim_28" },
3680 { "global.anim_29" },
3681 { "global.anim_30" },
3682 { "global.anim_31" },
3683 { "global.anim_32" },
3687 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3688 boolean prefix_found = FALSE;
3692 // search for prefix to check if base token has to be created
3693 for (i = 0; prefix_list[i].token != NULL; i++)
3694 if (strPrefix(token, prefix_list[i].token))
3695 prefix_found = TRUE;
3700 // search for suffix (parameter) to determine base token length
3701 for (i = 0; suffix_list[i].token != NULL; i++)
3702 if (strSuffix(token, suffix_list[i].token))
3703 len_suffix = strlen(suffix_list[i].token);
3705 return getStringCopyN(token, strlen(token) - len_suffix);
3708 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3709 struct ListNodeInfo ***, int *);
3711 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3712 struct ConfigTypeInfo *suffix_list,
3713 char **ignore_tokens,
3714 int num_file_list_entries)
3716 SetupFileHash *ignore_tokens_hash;
3717 struct FileInfo *file_list;
3718 int num_file_list_entries_found = 0;
3719 int num_suffix_list_entries = 0;
3723 // create hash from list of tokens to be ignored (for quick access)
3724 ignore_tokens_hash = newSetupFileHash();
3725 for (i = 0; ignore_tokens[i] != NULL; i++)
3726 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3728 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3730 for (i = 0; suffix_list[i].token != NULL; i++)
3731 num_suffix_list_entries++;
3733 // always start with reliable default values
3734 for (i = 0; i < num_file_list_entries; i++)
3736 file_list[i].token = NULL;
3738 file_list[i].default_filename = NULL;
3739 file_list[i].filename = NULL;
3741 if (num_suffix_list_entries > 0)
3743 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3745 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3746 file_list[i].parameter = checked_calloc(parameter_array_size);
3748 for (j = 0; j < num_suffix_list_entries; j++)
3750 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3751 setString(&file_list[i].parameter[j], suffix_list[j].value);
3754 file_list[i].redefined = FALSE;
3755 file_list[i].fallback_to_default = FALSE;
3756 file_list[i].default_is_cloned = FALSE;
3762 for (i = 0; config_list[i].token != NULL; i++)
3764 int len_config_token = strlen(config_list[i].token);
3765 boolean is_file_entry = TRUE;
3767 for (j = 0; suffix_list[j].token != NULL; j++)
3769 int len_suffix = strlen(suffix_list[j].token);
3771 if (len_suffix < len_config_token &&
3772 strEqual(&config_list[i].token[len_config_token - len_suffix],
3773 suffix_list[j].token))
3775 setString(&file_list[list_pos].default_parameter[j],
3776 config_list[i].value);
3778 is_file_entry = FALSE;
3784 // the following tokens are no file definitions, but other config tokens
3785 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3786 is_file_entry = FALSE;
3793 if (list_pos >= num_file_list_entries)
3796 file_list[list_pos].token = config_list[i].token;
3797 file_list[list_pos].default_filename = config_list[i].value;
3800 if (strSuffix(config_list[i].token, ".clone_from"))
3801 file_list[list_pos].default_is_cloned = TRUE;
3804 num_file_list_entries_found = list_pos + 1;
3805 if (num_file_list_entries_found != num_file_list_entries)
3808 Error("inconsistant config list information:");
3809 Error("- should be: %d (according to 'src/conf_xxx.h')",
3810 num_file_list_entries);
3811 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3812 num_file_list_entries_found);
3817 freeSetupFileHash(ignore_tokens_hash);
3822 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3824 int len_token = strlen(token);
3825 int len_suffix = strlen(suffix);
3827 if (start_pos < 0) // compare suffix from end of string
3828 start_pos += len_token;
3830 if (start_pos < 0 || start_pos + len_suffix > len_token)
3833 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3836 if (token[start_pos + len_suffix] == '\0')
3839 if (token[start_pos + len_suffix] == '.')
3845 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3847 static void read_token_parameters(SetupFileHash *setup_file_hash,
3848 struct ConfigTypeInfo *suffix_list,
3849 struct FileInfo *file_list_entry)
3851 // check for config token that is the base token without any suffixes
3852 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3853 char *known_token_value = KNOWN_TOKEN_VALUE;
3856 if (filename != NULL)
3858 setString(&file_list_entry->filename, filename);
3860 // when file definition found, set all parameters to default values
3861 for (i = 0; suffix_list[i].token != NULL; i++)
3862 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3864 file_list_entry->redefined = TRUE;
3866 // mark config file token as well known from default config
3867 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3870 // check for config tokens that can be build by base token and suffixes
3871 for (i = 0; suffix_list[i].token != NULL; i++)
3873 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3874 char *value = getHashEntry(setup_file_hash, token);
3878 setString(&file_list_entry->parameter[i], value);
3880 // mark config file token as well known from default config
3881 setHashEntry(setup_file_hash, token, known_token_value);
3888 static void add_dynamic_file_list_entry(struct FileInfo **list,
3889 int *num_list_entries,
3890 SetupFileHash *extra_file_hash,
3891 struct ConfigTypeInfo *suffix_list,
3892 int num_suffix_list_entries,
3895 struct FileInfo *new_list_entry;
3896 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3898 (*num_list_entries)++;
3899 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3900 new_list_entry = &(*list)[*num_list_entries - 1];
3902 new_list_entry->token = getStringCopy(token);
3903 new_list_entry->default_filename = NULL;
3904 new_list_entry->filename = NULL;
3905 new_list_entry->parameter = checked_calloc(parameter_array_size);
3907 new_list_entry->redefined = FALSE;
3908 new_list_entry->fallback_to_default = FALSE;
3909 new_list_entry->default_is_cloned = FALSE;
3911 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3914 static void add_property_mapping(struct PropertyMapping **list,
3915 int *num_list_entries,
3916 int base_index, int ext1_index,
3917 int ext2_index, int ext3_index,
3920 struct PropertyMapping *new_list_entry;
3922 (*num_list_entries)++;
3923 *list = checked_realloc(*list,
3924 *num_list_entries * sizeof(struct PropertyMapping));
3925 new_list_entry = &(*list)[*num_list_entries - 1];
3927 new_list_entry->base_index = base_index;
3928 new_list_entry->ext1_index = ext1_index;
3929 new_list_entry->ext2_index = ext2_index;
3930 new_list_entry->ext3_index = ext3_index;
3932 new_list_entry->artwork_index = artwork_index;
3935 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3938 struct FileInfo *file_list = artwork_info->file_list;
3939 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3940 char **base_prefixes = artwork_info->base_prefixes;
3941 char **ext1_suffixes = artwork_info->ext1_suffixes;
3942 char **ext2_suffixes = artwork_info->ext2_suffixes;
3943 char **ext3_suffixes = artwork_info->ext3_suffixes;
3944 char **ignore_tokens = artwork_info->ignore_tokens;
3945 int num_file_list_entries = artwork_info->num_file_list_entries;
3946 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3947 int num_base_prefixes = artwork_info->num_base_prefixes;
3948 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3949 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3950 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3951 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3952 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3953 SetupFileHash *extra_file_hash, *empty_file_hash;
3954 char *known_token_value = KNOWN_TOKEN_VALUE;
3955 char *base_token_value = UNDEFINED_FILENAME;
3958 if (filename == NULL)
3961 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3964 // separate valid (defined) from empty (undefined) config token values
3965 valid_file_hash = newSetupFileHash();
3966 empty_file_hash = newSetupFileHash();
3967 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3969 char *value = HASH_ITERATION_VALUE(itr);
3971 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3972 HASH_ITERATION_TOKEN(itr), value);
3974 END_HASH_ITERATION(setup_file_hash, itr)
3976 // at this point, we do not need the setup file hash anymore -- free it
3977 freeSetupFileHash(setup_file_hash);
3979 // prevent changing hash while iterating over it by using a temporary copy
3980 valid_file_hash_tmp = newSetupFileHash();
3981 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3983 setHashEntry(valid_file_hash_tmp,
3984 HASH_ITERATION_TOKEN(itr),
3985 HASH_ITERATION_VALUE(itr));
3987 END_HASH_ITERATION(valid_file_hash, itr)
3989 // (iterate over same temporary hash, as modifications are independent)
3991 // map deprecated to current tokens (using prefix match and replace)
3992 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3994 char *token = HASH_ITERATION_TOKEN(itr);
3995 char *mapped_token = get_mapped_token(token);
3997 if (mapped_token != NULL)
3999 char *value = HASH_ITERATION_VALUE(itr);
4002 setHashEntry(valid_file_hash, mapped_token, value);
4004 // ignore old token (by setting it to "known" keyword)
4005 setHashEntry(valid_file_hash, token, known_token_value);
4010 END_HASH_ITERATION(valid_file_hash_tmp, itr)
4012 // add special base tokens (using prefix match and replace)
4013 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
4015 char *token = HASH_ITERATION_TOKEN(itr);
4016 char *base_token = get_special_base_token(artwork_info, token);
4018 if (base_token != NULL)
4020 // add base token only if it does not already exist
4021 if (getHashEntry(valid_file_hash, base_token) == NULL)
4022 setHashEntry(valid_file_hash, base_token, base_token_value);
4027 END_HASH_ITERATION(valid_file_hash_tmp, itr)
4029 // free temporary hash used for iteration
4030 freeSetupFileHash(valid_file_hash_tmp);
4032 // read parameters for all known config file tokens
4033 for (i = 0; i < num_file_list_entries; i++)
4034 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
4036 // set all tokens that can be ignored here to "known" keyword
4037 for (i = 0; i < num_ignore_tokens; i++)
4038 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
4040 // copy all unknown config file tokens to extra config hash
4041 extra_file_hash = newSetupFileHash();
4042 BEGIN_HASH_ITERATION(valid_file_hash, itr)
4044 char *value = HASH_ITERATION_VALUE(itr);
4046 if (!strEqual(value, known_token_value))
4047 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
4049 END_HASH_ITERATION(valid_file_hash, itr)
4051 // at this point, we do not need the valid file hash anymore -- free it
4052 freeSetupFileHash(valid_file_hash);
4054 // now try to determine valid, dynamically defined config tokens
4056 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4058 struct FileInfo **dynamic_file_list =
4059 &artwork_info->dynamic_file_list;
4060 int *num_dynamic_file_list_entries =
4061 &artwork_info->num_dynamic_file_list_entries;
4062 struct PropertyMapping **property_mapping =
4063 &artwork_info->property_mapping;
4064 int *num_property_mapping_entries =
4065 &artwork_info->num_property_mapping_entries;
4066 int current_summarized_file_list_entry =
4067 artwork_info->num_file_list_entries +
4068 artwork_info->num_dynamic_file_list_entries;
4069 char *token = HASH_ITERATION_TOKEN(itr);
4070 int len_token = strlen(token);
4072 boolean base_prefix_found = FALSE;
4073 boolean parameter_suffix_found = FALSE;
4075 // skip all parameter definitions (handled by read_token_parameters())
4076 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
4078 int len_suffix = strlen(suffix_list[i].token);
4080 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
4081 parameter_suffix_found = TRUE;
4084 if (parameter_suffix_found)
4087 // ---------- step 0: search for matching base prefix ----------
4090 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
4092 char *base_prefix = base_prefixes[i];
4093 int len_base_prefix = strlen(base_prefix);
4094 boolean ext1_suffix_found = FALSE;
4095 boolean ext2_suffix_found = FALSE;
4096 boolean ext3_suffix_found = FALSE;
4097 boolean exact_match = FALSE;
4098 int base_index = -1;
4099 int ext1_index = -1;
4100 int ext2_index = -1;
4101 int ext3_index = -1;
4103 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
4105 if (!base_prefix_found)
4110 if (start_pos + len_base_prefix == len_token) // exact match
4114 add_dynamic_file_list_entry(dynamic_file_list,
4115 num_dynamic_file_list_entries,
4118 num_suffix_list_entries,
4120 add_property_mapping(property_mapping,
4121 num_property_mapping_entries,
4122 base_index, -1, -1, -1,
4123 current_summarized_file_list_entry);
4127 // ---------- step 1: search for matching first suffix ----------
4129 start_pos += len_base_prefix;
4130 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
4132 char *ext1_suffix = ext1_suffixes[j];
4133 int len_ext1_suffix = strlen(ext1_suffix);
4135 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
4137 if (!ext1_suffix_found)
4142 if (start_pos + len_ext1_suffix == len_token) // exact match
4146 add_dynamic_file_list_entry(dynamic_file_list,
4147 num_dynamic_file_list_entries,
4150 num_suffix_list_entries,
4152 add_property_mapping(property_mapping,
4153 num_property_mapping_entries,
4154 base_index, ext1_index, -1, -1,
4155 current_summarized_file_list_entry);
4159 start_pos += len_ext1_suffix;
4165 // ---------- step 2: search for matching second suffix ----------
4167 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
4169 char *ext2_suffix = ext2_suffixes[k];
4170 int len_ext2_suffix = strlen(ext2_suffix);
4172 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
4174 if (!ext2_suffix_found)
4179 if (start_pos + len_ext2_suffix == len_token) // exact match
4183 add_dynamic_file_list_entry(dynamic_file_list,
4184 num_dynamic_file_list_entries,
4187 num_suffix_list_entries,
4189 add_property_mapping(property_mapping,
4190 num_property_mapping_entries,
4191 base_index, ext1_index, ext2_index, -1,
4192 current_summarized_file_list_entry);
4196 start_pos += len_ext2_suffix;
4202 // ---------- step 3: search for matching third suffix ----------
4204 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4206 char *ext3_suffix = ext3_suffixes[l];
4207 int len_ext3_suffix = strlen(ext3_suffix);
4209 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4211 if (!ext3_suffix_found)
4216 if (start_pos + len_ext3_suffix == len_token) // exact match
4220 add_dynamic_file_list_entry(dynamic_file_list,
4221 num_dynamic_file_list_entries,
4224 num_suffix_list_entries,
4226 add_property_mapping(property_mapping,
4227 num_property_mapping_entries,
4228 base_index, ext1_index, ext2_index, ext3_index,
4229 current_summarized_file_list_entry);
4235 END_HASH_ITERATION(extra_file_hash, itr)
4237 if (artwork_info->num_dynamic_file_list_entries > 0)
4239 artwork_info->dynamic_artwork_list =
4240 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4241 artwork_info->sizeof_artwork_list_entry);
4244 if (options.verbose && IS_PARENT_PROCESS())
4246 SetupFileList *setup_file_list, *list;
4247 boolean dynamic_tokens_found = FALSE;
4248 boolean unknown_tokens_found = FALSE;
4249 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4251 // list may be NULL for empty artwork config files
4252 setup_file_list = loadSetupFileList(filename);
4254 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4256 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4257 dynamic_tokens_found = TRUE;
4259 unknown_tokens_found = TRUE;
4261 END_HASH_ITERATION(extra_file_hash, itr)
4263 if (options.debug && dynamic_tokens_found)
4265 Debug("config", "---");
4266 Debug("config", "dynamic token(s) found in config file:");
4267 Debug("config", "- config file: '%s'", filename);
4269 for (list = setup_file_list; list != NULL; list = list->next)
4271 char *value = getHashEntry(extra_file_hash, list->token);
4273 if (value != NULL && strEqual(value, known_token_value))
4274 Debug("config", "- dynamic token: '%s'", list->token);
4277 Debug("config", "---");
4280 if (unknown_tokens_found)
4283 Warn("unknown token(s) found in config file:");
4284 Warn("- config file: '%s'", filename);
4286 for (list = setup_file_list; list != NULL; list = list->next)
4288 char *value = getHashEntry(extra_file_hash, list->token);
4290 if (value != NULL && !strEqual(value, known_token_value))
4291 Warn("- dynamic token: '%s'", list->token);
4297 if (undefined_values_found)
4300 Warn("undefined values found in config file:");
4301 Warn("- config file: '%s'", filename);
4303 for (list = setup_file_list; list != NULL; list = list->next)
4305 char *value = getHashEntry(empty_file_hash, list->token);
4308 Warn("- undefined value for token: '%s'", list->token);
4314 freeSetupFileList(setup_file_list);
4317 freeSetupFileHash(extra_file_hash);
4318 freeSetupFileHash(empty_file_hash);
4321 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4323 struct FileInfo *file_list = artwork_info->file_list;
4324 int num_file_list_entries = artwork_info->num_file_list_entries;
4325 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4326 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4329 DrawInitTextHead("Loading artwork config");
4330 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4332 // always start with reliable default values
4333 for (i = 0; i < num_file_list_entries; i++)
4335 setString(&file_list[i].filename, file_list[i].default_filename);
4337 for (j = 0; j < num_suffix_list_entries; j++)
4338 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4340 file_list[i].redefined = FALSE;
4341 file_list[i].fallback_to_default = FALSE;
4344 // free previous dynamic artwork file array
4345 if (artwork_info->dynamic_file_list != NULL)
4347 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4349 free(artwork_info->dynamic_file_list[i].token);
4350 free(artwork_info->dynamic_file_list[i].filename);
4351 free(artwork_info->dynamic_file_list[i].parameter);
4354 free(artwork_info->dynamic_file_list);
4355 artwork_info->dynamic_file_list = NULL;
4357 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4358 &artwork_info->num_dynamic_file_list_entries);
4361 // free previous property mapping
4362 if (artwork_info->property_mapping != NULL)
4364 free(artwork_info->property_mapping);
4366 artwork_info->property_mapping = NULL;
4367 artwork_info->num_property_mapping_entries = 0;
4370 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4372 // first look for special artwork configured in level series config
4373 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4375 if (fileExists(filename_base))
4376 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4379 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4381 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4382 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4385 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4386 struct ListNodeInfo **listnode)
4390 char *filename = (*listnode)->source_filename;
4392 if (--(*listnode)->num_references <= 0)
4393 deleteNodeFromList(&artwork_info->content_list, filename,
4394 artwork_info->free_artwork);
4400 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4401 struct ListNodeInfo **listnode,
4402 struct FileInfo *file_list_entry)
4412 char *basename = file_list_entry->filename;
4413 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4415 // mark all images from non-default graphics directory as "redefined"
4416 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4417 !strPrefix(filename, options.graphics_directory))
4418 file_list_entry->redefined = TRUE;
4420 if (filename == NULL)
4422 Warn("cannot find artwork file '%s'", basename);
4424 basename = file_list_entry->default_filename;
4426 // fail for cloned default artwork that has no default filename defined
4427 if (file_list_entry->default_is_cloned &&
4428 strEqual(basename, UNDEFINED_FILENAME))
4430 void (*error_func)(char *, ...) = Warn;
4432 // we can get away without sounds and music, but not without graphics
4433 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4436 error_func("token '%s' was cloned and has no default filename",
4437 file_list_entry->token);
4442 // dynamic artwork has no default filename / skip empty default artwork
4443 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4446 file_list_entry->fallback_to_default = TRUE;
4448 Warn("trying default artwork file '%s'", basename);
4450 filename = getCustomArtworkFilename(basename, artwork_info->type);
4452 if (filename == NULL)
4454 void (*error_func)(char *, ...) = Warn;
4456 // we can get away without sounds and music, but not without graphics
4457 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4460 error_func("cannot find default artwork file '%s'", basename);
4466 // check if the old and the new artwork file are the same
4467 if (*listnode && strEqual((*listnode)->source_filename, filename))
4469 // The old and new artwork are the same (have the same filename and path).
4470 // This usually means that this artwork does not exist in this artwork set
4471 // and a fallback to the existing artwork is done.
4476 // delete existing artwork file entry
4477 deleteArtworkListEntry(artwork_info, listnode);
4479 // check if the new artwork file already exists in the list of artwork
4480 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4482 *listnode = (struct ListNodeInfo *)node->content;
4483 (*listnode)->num_references++;
4488 DrawInitTextHead(init_text[artwork_info->type]);
4489 DrawInitTextItem(basename);
4491 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4493 // add new artwork file entry to the list of artwork files
4494 (*listnode)->num_references = 1;
4495 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4500 void (*error_func)(char *, ...) = Warn;
4502 // we can get away without sounds and music, but not without graphics
4503 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4506 error_func("cannot load artwork file '%s'", basename);
4512 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4513 struct ListNodeInfo **listnode,
4514 struct FileInfo *file_list_entry)
4516 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4518 deleteArtworkListEntry(artwork_info, listnode);
4523 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4526 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4528 struct FileInfo *file_list = artwork_info->file_list;
4529 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4530 int num_file_list_entries = artwork_info->num_file_list_entries;
4531 int num_dynamic_file_list_entries =
4532 artwork_info->num_dynamic_file_list_entries;
4535 print_timestamp_init("ReloadCustomArtworkList");
4537 for (i = 0; i < num_file_list_entries; i++)
4538 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4541 for (i = 0; i < num_dynamic_file_list_entries; i++)
4542 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4543 &dynamic_file_list[i]);
4545 print_timestamp_done("ReloadCustomArtworkList");
4548 dumpList(artwork_info->content_list);
4552 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4553 struct ListNodeInfo ***list,
4554 int *num_list_entries)
4561 for (i = 0; i < *num_list_entries; i++)
4562 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4566 *num_list_entries = 0;
4569 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4571 if (artwork_info == NULL)
4574 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4575 &artwork_info->num_file_list_entries);
4577 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4578 &artwork_info->num_dynamic_file_list_entries);
4582 // ----------------------------------------------------------------------------
4583 // functions only needed for non-Unix (non-command-line) systems
4584 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4585 // (now also added for Windows, to create files in user data directory)
4586 // ----------------------------------------------------------------------------
4588 char *getLogBasename(char *basename)
4590 return getStringCat2(basename, ".log");
4593 char *getLogFilename(char *basename)
4595 return getPath2(getMainUserGameDataDir(), basename);
4598 void OpenLogFile(void)
4600 InitMainUserDataDirectory();
4602 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4604 program.log_file = program.log_file_default; // reset to default
4606 Warn("cannot open file '%s' for writing: %s",
4607 program.log_filename, strerror(errno));
4610 // output should be unbuffered so it is not truncated in a crash
4611 setbuf(program.log_file, NULL);
4614 void CloseLogFile(void)
4616 if (program.log_file != program.log_file_default)
4617 fclose(program.log_file);
4620 void DumpLogFile(void)
4622 FILE *log_file = fopen(program.log_filename, MODE_READ);
4624 if (log_file == NULL)
4627 while (!feof(log_file))
4628 fputc(fgetc(log_file), stdout);
4633 void NotifyUserAboutErrorFile(void)
4635 #if defined(PLATFORM_WINDOWS)
4636 char *title_text = getStringCat2(program.program_title, " Error Message");
4637 char *error_text = getStringCat2("The program was aborted due to an error; "
4638 "for details, see the following error file:"
4640 program.log_filename);
4642 MessageBox(NULL, error_text, title_text, MB_OK);
4647 // ----------------------------------------------------------------------------
4648 // the following is only for debugging purpose and normally not used
4649 // ----------------------------------------------------------------------------
4653 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4654 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4656 #define DEBUG_NUM_TIMESTAMPS 10
4657 #define DEBUG_TIME_IN_MICROSECONDS 0
4659 #if DEBUG_TIME_IN_MICROSECONDS
4660 static double Counter_Microseconds(void)
4662 static struct timeval base_time = { 0, 0 };
4663 struct timeval current_time;
4666 gettimeofday(¤t_time, NULL);
4668 // reset base time in case of wrap-around
4669 if (current_time.tv_sec < base_time.tv_sec)
4670 base_time = current_time;
4673 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4674 ((double)(current_time.tv_usec - base_time.tv_usec));
4676 return counter; // return microseconds since last init
4680 static char *debug_print_timestamp_get_padding(int padding_size)
4682 static char *padding = NULL;
4683 int max_padding_size = 100;
4685 if (padding == NULL)
4687 padding = checked_calloc(max_padding_size + 1);
4688 memset(padding, ' ', max_padding_size);
4691 return &padding[MAX(0, max_padding_size - padding_size)];
4694 void debug_print_timestamp(int counter_nr, char *message)
4696 int indent_size = 8;
4697 int padding_size = 40;
4698 float timestamp_interval;
4701 Fail("debugging: invalid negative counter");
4702 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4703 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4705 #if DEBUG_TIME_IN_MICROSECONDS
4706 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4709 counter[counter_nr][0] = Counter_Microseconds();
4711 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4714 counter[counter_nr][0] = Counter();
4717 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4718 counter[counter_nr][1] = counter[counter_nr][0];
4721 Debug("time:init", "%s%s%s %.3f %s",
4722 debug_print_timestamp_get_padding(counter_nr * indent_size),
4724 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4725 timestamp_interval / 1000,
4730 static void debug_print_parent_only(char *format, ...)
4732 if (!IS_PARENT_PROCESS())
4739 va_start(ap, format);
4740 vprintf(format, ap);
4750 static void print_timestamp_ext(char *message, char *mode)
4752 #if DEBUG_PRINT_INIT_TIMESTAMPS
4753 static char *debug_message = NULL;
4754 static char *last_message = NULL;
4755 static int counter_nr = 0;
4756 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4758 checked_free(debug_message);
4759 debug_message = getStringCat3(mode, " ", message);
4761 if (strEqual(mode, "INIT"))
4763 debug_print_timestamp(counter_nr, NULL);
4765 if (counter_nr + 1 < max_depth)
4766 debug_print_timestamp(counter_nr, debug_message);
4770 debug_print_timestamp(counter_nr, NULL);
4772 else if (strEqual(mode, "DONE"))
4776 if (counter_nr + 1 < max_depth ||
4777 (counter_nr == 0 && max_depth == 1))
4779 last_message = message;
4781 if (counter_nr == 0 && max_depth == 1)
4783 checked_free(debug_message);
4784 debug_message = getStringCat3("TIME", " ", message);
4787 debug_print_timestamp(counter_nr, debug_message);
4790 else if (!strEqual(mode, "TIME") ||
4791 !strEqual(message, last_message))
4793 if (counter_nr < max_depth)
4794 debug_print_timestamp(counter_nr, debug_message);
4799 void print_timestamp_init(char *message)
4801 print_timestamp_ext(message, "INIT");
4804 void print_timestamp_time(char *message)
4806 print_timestamp_ext(message, "TIME");
4809 void print_timestamp_done(char *message)
4811 print_timestamp_ext(message, "DONE");