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_LOG_OUT_TO_STDOUT TRUE
45 #define DUPLICATE_LOG_ERR_TO_STDERR TRUE
48 #if defined(PLATFORM_ANDROID)
49 static int android_log_prio = ANDROID_LOG_INFO;
50 static char *android_log_buffer = NULL;
52 static void append_to_android_log_buffer(char *format, va_list ap)
54 char text_new[MAX_OUTPUT_LINESIZE];
56 // print text to temporary string
57 vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
59 if (android_log_buffer == NULL)
61 android_log_buffer = getStringCopy(text_new);
65 char *android_log_buffer_old = android_log_buffer;
67 // append new text to existing text
68 android_log_buffer = getStringCat2(android_log_buffer, text_new);
70 checked_free(android_log_buffer_old);
74 static void vprintf_log_nonewline(char *format, va_list ap)
76 // add log output to buffer until text with newline is printed
77 append_to_android_log_buffer(format, ap);
80 static void vprintf_log(char *format, va_list ap)
82 // add log output to buffer
83 append_to_android_log_buffer(format, ap);
85 // __android_log_vprint(android_log_prio, program.program_title, format, ap);
86 __android_log_write(android_log_prio, program.program_title,
89 checked_free(android_log_buffer);
90 android_log_buffer = NULL;
95 static void vprintf_log_nonewline(char *format, va_list ap)
97 FILE *file = program.log_file[LOG_ERR_ID];
99 #if DUPLICATE_LOG_ERR_TO_STDERR
100 if (file != program.log_file_default[LOG_ERR_ID])
105 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
111 vfprintf(file, format, ap);
114 static void vprintf_log(char *format, va_list ap)
116 FILE *file = program.log_file[LOG_ERR_ID];
117 char *newline = STRING_NEWLINE;
119 #if DUPLICATE_LOG_ERR_TO_STDERR
120 if (file != program.log_file_default[LOG_ERR_ID])
125 vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
126 fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline);
132 vfprintf(file, format, ap);
133 fprintf(file, "%s", newline);
137 static void printf_log_nonewline(char *format, ...)
141 va_start(ap, format);
142 vprintf_log_nonewline(format, ap);
146 static void printf_log(char *format, ...)
150 va_start(ap, format);
151 vprintf_log(format, ap);
155 static void printf_log_line(char *line_chars, int line_length)
159 for (i = 0; i < line_length; i++)
160 printf_log_nonewline("%s", line_chars);
166 // ----------------------------------------------------------------------------
167 // platform independent wrappers for printf() et al.
168 // ----------------------------------------------------------------------------
170 void fprintf_line(FILE *file, char *line_chars, int line_length)
174 for (i = 0; i < line_length; i++)
175 fprintf(file, "%s", line_chars);
180 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
183 fprintf(file, "%s", prefix);
184 fprintf_line(file, line_chars, line_length);
187 void printf_line(char *line_chars, int line_length)
189 fprintf_line(stdout, line_chars, line_length);
192 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
194 fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
197 static void vPrint(char *format, va_list ap)
199 FILE *file = program.log_file[LOG_OUT_ID];
201 #if DUPLICATE_LOG_OUT_TO_STDOUT
202 if (file != program.log_file_default[LOG_OUT_ID])
207 vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2);
213 vfprintf(file, format, ap);
216 void Print(char *format, ...)
220 va_start(ap, format);
225 void PrintNoLog(char *format, ...)
227 FILE *file = program.log_file_default[LOG_OUT_ID];
230 va_start(ap, format);
231 vfprintf(file, format, ap);
237 void PrintLine(char *line_chars, int line_length)
241 for (i = 0; i < line_length; i++)
247 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
250 PrintLine(line_chars, line_length);
254 // ----------------------------------------------------------------------------
255 // generic logging and error handling functions
256 // ----------------------------------------------------------------------------
268 static char *log_tokens[] =
278 static void printf_log_prefix(int log_level, char *mode)
280 if (log_level < 0 || log_level > LOG_FATAL)
283 char *log_token = log_tokens[log_level];
285 if (log_level == LOG_DEBUG)
286 printf_log_nonewline("[%s] [%s] ", log_token, mode);
288 printf_log_nonewline("[%s] ", log_token);
291 static void vLog(int log_level, char *mode, char *format, va_list ap)
293 if (log_level < 0 || log_level > LOG_FATAL)
296 if (log_level == LOG_DEBUG)
298 // only show debug messages when in debug mode
302 // if optional debug mode specified, limit debug output accordingly
303 if (options.debug_mode != NULL &&
304 strstr(mode, options.debug_mode) == NULL)
307 else if (log_level == LOG_WARN)
309 // only show warning messages when in verbose mode
310 if (!options.verbose)
314 #if defined(PLATFORM_ANDROID)
315 android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
316 log_level == LOG_INFO ? ANDROID_LOG_INFO :
317 log_level == LOG_WARN ? ANDROID_LOG_WARN :
318 log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
319 log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
320 ANDROID_LOG_UNKNOWN);
323 static boolean last_line_was_separator = FALSE;
324 char *log_token = log_tokens[log_level];
326 if (strEqual(format, "===") ||
327 strEqual(format, "---"))
329 static char *mode_last = NULL;
330 char line_char[2] = { format[0], '\0' };
331 int line_length = 80 - strlen(log_token) - 3;
333 if (log_level == LOG_DEBUG)
334 line_length -= strlen(mode) + 3;
336 if (last_line_was_separator && strEqual(mode, mode_last))
339 printf_log_prefix(log_level, mode);
340 printf_log_line(line_char, line_length);
342 if (!strEqual(mode, mode_last))
343 setString(&mode_last, mode);
345 last_line_was_separator = TRUE;
350 last_line_was_separator = FALSE;
352 printf_log_prefix(log_level, mode);
354 vprintf_log(format, ap);
357 static void Log(int log_level, char *mode, char *format, ...)
361 va_start(ap, format);
362 vLog(log_level, mode, format, ap);
366 void DebugContinued(char *mode, char *format, ...)
368 static char message[MAX_LINE_LEN] = { 0 };
370 // initialize message (optional)
371 if (strEqual(format, ""))
378 char *message_ptr = message + strlen(message);
379 int size_left = MAX_LINE_LEN - strlen(message);
383 va_start(ap, format);
384 vsnprintf(message_ptr, size_left, format, ap);
388 if (strSuffix(format, "\n"))
390 message[strlen(message) - 1] = '\0';
392 Debug(mode, message);
398 void Debug(char *mode, char *format, ...)
402 va_start(ap, format);
403 vLog(LOG_DEBUG, mode, format, ap);
407 void Info(char *format, ...)
411 va_start(ap, format);
412 vLog(LOG_INFO, NULL, format, ap);
416 void Warn(char *format, ...)
420 va_start(ap, format);
421 vLog(LOG_WARN, NULL, format, ap);
425 void Error(char *format, ...)
429 va_start(ap, format);
430 vLog(LOG_ERROR, NULL, format, ap);
434 void Fail(char *format, ...)
438 va_start(ap, format);
439 vLog(LOG_FATAL, NULL, format, ap);
442 if (!network.is_server_thread)
444 va_start(ap, format);
445 program.exit_message_function(format, ap);
449 Log(LOG_FATAL, NULL, "aborting");
451 // network server thread: normal exit
452 if (network.is_server_thread)
455 // main process: clean up stuff
456 program.exit_function(1);
459 void FailWithHelp(char *format, ...)
463 va_start(ap, format);
464 vLog(LOG_FATAL, NULL, format, ap);
467 Log(LOG_FATAL, NULL, "try option '--help' for more information");
468 Log(LOG_FATAL, NULL, "aborting");
470 // main process: clean up stuff
471 program.exit_function(1);
475 // ----------------------------------------------------------------------------
477 // ----------------------------------------------------------------------------
479 /* int2str() returns a number converted to a string;
480 the used memory is static, but will be overwritten by later calls,
481 so if you want to save the result, copy it to a private string buffer;
482 there can be 10 local calls of int2str() without buffering the result --
483 the 11th call will then destroy the result from the first call and so on. */
485 char *int2str(int number, int size)
487 static char shift_array[10][40];
488 static int shift_counter = 0;
489 char *s = shift_array[shift_counter];
491 shift_counter = (shift_counter + 1) % 10;
498 sprintf(s, " %09d", number);
499 return &s[strlen(s) - size];
503 sprintf(s, "%d", number);
509 // something similar to "int2str()" above, but allocates its own memory
510 // and has a different interface; we cannot use "itoa()", because this
511 // seems to be already defined when cross-compiling to the win32 target
513 char *i_to_a(unsigned int i)
515 static char *a = NULL;
519 if (i > 2147483647) // yes, this is a kludge
522 a = checked_malloc(10 + 1);
530 // calculate base-2 logarithm of argument (rounded down to integer;
531 // this function returns the number of the highest bit set in argument)
533 int log_2(unsigned int x)
539 x -= (1 << e); // for rounding down (rounding up: remove this line)
546 boolean getTokenValueFromString(char *string, char **token, char **value)
548 return getTokenValueFromSetupLine(string, token, value);
552 // ----------------------------------------------------------------------------
554 // ----------------------------------------------------------------------------
556 #define UUID_BYTES 16
557 #define UUID_CHARS (UUID_BYTES * 2)
558 #define UUID_LENGTH (UUID_CHARS + 4)
560 static unsigned int uuid_random_function(int max)
562 return GetBetterRandom(max);
565 char *getUUIDExt(unsigned int (*random_function)(int max))
567 static char uuid[UUID_LENGTH + 1];
568 int data[UUID_BYTES];
572 for (i = 0; i < UUID_BYTES; i++)
573 data[i] = random_function(256);
575 data[6] = 0x40 | (data[6] & 0x0f);
576 data[8] = 0x80 | (data[8] & 0x3f);
578 for (i = 0; i < UUID_BYTES; i++)
580 sprintf(&uuid[count], "%02x", data[i]);
583 if (i == 3 || i == 5 || i == 7 || i == 9)
584 strcat(&uuid[count++], "-");
592 return getUUIDExt(uuid_random_function);
596 // ----------------------------------------------------------------------------
598 // ----------------------------------------------------------------------------
600 // maximal allowed length of a command line option
601 #define MAX_OPTION_LEN 256
603 static unsigned int getCurrentMS(void)
605 return SDL_GetTicks();
608 static unsigned int mainCounter(int mode)
610 static unsigned int base_ms = 0;
611 unsigned int current_ms;
613 // get current system milliseconds
614 current_ms = getCurrentMS();
616 // reset base timestamp in case of counter reset or wrap-around
617 if (mode == INIT_COUNTER || current_ms < base_ms)
618 base_ms = current_ms;
620 // return milliseconds since last counter reset
621 return current_ms - base_ms;
624 void InitCounter() // set counter back to zero
626 mainCounter(INIT_COUNTER);
629 unsigned int Counter() // get milliseconds since last call of InitCounter()
631 return mainCounter(READ_COUNTER);
634 static void sleep_milliseconds(unsigned int milliseconds_delay)
636 SDL_Delay(milliseconds_delay);
639 void Delay(unsigned int delay) // Sleep specified number of milliseconds
641 sleep_milliseconds(delay);
644 boolean DelayReachedExt2(unsigned int *counter_var, unsigned int delay,
645 unsigned int actual_counter)
647 if (actual_counter >= *counter_var &&
648 actual_counter < *counter_var + delay)
651 *counter_var = actual_counter;
656 boolean DelayReachedExt(DelayCounter *counter, unsigned int actual_counter)
658 return DelayReachedExt2(&counter->count, counter->value, actual_counter);
661 boolean FrameReached(DelayCounter *counter)
663 return DelayReachedExt(counter, FrameCounter);
666 boolean DelayReached(DelayCounter *counter)
668 return DelayReachedExt(counter, Counter());
671 void ResetDelayCounterExt(DelayCounter *counter, unsigned int actual_counter)
673 DelayReachedExt2(&counter->count, 0, actual_counter);
676 void ResetFrameCounter(DelayCounter *counter)
678 ResetDelayCounterExt(counter, FrameCounter);
681 void ResetDelayCounter(DelayCounter *counter)
683 ResetDelayCounterExt(counter, Counter());
686 int WaitUntilDelayReached(DelayCounter *counter)
688 unsigned int *counter_var = &counter->count;
689 unsigned int delay = counter->value;
690 unsigned int actual_counter;
695 actual_counter = Counter();
697 if (actual_counter >= *counter_var &&
698 actual_counter < *counter_var + delay)
699 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
704 if (*counter_var != 0 &&
706 actual_counter >= *counter_var + delay)
708 int lag = actual_counter - (*counter_var + delay);
709 int delay2 = (delay + 1) / 2;
712 skip_frames = (lag + delay2) / delay;
715 *counter_var = actual_counter;
720 void SkipUntilDelayReached(DelayCounter *counter,
721 int *loop_var, int last_loop_value)
723 int skip_frames = WaitUntilDelayReached(counter);
728 Debug("internal:SkipUntilDelayReached",
729 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
730 *loop_var, counter->value,
731 skip_frames, skip_frames * counter->value);
733 Debug("internal:SkipUntilDelayReached",
735 *loop_var, counter->value);
739 if (skip_frames == 0)
742 // when skipping frames, make sure to never skip the last frame, as
743 // this may be needed for animations to reach a defined end state;
744 // furthermore, we assume that this function is called at the end
745 // of a "for" loop, which continues by incrementing the loop variable
746 // by one before checking the loop condition again; therefore we have
747 // to check against the last loop value minus one here
751 if (*loop_var < last_loop_value) // never skip the last frame
753 *loop_var += skip_frames;
755 if (*loop_var > last_loop_value) // never skip the last frame
756 *loop_var = last_loop_value;
761 // ----------------------------------------------------------------------------
762 // random generator functions
763 // ----------------------------------------------------------------------------
765 static unsigned int init_random_number_ext(int nr, int seed)
767 if (seed == NEW_RANDOMIZE)
769 // default random seed
770 seed = (int)time(NULL); // seconds since the epoch
772 #if !defined(PLATFORM_WINDOWS)
773 // add some more randomness
774 struct timeval current_time;
776 gettimeofday(¤t_time, NULL);
778 seed += (int)current_time.tv_usec; // microseconds since the epoch
781 // add some more randomness
782 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
784 // add some more randomness
785 seed += GetSimpleRandom(1000000);
788 srandom_linux_libc(nr, (unsigned int) seed);
790 return (unsigned int) seed;
793 static unsigned int prng_seed_gettimeofday(void)
795 struct timeval current_time;
797 gettimeofday(¤t_time, NULL);
799 prng_seed_bytes(¤t_time, sizeof(current_time));
804 unsigned int init_random_number(int nr, int seed)
806 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
807 init_random_number_ext(nr, seed));
810 static unsigned int get_random_number_ext(int nr)
812 return (nr == RANDOM_BETTER ? prng_get_uint() :
813 random_linux_libc(nr));
816 unsigned int get_random_number(int nr, int max)
818 return (max > 0 ? get_random_number_ext(nr) % max : 0);
822 // ----------------------------------------------------------------------------
823 // system info functions
824 // ----------------------------------------------------------------------------
826 #if !defined(PLATFORM_ANDROID)
827 static char *get_corrected_real_name(char *real_name)
829 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
830 char *from_ptr = real_name;
831 char *to_ptr = real_name_new;
833 // copy the name string, but not more than MAX_USERNAME_LEN characters
834 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
836 // the name field read from "passwd" file may also contain additional
837 // user information, separated by commas, which will be removed here
838 if (*from_ptr == ',')
841 // the user's real name may contain 'german sharp s' characters,
842 // which have no equivalent in upper case letters (used by our fonts)
843 if (*from_ptr == CHAR_BYTE_SHARP_S)
850 *to_ptr++ = *from_ptr++;
855 return real_name_new;
859 #if defined(PLATFORM_UNIX)
860 static struct passwd *getPasswdEntry(void)
862 #if defined(PLATFORM_EMSCRIPTEN)
863 // currently not fully supported; force fallback to default values
866 return getpwuid(getuid());
870 char *getUnixLoginName(void)
872 struct passwd *pwd = getPasswdEntry();
874 if (pwd != NULL && strlen(pwd->pw_name) != 0)
880 char *getUnixRealName(void)
882 struct passwd *pwd = getPasswdEntry();
884 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
885 return pwd->pw_gecos;
890 char *getUnixHomeDir(void)
892 struct passwd *pwd = getPasswdEntry();
894 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
901 char *getLoginName(void)
903 static char *login_name = NULL;
905 #if defined(PLATFORM_WINDOWS)
906 if (login_name == NULL)
908 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
910 login_name = checked_malloc(buffer_size);
912 if (GetUserName(login_name, &buffer_size) == 0)
913 strcpy(login_name, ANONYMOUS_NAME);
915 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
916 if (login_name == NULL)
918 char *name = getUnixLoginName();
921 login_name = getStringCopy(name);
923 login_name = ANONYMOUS_NAME;
926 login_name = ANONYMOUS_NAME;
932 char *getRealName(void)
934 static char *real_name = NULL;
936 #if defined(PLATFORM_WINDOWS)
937 if (real_name == NULL)
939 static char buffer[MAX_USERNAME_LEN + 1];
940 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
942 if (GetUserName(buffer, &buffer_size) != 0)
943 real_name = get_corrected_real_name(buffer);
945 real_name = ANONYMOUS_NAME;
947 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
948 if (real_name == NULL)
950 char *name = getUnixRealName();
953 real_name = get_corrected_real_name(name);
955 real_name = ANONYMOUS_NAME;
958 real_name = ANONYMOUS_NAME;
964 char *getFixedUserName(char *name)
966 // needed because player name must be a fixed length string
967 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
969 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
970 name_new[MAX_PLAYER_NAME_LEN] = '\0';
972 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
973 if (strchr(name_new, ' '))
974 *strchr(name_new, ' ') = '\0';
979 char *getDefaultUserName(int nr)
981 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
983 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
985 if (user_name[nr] == NULL)
987 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
988 user_name[nr] = getFixedUserName(user_name[nr]);
991 return user_name[nr];
994 char *getTimestampFromEpoch(time_t epoch_seconds)
996 struct tm *now = localtime(&epoch_seconds);
997 static char timestamp[20];
999 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
1000 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
1001 now->tm_hour, now->tm_min, now->tm_sec);
1006 char *getCurrentTimestamp(void)
1008 return getTimestampFromEpoch(time(NULL));
1011 time_t getFileTimestampEpochSeconds(char *filename)
1013 struct stat file_status;
1015 if (stat(filename, &file_status) != 0) // cannot stat file
1018 return file_status.st_mtime;
1022 // ----------------------------------------------------------------------------
1023 // path manipulation functions
1024 // ----------------------------------------------------------------------------
1026 static char *getLastPathSeparatorPtr(char *filename)
1028 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1030 if (last_separator == NULL) // also try DOS/Windows variant
1031 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1033 return last_separator;
1036 char *getBaseNamePtr(char *filename)
1038 char *last_separator = getLastPathSeparatorPtr(filename);
1040 if (last_separator != NULL)
1041 return last_separator + 1; // separator found: strip base path
1043 return filename; // no separator found: filename has no path
1046 char *getBaseName(char *filename)
1048 return getStringCopy(getBaseNamePtr(filename));
1051 char *getBaseNameNoSuffix(char *filename)
1053 char *basename = getStringCopy(getBaseNamePtr(filename));
1055 // remove trailing suffix (separated by dot or hyphen)
1056 if (basename[0] != '.' && basename[0] != '-')
1058 if (strchr(basename, '.') != NULL)
1059 *strchr(basename, '.') = '\0';
1061 if (strchr(basename, '-') != NULL)
1062 *strchr(basename, '-') = '\0';
1068 char *getBasePath(char *filename)
1070 char *basepath = getStringCopy(filename);
1071 char *last_separator = getLastPathSeparatorPtr(basepath);
1073 // if no separator was found, use current directory
1074 if (last_separator == NULL)
1078 return getStringCopy(".");
1081 // separator found: strip basename
1082 *last_separator = '\0';
1088 // ----------------------------------------------------------------------------
1089 // various string functions
1090 // ----------------------------------------------------------------------------
1092 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1094 if (s1 == NULL || s2 == NULL || sep == NULL)
1097 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1100 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1102 return complete_string;
1105 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1107 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1110 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1111 strlen(s2) + strlen(sep) +
1114 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1116 return complete_string;
1119 char *getStringCat2(char *s1, char *s2)
1121 return getStringCat2WithSeparator(s1, s2, "");
1124 char *getStringCat3(char *s1, char *s2, char *s3)
1126 return getStringCat3WithSeparator(s1, s2, s3, "");
1129 char *getPath2(char *path1, char *path2)
1131 #if defined(PLATFORM_ANDROID)
1132 // workaround for reading from assets directory -- skip "." subdirs in path
1133 if (strEqual(path1, "."))
1134 return getStringCopy(path2);
1135 else if (strEqual(path2, "."))
1136 return getStringCopy(path1);
1139 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1142 char *getPath3(char *path1, char *path2, char *path3)
1144 #if defined(PLATFORM_ANDROID)
1145 // workaround for reading from assets directory -- skip "." subdirs in path
1146 if (strEqual(path1, "."))
1147 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1148 else if (strEqual(path2, "."))
1149 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1150 else if (strEqual(path3, "."))
1151 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1154 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1157 static char *getPngOrPcxIfNotExists(char *filename)
1159 // switch from PNG to PCX file and vice versa, if file does not exist
1160 // (backwards compatibility with PCX files used in previous versions)
1162 if (!fileExists(filename) && strSuffix(filename, ".png"))
1163 strcpy(&filename[strlen(filename) - 3], "pcx");
1164 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1165 strcpy(&filename[strlen(filename) - 3], "png");
1170 char *getImg2(char *path1, char *path2)
1172 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1175 char *getImg3(char *path1, char *path2, char *path3)
1177 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1180 char *getStringCopy(const char *s)
1187 s_copy = checked_malloc(strlen(s) + 1);
1193 char *getStringCopyN(const char *s, int n)
1196 int s_len = MAX(0, n);
1201 s_copy = checked_malloc(s_len + 1);
1202 strncpy(s_copy, s, s_len);
1203 s_copy[s_len] = '\0';
1208 char *getStringCopyNStatic(const char *s, int n)
1210 static char *s_copy = NULL;
1212 checked_free(s_copy);
1214 s_copy = getStringCopyN(s, n);
1219 char *getStringToLower(const char *s)
1221 char *s_copy = checked_malloc(strlen(s) + 1);
1222 char *s_ptr = s_copy;
1225 *s_ptr++ = tolower(*s++);
1231 void setString(char **old_value, char *new_value)
1233 checked_free(*old_value);
1235 *old_value = getStringCopy(new_value);
1238 boolean strEqual(char *s1, char *s2)
1240 return (s1 == NULL && s2 == NULL ? TRUE :
1241 s1 == NULL && s2 != NULL ? FALSE :
1242 s1 != NULL && s2 == NULL ? FALSE :
1243 strcmp(s1, s2) == 0);
1246 boolean strEqualN(char *s1, char *s2, int n)
1248 return (s1 == NULL && s2 == NULL ? TRUE :
1249 s1 == NULL && s2 != NULL ? FALSE :
1250 s1 != NULL && s2 == NULL ? FALSE :
1251 strncmp(s1, s2, n) == 0);
1254 boolean strEqualCase(char *s1, char *s2)
1256 return (s1 == NULL && s2 == NULL ? TRUE :
1257 s1 == NULL && s2 != NULL ? FALSE :
1258 s1 != NULL && s2 == NULL ? FALSE :
1259 strcasecmp(s1, s2) == 0);
1262 boolean strEqualCaseN(char *s1, char *s2, int n)
1264 return (s1 == NULL && s2 == NULL ? TRUE :
1265 s1 == NULL && s2 != NULL ? FALSE :
1266 s1 != NULL && s2 == NULL ? FALSE :
1267 strncasecmp(s1, s2, n) == 0);
1270 boolean strPrefix(char *s, char *prefix)
1272 return (s == NULL && prefix == NULL ? TRUE :
1273 s == NULL && prefix != NULL ? FALSE :
1274 s != NULL && prefix == NULL ? FALSE :
1275 strncmp(s, prefix, strlen(prefix)) == 0);
1278 boolean strSuffix(char *s, char *suffix)
1280 return (s == NULL && suffix == NULL ? TRUE :
1281 s == NULL && suffix != NULL ? FALSE :
1282 s != NULL && suffix == NULL ? FALSE :
1283 strlen(s) < strlen(suffix) ? FALSE :
1284 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1287 boolean strPrefixLower(char *s, char *prefix)
1289 char *s_lower = getStringToLower(s);
1290 boolean match = strPrefix(s_lower, prefix);
1297 boolean strSuffixLower(char *s, char *suffix)
1299 char *s_lower = getStringToLower(s);
1300 boolean match = strSuffix(s_lower, suffix);
1307 boolean isURL(char *s)
1309 while (*s && *s >= 'a' && *s <= 'z')
1312 return strPrefix(s, "://");
1316 // ----------------------------------------------------------------------------
1317 // command line option handling functions
1318 // ----------------------------------------------------------------------------
1320 void GetOptions(int argc, char *argv[],
1321 void (*print_usage_function)(void),
1322 void (*print_version_function)(void))
1324 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1325 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1326 char **options_left = &argvplus[1];
1328 // replace original "argv" with null-terminated array of string pointers
1330 argvplus[argc] = argv[argc];
1332 // initialize global program options
1333 options.server_host = NULL;
1334 options.server_port = 0;
1336 options.base_directory = base_path;
1338 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1339 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1340 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1341 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1342 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1343 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1345 options.execute_command = NULL;
1346 options.tape_log_filename = NULL;
1347 options.special_flags = NULL;
1348 options.debug_mode = NULL;
1349 options.player_name = NULL;
1350 options.identifier = NULL;
1351 options.level_nr = NULL;
1353 options.mytapes = FALSE;
1354 options.serveronly = FALSE;
1355 options.network = FALSE;
1356 options.verbose = FALSE;
1357 options.debug = FALSE;
1360 options.verbose = TRUE;
1362 #if !defined(PLATFORM_UNIX)
1363 if (*options_left == NULL) // no options given -- enable verbose mode
1364 options.verbose = TRUE;
1369 #if defined(PLATFORM_ANDROID)
1370 options.debug = TRUE;
1374 while (*options_left)
1376 char option_str[MAX_OPTION_LEN];
1377 char *option = options_left[0];
1378 char *next_option = options_left[1];
1379 char *option_arg = NULL;
1380 int option_len = strlen(option);
1382 if (option_len >= MAX_OPTION_LEN)
1383 FailWithHelp("unrecognized option '%s'", option);
1385 strcpy(option_str, option); // copy argument into buffer
1386 option = option_str;
1388 if (strEqual(option, "--")) // stop scanning arguments
1391 if (strPrefix(option, "--")) // treat '--' like '-'
1394 option_arg = strchr(option, '=');
1395 if (option_arg == NULL) // no '=' in option
1396 option_arg = next_option;
1399 *option_arg++ = '\0'; // cut argument from option
1400 if (*option_arg == '\0') // no argument after '='
1401 FailWithHelp("option '%s' has invalid argument", option_str);
1404 option_len = strlen(option);
1406 if (strEqual(option, "-"))
1408 FailWithHelp("unrecognized option '%s'", option);
1410 else if (strncmp(option, "-help", option_len) == 0)
1412 print_usage_function();
1416 else if (strncmp(option, "-basepath", option_len) == 0)
1418 if (option_arg == NULL)
1419 FailWithHelp("option '%s' requires an argument", option_str);
1421 options.base_directory = base_path = getStringCopy(option_arg);
1422 if (option_arg == next_option)
1425 // adjust paths for sub-directories in base directory accordingly
1426 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1427 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1428 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1429 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1430 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1431 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1433 else if (strncmp(option, "-levels", option_len) == 0)
1435 if (option_arg == NULL)
1436 FailWithHelp("option '%s' requires an argument", option_str);
1438 options.level_directory = getStringCopy(option_arg);
1439 if (option_arg == next_option)
1442 else if (strncmp(option, "-graphics", option_len) == 0)
1444 if (option_arg == NULL)
1445 FailWithHelp("option '%s' requires an argument", option_str);
1447 options.graphics_directory = getStringCopy(option_arg);
1448 if (option_arg == next_option)
1451 else if (strncmp(option, "-sounds", option_len) == 0)
1453 if (option_arg == NULL)
1454 FailWithHelp("option '%s' requires an argument", option_str);
1456 options.sounds_directory = getStringCopy(option_arg);
1457 if (option_arg == next_option)
1460 else if (strncmp(option, "-music", option_len) == 0)
1462 if (option_arg == NULL)
1463 FailWithHelp("option '%s' requires an argument", option_str);
1465 options.music_directory = getStringCopy(option_arg);
1466 if (option_arg == next_option)
1469 else if (strncmp(option, "-mytapes", option_len) == 0)
1471 options.mytapes = TRUE;
1473 else if (strncmp(option, "-network", option_len) == 0)
1475 options.network = TRUE;
1477 else if (strncmp(option, "-serveronly", option_len) == 0)
1479 options.serveronly = TRUE;
1481 else if (strncmp(option, "-debug", option_len) == 0)
1483 options.debug = TRUE;
1485 // optionally, debug output can be limited to a specific debug mode
1486 if (option_arg != next_option)
1487 options.debug_mode = getStringCopy(option_arg);
1489 else if (strncmp(option, "-player-name", option_len) == 0)
1491 if (option_arg == NULL)
1492 FailWithHelp("option '%s' requires an argument", option_str);
1494 options.player_name = getStringCopy(option_arg);
1495 if (option_arg == next_option)
1498 else if (strncmp(option, "-identifier", option_len) == 0)
1500 if (option_arg == NULL)
1501 FailWithHelp("option '%s' requires an argument", option_str);
1503 options.identifier = getStringCopy(option_arg);
1504 if (option_arg == next_option)
1507 else if (strncmp(option, "-level-nr", option_len) == 0)
1509 if (option_arg == NULL)
1510 FailWithHelp("option '%s' requires an argument", option_str);
1512 options.level_nr = getStringCopy(option_arg);
1513 if (option_arg == next_option)
1516 else if (strncmp(option, "-verbose", option_len) == 0)
1518 options.verbose = TRUE;
1520 else if (strncmp(option, "-version", option_len) == 0 ||
1521 strncmp(option, "-V", option_len) == 0)
1523 print_version_function();
1527 else if (strPrefix(option, "-D"))
1529 options.special_flags = getStringCopy(&option[2]);
1531 else if (strncmp(option, "-execute", option_len) == 0)
1533 if (option_arg == NULL)
1534 FailWithHelp("option '%s' requires an argument", option_str);
1536 options.execute_command = getStringCopy(option_arg);
1537 if (option_arg == next_option)
1540 // when doing batch processing, always enable verbose mode (warnings)
1541 options.verbose = TRUE;
1543 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1545 if (option_arg == NULL)
1546 FailWithHelp("option '%s' requires an argument", option_str);
1548 options.tape_log_filename = getStringCopy(option_arg);
1549 if (option_arg == next_option)
1552 #if defined(PLATFORM_MAC)
1553 else if (strPrefix(option, "-psn"))
1555 // ignore process serial number when launched via GUI on Mac OS X
1558 else if (*option == '-')
1560 FailWithHelp("unrecognized option '%s'", option_str);
1562 else if (options.server_host == NULL)
1564 options.server_host = *options_left;
1566 else if (options.server_port == 0)
1568 options.server_port = atoi(*options_left);
1569 if (options.server_port < 1024)
1570 FailWithHelp("bad port number '%d'", options.server_port);
1573 FailWithHelp("too many arguments");
1580 // ----------------------------------------------------------------------------
1581 // checked memory allocation and freeing functions
1582 // ----------------------------------------------------------------------------
1584 void *checked_malloc(unsigned int size)
1591 Fail("cannot allocate %d bytes -- out of memory", size);
1596 void *checked_calloc(unsigned int size)
1600 ptr = calloc(1, size);
1603 Fail("cannot allocate %d bytes -- out of memory", size);
1608 void *checked_realloc(void *ptr, unsigned int size)
1610 ptr = realloc(ptr, size);
1613 Fail("cannot allocate %d bytes -- out of memory", size);
1618 void checked_free(void *ptr)
1620 if (ptr != NULL) // this check should be done by free() anyway
1624 void clear_mem(void *ptr, unsigned int size)
1626 #if defined(PLATFORM_WINDOWS)
1627 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1628 char *cptr = (char *)ptr;
1633 memset(ptr, 0, size);
1638 // ----------------------------------------------------------------------------
1639 // various helper functions
1640 // ----------------------------------------------------------------------------
1642 void swap_numbers(int *i1, int *i2)
1650 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1662 /* the "put" variants of the following file access functions check for the file
1663 pointer being != NULL and return the number of bytes they have or would have
1664 written; this allows for chunk writing functions to first determine the size
1665 of the (not yet written) chunk, write the correct chunk size and finally
1666 write the chunk itself */
1668 int getFile8BitInteger(File *file)
1670 return getByteFromFile(file);
1673 int putFile8BitInteger(FILE *file, int value)
1681 int getFile16BitInteger(File *file, int byte_order)
1683 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1684 return ((getByteFromFile(file) << 8) |
1685 (getByteFromFile(file) << 0));
1686 else // BYTE_ORDER_LITTLE_ENDIAN
1687 return ((getByteFromFile(file) << 0) |
1688 (getByteFromFile(file) << 8));
1691 int putFile16BitInteger(FILE *file, int value, int byte_order)
1695 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1697 fputc((value >> 8) & 0xff, file);
1698 fputc((value >> 0) & 0xff, file);
1700 else // BYTE_ORDER_LITTLE_ENDIAN
1702 fputc((value >> 0) & 0xff, file);
1703 fputc((value >> 8) & 0xff, file);
1710 int getFile32BitInteger(File *file, int byte_order)
1712 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1713 return ((getByteFromFile(file) << 24) |
1714 (getByteFromFile(file) << 16) |
1715 (getByteFromFile(file) << 8) |
1716 (getByteFromFile(file) << 0));
1717 else // BYTE_ORDER_LITTLE_ENDIAN
1718 return ((getByteFromFile(file) << 0) |
1719 (getByteFromFile(file) << 8) |
1720 (getByteFromFile(file) << 16) |
1721 (getByteFromFile(file) << 24));
1724 int putFile32BitInteger(FILE *file, int value, int byte_order)
1728 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1730 fputc((value >> 24) & 0xff, file);
1731 fputc((value >> 16) & 0xff, file);
1732 fputc((value >> 8) & 0xff, file);
1733 fputc((value >> 0) & 0xff, file);
1735 else // BYTE_ORDER_LITTLE_ENDIAN
1737 fputc((value >> 0) & 0xff, file);
1738 fputc((value >> 8) & 0xff, file);
1739 fputc((value >> 16) & 0xff, file);
1740 fputc((value >> 24) & 0xff, file);
1747 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1750 const int chunk_name_length = 4;
1753 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1756 if (chunk_size != NULL)
1759 *chunk_size = getFile32BitInteger(file, byte_order);
1762 return (checkEndOfFile(file) ? FALSE : TRUE);
1765 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1772 fputs(chunk_name, file);
1774 num_bytes += strlen(chunk_name);
1776 if (chunk_size >= 0)
1780 putFile32BitInteger(file, chunk_size, byte_order);
1788 int getFileVersion(File *file)
1790 int version_super = getByteFromFile(file);
1791 int version_major = getByteFromFile(file);
1792 int version_minor = getByteFromFile(file);
1793 int version_patch = getByteFromFile(file);
1795 return VERSION_IDENT(version_super, version_major, version_minor,
1799 int putFileVersion(FILE *file, int version)
1803 int version_super = VERSION_SUPER(version);
1804 int version_major = VERSION_MAJOR(version);
1805 int version_minor = VERSION_MINOR(version);
1806 int version_patch = VERSION_PATCH(version);
1808 fputc(version_super, file);
1809 fputc(version_major, file);
1810 fputc(version_minor, file);
1811 fputc(version_patch, file);
1817 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1821 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1822 buffer[i] = getByteFromFile(file);
1825 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1829 for (i = 0; i < bytes; i++)
1830 fputc(buffer[i], file);
1833 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1835 while (bytes-- && !checkEndOfFile(file))
1836 getByteFromFile(file);
1839 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1846 // ----------------------------------------------------------------------------
1847 // functions to convert between ISO-8859-1 and UTF-8
1848 // ----------------------------------------------------------------------------
1850 char *getUTF8FromLatin1(char *latin1)
1852 int max_utf8_size = 2 * strlen(latin1) + 1;
1853 char *utf8 = checked_calloc(max_utf8_size);
1854 unsigned char *src = (unsigned char *)latin1;
1855 unsigned char *dst = (unsigned char *)utf8;
1859 if (*src < 128) // pure 7-bit ASCII
1863 else if (*src >= 160) // non-ASCII characters
1865 *dst++ = 194 + (*src >= 192);
1866 *dst++ = 128 + (*src & 63);
1868 else // undefined in ISO-8859-1
1876 // only use the smallest possible string buffer size
1877 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1882 char *getLatin1FromUTF8(char *utf8)
1884 int max_latin1_size = strlen(utf8) + 1;
1885 char *latin1 = checked_calloc(max_latin1_size);
1886 unsigned char *src = (unsigned char *)utf8;
1887 unsigned char *dst = (unsigned char *)latin1;
1891 if (*src < 128) // pure 7-bit ASCII
1895 else if (src[0] == 194 &&
1896 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1901 else if (src[0] == 195 &&
1902 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1904 *dst++ = src[1] + 64;
1908 // all other UTF-8 characters are undefined in ISO-8859-1
1910 else if (src[0] >= 192 && src[0] < 224 &&
1911 src[1] >= 128 && src[1] < 192)
1916 else if (src[0] >= 224 && src[0] < 240 &&
1917 src[1] >= 128 && src[1] < 192 &&
1918 src[2] >= 128 && src[2] < 192)
1923 else if (src[0] >= 240 && src[0] < 248 &&
1924 src[1] >= 128 && src[1] < 192 &&
1925 src[2] >= 128 && src[2] < 192 &&
1926 src[3] >= 128 && src[3] < 192)
1931 else if (src[0] >= 248 && src[0] < 252 &&
1932 src[1] >= 128 && src[1] < 192 &&
1933 src[2] >= 128 && src[2] < 192 &&
1934 src[3] >= 128 && src[3] < 192 &&
1935 src[4] >= 128 && src[4] < 192)
1940 else if (src[0] >= 252 && src[0] < 254 &&
1941 src[1] >= 128 && src[1] < 192 &&
1942 src[2] >= 128 && src[2] < 192 &&
1943 src[3] >= 128 && src[3] < 192 &&
1944 src[4] >= 128 && src[4] < 192 &&
1945 src[5] >= 128 && src[5] < 192)
1957 // only use the smallest possible string buffer size
1958 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1963 int getTextEncoding(char *text)
1965 unsigned char *src = (unsigned char *)text;
1966 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
1971 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
1977 else if (src[0] >= 192 && src[0] < 224 &&
1978 src[1] >= 128 && src[1] < 192)
1982 else if (src[0] >= 224 && src[0] < 240 &&
1983 src[1] >= 128 && src[1] < 192 &&
1984 src[2] >= 128 && src[2] < 192)
1988 else if (src[0] >= 240 && src[0] < 248 &&
1989 src[1] >= 128 && src[1] < 192 &&
1990 src[2] >= 128 && src[2] < 192 &&
1991 src[3] >= 128 && src[3] < 192)
1995 else if (src[0] >= 248 && src[0] < 252 &&
1996 src[1] >= 128 && src[1] < 192 &&
1997 src[2] >= 128 && src[2] < 192 &&
1998 src[3] >= 128 && src[3] < 192 &&
1999 src[4] >= 128 && src[4] < 192)
2003 else if (src[0] >= 252 && src[0] < 254 &&
2004 src[1] >= 128 && src[1] < 192 &&
2005 src[2] >= 128 && src[2] < 192 &&
2006 src[3] >= 128 && src[3] < 192 &&
2007 src[4] >= 128 && src[4] < 192 &&
2008 src[5] >= 128 && src[5] < 192)
2014 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2022 // ----------------------------------------------------------------------------
2023 // functions for JSON handling
2024 // ----------------------------------------------------------------------------
2026 char *getEscapedJSON(char *s)
2028 int max_json_size = 2 * strlen(s) + 1;
2029 char *json = checked_calloc(max_json_size);
2030 unsigned char *src = (unsigned char *)s;
2031 unsigned char *dst = (unsigned char *)json;
2032 char *escaped[256] =
2045 if (escaped[*src] != NULL)
2047 char *esc = escaped[*src++];
2058 // only use the smallest possible string buffer size
2059 json = checked_realloc(json, strlen(json) + 1);
2065 // ----------------------------------------------------------------------------
2066 // functions to translate key identifiers between different format
2067 // ----------------------------------------------------------------------------
2069 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2070 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2071 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2072 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2074 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2083 // return and escape keys
2084 { KSYM_Return, "XK_Return", "return" },
2085 { KSYM_Escape, "XK_Escape", "escape" },
2087 // normal cursor keys
2088 { KSYM_Left, "XK_Left", "cursor left" },
2089 { KSYM_Right, "XK_Right", "cursor right" },
2090 { KSYM_Up, "XK_Up", "cursor up" },
2091 { KSYM_Down, "XK_Down", "cursor down" },
2093 // keypad cursor keys
2095 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2096 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2097 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2098 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2101 // other keypad keys
2102 #ifdef KSYM_KP_Enter
2103 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2104 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2105 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2106 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2107 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2108 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2112 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2113 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2114 { KSYM_Control_L, "XK_Control_L", "left control" },
2115 { KSYM_Control_R, "XK_Control_R", "right control" },
2116 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2117 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2118 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2119 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2120 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2121 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2123 // some special keys
2124 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2125 { KSYM_Delete, "XK_Delete", "delete" },
2126 { KSYM_Insert, "XK_Insert", "insert" },
2127 { KSYM_Tab, "XK_Tab", "tab" },
2128 { KSYM_Home, "XK_Home", "home" },
2129 { KSYM_End, "XK_End", "end" },
2130 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2131 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2133 { KSYM_Select, "XK_Select", "select" },
2134 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2135 { KSYM_Back, "XK_Back", "back" }, // back key
2136 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2137 #if defined(PLATFORM_ANDROID)
2138 { KSYM_Rewind, "XK_Rewind", "rewind" },
2139 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2142 // ASCII 0x20 to 0x40 keys (except numbers)
2143 { KSYM_space, "XK_space", "space" },
2144 { KSYM_exclam, "XK_exclam", "!" },
2145 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2146 { KSYM_numbersign, "XK_numbersign", "#" },
2147 { KSYM_dollar, "XK_dollar", "$" },
2148 { KSYM_percent, "XK_percent", "%" },
2149 { KSYM_ampersand, "XK_ampersand", "&" },
2150 { KSYM_apostrophe, "XK_apostrophe", "'" },
2151 { KSYM_parenleft, "XK_parenleft", "(" },
2152 { KSYM_parenright, "XK_parenright", ")" },
2153 { KSYM_asterisk, "XK_asterisk", "*" },
2154 { KSYM_plus, "XK_plus", "+" },
2155 { KSYM_comma, "XK_comma", "," },
2156 { KSYM_minus, "XK_minus", "-" },
2157 { KSYM_period, "XK_period", "." },
2158 { KSYM_slash, "XK_slash", "/" },
2159 { KSYM_colon, "XK_colon", ":" },
2160 { KSYM_semicolon, "XK_semicolon", ";" },
2161 { KSYM_less, "XK_less", "<" },
2162 { KSYM_equal, "XK_equal", "=" },
2163 { KSYM_greater, "XK_greater", ">" },
2164 { KSYM_question, "XK_question", "?" },
2165 { KSYM_at, "XK_at", "@" },
2168 { KSYM_bracketleft, "XK_bracketleft", "[" },
2169 { KSYM_backslash, "XK_backslash", "\\" },
2170 { KSYM_bracketright,"XK_bracketright", "]" },
2171 { KSYM_asciicircum, "XK_asciicircum", "^" },
2172 { KSYM_underscore, "XK_underscore", "_" },
2173 { KSYM_grave, "XK_grave", "grave" },
2174 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2175 { KSYM_braceleft, "XK_braceleft", "brace left" },
2176 { KSYM_bar, "XK_bar", "bar" },
2177 { KSYM_braceright, "XK_braceright", "brace right" },
2178 { KSYM_asciitilde, "XK_asciitilde", "~" },
2180 // special (non-ASCII) keys
2181 { KSYM_degree, "XK_degree", "degree" },
2182 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2183 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2184 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2185 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2186 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2187 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2188 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2190 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2191 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2192 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2193 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2194 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2195 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2196 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2197 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2198 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2200 // other keys (for reverse mapping only)
2201 { KSYM_space, "XK_space", " " },
2203 // keypad keys are not in numerical order in SDL2
2204 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2205 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2206 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2207 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2208 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2209 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2210 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2211 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2212 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2213 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2215 // end-of-array identifier
2221 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2223 static char name_buffer[30];
2226 if (key >= KSYM_A && key <= KSYM_Z)
2227 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2228 else if (key >= KSYM_a && key <= KSYM_z)
2229 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2230 else if (key >= KSYM_0 && key <= KSYM_9)
2231 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2232 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2233 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2234 else if (key == KSYM_UNDEFINED)
2235 strcpy(name_buffer, "(undefined)");
2242 if (key == translate_key[i].key)
2244 strcpy(name_buffer, translate_key[i].name);
2248 while (translate_key[++i].name);
2250 if (!translate_key[i].name)
2251 strcpy(name_buffer, "(unknown)");
2254 *name = name_buffer;
2256 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2258 static char name_buffer[30];
2261 if (key >= KSYM_A && key <= KSYM_Z)
2262 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2263 else if (key >= KSYM_a && key <= KSYM_z)
2264 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2265 else if (key >= KSYM_0 && key <= KSYM_9)
2266 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2267 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2268 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2269 else if (key == KSYM_UNDEFINED)
2270 strcpy(name_buffer, "[undefined]");
2277 if (key == translate_key[i].key)
2279 strcpy(name_buffer, translate_key[i].x11name);
2283 while (translate_key[++i].x11name);
2285 if (!translate_key[i].x11name)
2286 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2289 *x11name = name_buffer;
2291 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2293 Key key = KSYM_UNDEFINED;
2294 char *name_ptr = *name;
2296 if (strlen(*name) == 1)
2298 char c = name_ptr[0];
2300 if (c >= 'A' && c <= 'Z')
2301 key = KSYM_A + (Key)(c - 'A');
2302 else if (c >= 'a' && c <= 'z')
2303 key = KSYM_a + (Key)(c - 'a');
2304 else if (c >= '0' && c <= '9')
2305 key = KSYM_0 + (Key)(c - '0');
2308 if (key == KSYM_UNDEFINED)
2314 if (strEqual(translate_key[i].name, *name))
2316 key = translate_key[i].key;
2320 while (translate_key[++i].x11name);
2323 if (key == KSYM_UNDEFINED)
2324 Warn("getKeyFromKeyName(): not completely implemented");
2328 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2330 Key key = KSYM_UNDEFINED;
2331 char *name_ptr = *x11name;
2333 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2335 char c = name_ptr[3];
2337 if (c >= 'A' && c <= 'Z')
2338 key = KSYM_A + (Key)(c - 'A');
2339 else if (c >= 'a' && c <= 'z')
2340 key = KSYM_a + (Key)(c - 'a');
2341 else if (c >= '0' && c <= '9')
2342 key = KSYM_0 + (Key)(c - '0');
2344 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2346 char c1 = name_ptr[4];
2347 char c2 = name_ptr[5];
2350 if ((c1 >= '0' && c1 <= '9') &&
2351 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2352 d = atoi(&name_ptr[4]);
2354 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2355 key = KSYM_F1 + (Key)(d - 1);
2357 else if (strPrefix(name_ptr, "XK_"))
2363 if (strEqual(name_ptr, translate_key[i].x11name))
2365 key = translate_key[i].key;
2369 while (translate_key[++i].x11name);
2371 else if (strPrefix(name_ptr, "0x"))
2373 unsigned int value = 0;
2379 char c = *name_ptr++;
2382 if (c >= '0' && c <= '9')
2384 else if (c >= 'a' && c <= 'f')
2385 d = (int)(c - 'a' + 10);
2386 else if (c >= 'A' && c <= 'F')
2387 d = (int)(c - 'A' + 10);
2395 value = value * 16 + d;
2406 char *getKeyNameFromKey(Key key)
2410 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2414 char *getX11KeyNameFromKey(Key key)
2418 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2422 Key getKeyFromKeyName(char *name)
2426 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2430 Key getKeyFromX11KeyName(char *x11name)
2434 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2438 char getCharFromKey(Key key)
2444 } translate_key_char[] =
2446 // special (non-ASCII) keys (ISO-8859-1)
2447 { KSYM_degree, CHAR_BYTE_DEGREE },
2448 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2449 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2450 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2451 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2452 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2453 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2454 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2456 // end-of-array identifier
2460 char *keyname = getKeyNameFromKey(key);
2463 if (strlen(keyname) == 1)
2465 else if (strEqual(keyname, "space"))
2473 if (key == translate_key_char[i].key)
2475 c = translate_key_char[i].key_char;
2480 while (translate_key_char[++i].key_char);
2486 char getValidConfigValueChar(char c)
2488 if (c == '#' || // used to mark comments
2489 c == '\\') // used to mark continued lines
2496 // ----------------------------------------------------------------------------
2497 // functions to translate string identifiers to integer or boolean value
2498 // ----------------------------------------------------------------------------
2500 int get_integer_from_string(char *s)
2502 // check for the most common case first
2503 if (s[0] >= '0' && s[0] <= '9')
2506 char *s_lower = getStringToLower(s);
2509 if (strEqual(s_lower, "false") ||
2510 strEqual(s_lower, "no") ||
2511 strEqual(s_lower, "off"))
2513 else if (strEqual(s_lower, "true") ||
2514 strEqual(s_lower, "yes") ||
2515 strEqual(s_lower, "on"))
2525 boolean get_boolean_from_string(char *s)
2527 char *s_lower = getStringToLower(s);
2528 boolean result = FALSE;
2530 if (strEqual(s_lower, "true") ||
2531 strEqual(s_lower, "yes") ||
2532 strEqual(s_lower, "on") ||
2533 get_integer_from_string(s) == 1)
2541 int get_switch3_from_string(char *s)
2543 char *s_lower = getStringToLower(s);
2546 if (strEqual(s_lower, "true") ||
2547 strEqual(s_lower, "yes") ||
2548 strEqual(s_lower, "on") ||
2549 get_integer_from_string(s) == 1)
2551 else if (strEqual(s_lower, "auto"))
2559 int get_player_nr_from_string(char *s)
2561 static char *player_text[] =
2571 char *s_lower = getStringToLower(s);
2575 for (i = 0; player_text[i] != NULL; i++)
2576 if (strEqual(s_lower, player_text[i]))
2585 // ----------------------------------------------------------------------------
2586 // functions for generic lists
2587 // ----------------------------------------------------------------------------
2589 ListNode *newListNode(void)
2591 return checked_calloc(sizeof(ListNode));
2594 void addNodeToList(ListNode **node_first, char *key, void *content)
2596 ListNode *node_new = newListNode();
2598 node_new->key = getStringCopy(key);
2599 node_new->content = content;
2600 node_new->next = *node_first;
2603 (*node_first)->prev = node_new;
2605 *node_first = node_new;
2608 void deleteNodeFromList(ListNode **node_first, char *key,
2609 void (*destructor_function)(void *))
2611 if (node_first == NULL || *node_first == NULL)
2614 if (strEqual((*node_first)->key, key))
2616 // after first recursion, (*node_first)->prev->next == *node_first,
2617 // so *node_first would be overwritten with (*node_first)->next
2618 // => use a copy of *node_first (and later of (*node_first)->next)
2619 ListNode *node = *node_first;
2620 ListNode *node_next = node->next;
2622 checked_free(node->key);
2624 if (destructor_function)
2625 destructor_function(node->content);
2628 node->prev->next = node->next;
2631 node->next->prev = node->prev;
2635 // after removing node, set list pointer to next valid list node
2636 // (this is important if the first node of the list was deleted)
2637 *node_first = node_next;
2641 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2645 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2647 if (node_first == NULL)
2650 if (strEqual(node_first->key, key))
2653 return getNodeFromKey(node_first->next, key);
2656 int getNumNodes(ListNode *node_first)
2658 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2662 static void dumpList(ListNode *node_first)
2664 ListNode *node = node_first;
2668 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2669 ((struct ListNodeInfo *)node->content)->num_references);
2673 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2678 // ----------------------------------------------------------------------------
2679 // functions for file handling
2680 // ----------------------------------------------------------------------------
2682 #define MAX_BUFFER_SIZE 4096
2684 File *openFile(char *filename, char *mode)
2686 File *file = checked_calloc(sizeof(File));
2688 file->file = fopen(filename, mode);
2690 if (file->file != NULL)
2692 file->filename = getStringCopy(filename);
2697 #if defined(PLATFORM_ANDROID)
2698 file->asset_file = SDL_RWFromFile(filename, mode);
2700 if (file->asset_file != NULL)
2702 file->file_is_asset = TRUE;
2703 file->filename = getStringCopy(filename);
2714 int closeFile(File *file)
2721 #if defined(PLATFORM_ANDROID)
2722 if (file->asset_file)
2723 result = SDL_RWclose(file->asset_file);
2727 result = fclose(file->file);
2729 checked_free(file->filename);
2735 int checkEndOfFile(File *file)
2737 #if defined(PLATFORM_ANDROID)
2738 if (file->file_is_asset)
2739 return file->end_of_file;
2742 return feof(file->file);
2745 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2747 #if defined(PLATFORM_ANDROID)
2748 if (file->file_is_asset)
2750 if (file->end_of_file)
2753 size_t num_items_read =
2754 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2756 if (num_items_read < num_items)
2757 file->end_of_file = TRUE;
2759 return num_items_read;
2763 return fread(buffer, item_size, num_items, file->file);
2766 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2768 return fwrite(buffer, item_size, num_items, file->file);
2771 int seekFile(File *file, long offset, int whence)
2773 #if defined(PLATFORM_ANDROID)
2774 if (file->file_is_asset)
2776 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2777 whence == SEEK_CUR ? RW_SEEK_CUR :
2778 whence == SEEK_END ? RW_SEEK_END : 0);
2780 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2784 return fseek(file->file, offset, whence);
2787 int getByteFromFile(File *file)
2789 #if defined(PLATFORM_ANDROID)
2790 if (file->file_is_asset)
2792 if (file->end_of_file)
2796 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2798 if (num_bytes_read < 1)
2799 file->end_of_file = TRUE;
2801 return (file->end_of_file ? EOF : (int)c);
2805 return fgetc(file->file);
2808 char *getStringFromFile(File *file, char *line, int size)
2810 #if defined(PLATFORM_ANDROID)
2811 if (file->file_is_asset)
2813 if (file->end_of_file)
2816 char *line_ptr = line;
2817 int num_bytes_read = 0;
2819 while (num_bytes_read < size - 1 &&
2820 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2821 *line_ptr++ != '\n')
2826 if (strlen(line) == 0)
2828 file->end_of_file = TRUE;
2837 return fgets(line, size, file->file);
2840 int copyFile(char *filename_from, char *filename_to)
2842 File *file_from, *file_to;
2844 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2849 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2851 closeFile(file_from);
2856 while (!checkEndOfFile(file_from))
2858 byte buffer[MAX_BUFFER_SIZE];
2859 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2861 writeFile(file_to, buffer, 1, bytes_read);
2864 closeFile(file_from);
2870 boolean touchFile(char *filename)
2874 if (!(file = fopen(filename, MODE_WRITE)))
2876 Warn("cannot touch file '%s'", filename);
2887 // ----------------------------------------------------------------------------
2888 // functions for directory handling
2889 // ----------------------------------------------------------------------------
2891 Directory *openDirectory(char *dir_name)
2893 Directory *dir = checked_calloc(sizeof(Directory));
2895 dir->dir = opendir(dir_name);
2897 if (dir->dir != NULL)
2899 dir->filename = getStringCopy(dir_name);
2904 #if defined(PLATFORM_ANDROID)
2905 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2907 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2909 checked_free(asset_toc_filename);
2911 if (dir->asset_toc_file != NULL)
2913 dir->directory_is_asset = TRUE;
2914 dir->filename = getStringCopy(dir_name);
2925 int closeDirectory(Directory *dir)
2932 #if defined(PLATFORM_ANDROID)
2933 if (dir->asset_toc_file)
2934 result = SDL_RWclose(dir->asset_toc_file);
2938 result = closedir(dir->dir);
2941 freeDirectoryEntry(dir->dir_entry);
2943 checked_free(dir->filename);
2949 DirectoryEntry *readDirectory(Directory *dir)
2952 freeDirectoryEntry(dir->dir_entry);
2954 dir->dir_entry = NULL;
2956 #if defined(PLATFORM_ANDROID)
2957 if (dir->directory_is_asset)
2959 char line[MAX_LINE_LEN];
2960 char *line_ptr = line;
2961 int num_bytes_read = 0;
2963 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2964 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2973 if (strlen(line) == 0)
2976 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2978 dir->dir_entry->is_directory = FALSE;
2979 if (line[strlen(line) - 1] == '/')
2981 dir->dir_entry->is_directory = TRUE;
2983 line[strlen(line) - 1] = '\0';
2986 dir->dir_entry->basename = getStringCopy(line);
2987 dir->dir_entry->filename = getPath2(dir->filename, line);
2989 return dir->dir_entry;
2993 struct dirent *dir_entry = readdir(dir->dir);
2995 if (dir_entry == NULL)
2998 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3000 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3001 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3003 struct stat file_status;
3005 dir->dir_entry->is_directory =
3006 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3007 S_ISDIR(file_status.st_mode));
3009 return dir->dir_entry;
3012 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3014 if (dir_entry == NULL)
3017 checked_free(dir_entry->basename);
3018 checked_free(dir_entry->filename);
3019 checked_free(dir_entry);
3023 // ----------------------------------------------------------------------------
3024 // functions for checking files and filenames
3025 // ----------------------------------------------------------------------------
3027 boolean directoryExists(char *dir_name)
3029 if (dir_name == NULL)
3032 struct stat file_status;
3033 boolean success = (stat(dir_name, &file_status) == 0 &&
3034 S_ISDIR(file_status.st_mode));
3036 #if defined(PLATFORM_ANDROID)
3039 // this might be an asset directory; check by trying to open toc file
3040 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3041 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3043 checked_free(asset_toc_filename);
3045 success = (file != NULL);
3055 boolean fileExists(char *filename)
3057 if (filename == NULL)
3060 boolean success = (access(filename, F_OK) == 0);
3062 #if defined(PLATFORM_ANDROID)
3065 // this might be an asset file; check by trying to open it
3066 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3068 success = (file != NULL);
3079 static boolean fileHasPrefix(char *basename, char *prefix)
3081 static char *basename_lower = NULL;
3082 int basename_length, prefix_length;
3084 checked_free(basename_lower);
3086 if (basename == NULL || prefix == NULL)
3089 basename_lower = getStringToLower(basename);
3090 basename_length = strlen(basename_lower);
3091 prefix_length = strlen(prefix);
3093 if (basename_length > prefix_length + 1 &&
3094 basename_lower[prefix_length] == '.' &&
3095 strncmp(basename_lower, prefix, prefix_length) == 0)
3102 static boolean fileHasSuffix(char *basename, char *suffix)
3104 static char *basename_lower = NULL;
3105 int basename_length, suffix_length;
3107 checked_free(basename_lower);
3109 if (basename == NULL || suffix == NULL)
3112 basename_lower = getStringToLower(basename);
3113 basename_length = strlen(basename_lower);
3114 suffix_length = strlen(suffix);
3116 if (basename_length > suffix_length + 1 &&
3117 basename_lower[basename_length - suffix_length - 1] == '.' &&
3118 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3124 static boolean FileCouldBeArtwork(char *filename)
3126 char *basename = getBaseNamePtr(filename);
3128 return (!strEqual(basename, ".") &&
3129 !strEqual(basename, "..") &&
3130 !fileHasSuffix(basename, "txt") &&
3131 !fileHasSuffix(basename, "conf") &&
3132 !directoryExists(filename));
3135 boolean FileIsGraphic(char *filename)
3137 return FileCouldBeArtwork(filename);
3140 boolean FileIsSound(char *filename)
3142 return FileCouldBeArtwork(filename);
3145 boolean FileIsMusic(char *filename)
3147 return FileCouldBeArtwork(filename);
3150 boolean FileIsArtworkType(char *filename, int type)
3152 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3153 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3154 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3160 // ----------------------------------------------------------------------------
3161 // functions for loading artwork configuration information
3162 // ----------------------------------------------------------------------------
3164 char *get_mapped_token(char *token)
3166 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3167 static char *map_token_prefix[][2] =
3169 { "char_procent", "char_percent" },
3170 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3171 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3172 { "bd_butterfly_left", "bd_butterfly.left" },
3173 { "bd_butterfly_right", "bd_butterfly.right" },
3174 { "bd_butterfly_up", "bd_butterfly.up" },
3175 { "bd_butterfly_down", "bd_butterfly.down" },
3176 { "bd_firefly_left", "bd_firefly.left" },
3177 { "bd_firefly_right", "bd_firefly.right" },
3178 { "bd_firefly_up", "bd_firefly.up" },
3179 { "bd_firefly_down", "bd_firefly.down" },
3185 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3187 int len_token_prefix = strlen(map_token_prefix[i][0]);
3189 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3190 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3193 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3194 char *gfx_substring = ".gfx";
3195 char *gfx_prefix = "gfx.";
3196 if (strstr(token, gfx_substring) != NULL)
3198 char *token_prefix = getStringCopy(token);
3199 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3200 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3203 // cut off token string at ".gfx" substring position
3204 *token_gfx_pos = '\0';
3206 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3207 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3211 return mapped_token;
3217 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3220 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3221 static struct ConfigTypeInfo prefix_list[] =
3223 { "global.anim_1" },
3224 { "global.anim_2" },
3225 { "global.anim_3" },
3226 { "global.anim_4" },
3227 { "global.anim_5" },
3228 { "global.anim_6" },
3229 { "global.anim_7" },
3230 { "global.anim_8" },
3231 { "global.anim_9" },
3232 { "global.anim_10" },
3233 { "global.anim_11" },
3234 { "global.anim_12" },
3235 { "global.anim_13" },
3236 { "global.anim_14" },
3237 { "global.anim_15" },
3238 { "global.anim_16" },
3239 { "global.anim_17" },
3240 { "global.anim_18" },
3241 { "global.anim_19" },
3242 { "global.anim_20" },
3243 { "global.anim_21" },
3244 { "global.anim_22" },
3245 { "global.anim_23" },
3246 { "global.anim_24" },
3247 { "global.anim_25" },
3248 { "global.anim_26" },
3249 { "global.anim_27" },
3250 { "global.anim_28" },
3251 { "global.anim_29" },
3252 { "global.anim_30" },
3253 { "global.anim_31" },
3254 { "global.anim_32" },
3258 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3259 boolean prefix_found = FALSE;
3263 // search for prefix to check if base token has to be created
3264 for (i = 0; prefix_list[i].token != NULL; i++)
3265 if (strPrefix(token, prefix_list[i].token))
3266 prefix_found = TRUE;
3271 // search for suffix (parameter) to determine base token length
3272 for (i = 0; suffix_list[i].token != NULL; i++)
3273 if (strSuffix(token, suffix_list[i].token))
3274 len_suffix = strlen(suffix_list[i].token);
3276 return getStringCopyN(token, strlen(token) - len_suffix);
3279 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3280 struct ListNodeInfo ***, int *);
3282 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3283 struct ConfigTypeInfo *suffix_list,
3284 char **ignore_tokens,
3285 int num_file_list_entries)
3287 SetupFileHash *ignore_tokens_hash;
3288 struct FileInfo *file_list;
3289 int num_file_list_entries_found = 0;
3290 int num_suffix_list_entries = 0;
3294 // create hash from list of tokens to be ignored (for quick access)
3295 ignore_tokens_hash = newSetupFileHash();
3296 for (i = 0; ignore_tokens[i] != NULL; i++)
3297 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3299 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3301 for (i = 0; suffix_list[i].token != NULL; i++)
3302 num_suffix_list_entries++;
3304 // always start with reliable default values
3305 for (i = 0; i < num_file_list_entries; i++)
3307 file_list[i].token = NULL;
3309 file_list[i].default_filename = NULL;
3310 file_list[i].filename = NULL;
3312 if (num_suffix_list_entries > 0)
3314 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3316 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3317 file_list[i].parameter = checked_calloc(parameter_array_size);
3319 for (j = 0; j < num_suffix_list_entries; j++)
3321 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3322 setString(&file_list[i].parameter[j], suffix_list[j].value);
3325 file_list[i].redefined = FALSE;
3326 file_list[i].fallback_to_default = FALSE;
3327 file_list[i].default_is_cloned = FALSE;
3333 for (i = 0; config_list[i].token != NULL; i++)
3335 int len_config_token = strlen(config_list[i].token);
3336 boolean is_file_entry = TRUE;
3338 for (j = 0; suffix_list[j].token != NULL; j++)
3340 int len_suffix = strlen(suffix_list[j].token);
3342 if (len_suffix < len_config_token &&
3343 strEqual(&config_list[i].token[len_config_token - len_suffix],
3344 suffix_list[j].token))
3346 setString(&file_list[list_pos].default_parameter[j],
3347 config_list[i].value);
3349 is_file_entry = FALSE;
3355 // the following tokens are no file definitions, but other config tokens
3356 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3357 is_file_entry = FALSE;
3364 if (list_pos >= num_file_list_entries)
3367 file_list[list_pos].token = config_list[i].token;
3368 file_list[list_pos].default_filename = config_list[i].value;
3371 if (strSuffix(config_list[i].token, ".clone_from"))
3372 file_list[list_pos].default_is_cloned = TRUE;
3375 num_file_list_entries_found = list_pos + 1;
3376 if (num_file_list_entries_found != num_file_list_entries)
3379 Error("inconsistant config list information:");
3380 Error("- should be: %d (according to 'src/conf_xxx.h')",
3381 num_file_list_entries);
3382 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3383 num_file_list_entries_found);
3388 freeSetupFileHash(ignore_tokens_hash);
3393 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3395 int len_token = strlen(token);
3396 int len_suffix = strlen(suffix);
3398 if (start_pos < 0) // compare suffix from end of string
3399 start_pos += len_token;
3401 if (start_pos < 0 || start_pos + len_suffix > len_token)
3404 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3407 if (token[start_pos + len_suffix] == '\0')
3410 if (token[start_pos + len_suffix] == '.')
3416 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3418 static void read_token_parameters(SetupFileHash *setup_file_hash,
3419 struct ConfigTypeInfo *suffix_list,
3420 struct FileInfo *file_list_entry)
3422 // check for config token that is the base token without any suffixes
3423 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3424 char *known_token_value = KNOWN_TOKEN_VALUE;
3427 if (filename != NULL)
3429 setString(&file_list_entry->filename, filename);
3431 // when file definition found, set all parameters to default values
3432 for (i = 0; suffix_list[i].token != NULL; i++)
3433 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3435 file_list_entry->redefined = TRUE;
3437 // mark config file token as well known from default config
3438 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3441 // check for config tokens that can be build by base token and suffixes
3442 for (i = 0; suffix_list[i].token != NULL; i++)
3444 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3445 char *value = getHashEntry(setup_file_hash, token);
3449 setString(&file_list_entry->parameter[i], value);
3451 // mark config file token as well known from default config
3452 setHashEntry(setup_file_hash, token, known_token_value);
3459 static void add_dynamic_file_list_entry(struct FileInfo **list,
3460 int *num_list_entries,
3461 SetupFileHash *extra_file_hash,
3462 struct ConfigTypeInfo *suffix_list,
3463 int num_suffix_list_entries,
3466 struct FileInfo *new_list_entry;
3467 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3469 (*num_list_entries)++;
3470 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3471 new_list_entry = &(*list)[*num_list_entries - 1];
3473 new_list_entry->token = getStringCopy(token);
3474 new_list_entry->default_filename = NULL;
3475 new_list_entry->filename = NULL;
3476 new_list_entry->parameter = checked_calloc(parameter_array_size);
3478 new_list_entry->redefined = FALSE;
3479 new_list_entry->fallback_to_default = FALSE;
3480 new_list_entry->default_is_cloned = FALSE;
3482 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3485 static void add_property_mapping(struct PropertyMapping **list,
3486 int *num_list_entries,
3487 int base_index, int ext1_index,
3488 int ext2_index, int ext3_index,
3491 struct PropertyMapping *new_list_entry;
3493 (*num_list_entries)++;
3494 *list = checked_realloc(*list,
3495 *num_list_entries * sizeof(struct PropertyMapping));
3496 new_list_entry = &(*list)[*num_list_entries - 1];
3498 new_list_entry->base_index = base_index;
3499 new_list_entry->ext1_index = ext1_index;
3500 new_list_entry->ext2_index = ext2_index;
3501 new_list_entry->ext3_index = ext3_index;
3503 new_list_entry->artwork_index = artwork_index;
3506 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3509 struct FileInfo *file_list = artwork_info->file_list;
3510 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3511 char **base_prefixes = artwork_info->base_prefixes;
3512 char **ext1_suffixes = artwork_info->ext1_suffixes;
3513 char **ext2_suffixes = artwork_info->ext2_suffixes;
3514 char **ext3_suffixes = artwork_info->ext3_suffixes;
3515 char **ignore_tokens = artwork_info->ignore_tokens;
3516 int num_file_list_entries = artwork_info->num_file_list_entries;
3517 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3518 int num_base_prefixes = artwork_info->num_base_prefixes;
3519 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3520 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3521 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3522 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3523 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3524 SetupFileHash *extra_file_hash, *empty_file_hash;
3525 char *known_token_value = KNOWN_TOKEN_VALUE;
3526 char *base_token_value = UNDEFINED_FILENAME;
3529 if (filename == NULL)
3532 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3535 // separate valid (defined) from empty (undefined) config token values
3536 valid_file_hash = newSetupFileHash();
3537 empty_file_hash = newSetupFileHash();
3538 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3540 char *value = HASH_ITERATION_VALUE(itr);
3542 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3543 HASH_ITERATION_TOKEN(itr), value);
3545 END_HASH_ITERATION(setup_file_hash, itr)
3547 // at this point, we do not need the setup file hash anymore -- free it
3548 freeSetupFileHash(setup_file_hash);
3550 // prevent changing hash while iterating over it by using a temporary copy
3551 valid_file_hash_tmp = newSetupFileHash();
3552 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3554 setHashEntry(valid_file_hash_tmp,
3555 HASH_ITERATION_TOKEN(itr),
3556 HASH_ITERATION_VALUE(itr));
3558 END_HASH_ITERATION(valid_file_hash, itr)
3560 // (iterate over same temporary hash, as modifications are independent)
3562 // map deprecated to current tokens (using prefix match and replace)
3563 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3565 char *token = HASH_ITERATION_TOKEN(itr);
3566 char *mapped_token = get_mapped_token(token);
3568 if (mapped_token != NULL)
3570 char *value = HASH_ITERATION_VALUE(itr);
3573 setHashEntry(valid_file_hash, mapped_token, value);
3575 // ignore old token (by setting it to "known" keyword)
3576 setHashEntry(valid_file_hash, token, known_token_value);
3581 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3583 // add special base tokens (using prefix match and replace)
3584 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3586 char *token = HASH_ITERATION_TOKEN(itr);
3587 char *base_token = get_special_base_token(artwork_info, token);
3589 if (base_token != NULL)
3591 // add base token only if it does not already exist
3592 if (getHashEntry(valid_file_hash, base_token) == NULL)
3593 setHashEntry(valid_file_hash, base_token, base_token_value);
3598 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3600 // free temporary hash used for iteration
3601 freeSetupFileHash(valid_file_hash_tmp);
3603 // read parameters for all known config file tokens
3604 for (i = 0; i < num_file_list_entries; i++)
3605 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3607 // set all tokens that can be ignored here to "known" keyword
3608 for (i = 0; i < num_ignore_tokens; i++)
3609 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3611 // copy all unknown config file tokens to extra config hash
3612 extra_file_hash = newSetupFileHash();
3613 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3615 char *value = HASH_ITERATION_VALUE(itr);
3617 if (!strEqual(value, known_token_value))
3618 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3620 END_HASH_ITERATION(valid_file_hash, itr)
3622 // at this point, we do not need the valid file hash anymore -- free it
3623 freeSetupFileHash(valid_file_hash);
3625 // now try to determine valid, dynamically defined config tokens
3627 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3629 struct FileInfo **dynamic_file_list =
3630 &artwork_info->dynamic_file_list;
3631 int *num_dynamic_file_list_entries =
3632 &artwork_info->num_dynamic_file_list_entries;
3633 struct PropertyMapping **property_mapping =
3634 &artwork_info->property_mapping;
3635 int *num_property_mapping_entries =
3636 &artwork_info->num_property_mapping_entries;
3637 int current_summarized_file_list_entry =
3638 artwork_info->num_file_list_entries +
3639 artwork_info->num_dynamic_file_list_entries;
3640 char *token = HASH_ITERATION_TOKEN(itr);
3641 int len_token = strlen(token);
3643 boolean base_prefix_found = FALSE;
3644 boolean parameter_suffix_found = FALSE;
3646 // skip all parameter definitions (handled by read_token_parameters())
3647 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3649 int len_suffix = strlen(suffix_list[i].token);
3651 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3652 parameter_suffix_found = TRUE;
3655 if (parameter_suffix_found)
3658 // ---------- step 0: search for matching base prefix ----------
3661 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3663 char *base_prefix = base_prefixes[i];
3664 int len_base_prefix = strlen(base_prefix);
3665 boolean ext1_suffix_found = FALSE;
3666 boolean ext2_suffix_found = FALSE;
3667 boolean ext3_suffix_found = FALSE;
3668 boolean exact_match = FALSE;
3669 int base_index = -1;
3670 int ext1_index = -1;
3671 int ext2_index = -1;
3672 int ext3_index = -1;
3674 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3676 if (!base_prefix_found)
3681 if (start_pos + len_base_prefix == len_token) // exact match
3685 add_dynamic_file_list_entry(dynamic_file_list,
3686 num_dynamic_file_list_entries,
3689 num_suffix_list_entries,
3691 add_property_mapping(property_mapping,
3692 num_property_mapping_entries,
3693 base_index, -1, -1, -1,
3694 current_summarized_file_list_entry);
3698 // ---------- step 1: search for matching first suffix ----------
3700 start_pos += len_base_prefix;
3701 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3703 char *ext1_suffix = ext1_suffixes[j];
3704 int len_ext1_suffix = strlen(ext1_suffix);
3706 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3708 if (!ext1_suffix_found)
3713 if (start_pos + len_ext1_suffix == len_token) // exact match
3717 add_dynamic_file_list_entry(dynamic_file_list,
3718 num_dynamic_file_list_entries,
3721 num_suffix_list_entries,
3723 add_property_mapping(property_mapping,
3724 num_property_mapping_entries,
3725 base_index, ext1_index, -1, -1,
3726 current_summarized_file_list_entry);
3730 start_pos += len_ext1_suffix;
3736 // ---------- step 2: search for matching second suffix ----------
3738 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3740 char *ext2_suffix = ext2_suffixes[k];
3741 int len_ext2_suffix = strlen(ext2_suffix);
3743 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3745 if (!ext2_suffix_found)
3750 if (start_pos + len_ext2_suffix == len_token) // exact match
3754 add_dynamic_file_list_entry(dynamic_file_list,
3755 num_dynamic_file_list_entries,
3758 num_suffix_list_entries,
3760 add_property_mapping(property_mapping,
3761 num_property_mapping_entries,
3762 base_index, ext1_index, ext2_index, -1,
3763 current_summarized_file_list_entry);
3767 start_pos += len_ext2_suffix;
3773 // ---------- step 3: search for matching third suffix ----------
3775 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3777 char *ext3_suffix = ext3_suffixes[l];
3778 int len_ext3_suffix = strlen(ext3_suffix);
3780 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3782 if (!ext3_suffix_found)
3787 if (start_pos + len_ext3_suffix == len_token) // exact match
3791 add_dynamic_file_list_entry(dynamic_file_list,
3792 num_dynamic_file_list_entries,
3795 num_suffix_list_entries,
3797 add_property_mapping(property_mapping,
3798 num_property_mapping_entries,
3799 base_index, ext1_index, ext2_index, ext3_index,
3800 current_summarized_file_list_entry);
3806 END_HASH_ITERATION(extra_file_hash, itr)
3808 if (artwork_info->num_dynamic_file_list_entries > 0)
3810 artwork_info->dynamic_artwork_list =
3811 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3812 artwork_info->sizeof_artwork_list_entry);
3815 if (options.verbose && IS_PARENT_PROCESS())
3817 SetupFileList *setup_file_list, *list;
3818 boolean dynamic_tokens_found = FALSE;
3819 boolean unknown_tokens_found = FALSE;
3820 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3822 // list may be NULL for empty artwork config files
3823 setup_file_list = loadSetupFileList(filename);
3825 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3827 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3828 dynamic_tokens_found = TRUE;
3830 unknown_tokens_found = TRUE;
3832 END_HASH_ITERATION(extra_file_hash, itr)
3834 if (options.debug && dynamic_tokens_found)
3836 Debug("config", "---");
3837 Debug("config", "dynamic token(s) found in config file:");
3838 Debug("config", "- config file: '%s'", filename);
3840 for (list = setup_file_list; list != NULL; list = list->next)
3842 char *value = getHashEntry(extra_file_hash, list->token);
3844 if (value != NULL && strEqual(value, known_token_value))
3845 Debug("config", "- dynamic token: '%s'", list->token);
3848 Debug("config", "---");
3851 if (unknown_tokens_found)
3854 Warn("unknown token(s) found in config file:");
3855 Warn("- config file: '%s'", filename);
3857 for (list = setup_file_list; list != NULL; list = list->next)
3859 char *value = getHashEntry(extra_file_hash, list->token);
3861 if (value != NULL && !strEqual(value, known_token_value))
3862 Warn("- dynamic token: '%s'", list->token);
3868 if (undefined_values_found)
3871 Warn("undefined values found in config file:");
3872 Warn("- config file: '%s'", filename);
3874 for (list = setup_file_list; list != NULL; list = list->next)
3876 char *value = getHashEntry(empty_file_hash, list->token);
3879 Warn("- undefined value for token: '%s'", list->token);
3885 freeSetupFileList(setup_file_list);
3888 freeSetupFileHash(extra_file_hash);
3889 freeSetupFileHash(empty_file_hash);
3892 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3894 struct FileInfo *file_list = artwork_info->file_list;
3895 int num_file_list_entries = artwork_info->num_file_list_entries;
3896 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3897 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3900 DrawInitTextHead("Loading artwork config");
3901 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
3903 // always start with reliable default values
3904 for (i = 0; i < num_file_list_entries; i++)
3906 setString(&file_list[i].filename, file_list[i].default_filename);
3908 for (j = 0; j < num_suffix_list_entries; j++)
3909 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3911 file_list[i].redefined = FALSE;
3912 file_list[i].fallback_to_default = FALSE;
3915 // free previous dynamic artwork file array
3916 if (artwork_info->dynamic_file_list != NULL)
3918 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3920 free(artwork_info->dynamic_file_list[i].token);
3921 free(artwork_info->dynamic_file_list[i].filename);
3922 free(artwork_info->dynamic_file_list[i].parameter);
3925 free(artwork_info->dynamic_file_list);
3926 artwork_info->dynamic_file_list = NULL;
3928 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3929 &artwork_info->num_dynamic_file_list_entries);
3932 // free previous property mapping
3933 if (artwork_info->property_mapping != NULL)
3935 free(artwork_info->property_mapping);
3937 artwork_info->property_mapping = NULL;
3938 artwork_info->num_property_mapping_entries = 0;
3941 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3943 // first look for special artwork configured in level series config
3944 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3946 if (fileExists(filename_base))
3947 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3950 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3952 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3953 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3956 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3957 struct ListNodeInfo **listnode)
3961 char *filename = (*listnode)->source_filename;
3963 if (--(*listnode)->num_references <= 0)
3964 deleteNodeFromList(&artwork_info->content_list, filename,
3965 artwork_info->free_artwork);
3971 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3972 struct ListNodeInfo **listnode,
3973 struct FileInfo *file_list_entry)
3983 char *basename = file_list_entry->filename;
3984 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3986 // mark all images from non-default graphics directory as "redefined"
3987 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
3988 !strPrefix(filename, options.graphics_directory))
3989 file_list_entry->redefined = TRUE;
3991 if (filename == NULL)
3993 Warn("cannot find artwork file '%s'", basename);
3995 basename = file_list_entry->default_filename;
3997 // fail for cloned default artwork that has no default filename defined
3998 if (file_list_entry->default_is_cloned &&
3999 strEqual(basename, UNDEFINED_FILENAME))
4001 void (*error_func)(char *, ...) = Warn;
4003 // we can get away without sounds and music, but not without graphics
4004 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4007 error_func("token '%s' was cloned and has no default filename",
4008 file_list_entry->token);
4013 // dynamic artwork has no default filename / skip empty default artwork
4014 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4017 file_list_entry->fallback_to_default = TRUE;
4019 Warn("trying default artwork file '%s'", basename);
4021 filename = getCustomArtworkFilename(basename, artwork_info->type);
4023 if (filename == NULL)
4025 void (*error_func)(char *, ...) = Warn;
4027 // we can get away without sounds and music, but not without graphics
4028 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4031 error_func("cannot find default artwork file '%s'", basename);
4037 // check if the old and the new artwork file are the same
4038 if (*listnode && strEqual((*listnode)->source_filename, filename))
4040 // The old and new artwork are the same (have the same filename and path).
4041 // This usually means that this artwork does not exist in this artwork set
4042 // and a fallback to the existing artwork is done.
4047 // delete existing artwork file entry
4048 deleteArtworkListEntry(artwork_info, listnode);
4050 // check if the new artwork file already exists in the list of artwork
4051 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4053 *listnode = (struct ListNodeInfo *)node->content;
4054 (*listnode)->num_references++;
4059 DrawInitTextHead(init_text[artwork_info->type]);
4060 DrawInitTextItem(basename);
4062 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4064 // add new artwork file entry to the list of artwork files
4065 (*listnode)->num_references = 1;
4066 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4071 void (*error_func)(char *, ...) = Warn;
4073 // we can get away without sounds and music, but not without graphics
4074 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4077 error_func("cannot load artwork file '%s'", basename);
4083 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4084 struct ListNodeInfo **listnode,
4085 struct FileInfo *file_list_entry)
4087 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4089 deleteArtworkListEntry(artwork_info, listnode);
4094 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4097 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4099 struct FileInfo *file_list = artwork_info->file_list;
4100 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4101 int num_file_list_entries = artwork_info->num_file_list_entries;
4102 int num_dynamic_file_list_entries =
4103 artwork_info->num_dynamic_file_list_entries;
4106 print_timestamp_init("ReloadCustomArtworkList");
4108 for (i = 0; i < num_file_list_entries; i++)
4109 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4112 for (i = 0; i < num_dynamic_file_list_entries; i++)
4113 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4114 &dynamic_file_list[i]);
4116 print_timestamp_done("ReloadCustomArtworkList");
4119 dumpList(artwork_info->content_list);
4123 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4124 struct ListNodeInfo ***list,
4125 int *num_list_entries)
4132 for (i = 0; i < *num_list_entries; i++)
4133 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4137 *num_list_entries = 0;
4140 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4142 if (artwork_info == NULL)
4145 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4146 &artwork_info->num_file_list_entries);
4148 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4149 &artwork_info->num_dynamic_file_list_entries);
4153 // ----------------------------------------------------------------------------
4154 // functions only needed for non-Unix (non-command-line) systems
4155 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4156 // (now also added for Windows, to create files in user data directory)
4157 // ----------------------------------------------------------------------------
4159 char *getLogFilename(char *basename)
4161 return getPath2(getMainUserGameDataDir(), basename);
4164 void OpenLogFiles(void)
4168 InitMainUserDataDirectory();
4170 for (i = 0; i < NUM_LOGS; i++)
4172 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
4175 program.log_file[i] = program.log_file_default[i]; // reset to default
4177 Warn("cannot open file '%s' for writing: %s",
4178 program.log_filename[i], strerror(errno));
4181 // output should be unbuffered so it is not truncated in a crash
4182 setbuf(program.log_file[i], NULL);
4186 void CloseLogFiles(void)
4190 for (i = 0; i < NUM_LOGS; i++)
4191 if (program.log_file[i] != program.log_file_default[i])
4192 fclose(program.log_file[i]);
4195 void DumpLogFile(int nr)
4197 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
4199 if (log_file == NULL)
4202 while (!feof(log_file))
4203 fputc(fgetc(log_file), stdout);
4208 void NotifyUserAboutErrorFile(void)
4210 #if defined(PLATFORM_WINDOWS)
4211 char *title_text = getStringCat2(program.program_title, " Error Message");
4212 char *error_text = getStringCat2("The program was aborted due to an error; "
4213 "for details, see the following error file:"
4215 program.log_filename[LOG_ERR_ID]);
4217 MessageBox(NULL, error_text, title_text, MB_OK);
4222 // ----------------------------------------------------------------------------
4223 // the following is only for debugging purpose and normally not used
4224 // ----------------------------------------------------------------------------
4228 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4229 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4231 #define DEBUG_NUM_TIMESTAMPS 10
4232 #define DEBUG_TIME_IN_MICROSECONDS 0
4234 #if DEBUG_TIME_IN_MICROSECONDS
4235 static double Counter_Microseconds(void)
4237 static struct timeval base_time = { 0, 0 };
4238 struct timeval current_time;
4241 gettimeofday(¤t_time, NULL);
4243 // reset base time in case of wrap-around
4244 if (current_time.tv_sec < base_time.tv_sec)
4245 base_time = current_time;
4248 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4249 ((double)(current_time.tv_usec - base_time.tv_usec));
4251 return counter; // return microseconds since last init
4255 static char *debug_print_timestamp_get_padding(int padding_size)
4257 static char *padding = NULL;
4258 int max_padding_size = 100;
4260 if (padding == NULL)
4262 padding = checked_calloc(max_padding_size + 1);
4263 memset(padding, ' ', max_padding_size);
4266 return &padding[MAX(0, max_padding_size - padding_size)];
4269 void debug_print_timestamp(int counter_nr, char *message)
4271 int indent_size = 8;
4272 int padding_size = 40;
4273 float timestamp_interval;
4276 Fail("debugging: invalid negative counter");
4277 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4278 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4280 #if DEBUG_TIME_IN_MICROSECONDS
4281 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4284 counter[counter_nr][0] = Counter_Microseconds();
4286 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4289 counter[counter_nr][0] = Counter();
4292 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4293 counter[counter_nr][1] = counter[counter_nr][0];
4296 Debug("time:init", "%s%s%s %.3f %s",
4297 debug_print_timestamp_get_padding(counter_nr * indent_size),
4299 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4300 timestamp_interval / 1000,
4305 static void debug_print_parent_only(char *format, ...)
4307 if (!IS_PARENT_PROCESS())
4314 va_start(ap, format);
4315 vprintf(format, ap);
4325 static void print_timestamp_ext(char *message, char *mode)
4327 #if DEBUG_PRINT_INIT_TIMESTAMPS
4328 static char *debug_message = NULL;
4329 static char *last_message = NULL;
4330 static int counter_nr = 0;
4331 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4333 checked_free(debug_message);
4334 debug_message = getStringCat3(mode, " ", message);
4336 if (strEqual(mode, "INIT"))
4338 debug_print_timestamp(counter_nr, NULL);
4340 if (counter_nr + 1 < max_depth)
4341 debug_print_timestamp(counter_nr, debug_message);
4345 debug_print_timestamp(counter_nr, NULL);
4347 else if (strEqual(mode, "DONE"))
4351 if (counter_nr + 1 < max_depth ||
4352 (counter_nr == 0 && max_depth == 1))
4354 last_message = message;
4356 if (counter_nr == 0 && max_depth == 1)
4358 checked_free(debug_message);
4359 debug_message = getStringCat3("TIME", " ", message);
4362 debug_print_timestamp(counter_nr, debug_message);
4365 else if (!strEqual(mode, "TIME") ||
4366 !strEqual(message, last_message))
4368 if (counter_nr < max_depth)
4369 debug_print_timestamp(counter_nr, debug_message);
4374 void print_timestamp_init(char *message)
4376 print_timestamp_ext(message, "INIT");
4379 void print_timestamp_time(char *message)
4381 print_timestamp_ext(message, "TIME");
4384 void print_timestamp_done(char *message)
4386 print_timestamp_ext(message, "DONE");