1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if defined(PLATFORM_UNIX)
26 #include <sys/param.h>
36 // ============================================================================
37 // some generic helper functions
38 // ============================================================================
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 #define DUPLICATE_LOGGING_TO_STDOUT TRUE
47 #if defined(PLATFORM_ANDROID)
48 static int android_log_prio = ANDROID_LOG_INFO;
49 static char *android_log_buffer = NULL;
51 static void append_to_android_log_buffer(char *format, va_list ap)
53 char text_new[MAX_OUTPUT_LINESIZE];
55 // print text to temporary string
56 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
58 if (android_log_buffer == NULL)
60 android_log_buffer = getStringCopy(text_new);
64 char *android_log_buffer_old = android_log_buffer;
66 // append new text to existing text
67 android_log_buffer = getStringCat2(android_log_buffer, text_new);
69 checked_free(android_log_buffer_old);
73 static void vprintf_log_nonewline(char *format, va_list ap)
75 // add log output to buffer until text with newline is printed
76 append_to_android_log_buffer(format, ap);
79 static void vprintf_log(char *format, va_list ap)
81 // add log output to buffer
82 append_to_android_log_buffer(format, ap);
84 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
85 __android_log_write(android_log_prio, program.program_title,
88 checked_free(android_log_buffer);
89 android_log_buffer = NULL;
94 static void vprintf_log_nonewline(char *format, va_list ap)
96 FILE *file = program.log_file;
98 #if DUPLICATE_LOGGING_TO_STDOUT
99 if (file != program.log_file_default)
104 vfprintf(program.log_file_default, format, ap2);
110 vfprintf(file, format, ap);
113 static void vprintf_log(char *format, va_list ap)
115 FILE *file = program.log_file;
116 char *newline = STRING_NEWLINE;
118 #if DUPLICATE_LOGGING_TO_STDOUT
119 if (file != program.log_file_default)
124 vfprintf(program.log_file_default, format, ap2);
125 fprintf(program.log_file_default, "%s", newline);
131 vfprintf(file, format, ap);
132 fprintf(file, "%s", newline);
136 static void printf_log_nonewline(char *format, ...)
140 va_start(ap, format);
141 vprintf_log_nonewline(format, ap);
145 static void printf_log(char *format, ...)
149 va_start(ap, format);
150 vprintf_log(format, ap);
154 static void printf_log_line(char *line_chars, int line_length)
158 for (i = 0; i < line_length; i++)
159 printf_log_nonewline("%s", line_chars);
165 // ----------------------------------------------------------------------------
166 // platform independent wrappers for printf() et al.
167 // ----------------------------------------------------------------------------
169 void fprintf_line(FILE *file, char *line_chars, int line_length)
173 for (i = 0; i < line_length; i++)
174 fprintf(file, "%s", line_chars);
179 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
182 fprintf(file, "%s", prefix);
183 fprintf_line(file, line_chars, line_length);
186 void printf_line(char *line_chars, int line_length)
188 fprintf_line(stdout, line_chars, line_length);
191 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
193 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
196 static void vPrint(char *format, va_list ap)
198 FILE *file = program.log_file;
200 #if DUPLICATE_LOGGING_TO_STDOUT
201 if (file != program.log_file_default)
206 vfprintf(program.log_file_default, format, ap2);
212 vfprintf(file, format, ap);
215 void Print(char *format, ...)
219 va_start(ap, format);
224 void PrintNoLog(char *format, ...)
226 FILE *file = program.log_file_default;
229 va_start(ap, format);
230 vfprintf(file, format, ap);
236 void PrintLine(char *line_chars, int line_length)
240 for (i = 0; i < line_length; i++)
246 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
249 PrintLine(line_chars, line_length);
253 // ----------------------------------------------------------------------------
254 // generic logging and error handling functions
255 // ----------------------------------------------------------------------------
267 static char *log_tokens[] =
277 static void printf_log_prefix(int log_level, char *mode)
279 if (log_level < 0 || log_level > LOG_FATAL)
282 char *log_token = log_tokens[log_level];
284 if (log_level == LOG_DEBUG)
285 printf_log_nonewline("[%s] [%s] ", log_token, mode);
287 printf_log_nonewline("[%s] ", log_token);
290 static void vLog(int log_level, char *mode, char *format, va_list ap)
292 if (log_level < 0 || log_level > LOG_FATAL)
295 if (log_level == LOG_DEBUG)
297 // only show debug messages when in debug mode
301 // if optional debug mode specified, limit debug output accordingly
302 if (options.debug_mode != NULL &&
303 strstr(mode, options.debug_mode) == NULL)
306 else if (log_level == LOG_WARN)
308 // only show warning messages when in verbose mode
309 if (!options.verbose)
313 #if defined(PLATFORM_ANDROID)
314 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
315 log_level == LOG_INFO ? ANDROID_LOG_INFO :
316 log_level == LOG_WARN ? ANDROID_LOG_WARN :
317 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
318 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
319 ANDROID_LOG_UNKNOWN);
322 static boolean last_line_was_separator = FALSE;
323 char *log_token = log_tokens[log_level];
325 if (strEqual(format, "===") ||
326 strEqual(format, "---"))
328 static char *mode_last = NULL;
329 char line_char[2] = { format[0], '\0' };
330 int line_length = 80 - strlen(log_token) - 3;
332 if (log_level == LOG_DEBUG)
333 line_length -= strlen(mode) + 3;
335 if (last_line_was_separator && strEqual(mode, mode_last))
338 printf_log_prefix(log_level, mode);
339 printf_log_line(line_char, line_length);
341 if (!strEqual(mode, mode_last))
342 setString(&mode_last, mode);
344 last_line_was_separator = TRUE;
349 last_line_was_separator = FALSE;
351 printf_log_prefix(log_level, mode);
353 vprintf_log(format, ap);
356 static void Log(int log_level, char *mode, char *format, ...)
360 va_start(ap, format);
361 vLog(log_level, mode, format, ap);
365 void DebugContinued(char *mode, char *format, ...)
367 static char message[MAX_LINE_LEN] = { 0 };
369 // initialize message (optional)
370 if (strEqual(format, ""))
377 char *message_ptr = message + strlen(message);
378 int size_left = MAX_LINE_LEN - strlen(message);
382 va_start(ap, format);
383 vsnprintf(message_ptr, size_left, format, ap);
387 if (strSuffix(format, "\n"))
389 message[strlen(message) - 1] = '\0';
391 Debug(mode, message);
397 void Debug(char *mode, char *format, ...)
401 va_start(ap, format);
402 vLog(LOG_DEBUG, mode, format, ap);
406 void Info(char *format, ...)
410 va_start(ap, format);
411 vLog(LOG_INFO, NULL, format, ap);
415 void Warn(char *format, ...)
419 va_start(ap, format);
420 vLog(LOG_WARN, NULL, format, ap);
424 void Error(char *format, ...)
428 va_start(ap, format);
429 vLog(LOG_ERROR, NULL, format, ap);
433 void Fail(char *format, ...)
437 va_start(ap, format);
438 vLog(LOG_FATAL, NULL, format, ap);
441 if (!network.is_server_thread)
443 va_start(ap, format);
444 program.exit_message_function(format, ap);
448 Log(LOG_FATAL, NULL, "aborting");
450 // network server thread: normal exit
451 if (network.is_server_thread)
454 // main process: clean up stuff
455 program.exit_function(1);
458 void FailWithHelp(char *format, ...)
462 va_start(ap, format);
463 vLog(LOG_FATAL, NULL, format, ap);
466 Log(LOG_FATAL, NULL, "try option '--help' for more information");
467 Log(LOG_FATAL, NULL, "aborting");
469 // main process: clean up stuff
470 program.exit_function(1);
474 // ----------------------------------------------------------------------------
476 // ----------------------------------------------------------------------------
478 /* int2str() returns a number converted to a string;
479 the used memory is static, but will be overwritten by later calls,
480 so if you want to save the result, copy it to a private string buffer;
481 there can be 10 local calls of int2str() without buffering the result --
482 the 11th call will then destroy the result from the first call and so on. */
484 char *int2str(int number, int size)
486 static char shift_array[10][40];
487 static int shift_counter = 0;
488 char *s = shift_array[shift_counter];
490 shift_counter = (shift_counter + 1) % 10;
497 sprintf(s, " %09d", number);
498 return &s[strlen(s) - size];
502 sprintf(s, "%d", number);
508 // something similar to "int2str()" above, but allocates its own memory
509 // and has a different interface; we cannot use "itoa()", because this
510 // seems to be already defined when cross-compiling to the win32 target
512 char *i_to_a(unsigned int i)
514 static char *a = NULL;
518 if (i > 2147483647) // yes, this is a kludge
521 a = checked_malloc(10 + 1);
529 // calculate base-2 logarithm of argument (rounded down to integer;
530 // this function returns the number of the highest bit set in argument)
532 int log_2(unsigned int x)
538 x -= (1 << e); // for rounding down (rounding up: remove this line)
545 boolean getTokenValueFromString(char *string, char **token, char **value)
547 return getTokenValueFromSetupLine(string, token, value);
551 // ----------------------------------------------------------------------------
553 // ----------------------------------------------------------------------------
555 #define UUID_BYTES 16
556 #define UUID_CHARS (UUID_BYTES * 2)
557 #define UUID_LENGTH (UUID_CHARS + 4)
559 static unsigned int uuid_random_function(int max)
561 return GetBetterRandom(max);
564 char *getUUIDExt(unsigned int (*random_function)(int max))
566 static char uuid[UUID_LENGTH + 1];
567 int data[UUID_BYTES];
571 for (i = 0; i < UUID_BYTES; i++)
572 data[i] = random_function(256);
574 data[6] = 0x40 | (data[6] & 0x0f);
575 data[8] = 0x80 | (data[8] & 0x3f);
577 for (i = 0; i < UUID_BYTES; i++)
579 sprintf(&uuid[count], "%02x", data[i]);
582 if (i == 3 || i == 5 || i == 7 || i == 9)
583 strcat(&uuid[count++], "-");
591 return getUUIDExt(uuid_random_function);
595 // ----------------------------------------------------------------------------
597 // ----------------------------------------------------------------------------
599 // maximal allowed length of a command line option
600 #define MAX_OPTION_LEN 256
602 static unsigned int getCurrentMS(void)
604 return SDL_GetTicks();
607 static unsigned int mainCounter(int mode)
609 static unsigned int base_ms = 0;
610 unsigned int current_ms;
612 // get current system milliseconds
613 current_ms = getCurrentMS();
615 // reset base timestamp in case of counter reset or wrap-around
616 if (mode == INIT_COUNTER || current_ms < base_ms)
617 base_ms = current_ms;
619 // return milliseconds since last counter reset
620 return current_ms - base_ms;
623 void InitCounter() // set counter back to zero
625 mainCounter(INIT_COUNTER);
628 unsigned int Counter() // get milliseconds since last call of InitCounter()
630 return mainCounter(READ_COUNTER);
633 static void sleep_milliseconds(unsigned int milliseconds_delay)
635 SDL_Delay(milliseconds_delay);
638 void Delay(unsigned int delay) // Sleep specified number of milliseconds
640 sleep_milliseconds(delay);
643 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
644 unsigned int actual_counter)
646 if (actual_counter >= *counter_var &&
647 actual_counter < *counter_var + delay)
650 *counter_var = actual_counter;
655 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
657 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
660 boolean FrameReached(DelayCounter *counter)
662 return DelayReachedExt(counter, FrameCounter);
665 boolean DelayReached(DelayCounter *counter)
667 return DelayReachedExt(counter, Counter());
670 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
672 DelayReachedExt2(&counter->count, 0, actual_counter);
675 void ResetFrameCounter(DelayCounter *counter)
677 ResetDelayCounterExt(counter, FrameCounter);
680 void ResetDelayCounter(DelayCounter *counter)
682 ResetDelayCounterExt(counter, Counter());
685 int WaitUntilDelayReached(DelayCounter *counter)
687 unsigned int *counter_var = &counter->count;
688 unsigned int delay = counter->value;
689 unsigned int actual_counter;
694 actual_counter = Counter();
696 if (actual_counter >= *counter_var &&
697 actual_counter < *counter_var + delay)
698 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
703 if (*counter_var != 0 &&
705 actual_counter >= *counter_var + delay)
707 int lag = actual_counter - (*counter_var + delay);
708 int delay2 = (delay + 1) / 2;
711 skip_frames = (lag + delay2) / delay;
714 *counter_var = actual_counter;
719 void SkipUntilDelayReached(DelayCounter *counter,
720 int *loop_var, int last_loop_value)
722 int skip_frames = WaitUntilDelayReached(counter);
727 Debug("internal:SkipUntilDelayReached",
728 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
729 *loop_var, counter->value,
730 skip_frames, skip_frames * counter->value);
732 Debug("internal:SkipUntilDelayReached",
734 *loop_var, counter->value);
738 if (skip_frames == 0)
741 // when skipping frames, make sure to never skip the last frame, as
742 // this may be needed for animations to reach a defined end state;
743 // furthermore, we assume that this function is called at the end
744 // of a "for" loop, which continues by incrementing the loop variable
745 // by one before checking the loop condition again; therefore we have
746 // to check against the last loop value minus one here
750 if (*loop_var < last_loop_value) // never skip the last frame
752 *loop_var += skip_frames;
754 if (*loop_var > last_loop_value) // never skip the last frame
755 *loop_var = last_loop_value;
760 // ----------------------------------------------------------------------------
761 // random generator functions
762 // ----------------------------------------------------------------------------
764 static unsigned int init_random_number_ext(int nr, int seed)
766 if (seed == NEW_RANDOMIZE)
768 // default random seed
769 seed = (int)time(NULL); // seconds since the epoch
771 #if !defined(PLATFORM_WINDOWS)
772 // add some more randomness
773 struct timeval current_time;
775 gettimeofday(¤t_time, NULL);
777 seed += (int)current_time.tv_usec; // microseconds since the epoch
780 // add some more randomness
781 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
783 // add some more randomness
784 seed += GetSimpleRandom(1000000);
787 srandom_linux_libc(nr, (unsigned int) seed);
789 return (unsigned int) seed;
792 static unsigned int prng_seed_gettimeofday(void)
794 struct timeval current_time;
796 gettimeofday(¤t_time, NULL);
798 prng_seed_bytes(¤t_time, sizeof(current_time));
803 unsigned int init_random_number(int nr, int seed)
805 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
806 init_random_number_ext(nr, seed));
809 static unsigned int get_random_number_ext(int nr)
811 return (nr == RANDOM_BETTER ? prng_get_uint() :
812 random_linux_libc(nr));
815 unsigned int get_random_number(int nr, int max)
817 return (max > 0 ? get_random_number_ext(nr) % max : 0);
821 // ----------------------------------------------------------------------------
822 // system info functions
823 // ----------------------------------------------------------------------------
825 #if !defined(PLATFORM_ANDROID)
826 static char *get_corrected_real_name(char *real_name)
828 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
829 char *from_ptr = real_name;
830 char *to_ptr = real_name_new;
832 // copy the name string, but not more than MAX_USERNAME_LEN characters
833 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
835 // the name field read from "passwd" file may also contain additional
836 // user information, separated by commas, which will be removed here
837 if (*from_ptr == ',')
840 // the user's real name may contain 'german sharp s' characters,
841 // which have no equivalent in upper case letters (used by our fonts)
842 if (*from_ptr == CHAR_BYTE_SHARP_S)
849 *to_ptr++ = *from_ptr++;
854 return real_name_new;
858 #if defined(PLATFORM_UNIX)
859 static struct passwd *getPasswdEntry(void)
861 #if defined(PLATFORM_EMSCRIPTEN)
862 // currently not fully supported; force fallback to default values
865 return getpwuid(getuid());
869 char *getUnixLoginName(void)
871 struct passwd *pwd = getPasswdEntry();
873 if (pwd != NULL && strlen(pwd->pw_name) != 0)
879 char *getUnixRealName(void)
881 struct passwd *pwd = getPasswdEntry();
883 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
884 return pwd->pw_gecos;
889 char *getUnixHomeDir(void)
891 struct passwd *pwd = getPasswdEntry();
893 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
900 char *getLoginName(void)
902 static char *login_name = NULL;
904 #if defined(PLATFORM_WINDOWS)
905 if (login_name == NULL)
907 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
909 login_name = checked_malloc(buffer_size);
911 if (GetUserName(login_name, &buffer_size) == 0)
912 strcpy(login_name, ANONYMOUS_NAME);
914 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
915 if (login_name == NULL)
917 char *name = getUnixLoginName();
920 login_name = getStringCopy(name);
922 login_name = ANONYMOUS_NAME;
925 login_name = ANONYMOUS_NAME;
931 char *getRealName(void)
933 static char *real_name = NULL;
935 #if defined(PLATFORM_WINDOWS)
936 if (real_name == NULL)
938 static char buffer[MAX_USERNAME_LEN + 1];
939 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
941 if (GetUserName(buffer, &buffer_size) != 0)
942 real_name = get_corrected_real_name(buffer);
944 real_name = ANONYMOUS_NAME;
946 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
947 if (real_name == NULL)
949 char *name = getUnixRealName();
952 real_name = get_corrected_real_name(name);
954 real_name = ANONYMOUS_NAME;
957 real_name = ANONYMOUS_NAME;
963 char *getFixedUserName(char *name)
965 // needed because player name must be a fixed length string
966 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
968 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
969 name_new[MAX_PLAYER_NAME_LEN] = '\0';
971 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
972 if (strchr(name_new, ' '))
973 *strchr(name_new, ' ') = '\0';
978 char *getDefaultUserName(int nr)
980 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
982 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
984 if (user_name[nr] == NULL)
986 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
987 user_name[nr] = getFixedUserName(user_name[nr]);
990 return user_name[nr];
993 char *getTimestampFromEpoch(time_t epoch_seconds)
995 struct tm *now = localtime(&epoch_seconds);
996 static char timestamp[20];
998 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
999 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1000 now->tm_hour, now->tm_min, now->tm_sec);
1005 char *getCurrentTimestamp(void)
1007 return getTimestampFromEpoch(time(NULL));
1010 time_t getFileTimestampEpochSeconds(char *filename)
1012 struct stat file_status;
1014 if (stat(filename, &file_status) != 0) // cannot stat file
1017 return file_status.st_mtime;
1021 // ----------------------------------------------------------------------------
1022 // path manipulation functions
1023 // ----------------------------------------------------------------------------
1025 static char *getLastPathSeparatorPtr(char *filename)
1027 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1029 if (last_separator == NULL) // also try DOS/Windows variant
1030 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1032 return last_separator;
1035 char *getBaseNamePtr(char *filename)
1037 char *last_separator = getLastPathSeparatorPtr(filename);
1039 if (last_separator != NULL)
1040 return last_separator + 1; // separator found: strip base path
1042 return filename; // no separator found: filename has no path
1045 char *getBaseName(char *filename)
1047 return getStringCopy(getBaseNamePtr(filename));
1050 char *getBaseNameNoSuffix(char *filename)
1052 char *basename = getStringCopy(getBaseNamePtr(filename));
1054 // remove trailing suffix (separated by dot or hyphen)
1055 if (basename[0] != '.' && basename[0] != '-')
1057 if (strchr(basename, '.') != NULL)
1058 *strchr(basename, '.') = '\0';
1060 if (strchr(basename, '-') != NULL)
1061 *strchr(basename, '-') = '\0';
1067 char *getBasePath(char *filename)
1069 char *basepath = getStringCopy(filename);
1070 char *last_separator = getLastPathSeparatorPtr(basepath);
1072 // if no separator was found, use current directory
1073 if (last_separator == NULL)
1077 return getStringCopy(".");
1080 // separator found: strip basename
1081 *last_separator = '\0';
1087 // ----------------------------------------------------------------------------
1088 // various string functions
1089 // ----------------------------------------------------------------------------
1091 char *getStringCat2WithSeparator(const char *s1,
1095 if (s1 == NULL || s2 == NULL || sep == NULL)
1098 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1101 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1103 return complete_string;
1106 char *getStringCat3WithSeparator(const char *s1,
1111 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1114 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1115 strlen(s2) + strlen(sep) +
1118 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1120 return complete_string;
1123 char *getStringCat2(const char *s1, const char *s2)
1125 return getStringCat2WithSeparator(s1, s2, "");
1128 char *getStringCat3(const char *s1, const char *s2, const char *s3)
1130 return getStringCat3WithSeparator(s1, s2, s3, "");
1133 char *getPath2(const char *path1, const char *path2)
1135 #if defined(PLATFORM_ANDROID)
1136 // workaround for reading from assets directory -- skip "." subdirs in path
1137 if (strEqual(path1, "."))
1138 return getStringCopy(path2);
1139 else if (strEqual(path2, "."))
1140 return getStringCopy(path1);
1143 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1146 char *getPath3(const char *path1, const char *path2, const char *path3)
1148 #if defined(PLATFORM_ANDROID)
1149 // workaround for reading from assets directory -- skip "." subdirs in path
1150 if (strEqual(path1, "."))
1151 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1152 else if (strEqual(path2, "."))
1153 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1154 else if (strEqual(path3, "."))
1155 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1158 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1161 static char *getPngOrPcxIfNotExists(char *filename)
1163 // switch from PNG to PCX file and vice versa, if file does not exist
1164 // (backwards compatibility with PCX files used in previous versions)
1166 if (!fileExists(filename) && strSuffix(filename, ".png"))
1167 strcpy(&filename[strlen(filename) - 3], "pcx");
1168 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1169 strcpy(&filename[strlen(filename) - 3], "png");
1174 char *getImg2(const char *path1, const char *path2)
1176 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1179 char *getImg3(const char *path1, const char *path2, const char *path3)
1181 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1184 char *getStringCopy(const char *s)
1191 s_copy = checked_malloc(strlen(s) + 1);
1197 char *getStringCopyN(const char *s, int n)
1200 int s_len = MAX(0, n);
1205 s_copy = checked_malloc(s_len + 1);
1206 strncpy(s_copy, s, s_len);
1207 s_copy[s_len] = '\0';
1212 char *getStringCopyNStatic(const char *s, int n)
1214 static char *s_copy = NULL;
1216 checked_free(s_copy);
1218 s_copy = getStringCopyN(s, n);
1223 char *getStringToLower(const char *s)
1225 char *s_copy = checked_malloc(strlen(s) + 1);
1226 char *s_ptr = s_copy;
1229 *s_ptr++ = tolower(*s++);
1235 void setString(char **old_value, const char *new_value)
1237 checked_free(*old_value);
1239 *old_value = getStringCopy(new_value);
1242 char **getSplitStringArray(const char *s, const char *separators, int max_tokens)
1244 const char *s_ptr, *s_last = s;
1245 byte separator_table[256] = { FALSE };
1247 char **tokens = NULL;
1252 if (separators == NULL)
1256 max_tokens = INT_MAX;
1258 // if string is empty, return empty array
1261 tokens = checked_malloc(sizeof(char *));
1267 // initialize separator table for all characters in separators string
1268 for (s_ptr = separators; *s_ptr != '\0'; s_ptr++)
1269 separator_table[*(byte *)s_ptr] = TRUE;
1271 // count number of tokens in string
1272 for (num_tokens = 1, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1273 if (separator_table[*(byte *)s_ptr] && num_tokens < max_tokens)
1276 // allocate array for determined number of tokens
1277 tokens = checked_malloc((num_tokens + 1) * sizeof(char *));
1279 // copy all but last separated sub-strings to array
1280 for (num_tokens = 0, s_ptr = s; *s_ptr != '\0'; s_ptr++)
1282 if (separator_table[*(byte *)s_ptr] && num_tokens + 1 < max_tokens)
1284 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1289 // copy last separated sub-string to array
1290 tokens[num_tokens++] = getStringCopyN(s_last, s_ptr - s_last);
1293 tokens[num_tokens] = NULL;
1298 int getStringArrayLength(char **s_array)
1300 int num_strings = 0;
1302 if (s_array == NULL)
1305 while (s_array[num_strings] != NULL)
1311 void freeStringArray(char **s_array)
1315 if (s_array == NULL)
1318 for (i = 0; s_array[i] != NULL; i++)
1319 checked_free(s_array[i]);
1321 checked_free(s_array);
1324 char *getUnescapedString(const char *s)
1326 const char *s_ptr = s;
1327 const char *octal_ptr;
1329 char *s_unescaped_ptr;
1334 s_unescaped = checked_malloc(strlen(s) + 1);
1335 s_unescaped_ptr = s_unescaped;
1337 while (*s_ptr != '\0')
1346 Warn("getUnescapedString: trailing \\");
1357 *s_unescaped_ptr = 0;
1360 while (s_ptr < octal_ptr + 3 && *s_ptr >= '0' && *s_ptr <= '7')
1362 *s_unescaped_ptr = (*s_unescaped_ptr * 8) + (*s_ptr - '0');
1371 *s_unescaped_ptr++ = '\b';
1375 *s_unescaped_ptr++ = '\f';
1379 *s_unescaped_ptr++ = '\n';
1383 *s_unescaped_ptr++ = '\r';
1387 *s_unescaped_ptr++ = '\t';
1391 *s_unescaped_ptr++ = '\v';
1395 /* also handles \" and \\ */
1396 *s_unescaped_ptr++ = *s_ptr;
1402 *s_unescaped_ptr++ = *s_ptr;
1409 *s_unescaped_ptr = '\0';
1414 boolean strEqual(const char *s1, const char *s2)
1416 return (s1 == NULL && s2 == NULL ? TRUE :
1417 s1 == NULL && s2 != NULL ? FALSE :
1418 s1 != NULL && s2 == NULL ? FALSE :
1419 strcmp(s1, s2) == 0);
1422 boolean strEqualN(const char *s1, const char *s2, int n)
1424 return (s1 == NULL && s2 == NULL ? TRUE :
1425 s1 == NULL && s2 != NULL ? FALSE :
1426 s1 != NULL && s2 == NULL ? FALSE :
1427 strncmp(s1, s2, n) == 0);
1430 boolean strEqualCase(const char *s1, const char *s2)
1432 return (s1 == NULL && s2 == NULL ? TRUE :
1433 s1 == NULL && s2 != NULL ? FALSE :
1434 s1 != NULL && s2 == NULL ? FALSE :
1435 strcasecmp(s1, s2) == 0);
1438 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1440 return (s1 == NULL && s2 == NULL ? TRUE :
1441 s1 == NULL && s2 != NULL ? FALSE :
1442 s1 != NULL && s2 == NULL ? FALSE :
1443 strncasecmp(s1, s2, n) == 0);
1446 boolean strPrefix(const char *s, const char *prefix)
1448 return (s == NULL && prefix == NULL ? TRUE :
1449 s == NULL && prefix != NULL ? FALSE :
1450 s != NULL && prefix == NULL ? FALSE :
1451 strncmp(s, prefix, strlen(prefix)) == 0);
1454 boolean strSuffix(const char *s, const char *suffix)
1456 return (s == NULL && suffix == NULL ? TRUE :
1457 s == NULL && suffix != NULL ? FALSE :
1458 s != NULL && suffix == NULL ? FALSE :
1459 strlen(s) < strlen(suffix) ? FALSE :
1460 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1463 boolean strPrefixLower(const char *s, const char *prefix)
1465 char *s_lower = getStringToLower(s);
1466 boolean match = strPrefix(s_lower, prefix);
1473 boolean strSuffixLower(const char *s, const char *suffix)
1475 char *s_lower = getStringToLower(s);
1476 boolean match = strSuffix(s_lower, suffix);
1483 boolean isURL(const char *s)
1485 while (*s && *s >= 'a' && *s <= 'z')
1488 return strPrefix(s, "://");
1492 // ----------------------------------------------------------------------------
1493 // command line option handling functions
1494 // ----------------------------------------------------------------------------
1496 void GetOptions(int argc, char *argv[],
1497 void (*print_usage_function)(void),
1498 void (*print_version_function)(void))
1500 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1501 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1502 char **options_left = &argvplus[1];
1504 // replace original "argv" with null-terminated array of string pointers
1506 argvplus[argc] = argv[argc];
1508 // initialize global program options
1509 options.server_host = NULL;
1510 options.server_port = 0;
1512 options.base_directory = base_path;
1514 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1515 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1516 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1517 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1518 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1519 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1521 options.execute_command = NULL;
1522 options.tape_log_filename = NULL;
1523 options.special_flags = NULL;
1524 options.debug_mode = NULL;
1525 options.player_name = NULL;
1526 options.identifier = NULL;
1527 options.level_nr = NULL;
1529 options.display_nr = 0;
1531 options.mytapes = FALSE;
1532 options.serveronly = FALSE;
1533 options.network = FALSE;
1534 options.verbose = FALSE;
1535 options.debug = FALSE;
1538 options.verbose = TRUE;
1540 #if !defined(PLATFORM_UNIX)
1541 if (*options_left == NULL) // no options given -- enable verbose mode
1542 options.verbose = TRUE;
1547 #if defined(PLATFORM_ANDROID)
1548 options.debug = TRUE;
1552 while (*options_left)
1554 char option_str[MAX_OPTION_LEN];
1555 char *option = options_left[0];
1556 char *next_option = options_left[1];
1557 char *option_arg = NULL;
1558 int option_len = strlen(option);
1560 if (option_len >= MAX_OPTION_LEN)
1561 FailWithHelp("unrecognized option '%s'", option);
1563 strcpy(option_str, option); // copy argument into buffer
1564 option = option_str;
1566 if (strEqual(option, "--")) // stop scanning arguments
1569 if (strPrefix(option, "--")) // treat '--' like '-'
1572 option_arg = strchr(option, '=');
1573 if (option_arg == NULL) // no '=' in option
1574 option_arg = next_option;
1577 *option_arg++ = '\0'; // cut argument from option
1578 if (*option_arg == '\0') // no argument after '='
1579 FailWithHelp("option '%s' has invalid argument", option_str);
1582 option_len = strlen(option);
1584 if (strEqual(option, "-"))
1586 FailWithHelp("unrecognized option '%s'", option);
1588 else if (strncmp(option, "-help", option_len) == 0)
1590 print_usage_function();
1594 else if (strncmp(option, "-basepath", option_len) == 0)
1596 if (option_arg == NULL)
1597 FailWithHelp("option '%s' requires an argument", option_str);
1599 options.base_directory = base_path = getStringCopy(option_arg);
1600 if (option_arg == next_option)
1603 // adjust paths for sub-directories in base directory accordingly
1604 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1605 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1606 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1607 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1608 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1609 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1611 else if (strncmp(option, "-levels", option_len) == 0)
1613 if (option_arg == NULL)
1614 FailWithHelp("option '%s' requires an argument", option_str);
1616 options.level_directory = getStringCopy(option_arg);
1617 if (option_arg == next_option)
1620 else if (strncmp(option, "-graphics", option_len) == 0)
1622 if (option_arg == NULL)
1623 FailWithHelp("option '%s' requires an argument", option_str);
1625 options.graphics_directory = getStringCopy(option_arg);
1626 if (option_arg == next_option)
1629 else if (strncmp(option, "-sounds", option_len) == 0)
1631 if (option_arg == NULL)
1632 FailWithHelp("option '%s' requires an argument", option_str);
1634 options.sounds_directory = getStringCopy(option_arg);
1635 if (option_arg == next_option)
1638 else if (strncmp(option, "-music", option_len) == 0)
1640 if (option_arg == NULL)
1641 FailWithHelp("option '%s' requires an argument", option_str);
1643 options.music_directory = getStringCopy(option_arg);
1644 if (option_arg == next_option)
1647 else if (strncmp(option, "-mytapes", option_len) == 0)
1649 options.mytapes = TRUE;
1651 else if (strncmp(option, "-network", option_len) == 0)
1653 options.network = TRUE;
1655 else if (strncmp(option, "-serveronly", option_len) == 0)
1657 options.serveronly = TRUE;
1659 else if (strncmp(option, "-debug", option_len) == 0)
1661 options.debug = TRUE;
1663 // optionally, debug output can be limited to a specific debug mode
1664 if (option_arg != next_option)
1665 options.debug_mode = getStringCopy(option_arg);
1667 else if (strncmp(option, "-player-name", option_len) == 0)
1669 if (option_arg == NULL)
1670 FailWithHelp("option '%s' requires an argument", option_str);
1672 options.player_name = getStringCopy(option_arg);
1673 if (option_arg == next_option)
1676 else if (strncmp(option, "-identifier", option_len) == 0)
1678 if (option_arg == NULL)
1679 FailWithHelp("option '%s' requires an argument", option_str);
1681 options.identifier = getStringCopy(option_arg);
1682 if (option_arg == next_option)
1685 else if (strncmp(option, "-level-nr", option_len) == 0)
1687 if (option_arg == NULL)
1688 FailWithHelp("option '%s' requires an argument", option_str);
1690 options.level_nr = getStringCopy(option_arg);
1691 if (option_arg == next_option)
1694 else if (strncmp(option, "-verbose", option_len) == 0)
1696 options.verbose = TRUE;
1698 else if (strncmp(option, "-version", option_len) == 0 ||
1699 strncmp(option, "-V", option_len) == 0)
1701 print_version_function();
1705 else if (strPrefix(option, "-D"))
1707 options.special_flags = getStringCopy(&option[2]);
1709 else if (strncmp(option, "-execute", option_len) == 0)
1711 if (option_arg == NULL)
1712 FailWithHelp("option '%s' requires an argument", option_str);
1714 options.execute_command = getStringCopy(option_arg);
1715 if (option_arg == next_option)
1718 // when doing batch processing, always enable verbose mode (warnings)
1719 options.verbose = TRUE;
1721 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1723 if (option_arg == NULL)
1724 FailWithHelp("option '%s' requires an argument", option_str);
1726 options.tape_log_filename = getStringCopy(option_arg);
1727 if (option_arg == next_option)
1730 else if (strncmp(option, "-display", option_len) == 0)
1732 if (option_arg == NULL)
1733 FailWithHelp("option '%s' requires an argument", option_str);
1735 if (option_arg == next_option)
1738 int display_nr = atoi(option_arg);
1741 // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1742 options.display_nr = display_nr;
1744 options.display_nr =
1745 MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1747 if (display_nr != options.display_nr)
1748 Warn("invalid display %d -- using display %d",
1749 display_nr, options.display_nr);
1752 #if defined(PLATFORM_MAC)
1753 else if (strPrefix(option, "-psn"))
1755 // ignore process serial number when launched via GUI on Mac OS X
1758 else if (*option == '-')
1760 FailWithHelp("unrecognized option '%s'", option_str);
1762 else if (options.server_host == NULL)
1764 options.server_host = *options_left;
1766 else if (options.server_port == 0)
1768 options.server_port = atoi(*options_left);
1769 if (options.server_port < 1024)
1770 FailWithHelp("bad port number '%d'", options.server_port);
1773 FailWithHelp("too many arguments");
1780 // ----------------------------------------------------------------------------
1781 // checked memory allocation and freeing functions
1782 // ----------------------------------------------------------------------------
1784 void *checked_malloc(unsigned int size)
1791 Fail("cannot allocate %d bytes -- out of memory", size);
1796 void *checked_calloc(unsigned int size)
1800 ptr = calloc(1, size);
1803 Fail("cannot allocate %d bytes -- out of memory", size);
1808 void *checked_realloc(void *ptr, unsigned int size)
1810 ptr = realloc(ptr, size);
1813 Fail("cannot allocate %d bytes -- out of memory", size);
1818 void checked_free(void *ptr)
1820 if (ptr != NULL) // this check should be done by free() anyway
1824 void clear_mem(void *ptr, unsigned int size)
1826 #if defined(PLATFORM_WINDOWS)
1827 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1828 char *cptr = (char *)ptr;
1833 memset(ptr, 0, size);
1838 // ----------------------------------------------------------------------------
1839 // various helper functions
1840 // ----------------------------------------------------------------------------
1842 void swap_numbers(int *i1, int *i2)
1850 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1862 int get_number_of_bits(int bits)
1865 Counting bits set, Brian Kernighan's way
1867 Brian Kernighan's method goes through as many iterations as there are set
1868 bits. So if we have a 32-bit word with only the high bit set, then it will
1869 only go once through the loop.
1871 Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1872 and Dennis M. Ritchie) mentions this in exercise 2-9.
1873 First published by Peter Wegner in CACM 3 (1960), 322.
1880 bits &= bits - 1; // clear the least significant bit set
1887 /* the "put" variants of the following file access functions check for the file
1888 pointer being != NULL and return the number of bytes they have or would have
1889 written; this allows for chunk writing functions to first determine the size
1890 of the (not yet written) chunk, write the correct chunk size and finally
1891 write the chunk itself */
1893 int getFile8BitInteger(File *file)
1895 return getByteFromFile(file);
1898 int putFile8BitInteger(FILE *file, int value)
1906 int getFile16BitInteger(File *file, int byte_order)
1908 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1909 return ((getByteFromFile(file) << 8) |
1910 (getByteFromFile(file) << 0));
1911 else // BYTE_ORDER_LITTLE_ENDIAN
1912 return ((getByteFromFile(file) << 0) |
1913 (getByteFromFile(file) << 8));
1916 int putFile16BitInteger(FILE *file, int value, int byte_order)
1920 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1922 fputc((value >> 8) & 0xff, file);
1923 fputc((value >> 0) & 0xff, file);
1925 else // BYTE_ORDER_LITTLE_ENDIAN
1927 fputc((value >> 0) & 0xff, file);
1928 fputc((value >> 8) & 0xff, file);
1935 int getFile32BitInteger(File *file, int byte_order)
1937 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1938 return ((getByteFromFile(file) << 24) |
1939 (getByteFromFile(file) << 16) |
1940 (getByteFromFile(file) << 8) |
1941 (getByteFromFile(file) << 0));
1942 else // BYTE_ORDER_LITTLE_ENDIAN
1943 return ((getByteFromFile(file) << 0) |
1944 (getByteFromFile(file) << 8) |
1945 (getByteFromFile(file) << 16) |
1946 (getByteFromFile(file) << 24));
1949 int putFile32BitInteger(FILE *file, int value, int byte_order)
1953 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1955 fputc((value >> 24) & 0xff, file);
1956 fputc((value >> 16) & 0xff, file);
1957 fputc((value >> 8) & 0xff, file);
1958 fputc((value >> 0) & 0xff, file);
1960 else // BYTE_ORDER_LITTLE_ENDIAN
1962 fputc((value >> 0) & 0xff, file);
1963 fputc((value >> 8) & 0xff, file);
1964 fputc((value >> 16) & 0xff, file);
1965 fputc((value >> 24) & 0xff, file);
1972 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1975 const int chunk_name_length = 4;
1978 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1981 if (chunk_size != NULL)
1984 *chunk_size = getFile32BitInteger(file, byte_order);
1987 return (checkEndOfFile(file) ? FALSE : TRUE);
1990 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1997 fputs(chunk_name, file);
1999 num_bytes += strlen(chunk_name);
2001 if (chunk_size >= 0)
2005 putFile32BitInteger(file, chunk_size, byte_order);
2013 int getFileVersion(File *file)
2015 int version_super = getByteFromFile(file);
2016 int version_major = getByteFromFile(file);
2017 int version_minor = getByteFromFile(file);
2018 int version_patch = getByteFromFile(file);
2020 return VERSION_IDENT(version_super, version_major, version_minor,
2024 int putFileVersion(FILE *file, int version)
2028 int version_super = VERSION_SUPER(version);
2029 int version_major = VERSION_MAJOR(version);
2030 int version_minor = VERSION_MINOR(version);
2031 int version_patch = VERSION_PATCH(version);
2033 fputc(version_super, file);
2034 fputc(version_major, file);
2035 fputc(version_minor, file);
2036 fputc(version_patch, file);
2042 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2046 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2047 buffer[i] = getByteFromFile(file);
2050 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2054 for (i = 0; i < bytes; i++)
2055 fputc(buffer[i], file);
2058 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2060 while (bytes-- && !checkEndOfFile(file))
2061 getByteFromFile(file);
2064 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2071 // ----------------------------------------------------------------------------
2072 // functions to convert between ISO-8859-1 and UTF-8
2073 // ----------------------------------------------------------------------------
2075 char *getUTF8FromLatin1(char *latin1)
2077 int max_utf8_size = 2 * strlen(latin1) + 1;
2078 char *utf8 = checked_calloc(max_utf8_size);
2079 unsigned char *src = (unsigned char *)latin1;
2080 unsigned char *dst = (unsigned char *)utf8;
2084 if (*src < 128) // pure 7-bit ASCII
2088 else if (*src >= 160) // non-ASCII characters
2090 *dst++ = 194 + (*src >= 192);
2091 *dst++ = 128 + (*src & 63);
2093 else // undefined in ISO-8859-1
2101 // only use the smallest possible string buffer size
2102 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2107 char *getLatin1FromUTF8(char *utf8)
2109 int max_latin1_size = strlen(utf8) + 1;
2110 char *latin1 = checked_calloc(max_latin1_size);
2111 unsigned char *src = (unsigned char *)utf8;
2112 unsigned char *dst = (unsigned char *)latin1;
2116 if (*src < 128) // pure 7-bit ASCII
2120 else if (src[0] == 194 &&
2121 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2126 else if (src[0] == 195 &&
2127 src[1] >= 128 && src[1] < 192) // non-ASCII characters
2129 *dst++ = src[1] + 64;
2133 // all other UTF-8 characters are undefined in ISO-8859-1
2135 else if (src[0] >= 192 && src[0] < 224 &&
2136 src[1] >= 128 && src[1] < 192)
2141 else if (src[0] >= 224 && src[0] < 240 &&
2142 src[1] >= 128 && src[1] < 192 &&
2143 src[2] >= 128 && src[2] < 192)
2148 else if (src[0] >= 240 && src[0] < 248 &&
2149 src[1] >= 128 && src[1] < 192 &&
2150 src[2] >= 128 && src[2] < 192 &&
2151 src[3] >= 128 && src[3] < 192)
2156 else if (src[0] >= 248 && src[0] < 252 &&
2157 src[1] >= 128 && src[1] < 192 &&
2158 src[2] >= 128 && src[2] < 192 &&
2159 src[3] >= 128 && src[3] < 192 &&
2160 src[4] >= 128 && src[4] < 192)
2165 else if (src[0] >= 252 && src[0] < 254 &&
2166 src[1] >= 128 && src[1] < 192 &&
2167 src[2] >= 128 && src[2] < 192 &&
2168 src[3] >= 128 && src[3] < 192 &&
2169 src[4] >= 128 && src[4] < 192 &&
2170 src[5] >= 128 && src[5] < 192)
2182 // only use the smallest possible string buffer size
2183 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2188 int getTextEncoding(char *text)
2190 unsigned char *src = (unsigned char *)text;
2191 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
2196 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
2202 else if (src[0] >= 192 && src[0] < 224 &&
2203 src[1] >= 128 && src[1] < 192)
2207 else if (src[0] >= 224 && src[0] < 240 &&
2208 src[1] >= 128 && src[1] < 192 &&
2209 src[2] >= 128 && src[2] < 192)
2213 else if (src[0] >= 240 && src[0] < 248 &&
2214 src[1] >= 128 && src[1] < 192 &&
2215 src[2] >= 128 && src[2] < 192 &&
2216 src[3] >= 128 && src[3] < 192)
2220 else if (src[0] >= 248 && src[0] < 252 &&
2221 src[1] >= 128 && src[1] < 192 &&
2222 src[2] >= 128 && src[2] < 192 &&
2223 src[3] >= 128 && src[3] < 192 &&
2224 src[4] >= 128 && src[4] < 192)
2228 else if (src[0] >= 252 && src[0] < 254 &&
2229 src[1] >= 128 && src[1] < 192 &&
2230 src[2] >= 128 && src[2] < 192 &&
2231 src[3] >= 128 && src[3] < 192 &&
2232 src[4] >= 128 && src[4] < 192 &&
2233 src[5] >= 128 && src[5] < 192)
2239 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2247 // ----------------------------------------------------------------------------
2248 // functions for JSON handling
2249 // ----------------------------------------------------------------------------
2251 char *getEscapedJSON(char *s)
2253 int max_json_size = 2 * strlen(s) + 1;
2254 char *json = checked_calloc(max_json_size);
2255 unsigned char *src = (unsigned char *)s;
2256 unsigned char *dst = (unsigned char *)json;
2257 char *escaped[256] =
2270 if (escaped[*src] != NULL)
2272 char *esc = escaped[*src++];
2283 // only use the smallest possible string buffer size
2284 json = checked_realloc(json, strlen(json) + 1);
2290 // ----------------------------------------------------------------------------
2291 // functions to translate key identifiers between different format
2292 // ----------------------------------------------------------------------------
2294 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2295 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2296 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2297 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2299 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2308 // return and escape keys
2309 { KSYM_Return, "XK_Return", "return" },
2310 { KSYM_Escape, "XK_Escape", "escape" },
2312 // normal cursor keys
2313 { KSYM_Left, "XK_Left", "cursor left" },
2314 { KSYM_Right, "XK_Right", "cursor right" },
2315 { KSYM_Up, "XK_Up", "cursor up" },
2316 { KSYM_Down, "XK_Down", "cursor down" },
2318 // keypad cursor keys
2320 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2321 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2322 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2323 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2326 // other keypad keys
2327 #ifdef KSYM_KP_Enter
2328 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2329 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2330 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2331 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2332 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2333 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2337 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2338 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2339 { KSYM_Control_L, "XK_Control_L", "left control" },
2340 { KSYM_Control_R, "XK_Control_R", "right control" },
2341 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2342 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2343 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2344 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2345 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2346 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2348 // some special keys
2349 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2350 { KSYM_Delete, "XK_Delete", "delete" },
2351 { KSYM_Insert, "XK_Insert", "insert" },
2352 { KSYM_Tab, "XK_Tab", "tab" },
2353 { KSYM_Home, "XK_Home", "home" },
2354 { KSYM_End, "XK_End", "end" },
2355 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2356 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2358 { KSYM_Select, "XK_Select", "select" },
2359 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2360 { KSYM_Back, "XK_Back", "back" }, // back key
2361 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2362 #if defined(PLATFORM_ANDROID)
2363 { KSYM_Rewind, "XK_Rewind", "rewind" },
2364 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2367 // ASCII 0x20 to 0x40 keys (except numbers)
2368 { KSYM_space, "XK_space", "space" },
2369 { KSYM_exclam, "XK_exclam", "!" },
2370 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2371 { KSYM_numbersign, "XK_numbersign", "#" },
2372 { KSYM_dollar, "XK_dollar", "$" },
2373 { KSYM_percent, "XK_percent", "%" },
2374 { KSYM_ampersand, "XK_ampersand", "&" },
2375 { KSYM_apostrophe, "XK_apostrophe", "'" },
2376 { KSYM_parenleft, "XK_parenleft", "(" },
2377 { KSYM_parenright, "XK_parenright", ")" },
2378 { KSYM_asterisk, "XK_asterisk", "*" },
2379 { KSYM_plus, "XK_plus", "+" },
2380 { KSYM_comma, "XK_comma", "," },
2381 { KSYM_minus, "XK_minus", "-" },
2382 { KSYM_period, "XK_period", "." },
2383 { KSYM_slash, "XK_slash", "/" },
2384 { KSYM_colon, "XK_colon", ":" },
2385 { KSYM_semicolon, "XK_semicolon", ";" },
2386 { KSYM_less, "XK_less", "<" },
2387 { KSYM_equal, "XK_equal", "=" },
2388 { KSYM_greater, "XK_greater", ">" },
2389 { KSYM_question, "XK_question", "?" },
2390 { KSYM_at, "XK_at", "@" },
2393 { KSYM_bracketleft, "XK_bracketleft", "[" },
2394 { KSYM_backslash, "XK_backslash", "\\" },
2395 { KSYM_bracketright,"XK_bracketright", "]" },
2396 { KSYM_asciicircum, "XK_asciicircum", "^" },
2397 { KSYM_underscore, "XK_underscore", "_" },
2398 { KSYM_grave, "XK_grave", "grave" },
2399 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2400 { KSYM_braceleft, "XK_braceleft", "brace left" },
2401 { KSYM_bar, "XK_bar", "bar" },
2402 { KSYM_braceright, "XK_braceright", "brace right" },
2403 { KSYM_asciitilde, "XK_asciitilde", "~" },
2405 // special (non-ASCII) keys
2406 { KSYM_degree, "XK_degree", "degree" },
2407 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2408 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2409 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2410 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2411 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2412 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2413 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2415 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2416 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2417 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2418 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2419 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2420 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2421 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2422 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2423 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2425 // other keys (for reverse mapping only)
2426 { KSYM_space, "XK_space", " " },
2428 // keypad keys are not in numerical order in SDL2
2429 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2430 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2431 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2432 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2433 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2434 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2435 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2436 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2437 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2438 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2440 // end-of-array identifier
2446 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2448 static char name_buffer[30];
2451 if (key >= KSYM_A && key <= KSYM_Z)
2452 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2453 else if (key >= KSYM_a && key <= KSYM_z)
2454 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2455 else if (key >= KSYM_0 && key <= KSYM_9)
2456 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2457 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2458 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2459 else if (key == KSYM_UNDEFINED)
2460 strcpy(name_buffer, "(undefined)");
2467 if (key == translate_key[i].key)
2469 strcpy(name_buffer, translate_key[i].name);
2473 while (translate_key[++i].name);
2475 if (!translate_key[i].name)
2476 strcpy(name_buffer, "(unknown)");
2479 *name = name_buffer;
2481 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2483 static char name_buffer[30];
2486 if (key >= KSYM_A && key <= KSYM_Z)
2487 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2488 else if (key >= KSYM_a && key <= KSYM_z)
2489 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2490 else if (key >= KSYM_0 && key <= KSYM_9)
2491 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2492 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2493 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2494 else if (key == KSYM_UNDEFINED)
2495 strcpy(name_buffer, "[undefined]");
2502 if (key == translate_key[i].key)
2504 strcpy(name_buffer, translate_key[i].x11name);
2508 while (translate_key[++i].x11name);
2510 if (!translate_key[i].x11name)
2511 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2514 *x11name = name_buffer;
2516 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2518 Key key = KSYM_UNDEFINED;
2519 char *name_ptr = *name;
2521 if (strlen(*name) == 1)
2523 char c = name_ptr[0];
2525 if (c >= 'A' && c <= 'Z')
2526 key = KSYM_A + (Key)(c - 'A');
2527 else if (c >= 'a' && c <= 'z')
2528 key = KSYM_a + (Key)(c - 'a');
2529 else if (c >= '0' && c <= '9')
2530 key = KSYM_0 + (Key)(c - '0');
2533 if (key == KSYM_UNDEFINED)
2539 if (strEqual(translate_key[i].name, *name))
2541 key = translate_key[i].key;
2545 while (translate_key[++i].x11name);
2548 if (key == KSYM_UNDEFINED)
2549 Warn("getKeyFromKeyName(): not completely implemented");
2553 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2555 Key key = KSYM_UNDEFINED;
2556 char *name_ptr = *x11name;
2558 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2560 char c = name_ptr[3];
2562 if (c >= 'A' && c <= 'Z')
2563 key = KSYM_A + (Key)(c - 'A');
2564 else if (c >= 'a' && c <= 'z')
2565 key = KSYM_a + (Key)(c - 'a');
2566 else if (c >= '0' && c <= '9')
2567 key = KSYM_0 + (Key)(c - '0');
2569 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2571 char c1 = name_ptr[4];
2572 char c2 = name_ptr[5];
2575 if ((c1 >= '0' && c1 <= '9') &&
2576 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2577 d = atoi(&name_ptr[4]);
2579 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2580 key = KSYM_F1 + (Key)(d - 1);
2582 else if (strPrefix(name_ptr, "XK_"))
2588 if (strEqual(name_ptr, translate_key[i].x11name))
2590 key = translate_key[i].key;
2594 while (translate_key[++i].x11name);
2596 else if (strPrefix(name_ptr, "0x"))
2598 unsigned int value = 0;
2604 char c = *name_ptr++;
2607 if (c >= '0' && c <= '9')
2609 else if (c >= 'a' && c <= 'f')
2610 d = (int)(c - 'a' + 10);
2611 else if (c >= 'A' && c <= 'F')
2612 d = (int)(c - 'A' + 10);
2620 value = value * 16 + d;
2631 char *getKeyNameFromKey(Key key)
2635 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2639 char *getX11KeyNameFromKey(Key key)
2643 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2647 Key getKeyFromKeyName(char *name)
2651 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2655 Key getKeyFromX11KeyName(char *x11name)
2659 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2663 char getCharFromKey(Key key)
2669 } translate_key_char[] =
2671 // special (non-ASCII) keys (ISO-8859-1)
2672 { KSYM_degree, CHAR_BYTE_DEGREE },
2673 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2674 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2675 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2676 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2677 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2678 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2679 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2681 // end-of-array identifier
2685 char *keyname = getKeyNameFromKey(key);
2688 if (strlen(keyname) == 1)
2690 else if (strEqual(keyname, "space"))
2698 if (key == translate_key_char[i].key)
2700 c = translate_key_char[i].key_char;
2705 while (translate_key_char[++i].key_char);
2711 char getValidConfigValueChar(char c)
2713 if (c == '#' || // used to mark comments
2714 c == '\\') // used to mark continued lines
2721 // ----------------------------------------------------------------------------
2722 // functions to translate string identifiers to integer or boolean value
2723 // ----------------------------------------------------------------------------
2725 int get_integer_from_string(char *s)
2727 // check for the most common case first
2728 if (s[0] >= '0' && s[0] <= '9')
2731 char *s_lower = getStringToLower(s);
2734 if (strEqual(s_lower, "false") ||
2735 strEqual(s_lower, "no") ||
2736 strEqual(s_lower, "off"))
2738 else if (strEqual(s_lower, "true") ||
2739 strEqual(s_lower, "yes") ||
2740 strEqual(s_lower, "on"))
2750 boolean get_boolean_from_string(char *s)
2752 char *s_lower = getStringToLower(s);
2753 boolean result = FALSE;
2755 if (strEqual(s_lower, "true") ||
2756 strEqual(s_lower, "yes") ||
2757 strEqual(s_lower, "on") ||
2758 get_integer_from_string(s) == 1)
2766 int get_switch3_from_string(char *s)
2768 char *s_lower = getStringToLower(s);
2771 if (strEqual(s_lower, "true") ||
2772 strEqual(s_lower, "yes") ||
2773 strEqual(s_lower, "on") ||
2774 get_integer_from_string(s) == 1)
2776 else if (strEqual(s_lower, "auto"))
2784 int get_player_nr_from_string(char *s)
2786 static char *player_text[] =
2796 char *s_lower = getStringToLower(s);
2800 for (i = 0; player_text[i] != NULL; i++)
2801 if (strEqual(s_lower, player_text[i]))
2810 // ----------------------------------------------------------------------------
2811 // functions for generic lists
2812 // ----------------------------------------------------------------------------
2814 ListNode *newListNode(void)
2816 return checked_calloc(sizeof(ListNode));
2819 void addNodeToList(ListNode **node_first, char *key, void *content)
2821 ListNode *node_new = newListNode();
2823 node_new->key = getStringCopy(key);
2824 node_new->content = content;
2825 node_new->next = *node_first;
2828 (*node_first)->prev = node_new;
2830 *node_first = node_new;
2833 void deleteNodeFromList(ListNode **node_first, char *key,
2834 void (*destructor_function)(void *))
2836 if (node_first == NULL || *node_first == NULL)
2839 if (strEqual((*node_first)->key, key))
2841 // after first recursion, (*node_first)->prev->next == *node_first,
2842 // so *node_first would be overwritten with (*node_first)->next
2843 // => use a copy of *node_first (and later of (*node_first)->next)
2844 ListNode *node = *node_first;
2845 ListNode *node_next = node->next;
2847 checked_free(node->key);
2849 if (destructor_function)
2850 destructor_function(node->content);
2853 node->prev->next = node->next;
2856 node->next->prev = node->prev;
2860 // after removing node, set list pointer to next valid list node
2861 // (this is important if the first node of the list was deleted)
2862 *node_first = node_next;
2866 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2870 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2872 if (node_first == NULL)
2875 if (strEqual(node_first->key, key))
2878 return getNodeFromKey(node_first->next, key);
2881 int getNumNodes(ListNode *node_first)
2883 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2887 static void dumpList(ListNode *node_first)
2889 ListNode *node = node_first;
2893 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2894 ((struct ListNodeInfo *)node->content)->num_references);
2898 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2903 // ----------------------------------------------------------------------------
2904 // functions for file handling
2905 // ----------------------------------------------------------------------------
2907 #define MAX_BUFFER_SIZE 4096
2909 File *openFile(char *filename, char *mode)
2911 File *file = checked_calloc(sizeof(File));
2913 file->file = fopen(filename, mode);
2915 if (file->file != NULL)
2917 file->filename = getStringCopy(filename);
2922 #if defined(PLATFORM_ANDROID)
2923 file->asset_file = SDL_RWFromFile(filename, mode);
2925 if (file->asset_file != NULL)
2927 file->file_is_asset = TRUE;
2928 file->filename = getStringCopy(filename);
2939 int closeFile(File *file)
2946 #if defined(PLATFORM_ANDROID)
2947 if (file->asset_file)
2948 result = SDL_RWclose(file->asset_file);
2952 result = fclose(file->file);
2954 checked_free(file->filename);
2960 int checkEndOfFile(File *file)
2962 #if defined(PLATFORM_ANDROID)
2963 if (file->file_is_asset)
2964 return file->end_of_file;
2967 return feof(file->file);
2970 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2972 #if defined(PLATFORM_ANDROID)
2973 if (file->file_is_asset)
2975 if (file->end_of_file)
2978 size_t num_items_read =
2979 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2981 if (num_items_read < num_items)
2982 file->end_of_file = TRUE;
2984 return num_items_read;
2988 return fread(buffer, item_size, num_items, file->file);
2991 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2993 return fwrite(buffer, item_size, num_items, file->file);
2996 int seekFile(File *file, long offset, int whence)
2998 #if defined(PLATFORM_ANDROID)
2999 if (file->file_is_asset)
3001 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3002 whence == SEEK_CUR ? RW_SEEK_CUR :
3003 whence == SEEK_END ? RW_SEEK_END : 0);
3005 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3009 return fseek(file->file, offset, whence);
3012 int getByteFromFile(File *file)
3014 #if defined(PLATFORM_ANDROID)
3015 if (file->file_is_asset)
3017 if (file->end_of_file)
3021 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3023 if (num_bytes_read < 1)
3024 file->end_of_file = TRUE;
3026 return (file->end_of_file ? EOF : (int)c);
3030 return fgetc(file->file);
3033 char *getStringFromFile(File *file, char *line, int size)
3035 #if defined(PLATFORM_ANDROID)
3036 if (file->file_is_asset)
3038 if (file->end_of_file)
3041 char *line_ptr = line;
3042 int num_bytes_read = 0;
3044 while (num_bytes_read < size - 1 &&
3045 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3046 *line_ptr++ != '\n')
3051 if (strlen(line) == 0)
3053 file->end_of_file = TRUE;
3062 return fgets(line, size, file->file);
3065 int copyFile(char *filename_from, char *filename_to)
3067 File *file_from, *file_to;
3069 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3074 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3076 closeFile(file_from);
3081 while (!checkEndOfFile(file_from))
3083 byte buffer[MAX_BUFFER_SIZE];
3084 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3086 writeFile(file_to, buffer, 1, bytes_read);
3089 closeFile(file_from);
3095 boolean touchFile(char *filename)
3099 if (!(file = fopen(filename, MODE_WRITE)))
3101 Warn("cannot touch file '%s'", filename);
3112 // ----------------------------------------------------------------------------
3113 // functions for directory handling
3114 // ----------------------------------------------------------------------------
3116 Directory *openDirectory(char *dir_name)
3118 Directory *dir = checked_calloc(sizeof(Directory));
3120 dir->dir = opendir(dir_name);
3122 if (dir->dir != NULL)
3124 dir->filename = getStringCopy(dir_name);
3129 #if defined(PLATFORM_ANDROID)
3130 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3132 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3134 checked_free(asset_toc_filename);
3136 if (dir->asset_toc_file != NULL)
3138 dir->directory_is_asset = TRUE;
3139 dir->filename = getStringCopy(dir_name);
3150 int closeDirectory(Directory *dir)
3157 #if defined(PLATFORM_ANDROID)
3158 if (dir->asset_toc_file)
3159 result = SDL_RWclose(dir->asset_toc_file);
3163 result = closedir(dir->dir);
3166 freeDirectoryEntry(dir->dir_entry);
3168 checked_free(dir->filename);
3174 DirectoryEntry *readDirectory(Directory *dir)
3177 freeDirectoryEntry(dir->dir_entry);
3179 dir->dir_entry = NULL;
3181 #if defined(PLATFORM_ANDROID)
3182 if (dir->directory_is_asset)
3184 char line[MAX_LINE_LEN];
3185 char *line_ptr = line;
3186 int num_bytes_read = 0;
3188 while (num_bytes_read < MAX_LINE_LEN - 1 &&
3189 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3198 if (strlen(line) == 0)
3201 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3203 dir->dir_entry->is_directory = FALSE;
3204 if (line[strlen(line) - 1] == '/')
3206 dir->dir_entry->is_directory = TRUE;
3208 line[strlen(line) - 1] = '\0';
3211 dir->dir_entry->basename = getStringCopy(line);
3212 dir->dir_entry->filename = getPath2(dir->filename, line);
3214 return dir->dir_entry;
3218 struct dirent *dir_entry = readdir(dir->dir);
3220 if (dir_entry == NULL)
3223 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3225 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3226 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3228 struct stat file_status;
3230 dir->dir_entry->is_directory =
3231 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3232 S_ISDIR(file_status.st_mode));
3234 return dir->dir_entry;
3237 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3239 if (dir_entry == NULL)
3242 checked_free(dir_entry->basename);
3243 checked_free(dir_entry->filename);
3244 checked_free(dir_entry);
3248 // ----------------------------------------------------------------------------
3249 // functions for checking files and filenames
3250 // ----------------------------------------------------------------------------
3252 boolean directoryExists(const char *dir_name)
3254 if (dir_name == NULL)
3257 struct stat file_status;
3258 boolean success = (stat(dir_name, &file_status) == 0 &&
3259 S_ISDIR(file_status.st_mode));
3261 #if defined(PLATFORM_ANDROID)
3264 // this might be an asset directory; check by trying to open toc file
3265 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3266 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3268 checked_free(asset_toc_filename);
3270 success = (file != NULL);
3280 boolean fileExists(const char *filename)
3282 if (filename == NULL)
3285 boolean success = (access(filename, F_OK) == 0);
3287 #if defined(PLATFORM_ANDROID)
3290 // this might be an asset file; check by trying to open it
3291 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3293 success = (file != NULL);
3304 static boolean fileHasPrefix(const char *basename, const char *prefix)
3306 static char *basename_lower = NULL;
3307 int basename_length, prefix_length;
3309 checked_free(basename_lower);
3311 if (basename == NULL || prefix == NULL)
3314 basename_lower = getStringToLower(basename);
3315 basename_length = strlen(basename_lower);
3316 prefix_length = strlen(prefix);
3318 if (basename_length > prefix_length + 1 &&
3319 basename_lower[prefix_length] == '.' &&
3320 strncmp(basename_lower, prefix, prefix_length) == 0)
3327 static boolean fileHasSuffix(const char *basename, const char *suffix)
3329 static char *basename_lower = NULL;
3330 int basename_length, suffix_length;
3332 checked_free(basename_lower);
3334 if (basename == NULL || suffix == NULL)
3337 basename_lower = getStringToLower(basename);
3338 basename_length = strlen(basename_lower);
3339 suffix_length = strlen(suffix);
3341 if (basename_length > suffix_length + 1 &&
3342 basename_lower[basename_length - suffix_length - 1] == '.' &&
3343 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3349 static boolean FileCouldBeArtwork(char *filename)
3351 char *basename = getBaseNamePtr(filename);
3353 return (!strEqual(basename, ".") &&
3354 !strEqual(basename, "..") &&
3355 !fileHasSuffix(basename, "txt") &&
3356 !fileHasSuffix(basename, "conf") &&
3357 !directoryExists(filename));
3360 boolean FileIsGraphic(char *filename)
3362 return FileCouldBeArtwork(filename);
3365 boolean FileIsSound(char *filename)
3367 return FileCouldBeArtwork(filename);
3370 boolean FileIsMusic(char *filename)
3372 return FileCouldBeArtwork(filename);
3375 boolean FileIsArtworkType(char *filename, int type)
3377 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3378 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3379 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3385 // ----------------------------------------------------------------------------
3386 // functions for loading artwork configuration information
3387 // ----------------------------------------------------------------------------
3389 char *get_mapped_token(char *token)
3391 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3392 static char *map_token_prefix[][2] =
3394 { "char_procent", "char_percent" },
3395 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3396 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3397 { "bd_butterfly_left", "bd_butterfly.left" },
3398 { "bd_butterfly_right", "bd_butterfly.right" },
3399 { "bd_butterfly_up", "bd_butterfly.up" },
3400 { "bd_butterfly_down", "bd_butterfly.down" },
3401 { "bd_firefly_left", "bd_firefly.left" },
3402 { "bd_firefly_right", "bd_firefly.right" },
3403 { "bd_firefly_up", "bd_firefly.up" },
3404 { "bd_firefly_down", "bd_firefly.down" },
3410 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3412 int len_token_prefix = strlen(map_token_prefix[i][0]);
3414 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3415 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3418 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3419 char *gfx_substring = ".gfx";
3420 char *gfx_prefix = "gfx.";
3421 if (strstr(token, gfx_substring) != NULL)
3423 char *token_prefix = getStringCopy(token);
3424 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3425 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3428 // cut off token string at ".gfx" substring position
3429 *token_gfx_pos = '\0';
3431 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3432 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3436 return mapped_token;
3442 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3445 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3446 static struct ConfigTypeInfo prefix_list[] =
3448 { "global.anim_1" },
3449 { "global.anim_2" },
3450 { "global.anim_3" },
3451 { "global.anim_4" },
3452 { "global.anim_5" },
3453 { "global.anim_6" },
3454 { "global.anim_7" },
3455 { "global.anim_8" },
3456 { "global.anim_9" },
3457 { "global.anim_10" },
3458 { "global.anim_11" },
3459 { "global.anim_12" },
3460 { "global.anim_13" },
3461 { "global.anim_14" },
3462 { "global.anim_15" },
3463 { "global.anim_16" },
3464 { "global.anim_17" },
3465 { "global.anim_18" },
3466 { "global.anim_19" },
3467 { "global.anim_20" },
3468 { "global.anim_21" },
3469 { "global.anim_22" },
3470 { "global.anim_23" },
3471 { "global.anim_24" },
3472 { "global.anim_25" },
3473 { "global.anim_26" },
3474 { "global.anim_27" },
3475 { "global.anim_28" },
3476 { "global.anim_29" },
3477 { "global.anim_30" },
3478 { "global.anim_31" },
3479 { "global.anim_32" },
3483 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3484 boolean prefix_found = FALSE;
3488 // search for prefix to check if base token has to be created
3489 for (i = 0; prefix_list[i].token != NULL; i++)
3490 if (strPrefix(token, prefix_list[i].token))
3491 prefix_found = TRUE;
3496 // search for suffix (parameter) to determine base token length
3497 for (i = 0; suffix_list[i].token != NULL; i++)
3498 if (strSuffix(token, suffix_list[i].token))
3499 len_suffix = strlen(suffix_list[i].token);
3501 return getStringCopyN(token, strlen(token) - len_suffix);
3504 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3505 struct ListNodeInfo ***, int *);
3507 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3508 struct ConfigTypeInfo *suffix_list,
3509 char **ignore_tokens,
3510 int num_file_list_entries)
3512 SetupFileHash *ignore_tokens_hash;
3513 struct FileInfo *file_list;
3514 int num_file_list_entries_found = 0;
3515 int num_suffix_list_entries = 0;
3519 // create hash from list of tokens to be ignored (for quick access)
3520 ignore_tokens_hash = newSetupFileHash();
3521 for (i = 0; ignore_tokens[i] != NULL; i++)
3522 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3524 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3526 for (i = 0; suffix_list[i].token != NULL; i++)
3527 num_suffix_list_entries++;
3529 // always start with reliable default values
3530 for (i = 0; i < num_file_list_entries; i++)
3532 file_list[i].token = NULL;
3534 file_list[i].default_filename = NULL;
3535 file_list[i].filename = NULL;
3537 if (num_suffix_list_entries > 0)
3539 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3541 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3542 file_list[i].parameter = checked_calloc(parameter_array_size);
3544 for (j = 0; j < num_suffix_list_entries; j++)
3546 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3547 setString(&file_list[i].parameter[j], suffix_list[j].value);
3550 file_list[i].redefined = FALSE;
3551 file_list[i].fallback_to_default = FALSE;
3552 file_list[i].default_is_cloned = FALSE;
3558 for (i = 0; config_list[i].token != NULL; i++)
3560 int len_config_token = strlen(config_list[i].token);
3561 boolean is_file_entry = TRUE;
3563 for (j = 0; suffix_list[j].token != NULL; j++)
3565 int len_suffix = strlen(suffix_list[j].token);
3567 if (len_suffix < len_config_token &&
3568 strEqual(&config_list[i].token[len_config_token - len_suffix],
3569 suffix_list[j].token))
3571 setString(&file_list[list_pos].default_parameter[j],
3572 config_list[i].value);
3574 is_file_entry = FALSE;
3580 // the following tokens are no file definitions, but other config tokens
3581 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3582 is_file_entry = FALSE;
3589 if (list_pos >= num_file_list_entries)
3592 file_list[list_pos].token = config_list[i].token;
3593 file_list[list_pos].default_filename = config_list[i].value;
3596 if (strSuffix(config_list[i].token, ".clone_from"))
3597 file_list[list_pos].default_is_cloned = TRUE;
3600 num_file_list_entries_found = list_pos + 1;
3601 if (num_file_list_entries_found != num_file_list_entries)
3604 Error("inconsistant config list information:");
3605 Error("- should be: %d (according to 'src/conf_xxx.h')",
3606 num_file_list_entries);
3607 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3608 num_file_list_entries_found);
3613 freeSetupFileHash(ignore_tokens_hash);
3618 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3620 int len_token = strlen(token);
3621 int len_suffix = strlen(suffix);
3623 if (start_pos < 0) // compare suffix from end of string
3624 start_pos += len_token;
3626 if (start_pos < 0 || start_pos + len_suffix > len_token)
3629 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3632 if (token[start_pos + len_suffix] == '\0')
3635 if (token[start_pos + len_suffix] == '.')
3641 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3643 static void read_token_parameters(SetupFileHash *setup_file_hash,
3644 struct ConfigTypeInfo *suffix_list,
3645 struct FileInfo *file_list_entry)
3647 // check for config token that is the base token without any suffixes
3648 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3649 char *known_token_value = KNOWN_TOKEN_VALUE;
3652 if (filename != NULL)
3654 setString(&file_list_entry->filename, filename);
3656 // when file definition found, set all parameters to default values
3657 for (i = 0; suffix_list[i].token != NULL; i++)
3658 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3660 file_list_entry->redefined = TRUE;
3662 // mark config file token as well known from default config
3663 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3666 // check for config tokens that can be build by base token and suffixes
3667 for (i = 0; suffix_list[i].token != NULL; i++)
3669 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3670 char *value = getHashEntry(setup_file_hash, token);
3674 setString(&file_list_entry->parameter[i], value);
3676 // mark config file token as well known from default config
3677 setHashEntry(setup_file_hash, token, known_token_value);
3684 static void add_dynamic_file_list_entry(struct FileInfo **list,
3685 int *num_list_entries,
3686 SetupFileHash *extra_file_hash,
3687 struct ConfigTypeInfo *suffix_list,
3688 int num_suffix_list_entries,
3691 struct FileInfo *new_list_entry;
3692 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3694 (*num_list_entries)++;
3695 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3696 new_list_entry = &(*list)[*num_list_entries - 1];
3698 new_list_entry->token = getStringCopy(token);
3699 new_list_entry->default_filename = NULL;
3700 new_list_entry->filename = NULL;
3701 new_list_entry->parameter = checked_calloc(parameter_array_size);
3703 new_list_entry->redefined = FALSE;
3704 new_list_entry->fallback_to_default = FALSE;
3705 new_list_entry->default_is_cloned = FALSE;
3707 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3710 static void add_property_mapping(struct PropertyMapping **list,
3711 int *num_list_entries,
3712 int base_index, int ext1_index,
3713 int ext2_index, int ext3_index,
3716 struct PropertyMapping *new_list_entry;
3718 (*num_list_entries)++;
3719 *list = checked_realloc(*list,
3720 *num_list_entries * sizeof(struct PropertyMapping));
3721 new_list_entry = &(*list)[*num_list_entries - 1];
3723 new_list_entry->base_index = base_index;
3724 new_list_entry->ext1_index = ext1_index;
3725 new_list_entry->ext2_index = ext2_index;
3726 new_list_entry->ext3_index = ext3_index;
3728 new_list_entry->artwork_index = artwork_index;
3731 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3734 struct FileInfo *file_list = artwork_info->file_list;
3735 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3736 char **base_prefixes = artwork_info->base_prefixes;
3737 char **ext1_suffixes = artwork_info->ext1_suffixes;
3738 char **ext2_suffixes = artwork_info->ext2_suffixes;
3739 char **ext3_suffixes = artwork_info->ext3_suffixes;
3740 char **ignore_tokens = artwork_info->ignore_tokens;
3741 int num_file_list_entries = artwork_info->num_file_list_entries;
3742 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3743 int num_base_prefixes = artwork_info->num_base_prefixes;
3744 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3745 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3746 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3747 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3748 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3749 SetupFileHash *extra_file_hash, *empty_file_hash;
3750 char *known_token_value = KNOWN_TOKEN_VALUE;
3751 char *base_token_value = UNDEFINED_FILENAME;
3754 if (filename == NULL)
3757 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3760 // separate valid (defined) from empty (undefined) config token values
3761 valid_file_hash = newSetupFileHash();
3762 empty_file_hash = newSetupFileHash();
3763 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3765 char *value = HASH_ITERATION_VALUE(itr);
3767 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3768 HASH_ITERATION_TOKEN(itr), value);
3770 END_HASH_ITERATION(setup_file_hash, itr)
3772 // at this point, we do not need the setup file hash anymore -- free it
3773 freeSetupFileHash(setup_file_hash);
3775 // prevent changing hash while iterating over it by using a temporary copy
3776 valid_file_hash_tmp = newSetupFileHash();
3777 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3779 setHashEntry(valid_file_hash_tmp,
3780 HASH_ITERATION_TOKEN(itr),
3781 HASH_ITERATION_VALUE(itr));
3783 END_HASH_ITERATION(valid_file_hash, itr)
3785 // (iterate over same temporary hash, as modifications are independent)
3787 // map deprecated to current tokens (using prefix match and replace)
3788 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3790 char *token = HASH_ITERATION_TOKEN(itr);
3791 char *mapped_token = get_mapped_token(token);
3793 if (mapped_token != NULL)
3795 char *value = HASH_ITERATION_VALUE(itr);
3798 setHashEntry(valid_file_hash, mapped_token, value);
3800 // ignore old token (by setting it to "known" keyword)
3801 setHashEntry(valid_file_hash, token, known_token_value);
3806 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3808 // add special base tokens (using prefix match and replace)
3809 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3811 char *token = HASH_ITERATION_TOKEN(itr);
3812 char *base_token = get_special_base_token(artwork_info, token);
3814 if (base_token != NULL)
3816 // add base token only if it does not already exist
3817 if (getHashEntry(valid_file_hash, base_token) == NULL)
3818 setHashEntry(valid_file_hash, base_token, base_token_value);
3823 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3825 // free temporary hash used for iteration
3826 freeSetupFileHash(valid_file_hash_tmp);
3828 // read parameters for all known config file tokens
3829 for (i = 0; i < num_file_list_entries; i++)
3830 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3832 // set all tokens that can be ignored here to "known" keyword
3833 for (i = 0; i < num_ignore_tokens; i++)
3834 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3836 // copy all unknown config file tokens to extra config hash
3837 extra_file_hash = newSetupFileHash();
3838 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3840 char *value = HASH_ITERATION_VALUE(itr);
3842 if (!strEqual(value, known_token_value))
3843 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3845 END_HASH_ITERATION(valid_file_hash, itr)
3847 // at this point, we do not need the valid file hash anymore -- free it
3848 freeSetupFileHash(valid_file_hash);
3850 // now try to determine valid, dynamically defined config tokens
3852 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3854 struct FileInfo **dynamic_file_list =
3855 &artwork_info->dynamic_file_list;
3856 int *num_dynamic_file_list_entries =
3857 &artwork_info->num_dynamic_file_list_entries;
3858 struct PropertyMapping **property_mapping =
3859 &artwork_info->property_mapping;
3860 int *num_property_mapping_entries =
3861 &artwork_info->num_property_mapping_entries;
3862 int current_summarized_file_list_entry =
3863 artwork_info->num_file_list_entries +
3864 artwork_info->num_dynamic_file_list_entries;
3865 char *token = HASH_ITERATION_TOKEN(itr);
3866 int len_token = strlen(token);
3868 boolean base_prefix_found = FALSE;
3869 boolean parameter_suffix_found = FALSE;
3871 // skip all parameter definitions (handled by read_token_parameters())
3872 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3874 int len_suffix = strlen(suffix_list[i].token);
3876 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3877 parameter_suffix_found = TRUE;
3880 if (parameter_suffix_found)
3883 // ---------- step 0: search for matching base prefix ----------
3886 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3888 char *base_prefix = base_prefixes[i];
3889 int len_base_prefix = strlen(base_prefix);
3890 boolean ext1_suffix_found = FALSE;
3891 boolean ext2_suffix_found = FALSE;
3892 boolean ext3_suffix_found = FALSE;
3893 boolean exact_match = FALSE;
3894 int base_index = -1;
3895 int ext1_index = -1;
3896 int ext2_index = -1;
3897 int ext3_index = -1;
3899 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3901 if (!base_prefix_found)
3906 if (start_pos + len_base_prefix == len_token) // exact match
3910 add_dynamic_file_list_entry(dynamic_file_list,
3911 num_dynamic_file_list_entries,
3914 num_suffix_list_entries,
3916 add_property_mapping(property_mapping,
3917 num_property_mapping_entries,
3918 base_index, -1, -1, -1,
3919 current_summarized_file_list_entry);
3923 // ---------- step 1: search for matching first suffix ----------
3925 start_pos += len_base_prefix;
3926 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3928 char *ext1_suffix = ext1_suffixes[j];
3929 int len_ext1_suffix = strlen(ext1_suffix);
3931 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3933 if (!ext1_suffix_found)
3938 if (start_pos + len_ext1_suffix == len_token) // exact match
3942 add_dynamic_file_list_entry(dynamic_file_list,
3943 num_dynamic_file_list_entries,
3946 num_suffix_list_entries,
3948 add_property_mapping(property_mapping,
3949 num_property_mapping_entries,
3950 base_index, ext1_index, -1, -1,
3951 current_summarized_file_list_entry);
3955 start_pos += len_ext1_suffix;
3961 // ---------- step 2: search for matching second suffix ----------
3963 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3965 char *ext2_suffix = ext2_suffixes[k];
3966 int len_ext2_suffix = strlen(ext2_suffix);
3968 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3970 if (!ext2_suffix_found)
3975 if (start_pos + len_ext2_suffix == len_token) // exact match
3979 add_dynamic_file_list_entry(dynamic_file_list,
3980 num_dynamic_file_list_entries,
3983 num_suffix_list_entries,
3985 add_property_mapping(property_mapping,
3986 num_property_mapping_entries,
3987 base_index, ext1_index, ext2_index, -1,
3988 current_summarized_file_list_entry);
3992 start_pos += len_ext2_suffix;
3998 // ---------- step 3: search for matching third suffix ----------
4000 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4002 char *ext3_suffix = ext3_suffixes[l];
4003 int len_ext3_suffix = strlen(ext3_suffix);
4005 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4007 if (!ext3_suffix_found)
4012 if (start_pos + len_ext3_suffix == len_token) // exact match
4016 add_dynamic_file_list_entry(dynamic_file_list,
4017 num_dynamic_file_list_entries,
4020 num_suffix_list_entries,
4022 add_property_mapping(property_mapping,
4023 num_property_mapping_entries,
4024 base_index, ext1_index, ext2_index, ext3_index,
4025 current_summarized_file_list_entry);
4031 END_HASH_ITERATION(extra_file_hash, itr)
4033 if (artwork_info->num_dynamic_file_list_entries > 0)
4035 artwork_info->dynamic_artwork_list =
4036 checked_calloc(artwork_info->num_dynamic_file_list_entries *
4037 artwork_info->sizeof_artwork_list_entry);
4040 if (options.verbose && IS_PARENT_PROCESS())
4042 SetupFileList *setup_file_list, *list;
4043 boolean dynamic_tokens_found = FALSE;
4044 boolean unknown_tokens_found = FALSE;
4045 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4047 // list may be NULL for empty artwork config files
4048 setup_file_list = loadSetupFileList(filename);
4050 BEGIN_HASH_ITERATION(extra_file_hash, itr)
4052 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4053 dynamic_tokens_found = TRUE;
4055 unknown_tokens_found = TRUE;
4057 END_HASH_ITERATION(extra_file_hash, itr)
4059 if (options.debug && dynamic_tokens_found)
4061 Debug("config", "---");
4062 Debug("config", "dynamic token(s) found in config file:");
4063 Debug("config", "- config file: '%s'", filename);
4065 for (list = setup_file_list; list != NULL; list = list->next)
4067 char *value = getHashEntry(extra_file_hash, list->token);
4069 if (value != NULL && strEqual(value, known_token_value))
4070 Debug("config", "- dynamic token: '%s'", list->token);
4073 Debug("config", "---");
4076 if (unknown_tokens_found)
4079 Warn("unknown token(s) found in config file:");
4080 Warn("- config file: '%s'", filename);
4082 for (list = setup_file_list; list != NULL; list = list->next)
4084 char *value = getHashEntry(extra_file_hash, list->token);
4086 if (value != NULL && !strEqual(value, known_token_value))
4087 Warn("- dynamic token: '%s'", list->token);
4093 if (undefined_values_found)
4096 Warn("undefined values found in config file:");
4097 Warn("- config file: '%s'", filename);
4099 for (list = setup_file_list; list != NULL; list = list->next)
4101 char *value = getHashEntry(empty_file_hash, list->token);
4104 Warn("- undefined value for token: '%s'", list->token);
4110 freeSetupFileList(setup_file_list);
4113 freeSetupFileHash(extra_file_hash);
4114 freeSetupFileHash(empty_file_hash);
4117 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4119 struct FileInfo *file_list = artwork_info->file_list;
4120 int num_file_list_entries = artwork_info->num_file_list_entries;
4121 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4122 char *filename_base = UNDEFINED_FILENAME, *filename_local;
4125 DrawInitTextHead("Loading artwork config");
4126 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4128 // always start with reliable default values
4129 for (i = 0; i < num_file_list_entries; i++)
4131 setString(&file_list[i].filename, file_list[i].default_filename);
4133 for (j = 0; j < num_suffix_list_entries; j++)
4134 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4136 file_list[i].redefined = FALSE;
4137 file_list[i].fallback_to_default = FALSE;
4140 // free previous dynamic artwork file array
4141 if (artwork_info->dynamic_file_list != NULL)
4143 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4145 free(artwork_info->dynamic_file_list[i].token);
4146 free(artwork_info->dynamic_file_list[i].filename);
4147 free(artwork_info->dynamic_file_list[i].parameter);
4150 free(artwork_info->dynamic_file_list);
4151 artwork_info->dynamic_file_list = NULL;
4153 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4154 &artwork_info->num_dynamic_file_list_entries);
4157 // free previous property mapping
4158 if (artwork_info->property_mapping != NULL)
4160 free(artwork_info->property_mapping);
4162 artwork_info->property_mapping = NULL;
4163 artwork_info->num_property_mapping_entries = 0;
4166 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4168 // first look for special artwork configured in level series config
4169 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4171 if (fileExists(filename_base))
4172 LoadArtworkConfigFromFilename(artwork_info, filename_base);
4175 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4177 if (filename_local != NULL && !strEqual(filename_base, filename_local))
4178 LoadArtworkConfigFromFilename(artwork_info, filename_local);
4181 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4182 struct ListNodeInfo **listnode)
4186 char *filename = (*listnode)->source_filename;
4188 if (--(*listnode)->num_references <= 0)
4189 deleteNodeFromList(&artwork_info->content_list, filename,
4190 artwork_info->free_artwork);
4196 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4197 struct ListNodeInfo **listnode,
4198 struct FileInfo *file_list_entry)
4208 char *basename = file_list_entry->filename;
4209 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4211 // mark all images from non-default graphics directory as "redefined"
4212 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4213 !strPrefix(filename, options.graphics_directory))
4214 file_list_entry->redefined = TRUE;
4216 if (filename == NULL)
4218 Warn("cannot find artwork file '%s'", basename);
4220 basename = file_list_entry->default_filename;
4222 // fail for cloned default artwork that has no default filename defined
4223 if (file_list_entry->default_is_cloned &&
4224 strEqual(basename, UNDEFINED_FILENAME))
4226 void (*error_func)(char *, ...) = Warn;
4228 // we can get away without sounds and music, but not without graphics
4229 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4232 error_func("token '%s' was cloned and has no default filename",
4233 file_list_entry->token);
4238 // dynamic artwork has no default filename / skip empty default artwork
4239 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4242 file_list_entry->fallback_to_default = TRUE;
4244 Warn("trying default artwork file '%s'", basename);
4246 filename = getCustomArtworkFilename(basename, artwork_info->type);
4248 if (filename == NULL)
4250 void (*error_func)(char *, ...) = Warn;
4252 // we can get away without sounds and music, but not without graphics
4253 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4256 error_func("cannot find default artwork file '%s'", basename);
4262 // check if the old and the new artwork file are the same
4263 if (*listnode && strEqual((*listnode)->source_filename, filename))
4265 // The old and new artwork are the same (have the same filename and path).
4266 // This usually means that this artwork does not exist in this artwork set
4267 // and a fallback to the existing artwork is done.
4272 // delete existing artwork file entry
4273 deleteArtworkListEntry(artwork_info, listnode);
4275 // check if the new artwork file already exists in the list of artwork
4276 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4278 *listnode = (struct ListNodeInfo *)node->content;
4279 (*listnode)->num_references++;
4284 DrawInitTextHead(init_text[artwork_info->type]);
4285 DrawInitTextItem(basename);
4287 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4289 // add new artwork file entry to the list of artwork files
4290 (*listnode)->num_references = 1;
4291 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4296 void (*error_func)(char *, ...) = Warn;
4298 // we can get away without sounds and music, but not without graphics
4299 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4302 error_func("cannot load artwork file '%s'", basename);
4308 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4309 struct ListNodeInfo **listnode,
4310 struct FileInfo *file_list_entry)
4312 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4314 deleteArtworkListEntry(artwork_info, listnode);
4319 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4322 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4324 struct FileInfo *file_list = artwork_info->file_list;
4325 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4326 int num_file_list_entries = artwork_info->num_file_list_entries;
4327 int num_dynamic_file_list_entries =
4328 artwork_info->num_dynamic_file_list_entries;
4331 print_timestamp_init("ReloadCustomArtworkList");
4333 for (i = 0; i < num_file_list_entries; i++)
4334 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4337 for (i = 0; i < num_dynamic_file_list_entries; i++)
4338 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4339 &dynamic_file_list[i]);
4341 print_timestamp_done("ReloadCustomArtworkList");
4344 dumpList(artwork_info->content_list);
4348 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4349 struct ListNodeInfo ***list,
4350 int *num_list_entries)
4357 for (i = 0; i < *num_list_entries; i++)
4358 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4362 *num_list_entries = 0;
4365 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4367 if (artwork_info == NULL)
4370 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4371 &artwork_info->num_file_list_entries);
4373 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4374 &artwork_info->num_dynamic_file_list_entries);
4378 // ----------------------------------------------------------------------------
4379 // functions only needed for non-Unix (non-command-line) systems
4380 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4381 // (now also added for Windows, to create files in user data directory)
4382 // ----------------------------------------------------------------------------
4384 char *getLogBasename(char *basename)
4386 return getStringCat2(basename, ".log");
4389 char *getLogFilename(char *basename)
4391 return getPath2(getMainUserGameDataDir(), basename);
4394 void OpenLogFile(void)
4396 InitMainUserDataDirectory();
4398 if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4400 program.log_file = program.log_file_default; // reset to default
4402 Warn("cannot open file '%s' for writing: %s",
4403 program.log_filename, strerror(errno));
4406 // output should be unbuffered so it is not truncated in a crash
4407 setbuf(program.log_file, NULL);
4410 void CloseLogFile(void)
4412 if (program.log_file != program.log_file_default)
4413 fclose(program.log_file);
4416 void DumpLogFile(void)
4418 FILE *log_file = fopen(program.log_filename, MODE_READ);
4420 if (log_file == NULL)
4423 while (!feof(log_file))
4424 fputc(fgetc(log_file), stdout);
4429 void NotifyUserAboutErrorFile(void)
4431 #if defined(PLATFORM_WINDOWS)
4432 char *title_text = getStringCat2(program.program_title, " Error Message");
4433 char *error_text = getStringCat2("The program was aborted due to an error; "
4434 "for details, see the following error file:"
4436 program.log_filename);
4438 MessageBox(NULL, error_text, title_text, MB_OK);
4443 // ----------------------------------------------------------------------------
4444 // the following is only for debugging purpose and normally not used
4445 // ----------------------------------------------------------------------------
4449 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4450 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4452 #define DEBUG_NUM_TIMESTAMPS 10
4453 #define DEBUG_TIME_IN_MICROSECONDS 0
4455 #if DEBUG_TIME_IN_MICROSECONDS
4456 static double Counter_Microseconds(void)
4458 static struct timeval base_time = { 0, 0 };
4459 struct timeval current_time;
4462 gettimeofday(¤t_time, NULL);
4464 // reset base time in case of wrap-around
4465 if (current_time.tv_sec < base_time.tv_sec)
4466 base_time = current_time;
4469 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4470 ((double)(current_time.tv_usec - base_time.tv_usec));
4472 return counter; // return microseconds since last init
4476 static char *debug_print_timestamp_get_padding(int padding_size)
4478 static char *padding = NULL;
4479 int max_padding_size = 100;
4481 if (padding == NULL)
4483 padding = checked_calloc(max_padding_size + 1);
4484 memset(padding, ' ', max_padding_size);
4487 return &padding[MAX(0, max_padding_size - padding_size)];
4490 void debug_print_timestamp(int counter_nr, char *message)
4492 int indent_size = 8;
4493 int padding_size = 40;
4494 float timestamp_interval;
4497 Fail("debugging: invalid negative counter");
4498 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4499 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4501 #if DEBUG_TIME_IN_MICROSECONDS
4502 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4505 counter[counter_nr][0] = Counter_Microseconds();
4507 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4510 counter[counter_nr][0] = Counter();
4513 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4514 counter[counter_nr][1] = counter[counter_nr][0];
4517 Debug("time:init", "%s%s%s %.3f %s",
4518 debug_print_timestamp_get_padding(counter_nr * indent_size),
4520 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4521 timestamp_interval / 1000,
4526 static void debug_print_parent_only(char *format, ...)
4528 if (!IS_PARENT_PROCESS())
4535 va_start(ap, format);
4536 vprintf(format, ap);
4546 static void print_timestamp_ext(char *message, char *mode)
4548 #if DEBUG_PRINT_INIT_TIMESTAMPS
4549 static char *debug_message = NULL;
4550 static char *last_message = NULL;
4551 static int counter_nr = 0;
4552 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4554 checked_free(debug_message);
4555 debug_message = getStringCat3(mode, " ", message);
4557 if (strEqual(mode, "INIT"))
4559 debug_print_timestamp(counter_nr, NULL);
4561 if (counter_nr + 1 < max_depth)
4562 debug_print_timestamp(counter_nr, debug_message);
4566 debug_print_timestamp(counter_nr, NULL);
4568 else if (strEqual(mode, "DONE"))
4572 if (counter_nr + 1 < max_depth ||
4573 (counter_nr == 0 && max_depth == 1))
4575 last_message = message;
4577 if (counter_nr == 0 && max_depth == 1)
4579 checked_free(debug_message);
4580 debug_message = getStringCat3("TIME", " ", message);
4583 debug_print_timestamp(counter_nr, debug_message);
4586 else if (!strEqual(mode, "TIME") ||
4587 !strEqual(message, last_message))
4589 if (counter_nr < max_depth)
4590 debug_print_timestamp(counter_nr, debug_message);
4595 void print_timestamp_init(char *message)
4597 print_timestamp_ext(message, "INIT");
4600 void print_timestamp_time(char *message)
4602 print_timestamp_ext(message, "TIME");
4605 void print_timestamp_done(char *message)
4607 print_timestamp_ext(message, "DONE");