1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter(void) // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter(void) // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToUpper(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = toupper(*s++);
1235 char *getStringToLower(const char *s)
1237 char *s_copy = checked_malloc(strlen(s) + 1);
1238 char *s_ptr = s_copy;
1241 *s_ptr++ = tolower(*s++);
1247 void setString(char **old_value, const char *new_value)
1249 checked_free(*old_value);
1251 *old_value = getStringCopy(new_value);
1254 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1256 const char *s_ptr, *s_last = s;
1257 byte separator_table[256] = { FALSE };
1259 char **tokens = NULL;
1264 if (separators == NULL)
1268 max_tokens = INT_MAX;
1270 // if string is empty, return empty array
1273 tokens = checked_malloc(sizeof(char *));
1279 // initialize separator table for all characters in separators string
1280 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1281 separator_table[*(byte *)s_ptr] = TRUE;
1283 // count number of tokens in string
1284 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1285 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1288 // allocate array for determined number of tokens
1289 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1291 // copy all but last separated sub-strings to array
1292 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1294 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1296 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1301 // copy last separated sub-string to array
1302 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1305 tokens[num_tokens] = NULL;
1310 int getStringArrayLength(char **s_array)
1312 int num_strings = 0;
1314 if (s_array == NULL)
1317 while (s_array[num_strings] != NULL)
1323 void freeStringArray(char **s_array)
1327 if (s_array == NULL)
1330 for (i = 0; s_array[i] != NULL; i++)
1331 checked_free(s_array[i]);
1333 checked_free(s_array);
1336 char *getUnescapedString(const char *s)
1338 const char *s_ptr = s;
1339 const char *octal_ptr;
1341 char *s_unescaped_ptr;
1346 s_unescaped = checked_malloc(strlen(s) + 1);
1347 s_unescaped_ptr = s_unescaped;
1349 while (*s_ptr != '\0')
1358 Warn("getUnescapedString: trailing \\");
1369 *s_unescaped_ptr = 0;
1372 while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7')
1374 *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0');
1383 *s_unescaped_ptr++ = '\b';
1387 *s_unescaped_ptr++ = '\f';
1391 *s_unescaped_ptr++ = '\n';
1395 *s_unescaped_ptr++ = '\r';
1399 *s_unescaped_ptr++ = '\t';
1403 *s_unescaped_ptr++ = '\v';
1407 /* also handles \" and \\ */
1408 *s_unescaped_ptr++ = *s_ptr;
1414 *s_unescaped_ptr++ = *s_ptr;
1421 *s_unescaped_ptr = '\0';
1426 boolean strEqual(const char *s1, const char *s2)
1428 return (s1 == NULL && s2 == NULL ? TRUE :
1429 s1 == NULL && s2 != NULL ? FALSE :
1430 s1 != NULL && s2 == NULL ? FALSE :
1431 strcmp(s1, s2) == 0);
1434 boolean strEqualN(const char *s1, const char *s2, int n)
1436 return (s1 == NULL && s2 == NULL ? TRUE :
1437 s1 == NULL && s2 != NULL ? FALSE :
1438 s1 != NULL && s2 == NULL ? FALSE :
1439 strncmp(s1, s2, n) == 0);
1442 boolean strEqualCase(const char *s1, const char *s2)
1444 return (s1 == NULL && s2 == NULL ? TRUE :
1445 s1 == NULL && s2 != NULL ? FALSE :
1446 s1 != NULL && s2 == NULL ? FALSE :
1447 strcasecmp(s1, s2) == 0);
1450 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1452 return (s1 == NULL && s2 == NULL ? TRUE :
1453 s1 == NULL && s2 != NULL ? FALSE :
1454 s1 != NULL && s2 == NULL ? FALSE :
1455 strncasecmp(s1, s2, n) == 0);
1458 boolean strPrefix(const char *s, const char *prefix)
1460 return (s == NULL && prefix == NULL ? TRUE :
1461 s == NULL && prefix != NULL ? FALSE :
1462 s != NULL && prefix == NULL ? FALSE :
1463 strncmp(s, prefix, strlen(prefix)) == 0);
1466 boolean strSuffix(const char *s, const char *suffix)
1468 return (s == NULL && suffix == NULL ? TRUE :
1469 s == NULL && suffix != NULL ? FALSE :
1470 s != NULL && suffix == NULL ? FALSE :
1471 strlen(s) < strlen(suffix) ? FALSE :
1472 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1475 boolean strPrefixLower(const char *s, const char *prefix)
1477 char *s_lower = getStringToLower(s);
1478 boolean match = strPrefix(s_lower, prefix);
1485 boolean strSuffixLower(const char *s, const char *suffix)
1487 char *s_lower = getStringToLower(s);
1488 boolean match = strSuffix(s_lower, suffix);
1495 boolean isURL(const char *s)
1497 while (*s && *s >= 'a' && *s <= 'z')
1500 return strPrefix(s, "://");
1504 // ----------------------------------------------------------------------------
1505 // command line option handling functions
1506 // ----------------------------------------------------------------------------
1508 void GetOptions(int argc, char *argv[],
1509 void (*print_usage_function)(void),
1510 void (*print_version_function)(void))
1512 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1513 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1514 char **options_left = &argvplus[1];
1516 // replace original "argv" with null-terminated array of string pointers
1518 argvplus[argc] = argv[argc];
1520 // initialize global program options
1521 options.server_host = NULL;
1522 options.server_port = 0;
1524 options.base_directory = base_path;
1526 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1527 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1528 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1529 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1530 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1531 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1533 options.execute_command = NULL;
1534 options.tape_log_filename = NULL;
1535 options.special_flags = NULL;
1536 options.debug_mode = NULL;
1537 options.player_name = NULL;
1538 options.identifier = NULL;
1539 options.level_nr = NULL;
1541 options.display_nr = 0;
1543 options.mytapes = FALSE;
1544 options.serveronly = FALSE;
1545 options.network = FALSE;
1546 options.verbose = FALSE;
1547 options.debug = FALSE;
1550 options.verbose = TRUE;
1552 #if !defined(PLATFORM_UNIX)
1553 if (*options_left == NULL) // no options given -- enable verbose mode
1554 options.verbose = TRUE;
1559 #if defined(PLATFORM_ANDROID)
1560 options.debug = TRUE;
1564 while (*options_left)
1566 char option_str[MAX_OPTION_LEN];
1567 char *option = options_left[0];
1568 char *next_option = options_left[1];
1569 char *option_arg = NULL;
1570 int option_len = strlen(option);
1572 if (option_len >= MAX_OPTION_LEN)
1573 FailWithHelp("unrecognized option '%s'", option);
1575 strcpy(option_str, option); // copy argument into buffer
1576 option = option_str;
1578 if (strEqual(option, "--")) // stop scanning arguments
1581 if (strPrefix(option, "--")) // treat '--' like '-'
1584 option_arg = strchr(option, '=');
1585 if (option_arg == NULL) // no '=' in option
1586 option_arg = next_option;
1589 *option_arg++ = '\0'; // cut argument from option
1590 if (*option_arg == '\0') // no argument after '='
1591 FailWithHelp("option '%s' has invalid argument", option_str);
1594 option_len = strlen(option);
1596 if (strEqual(option, "-"))
1598 FailWithHelp("unrecognized option '%s'", option);
1600 else if (strncmp(option, "-help", option_len) == 0)
1602 print_usage_function();
1606 else if (strncmp(option, "-basepath", option_len) == 0)
1608 if (option_arg == NULL)
1609 FailWithHelp("option '%s' requires an argument", option_str);
1611 options.base_directory = base_path = getStringCopy(option_arg);
1612 if (option_arg == next_option)
1615 // adjust paths for sub-directories in base directory accordingly
1616 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1617 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1618 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1619 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1620 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1621 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1623 else if (strncmp(option, "-levels", option_len) == 0)
1625 if (option_arg == NULL)
1626 FailWithHelp("option '%s' requires an argument", option_str);
1628 options.level_directory = getStringCopy(option_arg);
1629 if (option_arg == next_option)
1632 else if (strncmp(option, "-graphics", option_len) == 0)
1634 if (option_arg == NULL)
1635 FailWithHelp("option '%s' requires an argument", option_str);
1637 options.graphics_directory = getStringCopy(option_arg);
1638 if (option_arg == next_option)
1641 else if (strncmp(option, "-sounds", option_len) == 0)
1643 if (option_arg == NULL)
1644 FailWithHelp("option '%s' requires an argument", option_str);
1646 options.sounds_directory = getStringCopy(option_arg);
1647 if (option_arg == next_option)
1650 else if (strncmp(option, "-music", option_len) == 0)
1652 if (option_arg == NULL)
1653 FailWithHelp("option '%s' requires an argument", option_str);
1655 options.music_directory = getStringCopy(option_arg);
1656 if (option_arg == next_option)
1659 else if (strncmp(option, "-mytapes", option_len) == 0)
1661 options.mytapes = TRUE;
1663 else if (strncmp(option, "-network", option_len) == 0)
1665 options.network = TRUE;
1667 else if (strncmp(option, "-serveronly", option_len) == 0)
1669 options.serveronly = TRUE;
1671 else if (strncmp(option, "-debug", option_len) == 0)
1673 options.debug = TRUE;
1675 // optionally, debug output can be limited to a specific debug mode
1676 if (option_arg != next_option)
1677 options.debug_mode = getStringCopy(option_arg);
1679 else if (strncmp(option, "-player-name", option_len) == 0)
1681 if (option_arg == NULL)
1682 FailWithHelp("option '%s' requires an argument", option_str);
1684 options.player_name = getStringCopy(option_arg);
1685 if (option_arg == next_option)
1688 else if (strncmp(option, "-identifier", option_len) == 0)
1690 if (option_arg == NULL)
1691 FailWithHelp("option '%s' requires an argument", option_str);
1693 options.identifier = getStringCopy(option_arg);
1694 if (option_arg == next_option)
1697 else if (strncmp(option, "-level-nr", option_len) == 0)
1699 if (option_arg == NULL)
1700 FailWithHelp("option '%s' requires an argument", option_str);
1702 options.level_nr = getStringCopy(option_arg);
1703 if (option_arg == next_option)
1706 else if (strncmp(option, "-verbose", option_len) == 0)
1708 options.verbose = TRUE;
1710 else if (strncmp(option, "-version", option_len) == 0 ||
1711 strncmp(option, "-V", option_len) == 0)
1713 print_version_function();
1717 else if (strPrefix(option, "-D"))
1719 options.special_flags = getStringCopy(&option[2]);
1721 else if (strncmp(option, "-execute", option_len) == 0)
1723 if (option_arg == NULL)
1724 FailWithHelp("option '%s' requires an argument", option_str);
1726 options.execute_command = getStringCopy(option_arg);
1727 if (option_arg == next_option)
1730 // when doing batch processing, always enable verbose mode (warnings)
1731 options.verbose = TRUE;
1733 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1735 if (option_arg == NULL)
1736 FailWithHelp("option '%s' requires an argument", option_str);
1738 options.tape_log_filename = getStringCopy(option_arg);
1739 if (option_arg == next_option)
1742 else if (strncmp(option, "-display", option_len) == 0)
1744 if (option_arg == NULL)
1745 FailWithHelp("option '%s' requires an argument", option_str);
1747 if (option_arg == next_option)
1750 int display_nr = atoi(option_arg);
1753 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1754 options.display_nr = display_nr;
1756 options.display_nr =
1757 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1759 if (display_nr != options.display_nr)
1760 Warn("invalid display %d -- using display %d",
1761 display_nr, options.display_nr);
1764 #if defined(PLATFORM_MAC)
1765 else if (strPrefix(option, "-psn"))
1767 // ignore process serial number when launched via GUI on Mac OS X
1770 else if (*option == '-')
1772 FailWithHelp("unrecognized option '%s'", option_str);
1774 else if (options.server_host == NULL)
1776 options.server_host = *options_left;
1778 else if (options.server_port == 0)
1780 options.server_port = atoi(*options_left);
1781 if (options.server_port < 1024)
1782 FailWithHelp("bad port number '%d'", options.server_port);
1785 FailWithHelp("too many arguments");
1792 // ----------------------------------------------------------------------------
1793 // checked memory allocation and freeing functions
1794 // ----------------------------------------------------------------------------
1796 void *checked_malloc(unsigned int size)
1803 Fail("cannot allocate %d bytes -- out of memory", size);
1808 void *checked_calloc(unsigned int size)
1812 ptr = calloc(1, size);
1815 Fail("cannot allocate %d bytes -- out of memory", size);
1820 void *checked_realloc(void *ptr, unsigned int size)
1822 ptr = realloc(ptr, size);
1825 Fail("cannot allocate %d bytes -- out of memory", size);
1830 void checked_free(void *ptr)
1832 if (ptr != NULL) // this check should be done by free() anyway
1836 void clear_mem(void *ptr, unsigned int size)
1838 #if defined(PLATFORM_WINDOWS)
1839 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1840 char *cptr = (char *)ptr;
1845 memset(ptr, 0, size);
1850 // ----------------------------------------------------------------------------
1851 // various helper functions
1852 // ----------------------------------------------------------------------------
1854 void swap_numbers(int *i1, int *i2)
1862 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1874 int get_number_of_bits(int bits)
1877 Counting bits set, Brian Kernighan's way
1879 Brian Kernighan's method goes through as many iterations as there are set
1880 bits. So if we have a 32-bit word with only the high bit set, then it will
1881 only go once through the loop.
1883 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1884 and Dennis M. Ritchie) mentions this in exercise 2-9.
1885 First published by Peter Wegner in CACM 3 (1960), 322.
1892 bits &= bits - 1; // clear the least significant bit set
1899 /* the "put" variants of the following file access functions check for the file
1900 pointer being != NULL and return the number of bytes they have or would have
1901 written; this allows for chunk writing functions to first determine the size
1902 of the (not yet written) chunk, write the correct chunk size and finally
1903 write the chunk itself */
1905 int getFile8BitInteger(File *file)
1907 return getByteFromFile(file);
1910 int putFile8BitInteger(FILE *file, int value)
1918 int getFile16BitInteger(File *file, int byte_order)
1920 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1921 return ((getByteFromFile(file) << 8) |
1922 (getByteFromFile(file) << 0));
1923 else // BYTE_ORDER_LITTLE_ENDIAN
1924 return ((getByteFromFile(file) << 0) |
1925 (getByteFromFile(file) << 8));
1928 int putFile16BitInteger(FILE *file, int value, int byte_order)
1932 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1934 fputc((value >> 8) & 0xff, file);
1935 fputc((value >> 0) & 0xff, file);
1937 else // BYTE_ORDER_LITTLE_ENDIAN
1939 fputc((value >> 0) & 0xff, file);
1940 fputc((value >> 8) & 0xff, file);
1947 int getFile32BitInteger(File *file, int byte_order)
1949 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1950 return ((getByteFromFile(file) << 24) |
1951 (getByteFromFile(file) << 16) |
1952 (getByteFromFile(file) << 8) |
1953 (getByteFromFile(file) << 0));
1954 else // BYTE_ORDER_LITTLE_ENDIAN
1955 return ((getByteFromFile(file) << 0) |
1956 (getByteFromFile(file) << 8) |
1957 (getByteFromFile(file) << 16) |
1958 (getByteFromFile(file) << 24));
1961 int putFile32BitInteger(FILE *file, int value, int byte_order)
1965 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1967 fputc((value >> 24) & 0xff, file);
1968 fputc((value >> 16) & 0xff, file);
1969 fputc((value >> 8) & 0xff, file);
1970 fputc((value >> 0) & 0xff, file);
1972 else // BYTE_ORDER_LITTLE_ENDIAN
1974 fputc((value >> 0) & 0xff, file);
1975 fputc((value >> 8) & 0xff, file);
1976 fputc((value >> 16) & 0xff, file);
1977 fputc((value >> 24) & 0xff, file);
1984 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1987 const int chunk_name_length = 4;
1990 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1993 if (chunk_size != NULL)
1996 *chunk_size = getFile32BitInteger(file, byte_order);
1999 return (checkEndOfFile(file) ? FALSE : TRUE);
2002 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2009 fputs(chunk_name, file);
2011 num_bytes += strlen(chunk_name);
2013 if (chunk_size >= 0)
2017 putFile32BitInteger(file, chunk_size, byte_order);
2025 int getFileVersion(File *file)
2027 int version_super = getByteFromFile(file);
2028 int version_major = getByteFromFile(file);
2029 int version_minor = getByteFromFile(file);
2030 int version_patch = getByteFromFile(file);
2032 return VERSION_IDENT(version_super, version_major, version_minor,
2036 int putFileVersion(FILE *file, int version)
2040 int version_super = VERSION_SUPER(version);
2041 int version_major = VERSION_MAJOR(version);
2042 int version_minor = VERSION_MINOR(version);
2043 int version_patch = VERSION_PATCH(version);
2045 fputc(version_super, file);
2046 fputc(version_major, file);
2047 fputc(version_minor, file);
2048 fputc(version_patch, file);
2054 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2058 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2059 buffer[i] = getByteFromFile(file);
2062 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2066 for (i = 0; i < bytes; i++)
2067 fputc(buffer[i], file);
2070 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2072 while (bytes-- && !checkEndOfFile(file))
2073 getByteFromFile(file);
2076 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2083 // ----------------------------------------------------------------------------
2084 // functions to convert between ISO-8859-1 and UTF-8
2085 // ----------------------------------------------------------------------------
2087 char *getUTF8FromLatin1(char *latin1)
2089 int max_utf8_size = 2 * strlen(latin1) + 1;
2090 char *utf8 = checked_calloc(max_utf8_size);
2091 unsigned char *src = (unsigned char *)latin1;
2092 unsigned char *dst = (unsigned char *)utf8;
2096 if (*src < 128) // pure 7-bit ASCII
2100 else if (*src >= 160) // non-ASCII characters
2102 *dst++ = 194 + (*src >= 192);
2103 *dst++ = 128 + (*src & 63);
2105 else // undefined in ISO-8859-1
2113 // only use the smallest possible string buffer size
2114 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2119 char *getLatin1FromUTF8(char *utf8)
2121 int max_latin1_size = strlen(utf8) + 1;
2122 char *latin1 = checked_calloc(max_latin1_size);
2123 unsigned char *src = (unsigned char *)utf8;
2124 unsigned char *dst = (unsigned char *)latin1;
2128 if (*src < 128) // pure 7-bit ASCII
2132 else if (src[0] == 194 &&
2133 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2138 else if (src[0] == 195 &&
2139 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2141 *dst++ = src[1] + 64;
2145 // all other UTF-8 characters are undefined in ISO-8859-1
2147 else if (src[0] >= 192 && src[0] < 224 &&
2148 src[1] >= 128 && src[1] < 192)
2153 else if (src[0] >= 224 && src[0] < 240 &&
2154 src[1] >= 128 && src[1] < 192 &&
2155 src[2] >= 128 && src[2] < 192)
2160 else if (src[0] >= 240 && src[0] < 248 &&
2161 src[1] >= 128 && src[1] < 192 &&
2162 src[2] >= 128 && src[2] < 192 &&
2163 src[3] >= 128 && src[3] < 192)
2168 else if (src[0] >= 248 && src[0] < 252 &&
2169 src[1] >= 128 && src[1] < 192 &&
2170 src[2] >= 128 && src[2] < 192 &&
2171 src[3] >= 128 && src[3] < 192 &&
2172 src[4] >= 128 && src[4] < 192)
2177 else if (src[0] >= 252 && src[0] < 254 &&
2178 src[1] >= 128 && src[1] < 192 &&
2179 src[2] >= 128 && src[2] < 192 &&
2180 src[3] >= 128 && src[3] < 192 &&
2181 src[4] >= 128 && src[4] < 192 &&
2182 src[5] >= 128 && src[5] < 192)
2194 // only use the smallest possible string buffer size
2195 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2200 int getTextEncoding(char *text)
2202 unsigned char *src = (unsigned char *)text;
2203 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2208 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2214 else if (src[0] >= 192 && src[0] < 224 &&
2215 src[1] >= 128 && src[1] < 192)
2219 else if (src[0] >= 224 && src[0] < 240 &&
2220 src[1] >= 128 && src[1] < 192 &&
2221 src[2] >= 128 && src[2] < 192)
2225 else if (src[0] >= 240 && src[0] < 248 &&
2226 src[1] >= 128 && src[1] < 192 &&
2227 src[2] >= 128 && src[2] < 192 &&
2228 src[3] >= 128 && src[3] < 192)
2232 else if (src[0] >= 248 && src[0] < 252 &&
2233 src[1] >= 128 && src[1] < 192 &&
2234 src[2] >= 128 && src[2] < 192 &&
2235 src[3] >= 128 && src[3] < 192 &&
2236 src[4] >= 128 && src[4] < 192)
2240 else if (src[0] >= 252 && src[0] < 254 &&
2241 src[1] >= 128 && src[1] < 192 &&
2242 src[2] >= 128 && src[2] < 192 &&
2243 src[3] >= 128 && src[3] < 192 &&
2244 src[4] >= 128 && src[4] < 192 &&
2245 src[5] >= 128 && src[5] < 192)
2251 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2259 // ----------------------------------------------------------------------------
2260 // functions for JSON handling
2261 // ----------------------------------------------------------------------------
2263 char *getEscapedJSON(char *s)
2265 int max_json_size = 2 * strlen(s) + 1;
2266 char *json = checked_calloc(max_json_size);
2267 unsigned char *src = (unsigned char *)s;
2268 unsigned char *dst = (unsigned char *)json;
2269 char *escaped[256] =
2282 if (escaped[*src] != NULL)
2284 char *esc = escaped[*src++];
2295 // only use the smallest possible string buffer size
2296 json = checked_realloc(json, strlen(json) + 1);
2302 // ----------------------------------------------------------------------------
2303 // functions to translate key identifiers between different format
2304 // ----------------------------------------------------------------------------
2306 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2307 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2308 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2309 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2311 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2320 // return and escape keys
2321 { KSYM_Return, "XK_Return", "return" },
2322 { KSYM_Escape, "XK_Escape", "escape" },
2324 // normal cursor keys
2325 { KSYM_Left, "XK_Left", "cursor left" },
2326 { KSYM_Right, "XK_Right", "cursor right" },
2327 { KSYM_Up, "XK_Up", "cursor up" },
2328 { KSYM_Down, "XK_Down", "cursor down" },
2330 // keypad cursor keys
2332 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2333 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2334 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2335 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2338 // other keypad keys
2339 #ifdef KSYM_KP_Enter
2340 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2341 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2342 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2343 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2344 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2345 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2349 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2350 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2351 { KSYM_Control_L, "XK_Control_L", "left control" },
2352 { KSYM_Control_R, "XK_Control_R", "right control" },
2353 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2354 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2355 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2356 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2357 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2358 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2360 // some special keys
2361 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2362 { KSYM_Delete, "XK_Delete", "delete" },
2363 { KSYM_Insert, "XK_Insert", "insert" },
2364 { KSYM_Tab, "XK_Tab", "tab" },
2365 { KSYM_Home, "XK_Home", "home" },
2366 { KSYM_End, "XK_End", "end" },
2367 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2368 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2370 { KSYM_Select, "XK_Select", "select" },
2371 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2372 { KSYM_Back, "XK_Back", "back" }, // back key
2373 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2374 #if defined(PLATFORM_ANDROID)
2375 { KSYM_Rewind, "XK_Rewind", "rewind" },
2376 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2379 // ASCII 0x20 to 0x40 keys (except numbers)
2380 { KSYM_space, "XK_space", "space" },
2381 { KSYM_exclam, "XK_exclam", "!" },
2382 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2383 { KSYM_numbersign, "XK_numbersign", "#" },
2384 { KSYM_dollar, "XK_dollar", "$" },
2385 { KSYM_percent, "XK_percent", "%" },
2386 { KSYM_ampersand, "XK_ampersand", "&" },
2387 { KSYM_apostrophe, "XK_apostrophe", "'" },
2388 { KSYM_parenleft, "XK_parenleft", "(" },
2389 { KSYM_parenright, "XK_parenright", ")" },
2390 { KSYM_asterisk, "XK_asterisk", "*" },
2391 { KSYM_plus, "XK_plus", "+" },
2392 { KSYM_comma, "XK_comma", "," },
2393 { KSYM_minus, "XK_minus", "-" },
2394 { KSYM_period, "XK_period", "." },
2395 { KSYM_slash, "XK_slash", "/" },
2396 { KSYM_colon, "XK_colon", ":" },
2397 { KSYM_semicolon, "XK_semicolon", ";" },
2398 { KSYM_less, "XK_less", "<" },
2399 { KSYM_equal, "XK_equal", "=" },
2400 { KSYM_greater, "XK_greater", ">" },
2401 { KSYM_question, "XK_question", "?" },
2402 { KSYM_at, "XK_at", "@" },
2405 { KSYM_bracketleft, "XK_bracketleft", "[" },
2406 { KSYM_backslash, "XK_backslash", "\\" },
2407 { KSYM_bracketright,"XK_bracketright", "]" },
2408 { KSYM_asciicircum, "XK_asciicircum", "^" },
2409 { KSYM_underscore, "XK_underscore", "_" },
2410 { KSYM_grave, "XK_grave", "grave" },
2411 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2412 { KSYM_braceleft, "XK_braceleft", "brace left" },
2413 { KSYM_bar, "XK_bar", "bar" },
2414 { KSYM_braceright, "XK_braceright", "brace right" },
2415 { KSYM_asciitilde, "XK_asciitilde", "~" },
2417 // special (non-ASCII) keys
2418 { KSYM_degree, "XK_degree", "degree" },
2419 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2420 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2421 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2422 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2423 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2424 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2425 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2427 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2428 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2429 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2430 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2431 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2432 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2433 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2434 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2435 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2437 // other keys (for reverse mapping only)
2438 { KSYM_space, "XK_space", " " },
2440 // keypad keys are not in numerical order in SDL2
2441 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2442 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2443 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2444 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2445 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2446 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2447 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2448 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2449 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2450 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2452 // end-of-array identifier
2458 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2460 static char name_buffer[30];
2463 if (key >= KSYM_A && key <= KSYM_Z)
2464 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2465 else if (key >= KSYM_a && key <= KSYM_z)
2466 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2467 else if (key >= KSYM_0 && key <= KSYM_9)
2468 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2469 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2470 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2471 else if (key == KSYM_UNDEFINED)
2472 strcpy(name_buffer, "(undefined)");
2479 if (key == translate_key[i].key)
2481 strcpy(name_buffer, translate_key[i].name);
2485 while (translate_key[++i].name);
2487 if (!translate_key[i].name)
2488 strcpy(name_buffer, "(unknown)");
2491 *name = name_buffer;
2493 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2495 static char name_buffer[30];
2498 if (key >= KSYM_A && key <= KSYM_Z)
2499 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2500 else if (key >= KSYM_a && key <= KSYM_z)
2501 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2502 else if (key >= KSYM_0 && key <= KSYM_9)
2503 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2504 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2505 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2506 else if (key == KSYM_UNDEFINED)
2507 strcpy(name_buffer, "[undefined]");
2514 if (key == translate_key[i].key)
2516 strcpy(name_buffer, translate_key[i].x11name);
2520 while (translate_key[++i].x11name);
2522 if (!translate_key[i].x11name)
2523 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2526 *x11name = name_buffer;
2528 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2530 Key key = KSYM_UNDEFINED;
2531 char *name_ptr = *name;
2533 if (strlen(*name) == 1)
2535 char c = name_ptr[0];
2537 if (c >= 'A' && c <= 'Z')
2538 key = KSYM_A + (Key)(c - 'A');
2539 else if (c >= 'a' && c <= 'z')
2540 key = KSYM_a + (Key)(c - 'a');
2541 else if (c >= '0' && c <= '9')
2542 key = KSYM_0 + (Key)(c - '0');
2545 if (key == KSYM_UNDEFINED)
2551 if (strEqual(translate_key[i].name, *name))
2553 key = translate_key[i].key;
2557 while (translate_key[++i].x11name);
2560 if (key == KSYM_UNDEFINED)
2561 Warn("getKeyFromKeyName(): not completely implemented");
2565 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2567 Key key = KSYM_UNDEFINED;
2568 char *name_ptr = *x11name;
2570 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2572 char c = name_ptr[3];
2574 if (c >= 'A' && c <= 'Z')
2575 key = KSYM_A + (Key)(c - 'A');
2576 else if (c >= 'a' && c <= 'z')
2577 key = KSYM_a + (Key)(c - 'a');
2578 else if (c >= '0' && c <= '9')
2579 key = KSYM_0 + (Key)(c - '0');
2581 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2583 char c1 = name_ptr[4];
2584 char c2 = name_ptr[5];
2587 if ((c1 >= '0' && c1 <= '9') &&
2588 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2589 d = atoi(&name_ptr[4]);
2591 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2592 key = KSYM_F1 + (Key)(d - 1);
2594 else if (strPrefix(name_ptr, "XK_"))
2600 if (strEqual(name_ptr, translate_key[i].x11name))
2602 key = translate_key[i].key;
2606 while (translate_key[++i].x11name);
2608 else if (strPrefix(name_ptr, "0x"))
2610 unsigned int value = 0;
2616 char c = *name_ptr++;
2619 if (c >= '0' && c <= '9')
2621 else if (c >= 'a' && c <= 'f')
2622 d = (int)(c - 'a' + 10);
2623 else if (c >= 'A' && c <= 'F')
2624 d = (int)(c - 'A' + 10);
2632 value = value * 16 + d;
2643 char *getKeyNameFromKey(Key key)
2647 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2651 char *getX11KeyNameFromKey(Key key)
2655 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2659 Key getKeyFromKeyName(char *name)
2663 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2667 Key getKeyFromX11KeyName(char *x11name)
2671 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2675 char getCharFromKey(Key key)
2681 } translate_key_char[] =
2683 // special (non-ASCII) keys (ISO-8859-1)
2684 { KSYM_degree, CHAR_BYTE_DEGREE },
2685 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2686 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2687 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2688 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2689 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2690 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2691 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2693 // end-of-array identifier
2697 char *keyname = getKeyNameFromKey(key);
2700 if (strlen(keyname) == 1)
2702 else if (strEqual(keyname, "space"))
2710 if (key == translate_key_char[i].key)
2712 c = translate_key_char[i].key_char;
2717 while (translate_key_char[++i].key_char);
2723 char getValidConfigValueChar(char c)
2725 if (c == '#' || // used to mark comments
2726 c == '\\') // used to mark continued lines
2733 // ----------------------------------------------------------------------------
2734 // functions to translate string identifiers to integer or boolean value
2735 // ----------------------------------------------------------------------------
2737 int get_integer_from_string(char *s)
2739 // check for the most common case first
2740 if (s[0] >= '0' && s[0] <= '9')
2743 char *s_lower = getStringToLower(s);
2746 if (strEqual(s_lower, "false") ||
2747 strEqual(s_lower, "no") ||
2748 strEqual(s_lower, "off"))
2750 else if (strEqual(s_lower, "true") ||
2751 strEqual(s_lower, "yes") ||
2752 strEqual(s_lower, "on"))
2762 boolean get_boolean_from_string(char *s)
2764 char *s_lower = getStringToLower(s);
2765 boolean result = FALSE;
2767 if (strEqual(s_lower, "true") ||
2768 strEqual(s_lower, "yes") ||
2769 strEqual(s_lower, "on") ||
2770 get_integer_from_string(s) == 1)
2778 int get_switch3_from_string(char *s)
2780 char *s_lower = getStringToLower(s);
2783 if (strEqual(s_lower, "true") ||
2784 strEqual(s_lower, "yes") ||
2785 strEqual(s_lower, "on") ||
2786 get_integer_from_string(s) == 1)
2788 else if (strEqual(s_lower, "auto"))
2796 int get_player_nr_from_string(char *s)
2798 static char *player_text[] =
2808 char *s_lower = getStringToLower(s);
2812 for (i = 0; player_text[i] != NULL; i++)
2813 if (strEqual(s_lower, player_text[i]))
2822 // ----------------------------------------------------------------------------
2823 // functions for generic lists
2824 // ----------------------------------------------------------------------------
2826 ListNode *newListNode(void)
2828 return checked_calloc(sizeof(ListNode));
2831 void addNodeToList(ListNode **node_first, char *key, void *content)
2833 ListNode *node_new = newListNode();
2835 node_new->key = getStringCopy(key);
2836 node_new->content = content;
2837 node_new->next = *node_first;
2840 (*node_first)->prev = node_new;
2842 *node_first = node_new;
2845 void deleteNodeFromList(ListNode **node_first, char *key,
2846 void (*destructor_function)(void *))
2848 if (node_first == NULL || *node_first == NULL)
2851 if (strEqual((*node_first)->key, key))
2853 // after first recursion, (*node_first)->prev->next == *node_first,
2854 // so *node_first would be overwritten with (*node_first)->next
2855 // => use a copy of *node_first (and later of (*node_first)->next)
2856 ListNode *node = *node_first;
2857 ListNode *node_next = node->next;
2859 checked_free(node->key);
2861 if (destructor_function)
2862 destructor_function(node->content);
2865 node->prev->next = node->next;
2868 node->next->prev = node->prev;
2872 // after removing node, set list pointer to next valid list node
2873 // (this is important if the first node of the list was deleted)
2874 *node_first = node_next;
2878 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2882 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2884 if (node_first == NULL)
2887 if (strEqual(node_first->key, key))
2890 return getNodeFromKey(node_first->next, key);
2893 int getNumNodes(ListNode *node_first)
2895 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2899 static void dumpList(ListNode *node_first)
2901 ListNode *node = node_first;
2905 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2906 ((struct ListNodeInfo *)node->content)->num_references);
2910 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2915 // ----------------------------------------------------------------------------
2916 // functions for file handling
2917 // ----------------------------------------------------------------------------
2919 #define MAX_BUFFER_SIZE 4096
2921 File *openFile(char *filename, char *mode)
2923 File *file = checked_calloc(sizeof(File));
2925 file->file = fopen(filename, mode);
2927 if (file->file != NULL)
2929 file->filename = getStringCopy(filename);
2934 #if defined(PLATFORM_ANDROID)
2935 file->asset_file = SDL_RWFromFile(filename, mode);
2937 if (file->asset_file != NULL)
2939 file->file_is_asset = TRUE;
2940 file->filename = getStringCopy(filename);
2951 int closeFile(File *file)
2958 #if defined(PLATFORM_ANDROID)
2959 if (file->asset_file)
2960 result = SDL_RWclose(file->asset_file);
2964 result = fclose(file->file);
2966 checked_free(file->filename);
2972 int checkEndOfFile(File *file)
2974 #if defined(PLATFORM_ANDROID)
2975 if (file->file_is_asset)
2976 return file->end_of_file;
2979 return feof(file->file);
2982 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2984 #if defined(PLATFORM_ANDROID)
2985 if (file->file_is_asset)
2987 if (file->end_of_file)
2990 size_t num_items_read =
2991 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2993 if (num_items_read < num_items)
2994 file->end_of_file = TRUE;
2996 return num_items_read;
3000 return fread(buffer, item_size, num_items, file->file);
3003 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3005 return fwrite(buffer, item_size, num_items, file->file);
3008 int seekFile(File *file, long offset, int whence)
3010 #if defined(PLATFORM_ANDROID)
3011 if (file->file_is_asset)
3013 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3014 whence == SEEK_CUR ? RW_SEEK_CUR :
3015 whence == SEEK_END ? RW_SEEK_END : 0);
3017 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3021 return fseek(file->file, offset, whence);
3024 int getByteFromFile(File *file)
3026 #if defined(PLATFORM_ANDROID)
3027 if (file->file_is_asset)
3029 if (file->end_of_file)
3033 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3035 if (num_bytes_read < 1)
3036 file->end_of_file = TRUE;
3038 return (file->end_of_file ? EOF : (int)c);
3042 return fgetc(file->file);
3045 char *getStringFromFile(File *file, char *line, int size)
3047 #if defined(PLATFORM_ANDROID)
3048 if (file->file_is_asset)
3050 if (file->end_of_file)
3053 char *line_ptr = line;
3054 int num_bytes_read = 0;
3056 while (num_bytes_read < size - 1 &&
3057 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3058 *line_ptr++ != '\n')
3063 if (strlen(line) == 0)
3065 file->end_of_file = TRUE;
3074 return fgets(line, size, file->file);
3077 int copyFile(char *filename_from, char *filename_to)
3079 File *file_from, *file_to;
3081 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3086 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3088 closeFile(file_from);
3093 while (!checkEndOfFile(file_from))
3095 byte buffer[MAX_BUFFER_SIZE];
3096 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3098 writeFile(file_to, buffer, 1, bytes_read);
3101 closeFile(file_from);
3107 boolean touchFile(char *filename)
3111 if (!(file = fopen(filename, MODE_WRITE)))
3113 Warn("cannot touch file '%s'", filename);
3124 // ----------------------------------------------------------------------------
3125 // functions for directory handling
3126 // ----------------------------------------------------------------------------
3128 Directory *openDirectory(char *dir_name)
3130 Directory *dir = checked_calloc(sizeof(Directory));
3132 dir->dir = opendir(dir_name);
3134 if (dir->dir != NULL)
3136 dir->filename = getStringCopy(dir_name);
3141 #if defined(PLATFORM_ANDROID)
3142 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3144 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3146 checked_free(asset_toc_filename);
3148 if (dir->asset_toc_file != NULL)
3150 dir->directory_is_asset = TRUE;
3151 dir->filename = getStringCopy(dir_name);
3162 int closeDirectory(Directory *dir)
3169 #if defined(PLATFORM_ANDROID)
3170 if (dir->asset_toc_file)
3171 result = SDL_RWclose(dir->asset_toc_file);
3175 result = closedir(dir->dir);
3178 freeDirectoryEntry(dir->dir_entry);
3180 checked_free(dir->filename);
3186 DirectoryEntry *readDirectory(Directory *dir)
3189 freeDirectoryEntry(dir->dir_entry);
3191 dir->dir_entry = NULL;
3193 #if defined(PLATFORM_ANDROID)
3194 if (dir->directory_is_asset)
3196 char line[MAX_LINE_LEN];
3197 char *line_ptr = line;
3198 int num_bytes_read = 0;
3200 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3201 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3210 if (strlen(line) == 0)
3213 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3215 dir->dir_entry->is_directory = FALSE;
3216 if (line[strlen(line) - 1] == '/')
3218 dir->dir_entry->is_directory = TRUE;
3220 line[strlen(line) - 1] = '\0';
3223 dir->dir_entry->basename = getStringCopy(line);
3224 dir->dir_entry->filename = getPath2(dir->filename, line);
3226 return dir->dir_entry;
3230 struct dirent *dir_entry = readdir(dir->dir);
3232 if (dir_entry == NULL)
3235 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3237 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3238 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3240 struct stat file_status;
3242 dir->dir_entry->is_directory =
3243 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3244 S_ISDIR(file_status.st_mode));
3246 return dir->dir_entry;
3249 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3251 if (dir_entry == NULL)
3254 checked_free(dir_entry->basename);
3255 checked_free(dir_entry->filename);
3256 checked_free(dir_entry);
3260 // ----------------------------------------------------------------------------
3261 // functions for checking files and filenames
3262 // ----------------------------------------------------------------------------
3264 boolean directoryExists(const char *dir_name)
3266 if (dir_name == NULL)
3269 struct stat file_status;
3270 boolean success = (stat(dir_name, &file_status) == 0 &&
3271 S_ISDIR(file_status.st_mode));
3273 #if defined(PLATFORM_ANDROID)
3276 // this might be an asset directory; check by trying to open toc file
3277 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3278 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3280 checked_free(asset_toc_filename);
3282 success = (file != NULL);
3292 boolean fileExists(const char *filename)
3294 if (filename == NULL)
3297 boolean success = (access(filename, F_OK) == 0);
3299 #if defined(PLATFORM_ANDROID)
3302 // this might be an asset file; check by trying to open it
3303 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3305 success = (file != NULL);
3316 static boolean fileHasPrefix(const char *basename, const char *prefix)
3318 static char *basename_lower = NULL;
3319 int basename_length, prefix_length;
3321 checked_free(basename_lower);
3323 if (basename == NULL || prefix == NULL)
3326 basename_lower = getStringToLower(basename);
3327 basename_length = strlen(basename_lower);
3328 prefix_length = strlen(prefix);
3330 if (basename_length > prefix_length + 1 &&
3331 basename_lower[prefix_length] == '.' &&
3332 strncmp(basename_lower, prefix, prefix_length) == 0)
3339 static boolean fileHasSuffix(const char *basename, const char *suffix)
3341 static char *basename_lower = NULL;
3342 int basename_length, suffix_length;
3344 checked_free(basename_lower);
3346 if (basename == NULL || suffix == NULL)
3349 basename_lower = getStringToLower(basename);
3350 basename_length = strlen(basename_lower);
3351 suffix_length = strlen(suffix);
3353 if (basename_length > suffix_length + 1 &&
3354 basename_lower[basename_length - suffix_length - 1] == '.' &&
3355 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3361 static boolean FileCouldBeArtwork(char *filename)
3363 char *basename = getBaseNamePtr(filename);
3365 return (!strEqual(basename, ".") &&
3366 !strEqual(basename, "..") &&
3367 !fileHasSuffix(basename, "txt") &&
3368 !fileHasSuffix(basename, "conf") &&
3369 !directoryExists(filename));
3372 boolean FileIsGraphic(char *filename)
3374 return FileCouldBeArtwork(filename);
3377 boolean FileIsSound(char *filename)
3379 return FileCouldBeArtwork(filename);
3382 boolean FileIsMusic(char *filename)
3384 return FileCouldBeArtwork(filename);
3387 boolean FileIsArtworkType(char *filename, int type)
3389 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3390 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3391 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3397 // ----------------------------------------------------------------------------
3398 // functions for loading artwork configuration information
3399 // ----------------------------------------------------------------------------
3401 char *get_mapped_token(char *token)
3403 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3404 static char *map_token_prefix[][2] =
3406 { "char_procent", "char_percent" },
3407 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3408 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3409 { "bd_butterfly_left", "bd_butterfly.left" },
3410 { "bd_butterfly_right", "bd_butterfly.right" },
3411 { "bd_butterfly_up", "bd_butterfly.up" },
3412 { "bd_butterfly_down", "bd_butterfly.down" },
3413 { "bd_firefly_left", "bd_firefly.left" },
3414 { "bd_firefly_right", "bd_firefly.right" },
3415 { "bd_firefly_up", "bd_firefly.up" },
3416 { "bd_firefly_down", "bd_firefly.down" },
3422 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3424 int len_token_prefix = strlen(map_token_prefix[i][0]);
3426 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3427 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3430 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3431 char *gfx_substring = ".gfx";
3432 char *gfx_prefix = "gfx.";
3433 if (strstr(token, gfx_substring) != NULL)
3435 char *token_prefix = getStringCopy(token);
3436 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3437 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3440 // cut off token string at ".gfx" substring position
3441 *token_gfx_pos = '\0';
3443 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3444 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3448 return mapped_token;
3454 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3457 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3458 static struct ConfigTypeInfo prefix_list[] =
3460 { "global.anim_1" },
3461 { "global.anim_2" },
3462 { "global.anim_3" },
3463 { "global.anim_4" },
3464 { "global.anim_5" },
3465 { "global.anim_6" },
3466 { "global.anim_7" },
3467 { "global.anim_8" },
3468 { "global.anim_9" },
3469 { "global.anim_10" },
3470 { "global.anim_11" },
3471 { "global.anim_12" },
3472 { "global.anim_13" },
3473 { "global.anim_14" },
3474 { "global.anim_15" },
3475 { "global.anim_16" },
3476 { "global.anim_17" },
3477 { "global.anim_18" },
3478 { "global.anim_19" },
3479 { "global.anim_20" },
3480 { "global.anim_21" },
3481 { "global.anim_22" },
3482 { "global.anim_23" },
3483 { "global.anim_24" },
3484 { "global.anim_25" },
3485 { "global.anim_26" },
3486 { "global.anim_27" },
3487 { "global.anim_28" },
3488 { "global.anim_29" },
3489 { "global.anim_30" },
3490 { "global.anim_31" },
3491 { "global.anim_32" },
3495 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3496 boolean prefix_found = FALSE;
3500 // search for prefix to check if base token has to be created
3501 for (i = 0; prefix_list[i].token != NULL; i++)
3502 if (strPrefix(token, prefix_list[i].token))
3503 prefix_found = TRUE;
3508 // search for suffix (parameter) to determine base token length
3509 for (i = 0; suffix_list[i].token != NULL; i++)
3510 if (strSuffix(token, suffix_list[i].token))
3511 len_suffix = strlen(suffix_list[i].token);
3513 return getStringCopyN(token, strlen(token) - len_suffix);
3516 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3517 struct ListNodeInfo ***, int *);
3519 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3520 struct ConfigTypeInfo *suffix_list,
3521 char **ignore_tokens,
3522 int num_file_list_entries)
3524 SetupFileHash *ignore_tokens_hash;
3525 struct FileInfo *file_list;
3526 int num_file_list_entries_found = 0;
3527 int num_suffix_list_entries = 0;
3531 // create hash from list of tokens to be ignored (for quick access)
3532 ignore_tokens_hash = newSetupFileHash();
3533 for (i = 0; ignore_tokens[i] != NULL; i++)
3534 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3536 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3538 for (i = 0; suffix_list[i].token != NULL; i++)
3539 num_suffix_list_entries++;
3541 // always start with reliable default values
3542 for (i = 0; i < num_file_list_entries; i++)
3544 file_list[i].token = NULL;
3546 file_list[i].default_filename = NULL;
3547 file_list[i].filename = NULL;
3549 if (num_suffix_list_entries > 0)
3551 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3553 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3554 file_list[i].parameter = checked_calloc(parameter_array_size);
3556 for (j = 0; j < num_suffix_list_entries; j++)
3558 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3559 setString(&file_list[i].parameter[j], suffix_list[j].value);
3562 file_list[i].redefined = FALSE;
3563 file_list[i].fallback_to_default = FALSE;
3564 file_list[i].default_is_cloned = FALSE;
3570 for (i = 0; config_list[i].token != NULL; i++)
3572 int len_config_token = strlen(config_list[i].token);
3573 boolean is_file_entry = TRUE;
3575 for (j = 0; suffix_list[j].token != NULL; j++)
3577 int len_suffix = strlen(suffix_list[j].token);
3579 if (len_suffix < len_config_token &&
3580 strEqual(&config_list[i].token[len_config_token - len_suffix],
3581 suffix_list[j].token))
3583 setString(&file_list[list_pos].default_parameter[j],
3584 config_list[i].value);
3586 is_file_entry = FALSE;
3592 // the following tokens are no file definitions, but other config tokens
3593 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3594 is_file_entry = FALSE;
3601 if (list_pos >= num_file_list_entries)
3604 file_list[list_pos].token = config_list[i].token;
3605 file_list[list_pos].default_filename = config_list[i].value;
3608 if (strSuffix(config_list[i].token, ".clone_from"))
3609 file_list[list_pos].default_is_cloned = TRUE;
3612 num_file_list_entries_found = list_pos + 1;
3613 if (num_file_list_entries_found != num_file_list_entries)
3616 Error("inconsistant config list information:");
3617 Error("- should be: %d (according to 'src/conf_xxx.h')",
3618 num_file_list_entries);
3619 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3620 num_file_list_entries_found);
3625 freeSetupFileHash(ignore_tokens_hash);
3630 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3632 int len_token = strlen(token);
3633 int len_suffix = strlen(suffix);
3635 if (start_pos < 0) // compare suffix from end of string
3636 start_pos += len_token;
3638 if (start_pos < 0 || start_pos + len_suffix > len_token)
3641 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3644 if (token[start_pos + len_suffix] == '\0')
3647 if (token[start_pos + len_suffix] == '.')
3653 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3655 static void read_token_parameters(SetupFileHash *setup_file_hash,
3656 struct ConfigTypeInfo *suffix_list,
3657 struct FileInfo *file_list_entry)
3659 // check for config token that is the base token without any suffixes
3660 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3661 char *known_token_value = KNOWN_TOKEN_VALUE;
3664 if (filename != NULL)
3666 setString(&file_list_entry->filename, filename);
3668 // when file definition found, set all parameters to default values
3669 for (i = 0; suffix_list[i].token != NULL; i++)
3670 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3672 file_list_entry->redefined = TRUE;
3674 // mark config file token as well known from default config
3675 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3678 // check for config tokens that can be build by base token and suffixes
3679 for (i = 0; suffix_list[i].token != NULL; i++)
3681 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3682 char *value = getHashEntry(setup_file_hash, token);
3686 setString(&file_list_entry->parameter[i], value);
3688 // mark config file token as well known from default config
3689 setHashEntry(setup_file_hash, token, known_token_value);
3696 static void add_dynamic_file_list_entry(struct FileInfo **list,
3697 int *num_list_entries,
3698 SetupFileHash *extra_file_hash,
3699 struct ConfigTypeInfo *suffix_list,
3700 int num_suffix_list_entries,
3703 struct FileInfo *new_list_entry;
3704 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3706 (*num_list_entries)++;
3707 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3708 new_list_entry = &(*list)[*num_list_entries - 1];
3710 new_list_entry->token = getStringCopy(token);
3711 new_list_entry->default_filename = NULL;
3712 new_list_entry->filename = NULL;
3713 new_list_entry->parameter = checked_calloc(parameter_array_size);
3715 new_list_entry->redefined = FALSE;
3716 new_list_entry->fallback_to_default = FALSE;
3717 new_list_entry->default_is_cloned = FALSE;
3719 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3722 static void add_property_mapping(struct PropertyMapping **list,
3723 int *num_list_entries,
3724 int base_index, int ext1_index,
3725 int ext2_index, int ext3_index,
3728 struct PropertyMapping *new_list_entry;
3730 (*num_list_entries)++;
3731 *list = checked_realloc(*list,
3732 *num_list_entries * sizeof(struct PropertyMapping));
3733 new_list_entry = &(*list)[*num_list_entries - 1];
3735 new_list_entry->base_index = base_index;
3736 new_list_entry->ext1_index = ext1_index;
3737 new_list_entry->ext2_index = ext2_index;
3738 new_list_entry->ext3_index = ext3_index;
3740 new_list_entry->artwork_index = artwork_index;
3743 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3746 struct FileInfo *file_list = artwork_info->file_list;
3747 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3748 char **base_prefixes = artwork_info->base_prefixes;
3749 char **ext1_suffixes = artwork_info->ext1_suffixes;
3750 char **ext2_suffixes = artwork_info->ext2_suffixes;
3751 char **ext3_suffixes = artwork_info->ext3_suffixes;
3752 char **ignore_tokens = artwork_info->ignore_tokens;
3753 int num_file_list_entries = artwork_info->num_file_list_entries;
3754 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3755 int num_base_prefixes = artwork_info->num_base_prefixes;
3756 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3757 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3758 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3759 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3760 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3761 SetupFileHash *extra_file_hash, *empty_file_hash;
3762 char *known_token_value = KNOWN_TOKEN_VALUE;
3763 char *base_token_value = UNDEFINED_FILENAME;
3766 if (filename == NULL)
3769 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3772 // separate valid (defined) from empty (undefined) config token values
3773 valid_file_hash = newSetupFileHash();
3774 empty_file_hash = newSetupFileHash();
3775 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3777 char *value = HASH_ITERATION_VALUE(itr);
3779 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3780 HASH_ITERATION_TOKEN(itr), value);
3782 END_HASH_ITERATION(setup_file_hash, itr)
3784 // at this point, we do not need the setup file hash anymore -- free it
3785 freeSetupFileHash(setup_file_hash);
3787 // prevent changing hash while iterating over it by using a temporary copy
3788 valid_file_hash_tmp = newSetupFileHash();
3789 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3791 setHashEntry(valid_file_hash_tmp,
3792 HASH_ITERATION_TOKEN(itr),
3793 HASH_ITERATION_VALUE(itr));
3795 END_HASH_ITERATION(valid_file_hash, itr)
3797 // (iterate over same temporary hash, as modifications are independent)
3799 // map deprecated to current tokens (using prefix match and replace)
3800 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3802 char *token = HASH_ITERATION_TOKEN(itr);
3803 char *mapped_token = get_mapped_token(token);
3805 if (mapped_token != NULL)
3807 char *value = HASH_ITERATION_VALUE(itr);
3810 setHashEntry(valid_file_hash, mapped_token, value);
3812 // ignore old token (by setting it to "known" keyword)
3813 setHashEntry(valid_file_hash, token, known_token_value);
3818 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3820 // add special base tokens (using prefix match and replace)
3821 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3823 char *token = HASH_ITERATION_TOKEN(itr);
3824 char *base_token = get_special_base_token(artwork_info, token);
3826 if (base_token != NULL)
3828 // add base token only if it does not already exist
3829 if (getHashEntry(valid_file_hash, base_token) == NULL)
3830 setHashEntry(valid_file_hash, base_token, base_token_value);
3835 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3837 // free temporary hash used for iteration
3838 freeSetupFileHash(valid_file_hash_tmp);
3840 // read parameters for all known config file tokens
3841 for (i = 0; i < num_file_list_entries; i++)
3842 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3844 // set all tokens that can be ignored here to "known" keyword
3845 for (i = 0; i < num_ignore_tokens; i++)
3846 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3848 // copy all unknown config file tokens to extra config hash
3849 extra_file_hash = newSetupFileHash();
3850 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3852 char *value = HASH_ITERATION_VALUE(itr);
3854 if (!strEqual(value, known_token_value))
3855 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3857 END_HASH_ITERATION(valid_file_hash, itr)
3859 // at this point, we do not need the valid file hash anymore -- free it
3860 freeSetupFileHash(valid_file_hash);
3862 // now try to determine valid, dynamically defined config tokens
3864 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3866 struct FileInfo **dynamic_file_list =
3867 &artwork_info->dynamic_file_list;
3868 int *num_dynamic_file_list_entries =
3869 &artwork_info->num_dynamic_file_list_entries;
3870 struct PropertyMapping **property_mapping =
3871 &artwork_info->property_mapping;
3872 int *num_property_mapping_entries =
3873 &artwork_info->num_property_mapping_entries;
3874 int current_summarized_file_list_entry =
3875 artwork_info->num_file_list_entries +
3876 artwork_info->num_dynamic_file_list_entries;
3877 char *token = HASH_ITERATION_TOKEN(itr);
3878 int len_token = strlen(token);
3880 boolean base_prefix_found = FALSE;
3881 boolean parameter_suffix_found = FALSE;
3883 // skip all parameter definitions (handled by read_token_parameters())
3884 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3886 int len_suffix = strlen(suffix_list[i].token);
3888 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3889 parameter_suffix_found = TRUE;
3892 if (parameter_suffix_found)
3895 // ---------- step 0: search for matching base prefix ----------
3898 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3900 char *base_prefix = base_prefixes[i];
3901 int len_base_prefix = strlen(base_prefix);
3902 boolean ext1_suffix_found = FALSE;
3903 boolean ext2_suffix_found = FALSE;
3904 boolean ext3_suffix_found = FALSE;
3905 boolean exact_match = FALSE;
3906 int base_index = -1;
3907 int ext1_index = -1;
3908 int ext2_index = -1;
3909 int ext3_index = -1;
3911 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3913 if (!base_prefix_found)
3918 if (start_pos + len_base_prefix == len_token) // exact match
3922 add_dynamic_file_list_entry(dynamic_file_list,
3923 num_dynamic_file_list_entries,
3926 num_suffix_list_entries,
3928 add_property_mapping(property_mapping,
3929 num_property_mapping_entries,
3930 base_index, -1, -1, -1,
3931 current_summarized_file_list_entry);
3935 // ---------- step 1: search for matching first suffix ----------
3937 start_pos += len_base_prefix;
3938 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3940 char *ext1_suffix = ext1_suffixes[j];
3941 int len_ext1_suffix = strlen(ext1_suffix);
3943 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3945 if (!ext1_suffix_found)
3950 if (start_pos + len_ext1_suffix == len_token) // exact match
3954 add_dynamic_file_list_entry(dynamic_file_list,
3955 num_dynamic_file_list_entries,
3958 num_suffix_list_entries,
3960 add_property_mapping(property_mapping,
3961 num_property_mapping_entries,
3962 base_index, ext1_index, -1, -1,
3963 current_summarized_file_list_entry);
3967 start_pos += len_ext1_suffix;
3973 // ---------- step 2: search for matching second suffix ----------
3975 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3977 char *ext2_suffix = ext2_suffixes[k];
3978 int len_ext2_suffix = strlen(ext2_suffix);
3980 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3982 if (!ext2_suffix_found)
3987 if (start_pos + len_ext2_suffix == len_token) // exact match
3991 add_dynamic_file_list_entry(dynamic_file_list,
3992 num_dynamic_file_list_entries,
3995 num_suffix_list_entries,
3997 add_property_mapping(property_mapping,
3998 num_property_mapping_entries,
3999 base_index, ext1_index, ext2_index, -1,
4000 current_summarized_file_list_entry);
4004 start_pos += len_ext2_suffix;
4010 // ---------- step 3: search for matching third suffix ----------
4012 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4014 char *ext3_suffix = ext3_suffixes[l];
4015 int len_ext3_suffix = strlen(ext3_suffix);
4017 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4019 if (!ext3_suffix_found)
4024 if (start_pos + len_ext3_suffix == len_token) // exact match
4028 add_dynamic_file_list_entry(dynamic_file_list,
4029 num_dynamic_file_list_entries,
4032 num_suffix_list_entries,
4034 add_property_mapping(property_mapping,
4035 num_property_mapping_entries,
4036 base_index, ext1_index, ext2_index, ext3_index,
4037 current_summarized_file_list_entry);
4043 END_HASH_ITERATION(extra_file_hash, itr)
4045 if (artwork_info->num_dynamic_file_list_entries > 0)
4047 artwork_info->dynamic_artwork_list =
4048 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4049 artwork_info->sizeof_artwork_list_entry);
4052 if (options.verbose && IS_PARENT_PROCESS())
4054 SetupFileList *setup_file_list, *list;
4055 boolean dynamic_tokens_found = FALSE;
4056 boolean unknown_tokens_found = FALSE;
4057 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4059 // list may be NULL for empty artwork config files
4060 setup_file_list = loadSetupFileList(filename);
4062 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4064 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4065 dynamic_tokens_found = TRUE;
4067 unknown_tokens_found = TRUE;
4069 END_HASH_ITERATION(extra_file_hash, itr)
4071 if (options.debug && dynamic_tokens_found)
4073 Debug("config", "---");
4074 Debug("config", "dynamic token(s) found in config file:");
4075 Debug("config", "- config file: '%s'", filename);
4077 for (list = setup_file_list; list != NULL; list = list->next)
4079 char *value = getHashEntry(extra_file_hash, list->token);
4081 if (value != NULL && strEqual(value, known_token_value))
4082 Debug("config", "- dynamic token: '%s'", list->token);
4085 Debug("config", "---");
4088 if (unknown_tokens_found)
4091 Warn("unknown token(s) found in config file:");
4092 Warn("- config file: '%s'", filename);
4094 for (list = setup_file_list; list != NULL; list = list->next)
4096 char *value = getHashEntry(extra_file_hash, list->token);
4098 if (value != NULL && !strEqual(value, known_token_value))
4099 Warn("- dynamic token: '%s'", list->token);
4105 if (undefined_values_found)
4108 Warn("undefined values found in config file:");
4109 Warn("- config file: '%s'", filename);
4111 for (list = setup_file_list; list != NULL; list = list->next)
4113 char *value = getHashEntry(empty_file_hash, list->token);
4116 Warn("- undefined value for token: '%s'", list->token);
4122 freeSetupFileList(setup_file_list);
4125 freeSetupFileHash(extra_file_hash);
4126 freeSetupFileHash(empty_file_hash);
4129 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4131 struct FileInfo *file_list = artwork_info->file_list;
4132 int num_file_list_entries = artwork_info->num_file_list_entries;
4133 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4134 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4137 DrawInitTextHead("Loading artwork config");
4138 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4140 // always start with reliable default values
4141 for (i = 0; i < num_file_list_entries; i++)
4143 setString(&file_list[i].filename, file_list[i].default_filename);
4145 for (j = 0; j < num_suffix_list_entries; j++)
4146 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4148 file_list[i].redefined = FALSE;
4149 file_list[i].fallback_to_default = FALSE;
4152 // free previous dynamic artwork file array
4153 if (artwork_info->dynamic_file_list != NULL)
4155 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4157 free(artwork_info->dynamic_file_list[i].token);
4158 free(artwork_info->dynamic_file_list[i].filename);
4159 free(artwork_info->dynamic_file_list[i].parameter);
4162 free(artwork_info->dynamic_file_list);
4163 artwork_info->dynamic_file_list = NULL;
4165 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4166 &artwork_info->num_dynamic_file_list_entries);
4169 // free previous property mapping
4170 if (artwork_info->property_mapping != NULL)
4172 free(artwork_info->property_mapping);
4174 artwork_info->property_mapping = NULL;
4175 artwork_info->num_property_mapping_entries = 0;
4178 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4180 // first look for special artwork configured in level series config
4181 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4183 if (fileExists(filename_base))
4184 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4187 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4189 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4190 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4193 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4194 struct ListNodeInfo **listnode)
4198 char *filename = (*listnode)->source_filename;
4200 if (--(*listnode)->num_references <= 0)
4201 deleteNodeFromList(&artwork_info->content_list, filename,
4202 artwork_info->free_artwork);
4208 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4209 struct ListNodeInfo **listnode,
4210 struct FileInfo *file_list_entry)
4220 char *basename = file_list_entry->filename;
4221 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4223 // mark all images from non-default graphics directory as "redefined"
4224 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4225 !strPrefix(filename, options.graphics_directory))
4226 file_list_entry->redefined = TRUE;
4228 if (filename == NULL)
4230 Warn("cannot find artwork file '%s'", basename);
4232 basename = file_list_entry->default_filename;
4234 // fail for cloned default artwork that has no default filename defined
4235 if (file_list_entry->default_is_cloned &&
4236 strEqual(basename, UNDEFINED_FILENAME))
4238 void (*error_func)(char *, ...) = Warn;
4240 // we can get away without sounds and music, but not without graphics
4241 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4244 error_func("token '%s' was cloned and has no default filename",
4245 file_list_entry->token);
4250 // dynamic artwork has no default filename / skip empty default artwork
4251 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4254 file_list_entry->fallback_to_default = TRUE;
4256 Warn("trying default artwork file '%s'", basename);
4258 filename = getCustomArtworkFilename(basename, artwork_info->type);
4260 if (filename == NULL)
4262 void (*error_func)(char *, ...) = Warn;
4264 // we can get away without sounds and music, but not without graphics
4265 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4268 error_func("cannot find default artwork file '%s'", basename);
4274 // check if the old and the new artwork file are the same
4275 if (*listnode && strEqual((*listnode)->source_filename, filename))
4277 // The old and new artwork are the same (have the same filename and path).
4278 // This usually means that this artwork does not exist in this artwork set
4279 // and a fallback to the existing artwork is done.
4284 // delete existing artwork file entry
4285 deleteArtworkListEntry(artwork_info, listnode);
4287 // check if the new artwork file already exists in the list of artwork
4288 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4290 *listnode = (struct ListNodeInfo *)node->content;
4291 (*listnode)->num_references++;
4296 DrawInitTextHead(init_text[artwork_info->type]);
4297 DrawInitTextItem(basename);
4299 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4301 // add new artwork file entry to the list of artwork files
4302 (*listnode)->num_references = 1;
4303 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4308 void (*error_func)(char *, ...) = Warn;
4310 // we can get away without sounds and music, but not without graphics
4311 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4314 error_func("cannot load artwork file '%s'", basename);
4320 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4321 struct ListNodeInfo **listnode,
4322 struct FileInfo *file_list_entry)
4324 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4326 deleteArtworkListEntry(artwork_info, listnode);
4331 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4334 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4336 struct FileInfo *file_list = artwork_info->file_list;
4337 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4338 int num_file_list_entries = artwork_info->num_file_list_entries;
4339 int num_dynamic_file_list_entries =
4340 artwork_info->num_dynamic_file_list_entries;
4343 print_timestamp_init("ReloadCustomArtworkList");
4345 for (i = 0; i < num_file_list_entries; i++)
4346 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4349 for (i = 0; i < num_dynamic_file_list_entries; i++)
4350 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4351 &dynamic_file_list[i]);
4353 print_timestamp_done("ReloadCustomArtworkList");
4356 dumpList(artwork_info->content_list);
4360 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4361 struct ListNodeInfo ***list,
4362 int *num_list_entries)
4369 for (i = 0; i < *num_list_entries; i++)
4370 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4374 *num_list_entries = 0;
4377 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4379 if (artwork_info == NULL)
4382 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4383 &artwork_info->num_file_list_entries);
4385 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4386 &artwork_info->num_dynamic_file_list_entries);
4390 // ----------------------------------------------------------------------------
4391 // functions only needed for non-Unix (non-command-line) systems
4392 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4393 // (now also added for Windows, to create files in user data directory)
4394 // ----------------------------------------------------------------------------
4396 char *getLogBasename(char *basename)
4398 return getStringCat2(basename, ".log");
4401 char *getLogFilename(char *basename)
4403 return getPath2(getMainUserGameDataDir(), basename);
4406 void OpenLogFile(void)
4408 InitMainUserDataDirectory();
4410 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4412 program.log_file = program.log_file_default; // reset to default
4414 Warn("cannot open file '%s' for writing: %s",
4415 program.log_filename, strerror(errno));
4418 // output should be unbuffered so it is not truncated in a crash
4419 setbuf(program.log_file, NULL);
4422 void CloseLogFile(void)
4424 if (program.log_file != program.log_file_default)
4425 fclose(program.log_file);
4428 void DumpLogFile(void)
4430 FILE *log_file = fopen(program.log_filename, MODE_READ);
4432 if (log_file == NULL)
4435 while (!feof(log_file))
4436 fputc(fgetc(log_file), stdout);
4441 void NotifyUserAboutErrorFile(void)
4443 #if defined(PLATFORM_WINDOWS)
4444 char *title_text = getStringCat2(program.program_title, " Error Message");
4445 char *error_text = getStringCat2("The program was aborted due to an error; "
4446 "for details, see the following error file:"
4448 program.log_filename);
4450 MessageBox(NULL, error_text, title_text, MB_OK);
4455 // ----------------------------------------------------------------------------
4456 // the following is only for debugging purpose and normally not used
4457 // ----------------------------------------------------------------------------
4461 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4462 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4464 #define DEBUG_NUM_TIMESTAMPS 10
4465 #define DEBUG_TIME_IN_MICROSECONDS 0
4467 #if DEBUG_TIME_IN_MICROSECONDS
4468 static double Counter_Microseconds(void)
4470 static struct timeval base_time = { 0, 0 };
4471 struct timeval current_time;
4474 gettimeofday(¤t_time, NULL);
4476 // reset base time in case of wrap-around
4477 if (current_time.tv_sec < base_time.tv_sec)
4478 base_time = current_time;
4481 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4482 ((double)(current_time.tv_usec - base_time.tv_usec));
4484 return counter; // return microseconds since last init
4488 static char *debug_print_timestamp_get_padding(int padding_size)
4490 static char *padding = NULL;
4491 int max_padding_size = 100;
4493 if (padding == NULL)
4495 padding = checked_calloc(max_padding_size + 1);
4496 memset(padding, ' ', max_padding_size);
4499 return &padding[MAX(0, max_padding_size - padding_size)];
4502 void debug_print_timestamp(int counter_nr, char *message)
4504 int indent_size = 8;
4505 int padding_size = 40;
4506 float timestamp_interval;
4509 Fail("debugging: invalid negative counter");
4510 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4511 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4513 #if DEBUG_TIME_IN_MICROSECONDS
4514 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4517 counter[counter_nr][0] = Counter_Microseconds();
4519 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4522 counter[counter_nr][0] = Counter();
4525 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4526 counter[counter_nr][1] = counter[counter_nr][0];
4529 Debug("time:init", "%s%s%s %.3f %s",
4530 debug_print_timestamp_get_padding(counter_nr * indent_size),
4532 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4533 timestamp_interval / 1000,
4538 static void debug_print_parent_only(char *format, ...)
4540 if (!IS_PARENT_PROCESS())
4547 va_start(ap, format);
4548 vprintf(format, ap);
4558 static void print_timestamp_ext(char *message, char *mode)
4560 #if DEBUG_PRINT_INIT_TIMESTAMPS
4561 static char *debug_message = NULL;
4562 static char *last_message = NULL;
4563 static int counter_nr = 0;
4564 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4566 checked_free(debug_message);
4567 debug_message = getStringCat3(mode, " ", message);
4569 if (strEqual(mode, "INIT"))
4571 debug_print_timestamp(counter_nr, NULL);
4573 if (counter_nr + 1 < max_depth)
4574 debug_print_timestamp(counter_nr, debug_message);
4578 debug_print_timestamp(counter_nr, NULL);
4580 else if (strEqual(mode, "DONE"))
4584 if (counter_nr + 1 < max_depth ||
4585 (counter_nr == 0 && max_depth == 1))
4587 last_message = message;
4589 if (counter_nr == 0 && max_depth == 1)
4591 checked_free(debug_message);
4592 debug_message = getStringCat3("TIME", " ", message);
4595 debug_print_timestamp(counter_nr, debug_message);
4598 else if (!strEqual(mode, "TIME") ||
4599 !strEqual(message, last_message))
4601 if (counter_nr < max_depth)
4602 debug_print_timestamp(counter_nr, debug_message);
4607 void print_timestamp_init(char *message)
4609 print_timestamp_ext(message, "INIT");
4612 void print_timestamp_time(char *message)
4614 print_timestamp_ext(message, "TIME");
4617 void print_timestamp_done(char *message)
4619 print_timestamp_ext(message, "DONE");