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 DelayReachedExt(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 FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
658 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
661 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
663 return DelayReachedExt(counter_var, delay, Counter());
666 void ResetDelayCounterExt(unsigned int *counter_var,
667 unsigned int actual_counter)
669 DelayReachedExt(counter_var, 0, actual_counter);
672 void ResetFrameCounter(unsigned int *frame_counter_var)
674 FrameReached(frame_counter_var, 0);
677 void ResetDelayCounter(unsigned int *counter_var)
679 DelayReached(counter_var, 0);
682 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
684 unsigned int actual_counter;
689 actual_counter = Counter();
691 if (actual_counter >= *counter_var &&
692 actual_counter < *counter_var + delay)
693 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
698 if (*counter_var != 0 &&
700 actual_counter >= *counter_var + delay)
702 int lag = actual_counter - (*counter_var + delay);
703 int delay2 = (delay + 1) / 2;
706 skip_frames = (lag + delay2) / delay;
709 *counter_var = actual_counter;
714 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
715 int *loop_var, int last_loop_value)
717 int skip_frames = WaitUntilDelayReached(counter_var, delay);
722 Debug("internal:SkipUntilDelayReached",
723 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
725 skip_frames, skip_frames * delay);
727 Debug("internal:SkipUntilDelayReached",
733 if (skip_frames == 0)
736 // when skipping frames, make sure to never skip the last frame, as
737 // this may be needed for animations to reach a defined end state;
738 // furthermore, we assume that this function is called at the end
739 // of a "for" loop, which continues by incrementing the loop variable
740 // by one before checking the loop condition again; therefore we have
741 // to check against the last loop value minus one here
745 if (*loop_var < last_loop_value) // never skip the last frame
747 *loop_var += skip_frames;
749 if (*loop_var > last_loop_value) // never skip the last frame
750 *loop_var = last_loop_value;
755 // ----------------------------------------------------------------------------
756 // random generator functions
757 // ----------------------------------------------------------------------------
759 static unsigned int init_random_number_ext(int nr, int seed)
761 if (seed == NEW_RANDOMIZE)
763 // default random seed
764 seed = (int)time(NULL); // seconds since the epoch
766 #if !defined(PLATFORM_WIN32)
767 // add some more randomness
768 struct timeval current_time;
770 gettimeofday(¤t_time, NULL);
772 seed += (int)current_time.tv_usec; // microseconds since the epoch
775 // add some more randomness
776 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
778 // add some more randomness
779 seed += GetSimpleRandom(1000000);
782 srandom_linux_libc(nr, (unsigned int) seed);
784 return (unsigned int) seed;
787 static unsigned int prng_seed_gettimeofday(void)
789 struct timeval current_time;
791 gettimeofday(¤t_time, NULL);
793 prng_seed_bytes(¤t_time, sizeof(current_time));
798 unsigned int init_random_number(int nr, int seed)
800 return (nr == RANDOM_BETTER ? prng_seed_gettimeofday() :
801 init_random_number_ext(nr, seed));
804 static unsigned int get_random_number_ext(int nr)
806 return (nr == RANDOM_BETTER ? prng_get_uint() :
807 random_linux_libc(nr));
810 unsigned int get_random_number(int nr, int max)
812 return (max > 0 ? get_random_number_ext(nr) % max : 0);
816 // ----------------------------------------------------------------------------
817 // system info functions
818 // ----------------------------------------------------------------------------
820 #if !defined(PLATFORM_ANDROID)
821 static char *get_corrected_real_name(char *real_name)
823 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
824 char *from_ptr = real_name;
825 char *to_ptr = real_name_new;
827 // copy the name string, but not more than MAX_USERNAME_LEN characters
828 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
830 // the name field read from "passwd" file may also contain additional
831 // user information, separated by commas, which will be removed here
832 if (*from_ptr == ',')
835 // the user's real name may contain 'german sharp s' characters,
836 // which have no equivalent in upper case letters (used by our fonts)
837 if (*from_ptr == CHAR_BYTE_SHARP_S)
844 *to_ptr++ = *from_ptr++;
849 return real_name_new;
853 #if defined(PLATFORM_UNIX)
854 static struct passwd *getPasswdEntry(void)
856 #if defined(PLATFORM_EMSCRIPTEN)
857 // currently not fully supported; force fallback to default values
860 return getpwuid(getuid());
864 char *getUnixLoginName(void)
866 struct passwd *pwd = getPasswdEntry();
868 if (pwd != NULL && strlen(pwd->pw_name) != 0)
874 char *getUnixRealName(void)
876 struct passwd *pwd = getPasswdEntry();
878 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
879 return pwd->pw_gecos;
884 char *getUnixHomeDir(void)
886 struct passwd *pwd = getPasswdEntry();
888 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
895 char *getLoginName(void)
897 static char *login_name = NULL;
899 #if defined(PLATFORM_WIN32)
900 if (login_name == NULL)
902 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
904 login_name = checked_malloc(buffer_size);
906 if (GetUserName(login_name, &buffer_size) == 0)
907 strcpy(login_name, ANONYMOUS_NAME);
909 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
910 if (login_name == NULL)
912 char *name = getUnixLoginName();
915 login_name = getStringCopy(name);
917 login_name = ANONYMOUS_NAME;
920 login_name = ANONYMOUS_NAME;
926 char *getRealName(void)
928 static char *real_name = NULL;
930 #if defined(PLATFORM_WIN32)
931 if (real_name == NULL)
933 static char buffer[MAX_USERNAME_LEN + 1];
934 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
936 if (GetUserName(buffer, &buffer_size) != 0)
937 real_name = get_corrected_real_name(buffer);
939 real_name = ANONYMOUS_NAME;
941 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
942 if (real_name == NULL)
944 char *name = getUnixRealName();
947 real_name = get_corrected_real_name(name);
949 real_name = ANONYMOUS_NAME;
952 real_name = ANONYMOUS_NAME;
958 char *getFixedUserName(char *name)
960 // needed because player name must be a fixed length string
961 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
963 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
964 name_new[MAX_PLAYER_NAME_LEN] = '\0';
966 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
967 if (strchr(name_new, ' '))
968 *strchr(name_new, ' ') = '\0';
973 char *getDefaultUserName(int nr)
975 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
977 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
979 if (user_name[nr] == NULL)
981 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
982 user_name[nr] = getFixedUserName(user_name[nr]);
985 return user_name[nr];
988 char *getTimestampFromEpoch(time_t epoch_seconds)
990 struct tm *now = localtime(&epoch_seconds);
991 static char timestamp[20];
993 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
994 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
995 now->tm_hour, now->tm_min, now->tm_sec);
1000 char *getCurrentTimestamp(void)
1002 return getTimestampFromEpoch(time(NULL));
1005 time_t getFileTimestampEpochSeconds(char *filename)
1007 struct stat file_status;
1009 if (stat(filename, &file_status) != 0) // cannot stat file
1012 return file_status.st_mtime;
1016 // ----------------------------------------------------------------------------
1017 // path manipulation functions
1018 // ----------------------------------------------------------------------------
1020 static char *getLastPathSeparatorPtr(char *filename)
1022 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1024 if (last_separator == NULL) // also try DOS/Windows variant
1025 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1027 return last_separator;
1030 char *getBaseNamePtr(char *filename)
1032 char *last_separator = getLastPathSeparatorPtr(filename);
1034 if (last_separator != NULL)
1035 return last_separator + 1; // separator found: strip base path
1037 return filename; // no separator found: filename has no path
1040 char *getBaseName(char *filename)
1042 return getStringCopy(getBaseNamePtr(filename));
1045 char *getBaseNameNoSuffix(char *filename)
1047 char *basename = getStringCopy(getBaseNamePtr(filename));
1049 // remove trailing suffix (separated by dot or hyphen)
1050 if (basename[0] != '.' && basename[0] != '-')
1052 if (strchr(basename, '.') != NULL)
1053 *strchr(basename, '.') = '\0';
1055 if (strchr(basename, '-') != NULL)
1056 *strchr(basename, '-') = '\0';
1062 char *getBasePath(char *filename)
1064 char *basepath = getStringCopy(filename);
1065 char *last_separator = getLastPathSeparatorPtr(basepath);
1067 // if no separator was found, use current directory
1068 if (last_separator == NULL)
1072 return getStringCopy(".");
1075 // separator found: strip basename
1076 *last_separator = '\0';
1082 // ----------------------------------------------------------------------------
1083 // various string functions
1084 // ----------------------------------------------------------------------------
1086 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1088 if (s1 == NULL || s2 == NULL || sep == NULL)
1091 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1094 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1096 return complete_string;
1099 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1101 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1104 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1105 strlen(s2) + strlen(sep) +
1108 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1110 return complete_string;
1113 char *getStringCat2(char *s1, char *s2)
1115 return getStringCat2WithSeparator(s1, s2, "");
1118 char *getStringCat3(char *s1, char *s2, char *s3)
1120 return getStringCat3WithSeparator(s1, s2, s3, "");
1123 char *getPath2(char *path1, char *path2)
1125 #if defined(PLATFORM_ANDROID)
1126 // workaround for reading from assets directory -- skip "." subdirs in path
1127 if (strEqual(path1, "."))
1128 return getStringCopy(path2);
1129 else if (strEqual(path2, "."))
1130 return getStringCopy(path1);
1133 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1136 char *getPath3(char *path1, char *path2, char *path3)
1138 #if defined(PLATFORM_ANDROID)
1139 // workaround for reading from assets directory -- skip "." subdirs in path
1140 if (strEqual(path1, "."))
1141 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1142 else if (strEqual(path2, "."))
1143 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1144 else if (strEqual(path3, "."))
1145 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1148 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1151 static char *getPngOrPcxIfNotExists(char *filename)
1153 // switch from PNG to PCX file and vice versa, if file does not exist
1154 // (backwards compatibility with PCX files used in previous versions)
1156 if (!fileExists(filename) && strSuffix(filename, ".png"))
1157 strcpy(&filename[strlen(filename) - 3], "pcx");
1158 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1159 strcpy(&filename[strlen(filename) - 3], "png");
1164 char *getImg2(char *path1, char *path2)
1166 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1169 char *getImg3(char *path1, char *path2, char *path3)
1171 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1174 char *getStringCopy(const char *s)
1181 s_copy = checked_malloc(strlen(s) + 1);
1187 char *getStringCopyN(const char *s, int n)
1190 int s_len = MAX(0, n);
1195 s_copy = checked_malloc(s_len + 1);
1196 strncpy(s_copy, s, s_len);
1197 s_copy[s_len] = '\0';
1202 char *getStringCopyNStatic(const char *s, int n)
1204 static char *s_copy = NULL;
1206 checked_free(s_copy);
1208 s_copy = getStringCopyN(s, n);
1213 char *getStringToLower(const char *s)
1215 char *s_copy = checked_malloc(strlen(s) + 1);
1216 char *s_ptr = s_copy;
1219 *s_ptr++ = tolower(*s++);
1225 void setString(char **old_value, char *new_value)
1227 checked_free(*old_value);
1229 *old_value = getStringCopy(new_value);
1232 boolean strEqual(char *s1, char *s2)
1234 return (s1 == NULL && s2 == NULL ? TRUE :
1235 s1 == NULL && s2 != NULL ? FALSE :
1236 s1 != NULL && s2 == NULL ? FALSE :
1237 strcmp(s1, s2) == 0);
1240 boolean strEqualN(char *s1, char *s2, int n)
1242 return (s1 == NULL && s2 == NULL ? TRUE :
1243 s1 == NULL && s2 != NULL ? FALSE :
1244 s1 != NULL && s2 == NULL ? FALSE :
1245 strncmp(s1, s2, n) == 0);
1248 boolean strEqualCase(char *s1, char *s2)
1250 return (s1 == NULL && s2 == NULL ? TRUE :
1251 s1 == NULL && s2 != NULL ? FALSE :
1252 s1 != NULL && s2 == NULL ? FALSE :
1253 strcasecmp(s1, s2) == 0);
1256 boolean strEqualCaseN(char *s1, char *s2, int n)
1258 return (s1 == NULL && s2 == NULL ? TRUE :
1259 s1 == NULL && s2 != NULL ? FALSE :
1260 s1 != NULL && s2 == NULL ? FALSE :
1261 strncasecmp(s1, s2, n) == 0);
1264 boolean strPrefix(char *s, char *prefix)
1266 return (s == NULL && prefix == NULL ? TRUE :
1267 s == NULL && prefix != NULL ? FALSE :
1268 s != NULL && prefix == NULL ? FALSE :
1269 strncmp(s, prefix, strlen(prefix)) == 0);
1272 boolean strSuffix(char *s, char *suffix)
1274 return (s == NULL && suffix == NULL ? TRUE :
1275 s == NULL && suffix != NULL ? FALSE :
1276 s != NULL && suffix == NULL ? FALSE :
1277 strlen(s) < strlen(suffix) ? FALSE :
1278 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1281 boolean strPrefixLower(char *s, char *prefix)
1283 char *s_lower = getStringToLower(s);
1284 boolean match = strPrefix(s_lower, prefix);
1291 boolean strSuffixLower(char *s, char *suffix)
1293 char *s_lower = getStringToLower(s);
1294 boolean match = strSuffix(s_lower, suffix);
1301 boolean isURL(char *s)
1303 while (*s && *s >= 'a' && *s <= 'z')
1306 return strPrefix(s, "://");
1310 // ----------------------------------------------------------------------------
1311 // command line option handling functions
1312 // ----------------------------------------------------------------------------
1314 void GetOptions(int argc, char *argv[],
1315 void (*print_usage_function)(void),
1316 void (*print_version_function)(void))
1318 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1319 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1320 char **options_left = &argvplus[1];
1322 // replace original "argv" with null-terminated array of string pointers
1324 argvplus[argc] = argv[argc];
1326 // initialize global program options
1327 options.server_host = NULL;
1328 options.server_port = 0;
1330 options.base_directory = base_path;
1332 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1333 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1334 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1335 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1336 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1337 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1339 options.execute_command = NULL;
1340 options.tape_log_filename = NULL;
1341 options.special_flags = NULL;
1342 options.debug_mode = NULL;
1343 options.player_name = NULL;
1344 options.identifier = NULL;
1345 options.level_nr = NULL;
1347 options.mytapes = FALSE;
1348 options.serveronly = FALSE;
1349 options.network = FALSE;
1350 options.verbose = FALSE;
1351 options.debug = FALSE;
1354 options.verbose = TRUE;
1356 #if !defined(PLATFORM_UNIX)
1357 if (*options_left == NULL) // no options given -- enable verbose mode
1358 options.verbose = TRUE;
1363 #if defined(PLATFORM_ANDROID)
1364 options.debug = TRUE;
1368 while (*options_left)
1370 char option_str[MAX_OPTION_LEN];
1371 char *option = options_left[0];
1372 char *next_option = options_left[1];
1373 char *option_arg = NULL;
1374 int option_len = strlen(option);
1376 if (option_len >= MAX_OPTION_LEN)
1377 FailWithHelp("unrecognized option '%s'", option);
1379 strcpy(option_str, option); // copy argument into buffer
1380 option = option_str;
1382 if (strEqual(option, "--")) // stop scanning arguments
1385 if (strPrefix(option, "--")) // treat '--' like '-'
1388 option_arg = strchr(option, '=');
1389 if (option_arg == NULL) // no '=' in option
1390 option_arg = next_option;
1393 *option_arg++ = '\0'; // cut argument from option
1394 if (*option_arg == '\0') // no argument after '='
1395 FailWithHelp("option '%s' has invalid argument", option_str);
1398 option_len = strlen(option);
1400 if (strEqual(option, "-"))
1402 FailWithHelp("unrecognized option '%s'", option);
1404 else if (strncmp(option, "-help", option_len) == 0)
1406 print_usage_function();
1410 else if (strncmp(option, "-basepath", option_len) == 0)
1412 if (option_arg == NULL)
1413 FailWithHelp("option '%s' requires an argument", option_str);
1415 options.base_directory = base_path = getStringCopy(option_arg);
1416 if (option_arg == next_option)
1419 // adjust paths for sub-directories in base directory accordingly
1420 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1421 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1422 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1423 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1424 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1425 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1427 else if (strncmp(option, "-levels", option_len) == 0)
1429 if (option_arg == NULL)
1430 FailWithHelp("option '%s' requires an argument", option_str);
1432 options.level_directory = getStringCopy(option_arg);
1433 if (option_arg == next_option)
1436 else if (strncmp(option, "-graphics", option_len) == 0)
1438 if (option_arg == NULL)
1439 FailWithHelp("option '%s' requires an argument", option_str);
1441 options.graphics_directory = getStringCopy(option_arg);
1442 if (option_arg == next_option)
1445 else if (strncmp(option, "-sounds", option_len) == 0)
1447 if (option_arg == NULL)
1448 FailWithHelp("option '%s' requires an argument", option_str);
1450 options.sounds_directory = getStringCopy(option_arg);
1451 if (option_arg == next_option)
1454 else if (strncmp(option, "-music", option_len) == 0)
1456 if (option_arg == NULL)
1457 FailWithHelp("option '%s' requires an argument", option_str);
1459 options.music_directory = getStringCopy(option_arg);
1460 if (option_arg == next_option)
1463 else if (strncmp(option, "-mytapes", option_len) == 0)
1465 options.mytapes = TRUE;
1467 else if (strncmp(option, "-network", option_len) == 0)
1469 options.network = TRUE;
1471 else if (strncmp(option, "-serveronly", option_len) == 0)
1473 options.serveronly = TRUE;
1475 else if (strncmp(option, "-debug", option_len) == 0)
1477 options.debug = TRUE;
1479 // optionally, debug output can be limited to a specific debug mode
1480 if (option_arg != next_option)
1481 options.debug_mode = getStringCopy(option_arg);
1483 else if (strncmp(option, "-player-name", option_len) == 0)
1485 if (option_arg == NULL)
1486 FailWithHelp("option '%s' requires an argument", option_str);
1488 options.player_name = getStringCopy(option_arg);
1489 if (option_arg == next_option)
1492 else if (strncmp(option, "-identifier", option_len) == 0)
1494 if (option_arg == NULL)
1495 FailWithHelp("option '%s' requires an argument", option_str);
1497 options.identifier = getStringCopy(option_arg);
1498 if (option_arg == next_option)
1501 else if (strncmp(option, "-level-nr", option_len) == 0)
1503 if (option_arg == NULL)
1504 FailWithHelp("option '%s' requires an argument", option_str);
1506 options.level_nr = getStringCopy(option_arg);
1507 if (option_arg == next_option)
1510 else if (strncmp(option, "-verbose", option_len) == 0)
1512 options.verbose = TRUE;
1514 else if (strncmp(option, "-version", option_len) == 0 ||
1515 strncmp(option, "-V", option_len) == 0)
1517 print_version_function();
1521 else if (strPrefix(option, "-D"))
1523 options.special_flags = getStringCopy(&option[2]);
1525 else if (strncmp(option, "-execute", option_len) == 0)
1527 if (option_arg == NULL)
1528 FailWithHelp("option '%s' requires an argument", option_str);
1530 options.execute_command = getStringCopy(option_arg);
1531 if (option_arg == next_option)
1534 // when doing batch processing, always enable verbose mode (warnings)
1535 options.verbose = TRUE;
1537 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1539 if (option_arg == NULL)
1540 FailWithHelp("option '%s' requires an argument", option_str);
1542 options.tape_log_filename = getStringCopy(option_arg);
1543 if (option_arg == next_option)
1546 #if defined(PLATFORM_MACOSX)
1547 else if (strPrefix(option, "-psn"))
1549 // ignore process serial number when launched via GUI on Mac OS X
1552 else if (*option == '-')
1554 FailWithHelp("unrecognized option '%s'", option_str);
1556 else if (options.server_host == NULL)
1558 options.server_host = *options_left;
1560 else if (options.server_port == 0)
1562 options.server_port = atoi(*options_left);
1563 if (options.server_port < 1024)
1564 FailWithHelp("bad port number '%d'", options.server_port);
1567 FailWithHelp("too many arguments");
1574 // ----------------------------------------------------------------------------
1575 // checked memory allocation and freeing functions
1576 // ----------------------------------------------------------------------------
1578 void *checked_malloc(unsigned int size)
1585 Fail("cannot allocate %d bytes -- out of memory", size);
1590 void *checked_calloc(unsigned int size)
1594 ptr = calloc(1, size);
1597 Fail("cannot allocate %d bytes -- out of memory", size);
1602 void *checked_realloc(void *ptr, unsigned int size)
1604 ptr = realloc(ptr, size);
1607 Fail("cannot allocate %d bytes -- out of memory", size);
1612 void checked_free(void *ptr)
1614 if (ptr != NULL) // this check should be done by free() anyway
1618 void clear_mem(void *ptr, unsigned int size)
1620 #if defined(PLATFORM_WIN32)
1621 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1622 char *cptr = (char *)ptr;
1627 memset(ptr, 0, size);
1632 // ----------------------------------------------------------------------------
1633 // various helper functions
1634 // ----------------------------------------------------------------------------
1636 void swap_numbers(int *i1, int *i2)
1644 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1656 /* the "put" variants of the following file access functions check for the file
1657 pointer being != NULL and return the number of bytes they have or would have
1658 written; this allows for chunk writing functions to first determine the size
1659 of the (not yet written) chunk, write the correct chunk size and finally
1660 write the chunk itself */
1662 int getFile8BitInteger(File *file)
1664 return getByteFromFile(file);
1667 int putFile8BitInteger(FILE *file, int value)
1675 int getFile16BitInteger(File *file, int byte_order)
1677 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1678 return ((getByteFromFile(file) << 8) |
1679 (getByteFromFile(file) << 0));
1680 else // BYTE_ORDER_LITTLE_ENDIAN
1681 return ((getByteFromFile(file) << 0) |
1682 (getByteFromFile(file) << 8));
1685 int putFile16BitInteger(FILE *file, int value, int byte_order)
1689 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1691 fputc((value >> 8) & 0xff, file);
1692 fputc((value >> 0) & 0xff, file);
1694 else // BYTE_ORDER_LITTLE_ENDIAN
1696 fputc((value >> 0) & 0xff, file);
1697 fputc((value >> 8) & 0xff, file);
1704 int getFile32BitInteger(File *file, int byte_order)
1706 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1707 return ((getByteFromFile(file) << 24) |
1708 (getByteFromFile(file) << 16) |
1709 (getByteFromFile(file) << 8) |
1710 (getByteFromFile(file) << 0));
1711 else // BYTE_ORDER_LITTLE_ENDIAN
1712 return ((getByteFromFile(file) << 0) |
1713 (getByteFromFile(file) << 8) |
1714 (getByteFromFile(file) << 16) |
1715 (getByteFromFile(file) << 24));
1718 int putFile32BitInteger(FILE *file, int value, int byte_order)
1722 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1724 fputc((value >> 24) & 0xff, file);
1725 fputc((value >> 16) & 0xff, file);
1726 fputc((value >> 8) & 0xff, file);
1727 fputc((value >> 0) & 0xff, file);
1729 else // BYTE_ORDER_LITTLE_ENDIAN
1731 fputc((value >> 0) & 0xff, file);
1732 fputc((value >> 8) & 0xff, file);
1733 fputc((value >> 16) & 0xff, file);
1734 fputc((value >> 24) & 0xff, file);
1741 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1744 const int chunk_name_length = 4;
1747 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1750 if (chunk_size != NULL)
1753 *chunk_size = getFile32BitInteger(file, byte_order);
1756 return (checkEndOfFile(file) ? FALSE : TRUE);
1759 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1766 fputs(chunk_name, file);
1768 num_bytes += strlen(chunk_name);
1770 if (chunk_size >= 0)
1774 putFile32BitInteger(file, chunk_size, byte_order);
1782 int getFileVersion(File *file)
1784 int version_super = getByteFromFile(file);
1785 int version_major = getByteFromFile(file);
1786 int version_minor = getByteFromFile(file);
1787 int version_patch = getByteFromFile(file);
1789 return VERSION_IDENT(version_super, version_major, version_minor,
1793 int putFileVersion(FILE *file, int version)
1797 int version_super = VERSION_SUPER(version);
1798 int version_major = VERSION_MAJOR(version);
1799 int version_minor = VERSION_MINOR(version);
1800 int version_patch = VERSION_PATCH(version);
1802 fputc(version_super, file);
1803 fputc(version_major, file);
1804 fputc(version_minor, file);
1805 fputc(version_patch, file);
1811 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1815 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1816 buffer[i] = getByteFromFile(file);
1819 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1823 for (i = 0; i < bytes; i++)
1824 fputc(buffer[i], file);
1827 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1829 while (bytes-- && !checkEndOfFile(file))
1830 getByteFromFile(file);
1833 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1840 // ----------------------------------------------------------------------------
1841 // functions to convert between ISO-8859-1 and UTF-8
1842 // ----------------------------------------------------------------------------
1844 char *getUTF8FromLatin1(char *latin1)
1846 int max_utf8_size = 2 * strlen(latin1) + 1;
1847 char *utf8 = checked_calloc(max_utf8_size);
1848 unsigned char *src = (unsigned char *)latin1;
1849 unsigned char *dst = (unsigned char *)utf8;
1853 if (*src < 128) // pure 7-bit ASCII
1857 else if (*src >= 160) // non-ASCII characters
1859 *dst++ = 194 + (*src >= 192);
1860 *dst++ = 128 + (*src & 63);
1862 else // undefined in ISO-8859-1
1870 // only use the smallest possible string buffer size
1871 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1876 char *getLatin1FromUTF8(char *utf8)
1878 int max_latin1_size = strlen(utf8) + 1;
1879 char *latin1 = checked_calloc(max_latin1_size);
1880 unsigned char *src = (unsigned char *)utf8;
1881 unsigned char *dst = (unsigned char *)latin1;
1885 if (*src < 128) // pure 7-bit ASCII
1889 else if (src[0] == 194 &&
1890 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1895 else if (src[0] == 195 &&
1896 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1898 *dst++ = src[1] + 64;
1902 // all other UTF-8 characters are undefined in ISO-8859-1
1904 else if (src[0] >= 192 && src[0] < 224 &&
1905 src[1] >= 128 && src[1] < 192)
1910 else if (src[0] >= 224 && src[0] < 240 &&
1911 src[1] >= 128 && src[1] < 192 &&
1912 src[2] >= 128 && src[2] < 192)
1917 else if (src[0] >= 240 && src[0] < 248 &&
1918 src[1] >= 128 && src[1] < 192 &&
1919 src[2] >= 128 && src[2] < 192 &&
1920 src[3] >= 128 && src[3] < 192)
1925 else if (src[0] >= 248 && src[0] < 252 &&
1926 src[1] >= 128 && src[1] < 192 &&
1927 src[2] >= 128 && src[2] < 192 &&
1928 src[3] >= 128 && src[3] < 192 &&
1929 src[4] >= 128 && src[4] < 192)
1934 else if (src[0] >= 252 && src[0] < 254 &&
1935 src[1] >= 128 && src[1] < 192 &&
1936 src[2] >= 128 && src[2] < 192 &&
1937 src[3] >= 128 && src[3] < 192 &&
1938 src[4] >= 128 && src[4] < 192 &&
1939 src[5] >= 128 && src[5] < 192)
1951 // only use the smallest possible string buffer size
1952 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1957 int getTextEncoding(char *text)
1959 unsigned char *src = (unsigned char *)text;
1960 int encoding = TEXT_ENCODING_ASCII; // default: assume encoding is ASCII
1965 encoding = TEXT_ENCODING_UTF_8; // non-ASCII character: assume UTF-8
1971 else if (src[0] >= 192 && src[0] < 224 &&
1972 src[1] >= 128 && src[1] < 192)
1976 else if (src[0] >= 224 && src[0] < 240 &&
1977 src[1] >= 128 && src[1] < 192 &&
1978 src[2] >= 128 && src[2] < 192)
1982 else if (src[0] >= 240 && src[0] < 248 &&
1983 src[1] >= 128 && src[1] < 192 &&
1984 src[2] >= 128 && src[2] < 192 &&
1985 src[3] >= 128 && src[3] < 192)
1989 else if (src[0] >= 248 && src[0] < 252 &&
1990 src[1] >= 128 && src[1] < 192 &&
1991 src[2] >= 128 && src[2] < 192 &&
1992 src[3] >= 128 && src[3] < 192 &&
1993 src[4] >= 128 && src[4] < 192)
1997 else if (src[0] >= 252 && src[0] < 254 &&
1998 src[1] >= 128 && src[1] < 192 &&
1999 src[2] >= 128 && src[2] < 192 &&
2000 src[3] >= 128 && src[3] < 192 &&
2001 src[4] >= 128 && src[4] < 192 &&
2002 src[5] >= 128 && src[5] < 192)
2008 return TEXT_ENCODING_UNKNOWN; // non-UTF-8 character: unknown encoding
2016 // ----------------------------------------------------------------------------
2017 // functions for JSON handling
2018 // ----------------------------------------------------------------------------
2020 char *getEscapedJSON(char *s)
2022 int max_json_size = 2 * strlen(s) + 1;
2023 char *json = checked_calloc(max_json_size);
2024 unsigned char *src = (unsigned char *)s;
2025 unsigned char *dst = (unsigned char *)json;
2026 char *escaped[256] =
2039 if (escaped[*src] != NULL)
2041 char *esc = escaped[*src++];
2052 // only use the smallest possible string buffer size
2053 json = checked_realloc(json, strlen(json) + 1);
2059 // ----------------------------------------------------------------------------
2060 // functions to translate key identifiers between different format
2061 // ----------------------------------------------------------------------------
2063 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
2064 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
2065 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
2066 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
2068 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2077 // return and escape keys
2078 { KSYM_Return, "XK_Return", "return" },
2079 { KSYM_Escape, "XK_Escape", "escape" },
2081 // normal cursor keys
2082 { KSYM_Left, "XK_Left", "cursor left" },
2083 { KSYM_Right, "XK_Right", "cursor right" },
2084 { KSYM_Up, "XK_Up", "cursor up" },
2085 { KSYM_Down, "XK_Down", "cursor down" },
2087 // keypad cursor keys
2089 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
2090 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
2091 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
2092 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
2095 // other keypad keys
2096 #ifdef KSYM_KP_Enter
2097 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
2098 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
2099 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
2100 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
2101 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
2102 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
2106 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
2107 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2108 { KSYM_Control_L, "XK_Control_L", "left control" },
2109 { KSYM_Control_R, "XK_Control_R", "right control" },
2110 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2111 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2112 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2113 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2114 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2115 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2117 // some special keys
2118 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2119 { KSYM_Delete, "XK_Delete", "delete" },
2120 { KSYM_Insert, "XK_Insert", "insert" },
2121 { KSYM_Tab, "XK_Tab", "tab" },
2122 { KSYM_Home, "XK_Home", "home" },
2123 { KSYM_End, "XK_End", "end" },
2124 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2125 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2127 { KSYM_Select, "XK_Select", "select" },
2128 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2129 { KSYM_Back, "XK_Back", "back" }, // back key
2130 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2131 #if defined(PLATFORM_ANDROID)
2132 { KSYM_Rewind, "XK_Rewind", "rewind" },
2133 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2136 // ASCII 0x20 to 0x40 keys (except numbers)
2137 { KSYM_space, "XK_space", "space" },
2138 { KSYM_exclam, "XK_exclam", "!" },
2139 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2140 { KSYM_numbersign, "XK_numbersign", "#" },
2141 { KSYM_dollar, "XK_dollar", "$" },
2142 { KSYM_percent, "XK_percent", "%" },
2143 { KSYM_ampersand, "XK_ampersand", "&" },
2144 { KSYM_apostrophe, "XK_apostrophe", "'" },
2145 { KSYM_parenleft, "XK_parenleft", "(" },
2146 { KSYM_parenright, "XK_parenright", ")" },
2147 { KSYM_asterisk, "XK_asterisk", "*" },
2148 { KSYM_plus, "XK_plus", "+" },
2149 { KSYM_comma, "XK_comma", "," },
2150 { KSYM_minus, "XK_minus", "-" },
2151 { KSYM_period, "XK_period", "." },
2152 { KSYM_slash, "XK_slash", "/" },
2153 { KSYM_colon, "XK_colon", ":" },
2154 { KSYM_semicolon, "XK_semicolon", ";" },
2155 { KSYM_less, "XK_less", "<" },
2156 { KSYM_equal, "XK_equal", "=" },
2157 { KSYM_greater, "XK_greater", ">" },
2158 { KSYM_question, "XK_question", "?" },
2159 { KSYM_at, "XK_at", "@" },
2162 { KSYM_bracketleft, "XK_bracketleft", "[" },
2163 { KSYM_backslash, "XK_backslash", "\\" },
2164 { KSYM_bracketright,"XK_bracketright", "]" },
2165 { KSYM_asciicircum, "XK_asciicircum", "^" },
2166 { KSYM_underscore, "XK_underscore", "_" },
2167 { KSYM_grave, "XK_grave", "grave" },
2168 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2169 { KSYM_braceleft, "XK_braceleft", "brace left" },
2170 { KSYM_bar, "XK_bar", "bar" },
2171 { KSYM_braceright, "XK_braceright", "brace right" },
2172 { KSYM_asciitilde, "XK_asciitilde", "~" },
2174 // special (non-ASCII) keys
2175 { KSYM_degree, "XK_degree", "degree" },
2176 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2177 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2178 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2179 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2180 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2181 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2182 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2184 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2185 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2186 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2187 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2188 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2189 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2190 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2191 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2192 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2194 // other keys (for reverse mapping only)
2195 { KSYM_space, "XK_space", " " },
2197 // keypad keys are not in numerical order in SDL2
2198 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2199 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2200 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2201 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2202 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2203 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2204 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2205 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2206 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2207 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2209 // end-of-array identifier
2215 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2217 static char name_buffer[30];
2220 if (key >= KSYM_A && key <= KSYM_Z)
2221 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2222 else if (key >= KSYM_a && key <= KSYM_z)
2223 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2224 else if (key >= KSYM_0 && key <= KSYM_9)
2225 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2226 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2227 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2228 else if (key == KSYM_UNDEFINED)
2229 strcpy(name_buffer, "(undefined)");
2236 if (key == translate_key[i].key)
2238 strcpy(name_buffer, translate_key[i].name);
2242 while (translate_key[++i].name);
2244 if (!translate_key[i].name)
2245 strcpy(name_buffer, "(unknown)");
2248 *name = name_buffer;
2250 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2252 static char name_buffer[30];
2255 if (key >= KSYM_A && key <= KSYM_Z)
2256 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2257 else if (key >= KSYM_a && key <= KSYM_z)
2258 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2259 else if (key >= KSYM_0 && key <= KSYM_9)
2260 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2261 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2262 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2263 else if (key == KSYM_UNDEFINED)
2264 strcpy(name_buffer, "[undefined]");
2271 if (key == translate_key[i].key)
2273 strcpy(name_buffer, translate_key[i].x11name);
2277 while (translate_key[++i].x11name);
2279 if (!translate_key[i].x11name)
2280 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2283 *x11name = name_buffer;
2285 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2287 Key key = KSYM_UNDEFINED;
2288 char *name_ptr = *name;
2290 if (strlen(*name) == 1)
2292 char c = name_ptr[0];
2294 if (c >= 'A' && c <= 'Z')
2295 key = KSYM_A + (Key)(c - 'A');
2296 else if (c >= 'a' && c <= 'z')
2297 key = KSYM_a + (Key)(c - 'a');
2298 else if (c >= '0' && c <= '9')
2299 key = KSYM_0 + (Key)(c - '0');
2302 if (key == KSYM_UNDEFINED)
2308 if (strEqual(translate_key[i].name, *name))
2310 key = translate_key[i].key;
2314 while (translate_key[++i].x11name);
2317 if (key == KSYM_UNDEFINED)
2318 Warn("getKeyFromKeyName(): not completely implemented");
2322 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2324 Key key = KSYM_UNDEFINED;
2325 char *name_ptr = *x11name;
2327 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2329 char c = name_ptr[3];
2331 if (c >= 'A' && c <= 'Z')
2332 key = KSYM_A + (Key)(c - 'A');
2333 else if (c >= 'a' && c <= 'z')
2334 key = KSYM_a + (Key)(c - 'a');
2335 else if (c >= '0' && c <= '9')
2336 key = KSYM_0 + (Key)(c - '0');
2338 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2340 char c1 = name_ptr[4];
2341 char c2 = name_ptr[5];
2344 if ((c1 >= '0' && c1 <= '9') &&
2345 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2346 d = atoi(&name_ptr[4]);
2348 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2349 key = KSYM_F1 + (Key)(d - 1);
2351 else if (strPrefix(name_ptr, "XK_"))
2357 if (strEqual(name_ptr, translate_key[i].x11name))
2359 key = translate_key[i].key;
2363 while (translate_key[++i].x11name);
2365 else if (strPrefix(name_ptr, "0x"))
2367 unsigned int value = 0;
2373 char c = *name_ptr++;
2376 if (c >= '0' && c <= '9')
2378 else if (c >= 'a' && c <= 'f')
2379 d = (int)(c - 'a' + 10);
2380 else if (c >= 'A' && c <= 'F')
2381 d = (int)(c - 'A' + 10);
2389 value = value * 16 + d;
2400 char *getKeyNameFromKey(Key key)
2404 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2408 char *getX11KeyNameFromKey(Key key)
2412 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2416 Key getKeyFromKeyName(char *name)
2420 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2424 Key getKeyFromX11KeyName(char *x11name)
2428 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2432 char getCharFromKey(Key key)
2438 } translate_key_char[] =
2440 // special (non-ASCII) keys (ISO-8859-1)
2441 { KSYM_degree, CHAR_BYTE_DEGREE },
2442 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2443 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2444 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2445 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2446 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2447 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2448 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2450 // end-of-array identifier
2454 char *keyname = getKeyNameFromKey(key);
2457 if (strlen(keyname) == 1)
2459 else if (strEqual(keyname, "space"))
2467 if (key == translate_key_char[i].key)
2469 c = translate_key_char[i].key_char;
2474 while (translate_key_char[++i].key_char);
2480 char getValidConfigValueChar(char c)
2482 if (c == '#' || // used to mark comments
2483 c == '\\') // used to mark continued lines
2490 // ----------------------------------------------------------------------------
2491 // functions to translate string identifiers to integer or boolean value
2492 // ----------------------------------------------------------------------------
2494 int get_integer_from_string(char *s)
2496 // check for the most common case first
2497 if (s[0] >= '0' && s[0] <= '9')
2500 char *s_lower = getStringToLower(s);
2503 if (strEqual(s_lower, "false") ||
2504 strEqual(s_lower, "no") ||
2505 strEqual(s_lower, "off"))
2507 else if (strEqual(s_lower, "true") ||
2508 strEqual(s_lower, "yes") ||
2509 strEqual(s_lower, "on"))
2519 boolean get_boolean_from_string(char *s)
2521 char *s_lower = getStringToLower(s);
2522 boolean result = FALSE;
2524 if (strEqual(s_lower, "true") ||
2525 strEqual(s_lower, "yes") ||
2526 strEqual(s_lower, "on") ||
2527 get_integer_from_string(s) == 1)
2535 int get_switch3_from_string(char *s)
2537 char *s_lower = getStringToLower(s);
2540 if (strEqual(s_lower, "true") ||
2541 strEqual(s_lower, "yes") ||
2542 strEqual(s_lower, "on") ||
2543 get_integer_from_string(s) == 1)
2545 else if (strEqual(s_lower, "auto"))
2553 int get_player_nr_from_string(char *s)
2555 static char *player_text[] =
2565 char *s_lower = getStringToLower(s);
2569 for (i = 0; player_text[i] != NULL; i++)
2570 if (strEqual(s_lower, player_text[i]))
2579 // ----------------------------------------------------------------------------
2580 // functions for generic lists
2581 // ----------------------------------------------------------------------------
2583 ListNode *newListNode(void)
2585 return checked_calloc(sizeof(ListNode));
2588 void addNodeToList(ListNode **node_first, char *key, void *content)
2590 ListNode *node_new = newListNode();
2592 node_new->key = getStringCopy(key);
2593 node_new->content = content;
2594 node_new->next = *node_first;
2597 (*node_first)->prev = node_new;
2599 *node_first = node_new;
2602 void deleteNodeFromList(ListNode **node_first, char *key,
2603 void (*destructor_function)(void *))
2605 if (node_first == NULL || *node_first == NULL)
2608 if (strEqual((*node_first)->key, key))
2610 // after first recursion, (*node_first)->prev->next == *node_first,
2611 // so *node_first would be overwritten with (*node_first)->next
2612 // => use a copy of *node_first (and later of (*node_first)->next)
2613 ListNode *node = *node_first;
2614 ListNode *node_next = node->next;
2616 checked_free(node->key);
2618 if (destructor_function)
2619 destructor_function(node->content);
2622 node->prev->next = node->next;
2625 node->next->prev = node->prev;
2629 // after removing node, set list pointer to next valid list node
2630 // (this is important if the first node of the list was deleted)
2631 *node_first = node_next;
2635 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2639 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2641 if (node_first == NULL)
2644 if (strEqual(node_first->key, key))
2647 return getNodeFromKey(node_first->next, key);
2650 int getNumNodes(ListNode *node_first)
2652 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2656 static void dumpList(ListNode *node_first)
2658 ListNode *node = node_first;
2662 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2663 ((struct ListNodeInfo *)node->content)->num_references);
2667 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2672 // ----------------------------------------------------------------------------
2673 // functions for file handling
2674 // ----------------------------------------------------------------------------
2676 #define MAX_BUFFER_SIZE 4096
2678 File *openFile(char *filename, char *mode)
2680 File *file = checked_calloc(sizeof(File));
2682 file->file = fopen(filename, mode);
2684 if (file->file != NULL)
2686 file->filename = getStringCopy(filename);
2691 #if defined(PLATFORM_ANDROID)
2692 file->asset_file = SDL_RWFromFile(filename, mode);
2694 if (file->asset_file != NULL)
2696 file->file_is_asset = TRUE;
2697 file->filename = getStringCopy(filename);
2708 int closeFile(File *file)
2715 #if defined(PLATFORM_ANDROID)
2716 if (file->asset_file)
2717 result = SDL_RWclose(file->asset_file);
2721 result = fclose(file->file);
2723 checked_free(file->filename);
2729 int checkEndOfFile(File *file)
2731 #if defined(PLATFORM_ANDROID)
2732 if (file->file_is_asset)
2733 return file->end_of_file;
2736 return feof(file->file);
2739 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2741 #if defined(PLATFORM_ANDROID)
2742 if (file->file_is_asset)
2744 if (file->end_of_file)
2747 size_t num_items_read =
2748 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2750 if (num_items_read < num_items)
2751 file->end_of_file = TRUE;
2753 return num_items_read;
2757 return fread(buffer, item_size, num_items, file->file);
2760 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2762 return fwrite(buffer, item_size, num_items, file->file);
2765 int seekFile(File *file, long offset, int whence)
2767 #if defined(PLATFORM_ANDROID)
2768 if (file->file_is_asset)
2770 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2771 whence == SEEK_CUR ? RW_SEEK_CUR :
2772 whence == SEEK_END ? RW_SEEK_END : 0);
2774 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2778 return fseek(file->file, offset, whence);
2781 int getByteFromFile(File *file)
2783 #if defined(PLATFORM_ANDROID)
2784 if (file->file_is_asset)
2786 if (file->end_of_file)
2790 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2792 if (num_bytes_read < 1)
2793 file->end_of_file = TRUE;
2795 return (file->end_of_file ? EOF : (int)c);
2799 return fgetc(file->file);
2802 char *getStringFromFile(File *file, char *line, int size)
2804 #if defined(PLATFORM_ANDROID)
2805 if (file->file_is_asset)
2807 if (file->end_of_file)
2810 char *line_ptr = line;
2811 int num_bytes_read = 0;
2813 while (num_bytes_read < size - 1 &&
2814 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2815 *line_ptr++ != '\n')
2820 if (strlen(line) == 0)
2822 file->end_of_file = TRUE;
2831 return fgets(line, size, file->file);
2834 int copyFile(char *filename_from, char *filename_to)
2836 File *file_from, *file_to;
2838 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2843 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2845 closeFile(file_from);
2850 while (!checkEndOfFile(file_from))
2852 byte buffer[MAX_BUFFER_SIZE];
2853 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2855 writeFile(file_to, buffer, 1, bytes_read);
2858 closeFile(file_from);
2864 boolean touchFile(char *filename)
2868 if (!(file = fopen(filename, MODE_WRITE)))
2870 Warn("cannot touch file '%s'", filename);
2881 // ----------------------------------------------------------------------------
2882 // functions for directory handling
2883 // ----------------------------------------------------------------------------
2885 Directory *openDirectory(char *dir_name)
2887 Directory *dir = checked_calloc(sizeof(Directory));
2889 dir->dir = opendir(dir_name);
2891 if (dir->dir != NULL)
2893 dir->filename = getStringCopy(dir_name);
2898 #if defined(PLATFORM_ANDROID)
2899 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2901 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2903 checked_free(asset_toc_filename);
2905 if (dir->asset_toc_file != NULL)
2907 dir->directory_is_asset = TRUE;
2908 dir->filename = getStringCopy(dir_name);
2919 int closeDirectory(Directory *dir)
2926 #if defined(PLATFORM_ANDROID)
2927 if (dir->asset_toc_file)
2928 result = SDL_RWclose(dir->asset_toc_file);
2932 result = closedir(dir->dir);
2935 freeDirectoryEntry(dir->dir_entry);
2937 checked_free(dir->filename);
2943 DirectoryEntry *readDirectory(Directory *dir)
2946 freeDirectoryEntry(dir->dir_entry);
2948 dir->dir_entry = NULL;
2950 #if defined(PLATFORM_ANDROID)
2951 if (dir->directory_is_asset)
2953 char line[MAX_LINE_LEN];
2954 char *line_ptr = line;
2955 int num_bytes_read = 0;
2957 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2958 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2967 if (strlen(line) == 0)
2970 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2972 dir->dir_entry->is_directory = FALSE;
2973 if (line[strlen(line) - 1] == '/')
2975 dir->dir_entry->is_directory = TRUE;
2977 line[strlen(line) - 1] = '\0';
2980 dir->dir_entry->basename = getStringCopy(line);
2981 dir->dir_entry->filename = getPath2(dir->filename, line);
2983 return dir->dir_entry;
2987 struct dirent *dir_entry = readdir(dir->dir);
2989 if (dir_entry == NULL)
2992 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2994 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2995 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2997 struct stat file_status;
2999 dir->dir_entry->is_directory =
3000 (stat(dir->dir_entry->filename, &file_status) == 0 &&
3001 S_ISDIR(file_status.st_mode));
3003 return dir->dir_entry;
3006 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3008 if (dir_entry == NULL)
3011 checked_free(dir_entry->basename);
3012 checked_free(dir_entry->filename);
3013 checked_free(dir_entry);
3017 // ----------------------------------------------------------------------------
3018 // functions for checking files and filenames
3019 // ----------------------------------------------------------------------------
3021 boolean directoryExists(char *dir_name)
3023 if (dir_name == NULL)
3026 struct stat file_status;
3027 boolean success = (stat(dir_name, &file_status) == 0 &&
3028 S_ISDIR(file_status.st_mode));
3030 #if defined(PLATFORM_ANDROID)
3033 // this might be an asset directory; check by trying to open toc file
3034 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3035 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3037 checked_free(asset_toc_filename);
3039 success = (file != NULL);
3049 boolean fileExists(char *filename)
3051 if (filename == NULL)
3054 boolean success = (access(filename, F_OK) == 0);
3056 #if defined(PLATFORM_ANDROID)
3059 // this might be an asset file; check by trying to open it
3060 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3062 success = (file != NULL);
3073 static boolean fileHasPrefix(char *basename, char *prefix)
3075 static char *basename_lower = NULL;
3076 int basename_length, prefix_length;
3078 checked_free(basename_lower);
3080 if (basename == NULL || prefix == NULL)
3083 basename_lower = getStringToLower(basename);
3084 basename_length = strlen(basename_lower);
3085 prefix_length = strlen(prefix);
3087 if (basename_length > prefix_length + 1 &&
3088 basename_lower[prefix_length] == '.' &&
3089 strncmp(basename_lower, prefix, prefix_length) == 0)
3096 static boolean fileHasSuffix(char *basename, char *suffix)
3098 static char *basename_lower = NULL;
3099 int basename_length, suffix_length;
3101 checked_free(basename_lower);
3103 if (basename == NULL || suffix == NULL)
3106 basename_lower = getStringToLower(basename);
3107 basename_length = strlen(basename_lower);
3108 suffix_length = strlen(suffix);
3110 if (basename_length > suffix_length + 1 &&
3111 basename_lower[basename_length - suffix_length - 1] == '.' &&
3112 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3118 static boolean FileCouldBeArtwork(char *filename)
3120 char *basename = getBaseNamePtr(filename);
3122 return (!strEqual(basename, ".") &&
3123 !strEqual(basename, "..") &&
3124 !fileHasSuffix(basename, "txt") &&
3125 !fileHasSuffix(basename, "conf") &&
3126 !directoryExists(filename));
3129 boolean FileIsGraphic(char *filename)
3131 return FileCouldBeArtwork(filename);
3134 boolean FileIsSound(char *filename)
3136 return FileCouldBeArtwork(filename);
3139 boolean FileIsMusic(char *filename)
3141 return FileCouldBeArtwork(filename);
3144 boolean FileIsArtworkType(char *filename, int type)
3146 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3147 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3148 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3154 // ----------------------------------------------------------------------------
3155 // functions for loading artwork configuration information
3156 // ----------------------------------------------------------------------------
3158 char *get_mapped_token(char *token)
3160 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3161 static char *map_token_prefix[][2] =
3163 { "char_procent", "char_percent" },
3164 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3165 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3166 { "bd_butterfly_left", "bd_butterfly.left" },
3167 { "bd_butterfly_right", "bd_butterfly.right" },
3168 { "bd_butterfly_up", "bd_butterfly.up" },
3169 { "bd_butterfly_down", "bd_butterfly.down" },
3170 { "bd_firefly_left", "bd_firefly.left" },
3171 { "bd_firefly_right", "bd_firefly.right" },
3172 { "bd_firefly_up", "bd_firefly.up" },
3173 { "bd_firefly_down", "bd_firefly.down" },
3179 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3181 int len_token_prefix = strlen(map_token_prefix[i][0]);
3183 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3184 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3187 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3188 char *gfx_substring = ".gfx";
3189 char *gfx_prefix = "gfx.";
3190 if (strstr(token, gfx_substring) != NULL)
3192 char *token_prefix = getStringCopy(token);
3193 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3194 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3197 // cut off token string at ".gfx" substring position
3198 *token_gfx_pos = '\0';
3200 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3201 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3205 return mapped_token;
3211 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3214 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3215 static struct ConfigTypeInfo prefix_list[] =
3217 { "global.anim_1" },
3218 { "global.anim_2" },
3219 { "global.anim_3" },
3220 { "global.anim_4" },
3221 { "global.anim_5" },
3222 { "global.anim_6" },
3223 { "global.anim_7" },
3224 { "global.anim_8" },
3225 { "global.anim_9" },
3226 { "global.anim_10" },
3227 { "global.anim_11" },
3228 { "global.anim_12" },
3229 { "global.anim_13" },
3230 { "global.anim_14" },
3231 { "global.anim_15" },
3232 { "global.anim_16" },
3233 { "global.anim_17" },
3234 { "global.anim_18" },
3235 { "global.anim_19" },
3236 { "global.anim_20" },
3237 { "global.anim_21" },
3238 { "global.anim_22" },
3239 { "global.anim_23" },
3240 { "global.anim_24" },
3241 { "global.anim_25" },
3242 { "global.anim_26" },
3243 { "global.anim_27" },
3244 { "global.anim_28" },
3245 { "global.anim_29" },
3246 { "global.anim_30" },
3247 { "global.anim_31" },
3248 { "global.anim_32" },
3252 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3253 boolean prefix_found = FALSE;
3257 // search for prefix to check if base token has to be created
3258 for (i = 0; prefix_list[i].token != NULL; i++)
3259 if (strPrefix(token, prefix_list[i].token))
3260 prefix_found = TRUE;
3265 // search for suffix (parameter) to determine base token length
3266 for (i = 0; suffix_list[i].token != NULL; i++)
3267 if (strSuffix(token, suffix_list[i].token))
3268 len_suffix = strlen(suffix_list[i].token);
3270 return getStringCopyN(token, strlen(token) - len_suffix);
3273 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3274 struct ListNodeInfo ***, int *);
3276 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3277 struct ConfigTypeInfo *suffix_list,
3278 char **ignore_tokens,
3279 int num_file_list_entries)
3281 SetupFileHash *ignore_tokens_hash;
3282 struct FileInfo *file_list;
3283 int num_file_list_entries_found = 0;
3284 int num_suffix_list_entries = 0;
3288 // create hash from list of tokens to be ignored (for quick access)
3289 ignore_tokens_hash = newSetupFileHash();
3290 for (i = 0; ignore_tokens[i] != NULL; i++)
3291 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3293 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3295 for (i = 0; suffix_list[i].token != NULL; i++)
3296 num_suffix_list_entries++;
3298 // always start with reliable default values
3299 for (i = 0; i < num_file_list_entries; i++)
3301 file_list[i].token = NULL;
3303 file_list[i].default_filename = NULL;
3304 file_list[i].filename = NULL;
3306 if (num_suffix_list_entries > 0)
3308 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3310 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3311 file_list[i].parameter = checked_calloc(parameter_array_size);
3313 for (j = 0; j < num_suffix_list_entries; j++)
3315 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3316 setString(&file_list[i].parameter[j], suffix_list[j].value);
3319 file_list[i].redefined = FALSE;
3320 file_list[i].fallback_to_default = FALSE;
3321 file_list[i].default_is_cloned = FALSE;
3327 for (i = 0; config_list[i].token != NULL; i++)
3329 int len_config_token = strlen(config_list[i].token);
3330 boolean is_file_entry = TRUE;
3332 for (j = 0; suffix_list[j].token != NULL; j++)
3334 int len_suffix = strlen(suffix_list[j].token);
3336 if (len_suffix < len_config_token &&
3337 strEqual(&config_list[i].token[len_config_token - len_suffix],
3338 suffix_list[j].token))
3340 setString(&file_list[list_pos].default_parameter[j],
3341 config_list[i].value);
3343 is_file_entry = FALSE;
3349 // the following tokens are no file definitions, but other config tokens
3350 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3351 is_file_entry = FALSE;
3358 if (list_pos >= num_file_list_entries)
3361 file_list[list_pos].token = config_list[i].token;
3362 file_list[list_pos].default_filename = config_list[i].value;
3365 if (strSuffix(config_list[i].token, ".clone_from"))
3366 file_list[list_pos].default_is_cloned = TRUE;
3369 num_file_list_entries_found = list_pos + 1;
3370 if (num_file_list_entries_found != num_file_list_entries)
3373 Error("inconsistant config list information:");
3374 Error("- should be: %d (according to 'src/conf_xxx.h')",
3375 num_file_list_entries);
3376 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3377 num_file_list_entries_found);
3382 freeSetupFileHash(ignore_tokens_hash);
3387 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3389 int len_token = strlen(token);
3390 int len_suffix = strlen(suffix);
3392 if (start_pos < 0) // compare suffix from end of string
3393 start_pos += len_token;
3395 if (start_pos < 0 || start_pos + len_suffix > len_token)
3398 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3401 if (token[start_pos + len_suffix] == '\0')
3404 if (token[start_pos + len_suffix] == '.')
3410 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3412 static void read_token_parameters(SetupFileHash *setup_file_hash,
3413 struct ConfigTypeInfo *suffix_list,
3414 struct FileInfo *file_list_entry)
3416 // check for config token that is the base token without any suffixes
3417 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3418 char *known_token_value = KNOWN_TOKEN_VALUE;
3421 if (filename != NULL)
3423 setString(&file_list_entry->filename, filename);
3425 // when file definition found, set all parameters to default values
3426 for (i = 0; suffix_list[i].token != NULL; i++)
3427 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3429 file_list_entry->redefined = TRUE;
3431 // mark config file token as well known from default config
3432 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3435 // check for config tokens that can be build by base token and suffixes
3436 for (i = 0; suffix_list[i].token != NULL; i++)
3438 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3439 char *value = getHashEntry(setup_file_hash, token);
3443 setString(&file_list_entry->parameter[i], value);
3445 // mark config file token as well known from default config
3446 setHashEntry(setup_file_hash, token, known_token_value);
3453 static void add_dynamic_file_list_entry(struct FileInfo **list,
3454 int *num_list_entries,
3455 SetupFileHash *extra_file_hash,
3456 struct ConfigTypeInfo *suffix_list,
3457 int num_suffix_list_entries,
3460 struct FileInfo *new_list_entry;
3461 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3463 (*num_list_entries)++;
3464 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3465 new_list_entry = &(*list)[*num_list_entries - 1];
3467 new_list_entry->token = getStringCopy(token);
3468 new_list_entry->default_filename = NULL;
3469 new_list_entry->filename = NULL;
3470 new_list_entry->parameter = checked_calloc(parameter_array_size);
3472 new_list_entry->redefined = FALSE;
3473 new_list_entry->fallback_to_default = FALSE;
3474 new_list_entry->default_is_cloned = FALSE;
3476 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3479 static void add_property_mapping(struct PropertyMapping **list,
3480 int *num_list_entries,
3481 int base_index, int ext1_index,
3482 int ext2_index, int ext3_index,
3485 struct PropertyMapping *new_list_entry;
3487 (*num_list_entries)++;
3488 *list = checked_realloc(*list,
3489 *num_list_entries * sizeof(struct PropertyMapping));
3490 new_list_entry = &(*list)[*num_list_entries - 1];
3492 new_list_entry->base_index = base_index;
3493 new_list_entry->ext1_index = ext1_index;
3494 new_list_entry->ext2_index = ext2_index;
3495 new_list_entry->ext3_index = ext3_index;
3497 new_list_entry->artwork_index = artwork_index;
3500 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3503 struct FileInfo *file_list = artwork_info->file_list;
3504 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3505 char **base_prefixes = artwork_info->base_prefixes;
3506 char **ext1_suffixes = artwork_info->ext1_suffixes;
3507 char **ext2_suffixes = artwork_info->ext2_suffixes;
3508 char **ext3_suffixes = artwork_info->ext3_suffixes;
3509 char **ignore_tokens = artwork_info->ignore_tokens;
3510 int num_file_list_entries = artwork_info->num_file_list_entries;
3511 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3512 int num_base_prefixes = artwork_info->num_base_prefixes;
3513 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3514 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3515 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3516 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3517 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3518 SetupFileHash *extra_file_hash, *empty_file_hash;
3519 char *known_token_value = KNOWN_TOKEN_VALUE;
3520 char *base_token_value = UNDEFINED_FILENAME;
3523 if (filename == NULL)
3526 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3529 // separate valid (defined) from empty (undefined) config token values
3530 valid_file_hash = newSetupFileHash();
3531 empty_file_hash = newSetupFileHash();
3532 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3534 char *value = HASH_ITERATION_VALUE(itr);
3536 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3537 HASH_ITERATION_TOKEN(itr), value);
3539 END_HASH_ITERATION(setup_file_hash, itr)
3541 // at this point, we do not need the setup file hash anymore -- free it
3542 freeSetupFileHash(setup_file_hash);
3544 // prevent changing hash while iterating over it by using a temporary copy
3545 valid_file_hash_tmp = newSetupFileHash();
3546 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3548 setHashEntry(valid_file_hash_tmp,
3549 HASH_ITERATION_TOKEN(itr),
3550 HASH_ITERATION_VALUE(itr));
3552 END_HASH_ITERATION(valid_file_hash, itr)
3554 // (iterate over same temporary hash, as modifications are independent)
3556 // map deprecated to current tokens (using prefix match and replace)
3557 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3559 char *token = HASH_ITERATION_TOKEN(itr);
3560 char *mapped_token = get_mapped_token(token);
3562 if (mapped_token != NULL)
3564 char *value = HASH_ITERATION_VALUE(itr);
3567 setHashEntry(valid_file_hash, mapped_token, value);
3569 // ignore old token (by setting it to "known" keyword)
3570 setHashEntry(valid_file_hash, token, known_token_value);
3575 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3577 // add special base tokens (using prefix match and replace)
3578 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3580 char *token = HASH_ITERATION_TOKEN(itr);
3581 char *base_token = get_special_base_token(artwork_info, token);
3583 if (base_token != NULL)
3585 // add base token only if it does not already exist
3586 if (getHashEntry(valid_file_hash, base_token) == NULL)
3587 setHashEntry(valid_file_hash, base_token, base_token_value);
3592 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3594 // free temporary hash used for iteration
3595 freeSetupFileHash(valid_file_hash_tmp);
3597 // read parameters for all known config file tokens
3598 for (i = 0; i < num_file_list_entries; i++)
3599 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3601 // set all tokens that can be ignored here to "known" keyword
3602 for (i = 0; i < num_ignore_tokens; i++)
3603 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3605 // copy all unknown config file tokens to extra config hash
3606 extra_file_hash = newSetupFileHash();
3607 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3609 char *value = HASH_ITERATION_VALUE(itr);
3611 if (!strEqual(value, known_token_value))
3612 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3614 END_HASH_ITERATION(valid_file_hash, itr)
3616 // at this point, we do not need the valid file hash anymore -- free it
3617 freeSetupFileHash(valid_file_hash);
3619 // now try to determine valid, dynamically defined config tokens
3621 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3623 struct FileInfo **dynamic_file_list =
3624 &artwork_info->dynamic_file_list;
3625 int *num_dynamic_file_list_entries =
3626 &artwork_info->num_dynamic_file_list_entries;
3627 struct PropertyMapping **property_mapping =
3628 &artwork_info->property_mapping;
3629 int *num_property_mapping_entries =
3630 &artwork_info->num_property_mapping_entries;
3631 int current_summarized_file_list_entry =
3632 artwork_info->num_file_list_entries +
3633 artwork_info->num_dynamic_file_list_entries;
3634 char *token = HASH_ITERATION_TOKEN(itr);
3635 int len_token = strlen(token);
3637 boolean base_prefix_found = FALSE;
3638 boolean parameter_suffix_found = FALSE;
3640 // skip all parameter definitions (handled by read_token_parameters())
3641 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3643 int len_suffix = strlen(suffix_list[i].token);
3645 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3646 parameter_suffix_found = TRUE;
3649 if (parameter_suffix_found)
3652 // ---------- step 0: search for matching base prefix ----------
3655 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3657 char *base_prefix = base_prefixes[i];
3658 int len_base_prefix = strlen(base_prefix);
3659 boolean ext1_suffix_found = FALSE;
3660 boolean ext2_suffix_found = FALSE;
3661 boolean ext3_suffix_found = FALSE;
3662 boolean exact_match = FALSE;
3663 int base_index = -1;
3664 int ext1_index = -1;
3665 int ext2_index = -1;
3666 int ext3_index = -1;
3668 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3670 if (!base_prefix_found)
3675 if (start_pos + len_base_prefix == len_token) // exact match
3679 add_dynamic_file_list_entry(dynamic_file_list,
3680 num_dynamic_file_list_entries,
3683 num_suffix_list_entries,
3685 add_property_mapping(property_mapping,
3686 num_property_mapping_entries,
3687 base_index, -1, -1, -1,
3688 current_summarized_file_list_entry);
3692 // ---------- step 1: search for matching first suffix ----------
3694 start_pos += len_base_prefix;
3695 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3697 char *ext1_suffix = ext1_suffixes[j];
3698 int len_ext1_suffix = strlen(ext1_suffix);
3700 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3702 if (!ext1_suffix_found)
3707 if (start_pos + len_ext1_suffix == len_token) // exact match
3711 add_dynamic_file_list_entry(dynamic_file_list,
3712 num_dynamic_file_list_entries,
3715 num_suffix_list_entries,
3717 add_property_mapping(property_mapping,
3718 num_property_mapping_entries,
3719 base_index, ext1_index, -1, -1,
3720 current_summarized_file_list_entry);
3724 start_pos += len_ext1_suffix;
3730 // ---------- step 2: search for matching second suffix ----------
3732 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3734 char *ext2_suffix = ext2_suffixes[k];
3735 int len_ext2_suffix = strlen(ext2_suffix);
3737 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3739 if (!ext2_suffix_found)
3744 if (start_pos + len_ext2_suffix == len_token) // exact match
3748 add_dynamic_file_list_entry(dynamic_file_list,
3749 num_dynamic_file_list_entries,
3752 num_suffix_list_entries,
3754 add_property_mapping(property_mapping,
3755 num_property_mapping_entries,
3756 base_index, ext1_index, ext2_index, -1,
3757 current_summarized_file_list_entry);
3761 start_pos += len_ext2_suffix;
3767 // ---------- step 3: search for matching third suffix ----------
3769 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3771 char *ext3_suffix = ext3_suffixes[l];
3772 int len_ext3_suffix = strlen(ext3_suffix);
3774 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3776 if (!ext3_suffix_found)
3781 if (start_pos + len_ext3_suffix == len_token) // exact match
3785 add_dynamic_file_list_entry(dynamic_file_list,
3786 num_dynamic_file_list_entries,
3789 num_suffix_list_entries,
3791 add_property_mapping(property_mapping,
3792 num_property_mapping_entries,
3793 base_index, ext1_index, ext2_index, ext3_index,
3794 current_summarized_file_list_entry);
3800 END_HASH_ITERATION(extra_file_hash, itr)
3802 if (artwork_info->num_dynamic_file_list_entries > 0)
3804 artwork_info->dynamic_artwork_list =
3805 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3806 artwork_info->sizeof_artwork_list_entry);
3809 if (options.verbose && IS_PARENT_PROCESS())
3811 SetupFileList *setup_file_list, *list;
3812 boolean dynamic_tokens_found = FALSE;
3813 boolean unknown_tokens_found = FALSE;
3814 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3816 // list may be NULL for empty artwork config files
3817 setup_file_list = loadSetupFileList(filename);
3819 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3821 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3822 dynamic_tokens_found = TRUE;
3824 unknown_tokens_found = TRUE;
3826 END_HASH_ITERATION(extra_file_hash, itr)
3828 if (options.debug && dynamic_tokens_found)
3830 Debug("config", "---");
3831 Debug("config", "dynamic token(s) found in config file:");
3832 Debug("config", "- config file: '%s'", filename);
3834 for (list = setup_file_list; list != NULL; list = list->next)
3836 char *value = getHashEntry(extra_file_hash, list->token);
3838 if (value != NULL && strEqual(value, known_token_value))
3839 Debug("config", "- dynamic token: '%s'", list->token);
3842 Debug("config", "---");
3845 if (unknown_tokens_found)
3848 Warn("unknown token(s) found in config file:");
3849 Warn("- config file: '%s'", filename);
3851 for (list = setup_file_list; list != NULL; list = list->next)
3853 char *value = getHashEntry(extra_file_hash, list->token);
3855 if (value != NULL && !strEqual(value, known_token_value))
3856 Warn("- dynamic token: '%s'", list->token);
3862 if (undefined_values_found)
3865 Warn("undefined values found in config file:");
3866 Warn("- config file: '%s'", filename);
3868 for (list = setup_file_list; list != NULL; list = list->next)
3870 char *value = getHashEntry(empty_file_hash, list->token);
3873 Warn("- undefined value for token: '%s'", list->token);
3879 freeSetupFileList(setup_file_list);
3882 freeSetupFileHash(extra_file_hash);
3883 freeSetupFileHash(empty_file_hash);
3886 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3888 struct FileInfo *file_list = artwork_info->file_list;
3889 int num_file_list_entries = artwork_info->num_file_list_entries;
3890 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3891 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3894 DrawInitTextHead("Loading artwork config");
3895 DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
3897 // always start with reliable default values
3898 for (i = 0; i < num_file_list_entries; i++)
3900 setString(&file_list[i].filename, file_list[i].default_filename);
3902 for (j = 0; j < num_suffix_list_entries; j++)
3903 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3905 file_list[i].redefined = FALSE;
3906 file_list[i].fallback_to_default = FALSE;
3909 // free previous dynamic artwork file array
3910 if (artwork_info->dynamic_file_list != NULL)
3912 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3914 free(artwork_info->dynamic_file_list[i].token);
3915 free(artwork_info->dynamic_file_list[i].filename);
3916 free(artwork_info->dynamic_file_list[i].parameter);
3919 free(artwork_info->dynamic_file_list);
3920 artwork_info->dynamic_file_list = NULL;
3922 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3923 &artwork_info->num_dynamic_file_list_entries);
3926 // free previous property mapping
3927 if (artwork_info->property_mapping != NULL)
3929 free(artwork_info->property_mapping);
3931 artwork_info->property_mapping = NULL;
3932 artwork_info->num_property_mapping_entries = 0;
3935 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3937 // first look for special artwork configured in level series config
3938 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3940 if (fileExists(filename_base))
3941 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3944 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3946 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3947 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3950 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3951 struct ListNodeInfo **listnode)
3955 char *filename = (*listnode)->source_filename;
3957 if (--(*listnode)->num_references <= 0)
3958 deleteNodeFromList(&artwork_info->content_list, filename,
3959 artwork_info->free_artwork);
3965 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3966 struct ListNodeInfo **listnode,
3967 struct FileInfo *file_list_entry)
3977 char *basename = file_list_entry->filename;
3978 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3980 // mark all images from non-default graphics directory as "redefined"
3981 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
3982 !strPrefix(filename, options.graphics_directory))
3983 file_list_entry->redefined = TRUE;
3985 if (filename == NULL)
3987 Warn("cannot find artwork file '%s'", basename);
3989 basename = file_list_entry->default_filename;
3991 // fail for cloned default artwork that has no default filename defined
3992 if (file_list_entry->default_is_cloned &&
3993 strEqual(basename, UNDEFINED_FILENAME))
3995 void (*error_func)(char *, ...) = Warn;
3997 // we can get away without sounds and music, but not without graphics
3998 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4001 error_func("token '%s' was cloned and has no default filename",
4002 file_list_entry->token);
4007 // dynamic artwork has no default filename / skip empty default artwork
4008 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4011 file_list_entry->fallback_to_default = TRUE;
4013 Warn("trying default artwork file '%s'", basename);
4015 filename = getCustomArtworkFilename(basename, artwork_info->type);
4017 if (filename == NULL)
4019 void (*error_func)(char *, ...) = Warn;
4021 // we can get away without sounds and music, but not without graphics
4022 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4025 error_func("cannot find default artwork file '%s'", basename);
4031 // check if the old and the new artwork file are the same
4032 if (*listnode && strEqual((*listnode)->source_filename, filename))
4034 // The old and new artwork are the same (have the same filename and path).
4035 // This usually means that this artwork does not exist in this artwork set
4036 // and a fallback to the existing artwork is done.
4041 // delete existing artwork file entry
4042 deleteArtworkListEntry(artwork_info, listnode);
4044 // check if the new artwork file already exists in the list of artwork
4045 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4047 *listnode = (struct ListNodeInfo *)node->content;
4048 (*listnode)->num_references++;
4053 DrawInitTextHead(init_text[artwork_info->type]);
4054 DrawInitTextItem(basename);
4056 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4058 // add new artwork file entry to the list of artwork files
4059 (*listnode)->num_references = 1;
4060 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4065 void (*error_func)(char *, ...) = Warn;
4067 // we can get away without sounds and music, but not without graphics
4068 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4071 error_func("cannot load artwork file '%s'", basename);
4077 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4078 struct ListNodeInfo **listnode,
4079 struct FileInfo *file_list_entry)
4081 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4083 deleteArtworkListEntry(artwork_info, listnode);
4088 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4091 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4093 struct FileInfo *file_list = artwork_info->file_list;
4094 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4095 int num_file_list_entries = artwork_info->num_file_list_entries;
4096 int num_dynamic_file_list_entries =
4097 artwork_info->num_dynamic_file_list_entries;
4100 print_timestamp_init("ReloadCustomArtworkList");
4102 for (i = 0; i < num_file_list_entries; i++)
4103 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4106 for (i = 0; i < num_dynamic_file_list_entries; i++)
4107 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4108 &dynamic_file_list[i]);
4110 print_timestamp_done("ReloadCustomArtworkList");
4113 dumpList(artwork_info->content_list);
4117 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4118 struct ListNodeInfo ***list,
4119 int *num_list_entries)
4126 for (i = 0; i < *num_list_entries; i++)
4127 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4131 *num_list_entries = 0;
4134 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4136 if (artwork_info == NULL)
4139 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4140 &artwork_info->num_file_list_entries);
4142 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4143 &artwork_info->num_dynamic_file_list_entries);
4147 // ----------------------------------------------------------------------------
4148 // functions only needed for non-Unix (non-command-line) systems
4149 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4150 // (now also added for Windows, to create files in user data directory)
4151 // ----------------------------------------------------------------------------
4153 char *getLogFilename(char *basename)
4155 return getPath2(getMainUserGameDataDir(), basename);
4158 void OpenLogFiles(void)
4162 InitMainUserDataDirectory();
4164 for (i = 0; i < NUM_LOGS; i++)
4166 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
4169 program.log_file[i] = program.log_file_default[i]; // reset to default
4171 Warn("cannot open file '%s' for writing: %s",
4172 program.log_filename[i], strerror(errno));
4175 // output should be unbuffered so it is not truncated in a crash
4176 setbuf(program.log_file[i], NULL);
4180 void CloseLogFiles(void)
4184 for (i = 0; i < NUM_LOGS; i++)
4185 if (program.log_file[i] != program.log_file_default[i])
4186 fclose(program.log_file[i]);
4189 void DumpLogFile(int nr)
4191 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
4193 if (log_file == NULL)
4196 while (!feof(log_file))
4197 fputc(fgetc(log_file), stdout);
4202 void NotifyUserAboutErrorFile(void)
4204 #if defined(PLATFORM_WIN32)
4205 char *title_text = getStringCat2(program.program_title, " Error Message");
4206 char *error_text = getStringCat2("The program was aborted due to an error; "
4207 "for details, see the following error file:"
4209 program.log_filename[LOG_ERR_ID]);
4211 MessageBox(NULL, error_text, title_text, MB_OK);
4216 // ----------------------------------------------------------------------------
4217 // the following is only for debugging purpose and normally not used
4218 // ----------------------------------------------------------------------------
4222 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4223 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4225 #define DEBUG_NUM_TIMESTAMPS 10
4226 #define DEBUG_TIME_IN_MICROSECONDS 0
4228 #if DEBUG_TIME_IN_MICROSECONDS
4229 static double Counter_Microseconds(void)
4231 static struct timeval base_time = { 0, 0 };
4232 struct timeval current_time;
4235 gettimeofday(¤t_time, NULL);
4237 // reset base time in case of wrap-around
4238 if (current_time.tv_sec < base_time.tv_sec)
4239 base_time = current_time;
4242 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4243 ((double)(current_time.tv_usec - base_time.tv_usec));
4245 return counter; // return microseconds since last init
4249 static char *debug_print_timestamp_get_padding(int padding_size)
4251 static char *padding = NULL;
4252 int max_padding_size = 100;
4254 if (padding == NULL)
4256 padding = checked_calloc(max_padding_size + 1);
4257 memset(padding, ' ', max_padding_size);
4260 return &padding[MAX(0, max_padding_size - padding_size)];
4263 void debug_print_timestamp(int counter_nr, char *message)
4265 int indent_size = 8;
4266 int padding_size = 40;
4267 float timestamp_interval;
4270 Fail("debugging: invalid negative counter");
4271 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4272 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4274 #if DEBUG_TIME_IN_MICROSECONDS
4275 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4278 counter[counter_nr][0] = Counter_Microseconds();
4280 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4283 counter[counter_nr][0] = Counter();
4286 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4287 counter[counter_nr][1] = counter[counter_nr][0];
4290 Debug("time:init", "%s%s%s %.3f %s",
4291 debug_print_timestamp_get_padding(counter_nr * indent_size),
4293 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4294 timestamp_interval / 1000,
4299 static void debug_print_parent_only(char *format, ...)
4301 if (!IS_PARENT_PROCESS())
4308 va_start(ap, format);
4309 vprintf(format, ap);
4319 static void print_timestamp_ext(char *message, char *mode)
4321 #if DEBUG_PRINT_INIT_TIMESTAMPS
4322 static char *debug_message = NULL;
4323 static char *last_message = NULL;
4324 static int counter_nr = 0;
4325 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4327 checked_free(debug_message);
4328 debug_message = getStringCat3(mode, " ", message);
4330 if (strEqual(mode, "INIT"))
4332 debug_print_timestamp(counter_nr, NULL);
4334 if (counter_nr + 1 < max_depth)
4335 debug_print_timestamp(counter_nr, debug_message);
4339 debug_print_timestamp(counter_nr, NULL);
4341 else if (strEqual(mode, "DONE"))
4345 if (counter_nr + 1 < max_depth ||
4346 (counter_nr == 0 && max_depth == 1))
4348 last_message = message;
4350 if (counter_nr == 0 && max_depth == 1)
4352 checked_free(debug_message);
4353 debug_message = getStringCat3("TIME", " ", message);
4356 debug_print_timestamp(counter_nr, debug_message);
4359 else if (!strEqual(mode, "TIME") ||
4360 !strEqual(message, last_message))
4362 if (counter_nr < max_depth)
4363 debug_print_timestamp(counter_nr, debug_message);
4368 void print_timestamp_init(char *message)
4370 print_timestamp_ext(message, "INIT");
4373 void print_timestamp_time(char *message)
4375 print_timestamp_ext(message, "TIME");
4378 void print_timestamp_done(char *message)
4380 print_timestamp_ext(message, "DONE");