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 char *getUUID(void)
562 static char uuid[UUID_LENGTH + 1];
563 int data[UUID_BYTES];
567 for (i = 0; i < UUID_BYTES; i++)
568 data[i] = GetSimpleRandom(256);
570 data[6] = 0x40 | (data[6] & 0x0f);
571 data[8] = 0x80 | (data[8] & 0x3f);
573 for (i = 0; i < UUID_BYTES; i++)
575 sprintf(&uuid[count], "%02x", data[i]);
578 if (i == 3 || i == 5 || i == 7 || i == 9)
579 strcat(&uuid[count++], "-");
585 char *GetPlayerUUID(void)
590 char *GetSystemUUID(void)
592 if (program.system_uuid != NULL)
593 return program.system_uuid;
598 void SetSystemUUID(char *uuid)
600 if (program.system_uuid != NULL)
601 checked_free(program.system_uuid);
603 program.system_uuid = getStringCopy(uuid);
607 // ----------------------------------------------------------------------------
609 // ----------------------------------------------------------------------------
611 // maximal allowed length of a command line option
612 #define MAX_OPTION_LEN 256
614 static unsigned int getCurrentMS(void)
616 return SDL_GetTicks();
619 static unsigned int mainCounter(int mode)
621 static unsigned int base_ms = 0;
622 unsigned int current_ms;
624 // get current system milliseconds
625 current_ms = getCurrentMS();
627 // reset base timestamp in case of counter reset or wrap-around
628 if (mode == INIT_COUNTER || current_ms < base_ms)
629 base_ms = current_ms;
631 // return milliseconds since last counter reset
632 return current_ms - base_ms;
635 void InitCounter() // set counter back to zero
637 mainCounter(INIT_COUNTER);
640 unsigned int Counter() // get milliseconds since last call of InitCounter()
642 return mainCounter(READ_COUNTER);
645 static void sleep_milliseconds(unsigned int milliseconds_delay)
647 SDL_Delay(milliseconds_delay);
650 void Delay(unsigned int delay) // Sleep specified number of milliseconds
652 sleep_milliseconds(delay);
655 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
656 unsigned int actual_counter)
658 if (actual_counter >= *counter_var &&
659 actual_counter < *counter_var + delay)
662 *counter_var = actual_counter;
667 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
669 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
672 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
674 return DelayReachedExt(counter_var, delay, Counter());
677 void ResetDelayCounterExt(unsigned int *counter_var,
678 unsigned int actual_counter)
680 DelayReachedExt(counter_var, 0, actual_counter);
683 void ResetFrameCounter(unsigned int *frame_counter_var)
685 FrameReached(frame_counter_var, 0);
688 void ResetDelayCounter(unsigned int *counter_var)
690 DelayReached(counter_var, 0);
693 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
695 unsigned int actual_counter;
700 actual_counter = Counter();
702 if (actual_counter >= *counter_var &&
703 actual_counter < *counter_var + delay)
704 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
709 if (*counter_var != 0 &&
711 actual_counter >= *counter_var + delay)
713 int lag = actual_counter - (*counter_var + delay);
714 int delay2 = (delay + 1) / 2;
717 skip_frames = (lag + delay2) / delay;
720 *counter_var = actual_counter;
725 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
726 int *loop_var, int last_loop_value)
728 int skip_frames = WaitUntilDelayReached(counter_var, delay);
733 Debug("internal:SkipUntilDelayReached",
734 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
736 skip_frames, skip_frames * delay);
738 Debug("internal:SkipUntilDelayReached",
744 if (skip_frames == 0)
747 // when skipping frames, make sure to never skip the last frame, as
748 // this may be needed for animations to reach a defined end state;
749 // furthermore, we assume that this function is called at the end
750 // of a "for" loop, which continues by incrementing the loop variable
751 // by one before checking the loop condition again; therefore we have
752 // to check against the last loop value minus one here
756 if (*loop_var < last_loop_value) // never skip the last frame
758 *loop_var += skip_frames;
760 if (*loop_var > last_loop_value) // never skip the last frame
761 *loop_var = last_loop_value;
766 // ----------------------------------------------------------------------------
767 // random generator functions
768 // ----------------------------------------------------------------------------
770 unsigned int init_random_number(int nr, int seed)
772 if (seed == NEW_RANDOMIZE)
774 // default random seed
775 seed = (int)time(NULL); // seconds since the epoch
777 #if !defined(PLATFORM_WIN32)
778 // add some more randomness
779 struct timeval current_time;
781 gettimeofday(¤t_time, NULL);
783 seed += (int)current_time.tv_usec; // microseconds since the epoch
786 // add some more randomness
787 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
789 // add some more randomness
790 seed += GetSimpleRandom(1000000);
793 srandom_linux_libc(nr, (unsigned int) seed);
795 return (unsigned int) seed;
798 unsigned int get_random_number(int nr, int max)
800 return (max > 0 ? random_linux_libc(nr) % max : 0);
804 // ----------------------------------------------------------------------------
805 // system info functions
806 // ----------------------------------------------------------------------------
808 #if !defined(PLATFORM_ANDROID)
809 static char *get_corrected_real_name(char *real_name)
811 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
812 char *from_ptr = real_name;
813 char *to_ptr = real_name_new;
815 // copy the name string, but not more than MAX_USERNAME_LEN characters
816 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
818 // the name field read from "passwd" file may also contain additional
819 // user information, separated by commas, which will be removed here
820 if (*from_ptr == ',')
823 // the user's real name may contain 'german sharp s' characters,
824 // which have no equivalent in upper case letters (used by our fonts)
825 if (*from_ptr == CHAR_BYTE_SHARP_S)
832 *to_ptr++ = *from_ptr++;
837 return real_name_new;
841 #if defined(PLATFORM_UNIX)
842 static struct passwd *getPasswdEntry(void)
844 #if defined(PLATFORM_EMSCRIPTEN)
845 // currently not fully supported; force fallback to default values
848 return getpwuid(getuid());
852 char *getUnixLoginName(void)
854 struct passwd *pwd = getPasswdEntry();
856 if (pwd != NULL && strlen(pwd->pw_name) != 0)
862 char *getUnixRealName(void)
864 struct passwd *pwd = getPasswdEntry();
866 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
867 return pwd->pw_gecos;
872 char *getUnixHomeDir(void)
874 struct passwd *pwd = getPasswdEntry();
876 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
883 char *getLoginName(void)
885 static char *login_name = NULL;
887 #if defined(PLATFORM_WIN32)
888 if (login_name == NULL)
890 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
892 login_name = checked_malloc(buffer_size);
894 if (GetUserName(login_name, &buffer_size) == 0)
895 strcpy(login_name, ANONYMOUS_NAME);
897 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
898 if (login_name == NULL)
900 char *name = getUnixLoginName();
903 login_name = getStringCopy(name);
905 login_name = ANONYMOUS_NAME;
908 login_name = ANONYMOUS_NAME;
914 char *getRealName(void)
916 static char *real_name = NULL;
918 #if defined(PLATFORM_WIN32)
919 if (real_name == NULL)
921 static char buffer[MAX_USERNAME_LEN + 1];
922 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
924 if (GetUserName(buffer, &buffer_size) != 0)
925 real_name = get_corrected_real_name(buffer);
927 real_name = ANONYMOUS_NAME;
929 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
930 if (real_name == NULL)
932 char *name = getUnixRealName();
935 real_name = get_corrected_real_name(name);
937 real_name = ANONYMOUS_NAME;
940 real_name = ANONYMOUS_NAME;
946 char *getFixedUserName(char *name)
948 // needed because player name must be a fixed length string
949 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
951 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
952 name_new[MAX_PLAYER_NAME_LEN] = '\0';
954 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
955 if (strchr(name_new, ' '))
956 *strchr(name_new, ' ') = '\0';
961 char *getDefaultUserName(int nr)
963 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
965 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
967 if (user_name[nr] == NULL)
969 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
970 user_name[nr] = getFixedUserName(user_name[nr]);
973 return user_name[nr];
976 char *getTimestampFromEpoch(time_t epoch_seconds)
978 struct tm *now = localtime(&epoch_seconds);
979 static char timestamp[20];
981 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
982 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
983 now->tm_hour, now->tm_min, now->tm_sec);
988 char *getCurrentTimestamp(void)
990 return getTimestampFromEpoch(time(NULL));
993 time_t getFileTimestampEpochSeconds(char *filename)
995 struct stat file_status;
997 if (stat(filename, &file_status) != 0) // cannot stat file
1000 return file_status.st_mtime;
1004 // ----------------------------------------------------------------------------
1005 // path manipulation functions
1006 // ----------------------------------------------------------------------------
1008 static char *getLastPathSeparatorPtr(char *filename)
1010 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
1012 if (last_separator == NULL) // also try DOS/Windows variant
1013 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
1015 return last_separator;
1018 char *getBaseNamePtr(char *filename)
1020 char *last_separator = getLastPathSeparatorPtr(filename);
1022 if (last_separator != NULL)
1023 return last_separator + 1; // separator found: strip base path
1025 return filename; // no separator found: filename has no path
1028 char *getBaseName(char *filename)
1030 return getStringCopy(getBaseNamePtr(filename));
1033 char *getBaseNameNoSuffix(char *filename)
1035 char *basename = getStringCopy(getBaseNamePtr(filename));
1037 // remove trailing suffix (separated by dot or hyphen)
1038 if (basename[0] != '.' && basename[0] != '-')
1040 if (strchr(basename, '.') != NULL)
1041 *strchr(basename, '.') = '\0';
1043 if (strchr(basename, '-') != NULL)
1044 *strchr(basename, '-') = '\0';
1050 char *getBasePath(char *filename)
1052 char *basepath = getStringCopy(filename);
1053 char *last_separator = getLastPathSeparatorPtr(basepath);
1055 // if no separator was found, use current directory
1056 if (last_separator == NULL)
1060 return getStringCopy(".");
1063 // separator found: strip basename
1064 *last_separator = '\0';
1070 // ----------------------------------------------------------------------------
1071 // various string functions
1072 // ----------------------------------------------------------------------------
1074 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1076 if (s1 == NULL || s2 == NULL || sep == NULL)
1079 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1082 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1084 return complete_string;
1087 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1089 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1092 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1093 strlen(s2) + strlen(sep) +
1096 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1098 return complete_string;
1101 char *getStringCat2(char *s1, char *s2)
1103 return getStringCat2WithSeparator(s1, s2, "");
1106 char *getStringCat3(char *s1, char *s2, char *s3)
1108 return getStringCat3WithSeparator(s1, s2, s3, "");
1111 char *getPath2(char *path1, char *path2)
1113 #if defined(PLATFORM_ANDROID)
1114 // workaround for reading from assets directory -- skip "." subdirs in path
1115 if (strEqual(path1, "."))
1116 return getStringCopy(path2);
1117 else if (strEqual(path2, "."))
1118 return getStringCopy(path1);
1121 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1124 char *getPath3(char *path1, char *path2, char *path3)
1126 #if defined(PLATFORM_ANDROID)
1127 // workaround for reading from assets directory -- skip "." subdirs in path
1128 if (strEqual(path1, "."))
1129 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1130 else if (strEqual(path2, "."))
1131 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1132 else if (strEqual(path3, "."))
1133 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1136 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1139 static char *getPngOrPcxIfNotExists(char *filename)
1141 // switch from PNG to PCX file and vice versa, if file does not exist
1142 // (backwards compatibility with PCX files used in previous versions)
1144 if (!fileExists(filename) && strSuffix(filename, ".png"))
1145 strcpy(&filename[strlen(filename) - 3], "pcx");
1146 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1147 strcpy(&filename[strlen(filename) - 3], "png");
1152 char *getImg2(char *path1, char *path2)
1154 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1157 char *getImg3(char *path1, char *path2, char *path3)
1159 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1162 char *getStringCopy(const char *s)
1169 s_copy = checked_malloc(strlen(s) + 1);
1175 char *getStringCopyN(const char *s, int n)
1178 int s_len = MAX(0, n);
1183 s_copy = checked_malloc(s_len + 1);
1184 strncpy(s_copy, s, s_len);
1185 s_copy[s_len] = '\0';
1190 char *getStringCopyNStatic(const char *s, int n)
1192 static char *s_copy = NULL;
1194 checked_free(s_copy);
1196 s_copy = getStringCopyN(s, n);
1201 char *getStringToLower(const char *s)
1203 char *s_copy = checked_malloc(strlen(s) + 1);
1204 char *s_ptr = s_copy;
1207 *s_ptr++ = tolower(*s++);
1213 void setString(char **old_value, char *new_value)
1215 checked_free(*old_value);
1217 *old_value = getStringCopy(new_value);
1220 boolean strEqual(char *s1, char *s2)
1222 return (s1 == NULL && s2 == NULL ? TRUE :
1223 s1 == NULL && s2 != NULL ? FALSE :
1224 s1 != NULL && s2 == NULL ? FALSE :
1225 strcmp(s1, s2) == 0);
1228 boolean strEqualN(char *s1, char *s2, int n)
1230 return (s1 == NULL && s2 == NULL ? TRUE :
1231 s1 == NULL && s2 != NULL ? FALSE :
1232 s1 != NULL && s2 == NULL ? FALSE :
1233 strncmp(s1, s2, n) == 0);
1236 boolean strEqualCase(char *s1, char *s2)
1238 return (s1 == NULL && s2 == NULL ? TRUE :
1239 s1 == NULL && s2 != NULL ? FALSE :
1240 s1 != NULL && s2 == NULL ? FALSE :
1241 strcasecmp(s1, s2) == 0);
1244 boolean strEqualCaseN(char *s1, char *s2, int n)
1246 return (s1 == NULL && s2 == NULL ? TRUE :
1247 s1 == NULL && s2 != NULL ? FALSE :
1248 s1 != NULL && s2 == NULL ? FALSE :
1249 strncasecmp(s1, s2, n) == 0);
1252 boolean strPrefix(char *s, char *prefix)
1254 return (s == NULL && prefix == NULL ? TRUE :
1255 s == NULL && prefix != NULL ? FALSE :
1256 s != NULL && prefix == NULL ? FALSE :
1257 strncmp(s, prefix, strlen(prefix)) == 0);
1260 boolean strSuffix(char *s, char *suffix)
1262 return (s == NULL && suffix == NULL ? TRUE :
1263 s == NULL && suffix != NULL ? FALSE :
1264 s != NULL && suffix == NULL ? FALSE :
1265 strlen(s) < strlen(suffix) ? FALSE :
1266 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1269 boolean strPrefixLower(char *s, char *prefix)
1271 char *s_lower = getStringToLower(s);
1272 boolean match = strPrefix(s_lower, prefix);
1279 boolean strSuffixLower(char *s, char *suffix)
1281 char *s_lower = getStringToLower(s);
1282 boolean match = strSuffix(s_lower, suffix);
1290 // ----------------------------------------------------------------------------
1291 // command line option handling functions
1292 // ----------------------------------------------------------------------------
1294 void GetOptions(int argc, char *argv[],
1295 void (*print_usage_function)(void),
1296 void (*print_version_function)(void))
1298 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1299 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1300 char **options_left = &argvplus[1];
1302 // replace original "argv" with null-terminated array of string pointers
1304 argvplus[argc] = argv[argc];
1306 // initialize global program options
1307 options.server_host = NULL;
1308 options.server_port = 0;
1310 options.base_directory = base_path;
1312 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1313 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1314 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1315 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1316 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1317 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1319 options.execute_command = NULL;
1320 options.tape_log_filename = NULL;
1321 options.special_flags = NULL;
1322 options.debug_mode = NULL;
1324 options.mytapes = FALSE;
1325 options.serveronly = FALSE;
1326 options.network = FALSE;
1327 options.verbose = FALSE;
1328 options.debug = FALSE;
1331 options.verbose = TRUE;
1333 #if !defined(PLATFORM_UNIX)
1334 if (*options_left == NULL) // no options given -- enable verbose mode
1335 options.verbose = TRUE;
1340 #if defined(PLATFORM_ANDROID)
1341 options.debug = TRUE;
1345 while (*options_left)
1347 char option_str[MAX_OPTION_LEN];
1348 char *option = options_left[0];
1349 char *next_option = options_left[1];
1350 char *option_arg = NULL;
1351 int option_len = strlen(option);
1353 if (option_len >= MAX_OPTION_LEN)
1354 FailWithHelp("unrecognized option '%s'", option);
1356 strcpy(option_str, option); // copy argument into buffer
1357 option = option_str;
1359 if (strEqual(option, "--")) // stop scanning arguments
1362 if (strPrefix(option, "--")) // treat '--' like '-'
1365 option_arg = strchr(option, '=');
1366 if (option_arg == NULL) // no '=' in option
1367 option_arg = next_option;
1370 *option_arg++ = '\0'; // cut argument from option
1371 if (*option_arg == '\0') // no argument after '='
1372 FailWithHelp("option '%s' has invalid argument", option_str);
1375 option_len = strlen(option);
1377 if (strEqual(option, "-"))
1379 FailWithHelp("unrecognized option '%s'", option);
1381 else if (strncmp(option, "-help", option_len) == 0)
1383 print_usage_function();
1387 else if (strncmp(option, "-basepath", option_len) == 0)
1389 if (option_arg == NULL)
1390 FailWithHelp("option '%s' requires an argument", option_str);
1392 options.base_directory = base_path = getStringCopy(option_arg);
1393 if (option_arg == next_option)
1396 // adjust paths for sub-directories in base directory accordingly
1397 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1398 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1399 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1400 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1401 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1402 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1404 else if (strncmp(option, "-levels", option_len) == 0)
1406 if (option_arg == NULL)
1407 FailWithHelp("option '%s' requires an argument", option_str);
1409 options.level_directory = getStringCopy(option_arg);
1410 if (option_arg == next_option)
1413 else if (strncmp(option, "-graphics", option_len) == 0)
1415 if (option_arg == NULL)
1416 FailWithHelp("option '%s' requires an argument", option_str);
1418 options.graphics_directory = getStringCopy(option_arg);
1419 if (option_arg == next_option)
1422 else if (strncmp(option, "-sounds", option_len) == 0)
1424 if (option_arg == NULL)
1425 FailWithHelp("option '%s' requires an argument", option_str);
1427 options.sounds_directory = getStringCopy(option_arg);
1428 if (option_arg == next_option)
1431 else if (strncmp(option, "-music", option_len) == 0)
1433 if (option_arg == NULL)
1434 FailWithHelp("option '%s' requires an argument", option_str);
1436 options.music_directory = getStringCopy(option_arg);
1437 if (option_arg == next_option)
1440 else if (strncmp(option, "-mytapes", option_len) == 0)
1442 options.mytapes = TRUE;
1444 else if (strncmp(option, "-network", option_len) == 0)
1446 options.network = TRUE;
1448 else if (strncmp(option, "-serveronly", option_len) == 0)
1450 options.serveronly = TRUE;
1452 else if (strncmp(option, "-debug", option_len) == 0)
1454 options.debug = TRUE;
1456 // optionally, debug output can be limited to a specific debug mode
1457 if (option_arg != next_option)
1458 options.debug_mode = getStringCopy(option_arg);
1460 else if (strncmp(option, "-verbose", option_len) == 0)
1462 options.verbose = TRUE;
1464 else if (strncmp(option, "-version", option_len) == 0 ||
1465 strncmp(option, "-V", option_len) == 0)
1467 print_version_function();
1471 else if (strPrefix(option, "-D"))
1473 options.special_flags = getStringCopy(&option[2]);
1475 else if (strncmp(option, "-execute", option_len) == 0)
1477 if (option_arg == NULL)
1478 FailWithHelp("option '%s' requires an argument", option_str);
1480 options.execute_command = getStringCopy(option_arg);
1481 if (option_arg == next_option)
1484 // when doing batch processing, always enable verbose mode (warnings)
1485 options.verbose = TRUE;
1487 else if (strncmp(option, "-tape_logfile", option_len) == 0)
1489 if (option_arg == NULL)
1490 FailWithHelp("option '%s' requires an argument", option_str);
1492 options.tape_log_filename = getStringCopy(option_arg);
1493 if (option_arg == next_option)
1496 #if defined(PLATFORM_MACOSX)
1497 else if (strPrefix(option, "-psn"))
1499 // ignore process serial number when launched via GUI on Mac OS X
1502 else if (*option == '-')
1504 FailWithHelp("unrecognized option '%s'", option_str);
1506 else if (options.server_host == NULL)
1508 options.server_host = *options_left;
1510 else if (options.server_port == 0)
1512 options.server_port = atoi(*options_left);
1513 if (options.server_port < 1024)
1514 FailWithHelp("bad port number '%d'", options.server_port);
1517 FailWithHelp("too many arguments");
1524 // ----------------------------------------------------------------------------
1525 // checked memory allocation and freeing functions
1526 // ----------------------------------------------------------------------------
1528 void *checked_malloc(unsigned int size)
1535 Fail("cannot allocate %d bytes -- out of memory", size);
1540 void *checked_calloc(unsigned int size)
1544 ptr = calloc(1, size);
1547 Fail("cannot allocate %d bytes -- out of memory", size);
1552 void *checked_realloc(void *ptr, unsigned int size)
1554 ptr = realloc(ptr, size);
1557 Fail("cannot allocate %d bytes -- out of memory", size);
1562 void checked_free(void *ptr)
1564 if (ptr != NULL) // this check should be done by free() anyway
1568 void clear_mem(void *ptr, unsigned int size)
1570 #if defined(PLATFORM_WIN32)
1571 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1572 char *cptr = (char *)ptr;
1577 memset(ptr, 0, size);
1582 // ----------------------------------------------------------------------------
1583 // various helper functions
1584 // ----------------------------------------------------------------------------
1586 void swap_numbers(int *i1, int *i2)
1594 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1606 /* the "put" variants of the following file access functions check for the file
1607 pointer being != NULL and return the number of bytes they have or would have
1608 written; this allows for chunk writing functions to first determine the size
1609 of the (not yet written) chunk, write the correct chunk size and finally
1610 write the chunk itself */
1612 int getFile8BitInteger(File *file)
1614 return getByteFromFile(file);
1617 int putFile8BitInteger(FILE *file, int value)
1625 int getFile16BitInteger(File *file, int byte_order)
1627 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1628 return ((getByteFromFile(file) << 8) |
1629 (getByteFromFile(file) << 0));
1630 else // BYTE_ORDER_LITTLE_ENDIAN
1631 return ((getByteFromFile(file) << 0) |
1632 (getByteFromFile(file) << 8));
1635 int putFile16BitInteger(FILE *file, int value, int byte_order)
1639 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1641 fputc((value >> 8) & 0xff, file);
1642 fputc((value >> 0) & 0xff, file);
1644 else // BYTE_ORDER_LITTLE_ENDIAN
1646 fputc((value >> 0) & 0xff, file);
1647 fputc((value >> 8) & 0xff, file);
1654 int getFile32BitInteger(File *file, int byte_order)
1656 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1657 return ((getByteFromFile(file) << 24) |
1658 (getByteFromFile(file) << 16) |
1659 (getByteFromFile(file) << 8) |
1660 (getByteFromFile(file) << 0));
1661 else // BYTE_ORDER_LITTLE_ENDIAN
1662 return ((getByteFromFile(file) << 0) |
1663 (getByteFromFile(file) << 8) |
1664 (getByteFromFile(file) << 16) |
1665 (getByteFromFile(file) << 24));
1668 int putFile32BitInteger(FILE *file, int value, int byte_order)
1672 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1674 fputc((value >> 24) & 0xff, file);
1675 fputc((value >> 16) & 0xff, file);
1676 fputc((value >> 8) & 0xff, file);
1677 fputc((value >> 0) & 0xff, file);
1679 else // BYTE_ORDER_LITTLE_ENDIAN
1681 fputc((value >> 0) & 0xff, file);
1682 fputc((value >> 8) & 0xff, file);
1683 fputc((value >> 16) & 0xff, file);
1684 fputc((value >> 24) & 0xff, file);
1691 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1694 const int chunk_name_length = 4;
1697 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1700 if (chunk_size != NULL)
1703 *chunk_size = getFile32BitInteger(file, byte_order);
1706 return (checkEndOfFile(file) ? FALSE : TRUE);
1709 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1716 fputs(chunk_name, file);
1718 num_bytes += strlen(chunk_name);
1720 if (chunk_size >= 0)
1724 putFile32BitInteger(file, chunk_size, byte_order);
1732 int getFileVersion(File *file)
1734 int version_super = getByteFromFile(file);
1735 int version_major = getByteFromFile(file);
1736 int version_minor = getByteFromFile(file);
1737 int version_patch = getByteFromFile(file);
1739 return VERSION_IDENT(version_super, version_major, version_minor,
1743 int putFileVersion(FILE *file, int version)
1747 int version_super = VERSION_SUPER(version);
1748 int version_major = VERSION_MAJOR(version);
1749 int version_minor = VERSION_MINOR(version);
1750 int version_patch = VERSION_PATCH(version);
1752 fputc(version_super, file);
1753 fputc(version_major, file);
1754 fputc(version_minor, file);
1755 fputc(version_patch, file);
1761 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1765 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1766 buffer[i] = getByteFromFile(file);
1769 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1773 for (i = 0; i < bytes; i++)
1774 fputc(buffer[i], file);
1777 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1779 while (bytes-- && !checkEndOfFile(file))
1780 getByteFromFile(file);
1783 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1790 // ----------------------------------------------------------------------------
1791 // functions to convert between ISO-8859-1 and UTF-8
1792 // ----------------------------------------------------------------------------
1794 char *getUTF8FromLatin1(char *latin1)
1796 int max_utf8_size = 2 * strlen(latin1) + 1;
1797 char *utf8 = checked_calloc(max_utf8_size);
1798 unsigned char *src = (unsigned char *)latin1;
1799 unsigned char *dst = (unsigned char *)utf8;
1803 if (*src < 128) // pure 7-bit ASCII
1807 else if (*src >= 160) // non-ASCII characters
1809 *dst++ = 194 + (*src >= 192);
1810 *dst++ = 128 + (*src & 63);
1812 else // undefined in ISO-8859-1
1820 // only use the smallest possible string buffer size
1821 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1826 char *getLatin1FromUTF8(char *utf8)
1828 int max_latin1_size = strlen(utf8) + 1;
1829 char *latin1 = checked_calloc(max_latin1_size);
1830 unsigned char *src = (unsigned char *)utf8;
1831 unsigned char *dst = (unsigned char *)latin1;
1835 if (*src < 128) // pure 7-bit ASCII
1839 else if (src[0] == 194 &&
1840 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1845 else if (src[0] == 195 &&
1846 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1848 *dst++ = src[1] + 64;
1852 // all other UTF-8 characters are undefined in ISO-8859-1
1854 else if (src[0] >= 192 && src[0] < 224 &&
1855 src[1] >= 128 && src[1] < 192)
1860 else if (src[0] >= 224 && src[0] < 240 &&
1861 src[1] >= 128 && src[1] < 192 &&
1862 src[2] >= 128 && src[2] < 192)
1867 else if (src[0] >= 240 && src[0] < 248 &&
1868 src[1] >= 128 && src[1] < 192 &&
1869 src[2] >= 128 && src[2] < 192 &&
1870 src[3] >= 128 && src[3] < 192)
1875 else if (src[0] >= 248 && src[0] < 252 &&
1876 src[1] >= 128 && src[1] < 192 &&
1877 src[2] >= 128 && src[2] < 192 &&
1878 src[3] >= 128 && src[3] < 192 &&
1879 src[4] >= 128 && src[4] < 192)
1884 else if (src[0] >= 252 && src[0] < 254 &&
1885 src[1] >= 128 && src[1] < 192 &&
1886 src[2] >= 128 && src[2] < 192 &&
1887 src[3] >= 128 && src[3] < 192 &&
1888 src[4] >= 128 && src[4] < 192 &&
1889 src[5] >= 128 && src[5] < 192)
1901 // only use the smallest possible string buffer size
1902 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1908 // ----------------------------------------------------------------------------
1909 // functions for JSON handling
1910 // ----------------------------------------------------------------------------
1912 char *getEscapedJSON(char *s)
1914 int max_json_size = 2 * strlen(s) + 1;
1915 char *json = checked_calloc(max_json_size);
1916 unsigned char *src = (unsigned char *)s;
1917 unsigned char *dst = (unsigned char *)json;
1918 char *escaped[256] =
1931 if (escaped[*src] != NULL)
1933 char *esc = escaped[*src++];
1944 // only use the smallest possible string buffer size
1945 json = checked_realloc(json, strlen(json) + 1);
1951 // ----------------------------------------------------------------------------
1952 // functions to translate key identifiers between different format
1953 // ----------------------------------------------------------------------------
1955 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1956 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1957 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1958 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1960 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1969 // return and escape keys
1970 { KSYM_Return, "XK_Return", "return" },
1971 { KSYM_Escape, "XK_Escape", "escape" },
1973 // normal cursor keys
1974 { KSYM_Left, "XK_Left", "cursor left" },
1975 { KSYM_Right, "XK_Right", "cursor right" },
1976 { KSYM_Up, "XK_Up", "cursor up" },
1977 { KSYM_Down, "XK_Down", "cursor down" },
1979 // keypad cursor keys
1981 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1982 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1983 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1984 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1987 // other keypad keys
1988 #ifdef KSYM_KP_Enter
1989 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1990 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1991 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1992 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1993 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1994 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1998 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1999 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
2000 { KSYM_Control_L, "XK_Control_L", "left control" },
2001 { KSYM_Control_R, "XK_Control_R", "right control" },
2002 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
2003 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
2004 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
2005 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
2006 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
2007 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
2009 // some special keys
2010 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
2011 { KSYM_Delete, "XK_Delete", "delete" },
2012 { KSYM_Insert, "XK_Insert", "insert" },
2013 { KSYM_Tab, "XK_Tab", "tab" },
2014 { KSYM_Home, "XK_Home", "home" },
2015 { KSYM_End, "XK_End", "end" },
2016 { KSYM_Page_Up, "XK_Page_Up", "page up" },
2017 { KSYM_Page_Down, "XK_Page_Down", "page down" },
2019 { KSYM_Select, "XK_Select", "select" },
2020 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
2021 { KSYM_Back, "XK_Back", "back" }, // back key
2022 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
2023 #if defined(PLATFORM_ANDROID)
2024 { KSYM_Rewind, "XK_Rewind", "rewind" },
2025 { KSYM_FastForward, "XK_FastForward", "fast forward" },
2028 // ASCII 0x20 to 0x40 keys (except numbers)
2029 { KSYM_space, "XK_space", "space" },
2030 { KSYM_exclam, "XK_exclam", "!" },
2031 { KSYM_quotedbl, "XK_quotedbl", "\"" },
2032 { KSYM_numbersign, "XK_numbersign", "#" },
2033 { KSYM_dollar, "XK_dollar", "$" },
2034 { KSYM_percent, "XK_percent", "%" },
2035 { KSYM_ampersand, "XK_ampersand", "&" },
2036 { KSYM_apostrophe, "XK_apostrophe", "'" },
2037 { KSYM_parenleft, "XK_parenleft", "(" },
2038 { KSYM_parenright, "XK_parenright", ")" },
2039 { KSYM_asterisk, "XK_asterisk", "*" },
2040 { KSYM_plus, "XK_plus", "+" },
2041 { KSYM_comma, "XK_comma", "," },
2042 { KSYM_minus, "XK_minus", "-" },
2043 { KSYM_period, "XK_period", "." },
2044 { KSYM_slash, "XK_slash", "/" },
2045 { KSYM_colon, "XK_colon", ":" },
2046 { KSYM_semicolon, "XK_semicolon", ";" },
2047 { KSYM_less, "XK_less", "<" },
2048 { KSYM_equal, "XK_equal", "=" },
2049 { KSYM_greater, "XK_greater", ">" },
2050 { KSYM_question, "XK_question", "?" },
2051 { KSYM_at, "XK_at", "@" },
2054 { KSYM_bracketleft, "XK_bracketleft", "[" },
2055 { KSYM_backslash, "XK_backslash", "\\" },
2056 { KSYM_bracketright,"XK_bracketright", "]" },
2057 { KSYM_asciicircum, "XK_asciicircum", "^" },
2058 { KSYM_underscore, "XK_underscore", "_" },
2059 { KSYM_grave, "XK_grave", "grave" },
2060 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
2061 { KSYM_braceleft, "XK_braceleft", "brace left" },
2062 { KSYM_bar, "XK_bar", "bar" },
2063 { KSYM_braceright, "XK_braceright", "brace right" },
2064 { KSYM_asciitilde, "XK_asciitilde", "~" },
2066 // special (non-ASCII) keys
2067 { KSYM_degree, "XK_degree", "degree" },
2068 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
2069 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
2070 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
2071 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
2072 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
2073 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
2074 { KSYM_ssharp, "XK_ssharp", "sharp s" },
2076 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2077 { KSYM_degree, "XK_degree", "\xc2\xb0" },
2078 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
2079 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
2080 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
2081 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
2082 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
2083 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
2084 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
2086 // other keys (for reverse mapping only)
2087 { KSYM_space, "XK_space", " " },
2089 // keypad keys are not in numerical order in SDL2
2090 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
2091 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
2092 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
2093 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
2094 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
2095 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
2096 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
2097 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
2098 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
2099 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
2101 // end-of-array identifier
2107 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2109 static char name_buffer[30];
2112 if (key >= KSYM_A && key <= KSYM_Z)
2113 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2114 else if (key >= KSYM_a && key <= KSYM_z)
2115 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2116 else if (key >= KSYM_0 && key <= KSYM_9)
2117 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2118 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2119 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2120 else if (key == KSYM_UNDEFINED)
2121 strcpy(name_buffer, "(undefined)");
2128 if (key == translate_key[i].key)
2130 strcpy(name_buffer, translate_key[i].name);
2134 while (translate_key[++i].name);
2136 if (!translate_key[i].name)
2137 strcpy(name_buffer, "(unknown)");
2140 *name = name_buffer;
2142 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2144 static char name_buffer[30];
2147 if (key >= KSYM_A && key <= KSYM_Z)
2148 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2149 else if (key >= KSYM_a && key <= KSYM_z)
2150 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2151 else if (key >= KSYM_0 && key <= KSYM_9)
2152 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2153 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2154 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2155 else if (key == KSYM_UNDEFINED)
2156 strcpy(name_buffer, "[undefined]");
2163 if (key == translate_key[i].key)
2165 strcpy(name_buffer, translate_key[i].x11name);
2169 while (translate_key[++i].x11name);
2171 if (!translate_key[i].x11name)
2172 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2175 *x11name = name_buffer;
2177 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2179 Key key = KSYM_UNDEFINED;
2180 char *name_ptr = *name;
2182 if (strlen(*name) == 1)
2184 char c = name_ptr[0];
2186 if (c >= 'A' && c <= 'Z')
2187 key = KSYM_A + (Key)(c - 'A');
2188 else if (c >= 'a' && c <= 'z')
2189 key = KSYM_a + (Key)(c - 'a');
2190 else if (c >= '0' && c <= '9')
2191 key = KSYM_0 + (Key)(c - '0');
2194 if (key == KSYM_UNDEFINED)
2200 if (strEqual(translate_key[i].name, *name))
2202 key = translate_key[i].key;
2206 while (translate_key[++i].x11name);
2209 if (key == KSYM_UNDEFINED)
2210 Warn("getKeyFromKeyName(): not completely implemented");
2214 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2216 Key key = KSYM_UNDEFINED;
2217 char *name_ptr = *x11name;
2219 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2221 char c = name_ptr[3];
2223 if (c >= 'A' && c <= 'Z')
2224 key = KSYM_A + (Key)(c - 'A');
2225 else if (c >= 'a' && c <= 'z')
2226 key = KSYM_a + (Key)(c - 'a');
2227 else if (c >= '0' && c <= '9')
2228 key = KSYM_0 + (Key)(c - '0');
2230 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2232 char c1 = name_ptr[4];
2233 char c2 = name_ptr[5];
2236 if ((c1 >= '0' && c1 <= '9') &&
2237 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2238 d = atoi(&name_ptr[4]);
2240 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2241 key = KSYM_F1 + (Key)(d - 1);
2243 else if (strPrefix(name_ptr, "XK_"))
2249 if (strEqual(name_ptr, translate_key[i].x11name))
2251 key = translate_key[i].key;
2255 while (translate_key[++i].x11name);
2257 else if (strPrefix(name_ptr, "0x"))
2259 unsigned int value = 0;
2265 char c = *name_ptr++;
2268 if (c >= '0' && c <= '9')
2270 else if (c >= 'a' && c <= 'f')
2271 d = (int)(c - 'a' + 10);
2272 else if (c >= 'A' && c <= 'F')
2273 d = (int)(c - 'A' + 10);
2281 value = value * 16 + d;
2292 char *getKeyNameFromKey(Key key)
2296 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2300 char *getX11KeyNameFromKey(Key key)
2304 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2308 Key getKeyFromKeyName(char *name)
2312 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2316 Key getKeyFromX11KeyName(char *x11name)
2320 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2324 char getCharFromKey(Key key)
2330 } translate_key_char[] =
2332 // special (non-ASCII) keys (ISO-8859-1)
2333 { KSYM_degree, CHAR_BYTE_DEGREE },
2334 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2335 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2336 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2337 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2338 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2339 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2340 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2342 // end-of-array identifier
2346 char *keyname = getKeyNameFromKey(key);
2349 if (strlen(keyname) == 1)
2351 else if (strEqual(keyname, "space"))
2359 if (key == translate_key_char[i].key)
2361 c = translate_key_char[i].key_char;
2366 while (translate_key_char[++i].key_char);
2372 char getValidConfigValueChar(char c)
2374 if (c == '#' || // used to mark comments
2375 c == '\\') // used to mark continued lines
2382 // ----------------------------------------------------------------------------
2383 // functions to translate string identifiers to integer or boolean value
2384 // ----------------------------------------------------------------------------
2386 int get_integer_from_string(char *s)
2388 static char *number_text[][3] =
2390 { "0", "zero", "null", },
2391 { "1", "one", "first" },
2392 { "2", "two", "second" },
2393 { "3", "three", "third" },
2394 { "4", "four", "fourth" },
2395 { "5", "five", "fifth" },
2396 { "6", "six", "sixth" },
2397 { "7", "seven", "seventh" },
2398 { "8", "eight", "eighth" },
2399 { "9", "nine", "ninth" },
2400 { "10", "ten", "tenth" },
2401 { "11", "eleven", "eleventh" },
2402 { "12", "twelve", "twelfth" },
2404 { NULL, NULL, NULL },
2408 char *s_lower = getStringToLower(s);
2411 for (i = 0; number_text[i][0] != NULL; i++)
2412 for (j = 0; j < 3; j++)
2413 if (strEqual(s_lower, number_text[i][j]))
2418 if (strEqual(s_lower, "false") ||
2419 strEqual(s_lower, "no") ||
2420 strEqual(s_lower, "off"))
2422 else if (strEqual(s_lower, "true") ||
2423 strEqual(s_lower, "yes") ||
2424 strEqual(s_lower, "on"))
2435 boolean get_boolean_from_string(char *s)
2437 char *s_lower = getStringToLower(s);
2438 boolean result = FALSE;
2440 if (strEqual(s_lower, "true") ||
2441 strEqual(s_lower, "yes") ||
2442 strEqual(s_lower, "on") ||
2443 get_integer_from_string(s) == 1)
2451 int get_switch3_from_string(char *s)
2453 char *s_lower = getStringToLower(s);
2456 if (strEqual(s_lower, "true") ||
2457 strEqual(s_lower, "yes") ||
2458 strEqual(s_lower, "on") ||
2459 get_integer_from_string(s) == 1)
2461 else if (strEqual(s_lower, "auto"))
2469 int get_player_nr_from_string(char *s)
2471 static char *player_text[] =
2481 char *s_lower = getStringToLower(s);
2485 for (i = 0; player_text[i] != NULL; i++)
2486 if (strEqual(s_lower, player_text[i]))
2495 // ----------------------------------------------------------------------------
2496 // functions for generic lists
2497 // ----------------------------------------------------------------------------
2499 ListNode *newListNode(void)
2501 return checked_calloc(sizeof(ListNode));
2504 void addNodeToList(ListNode **node_first, char *key, void *content)
2506 ListNode *node_new = newListNode();
2508 node_new->key = getStringCopy(key);
2509 node_new->content = content;
2510 node_new->next = *node_first;
2513 (*node_first)->prev = node_new;
2515 *node_first = node_new;
2518 void deleteNodeFromList(ListNode **node_first, char *key,
2519 void (*destructor_function)(void *))
2521 if (node_first == NULL || *node_first == NULL)
2524 if (strEqual((*node_first)->key, key))
2526 // after first recursion, (*node_first)->prev->next == *node_first,
2527 // so *node_first would be overwritten with (*node_first)->next
2528 // => use a copy of *node_first (and later of (*node_first)->next)
2529 ListNode *node = *node_first;
2530 ListNode *node_next = node->next;
2532 checked_free(node->key);
2534 if (destructor_function)
2535 destructor_function(node->content);
2538 node->prev->next = node->next;
2541 node->next->prev = node->prev;
2545 // after removing node, set list pointer to next valid list node
2546 // (this is important if the first node of the list was deleted)
2547 *node_first = node_next;
2551 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2555 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2557 if (node_first == NULL)
2560 if (strEqual(node_first->key, key))
2563 return getNodeFromKey(node_first->next, key);
2566 int getNumNodes(ListNode *node_first)
2568 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2572 static void dumpList(ListNode *node_first)
2574 ListNode *node = node_first;
2578 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2579 ((struct ListNodeInfo *)node->content)->num_references);
2583 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2588 // ----------------------------------------------------------------------------
2589 // functions for file handling
2590 // ----------------------------------------------------------------------------
2592 #define MAX_BUFFER_SIZE 4096
2594 File *openFile(char *filename, char *mode)
2596 File *file = checked_calloc(sizeof(File));
2598 file->file = fopen(filename, mode);
2600 if (file->file != NULL)
2602 file->filename = getStringCopy(filename);
2607 #if defined(PLATFORM_ANDROID)
2608 file->asset_file = SDL_RWFromFile(filename, mode);
2610 if (file->asset_file != NULL)
2612 file->file_is_asset = TRUE;
2613 file->filename = getStringCopy(filename);
2624 int closeFile(File *file)
2631 #if defined(PLATFORM_ANDROID)
2632 if (file->asset_file)
2633 result = SDL_RWclose(file->asset_file);
2637 result = fclose(file->file);
2639 checked_free(file->filename);
2645 int checkEndOfFile(File *file)
2647 #if defined(PLATFORM_ANDROID)
2648 if (file->file_is_asset)
2649 return file->end_of_file;
2652 return feof(file->file);
2655 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2657 #if defined(PLATFORM_ANDROID)
2658 if (file->file_is_asset)
2660 if (file->end_of_file)
2663 size_t num_items_read =
2664 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2666 if (num_items_read < num_items)
2667 file->end_of_file = TRUE;
2669 return num_items_read;
2673 return fread(buffer, item_size, num_items, file->file);
2676 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2678 return fwrite(buffer, item_size, num_items, file->file);
2681 int seekFile(File *file, long offset, int whence)
2683 #if defined(PLATFORM_ANDROID)
2684 if (file->file_is_asset)
2686 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2687 whence == SEEK_CUR ? RW_SEEK_CUR :
2688 whence == SEEK_END ? RW_SEEK_END : 0);
2690 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2694 return fseek(file->file, offset, whence);
2697 int getByteFromFile(File *file)
2699 #if defined(PLATFORM_ANDROID)
2700 if (file->file_is_asset)
2702 if (file->end_of_file)
2706 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2708 if (num_bytes_read < 1)
2709 file->end_of_file = TRUE;
2711 return (file->end_of_file ? EOF : (int)c);
2715 return fgetc(file->file);
2718 char *getStringFromFile(File *file, char *line, int size)
2720 #if defined(PLATFORM_ANDROID)
2721 if (file->file_is_asset)
2723 if (file->end_of_file)
2726 char *line_ptr = line;
2727 int num_bytes_read = 0;
2729 while (num_bytes_read < size - 1 &&
2730 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2731 *line_ptr++ != '\n')
2736 if (strlen(line) == 0)
2738 file->end_of_file = TRUE;
2747 return fgets(line, size, file->file);
2750 int copyFile(char *filename_from, char *filename_to)
2752 File *file_from, *file_to;
2754 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2759 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2761 closeFile(file_from);
2766 while (!checkEndOfFile(file_from))
2768 byte buffer[MAX_BUFFER_SIZE];
2769 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2771 writeFile(file_to, buffer, 1, bytes_read);
2774 closeFile(file_from);
2781 // ----------------------------------------------------------------------------
2782 // functions for directory handling
2783 // ----------------------------------------------------------------------------
2785 Directory *openDirectory(char *dir_name)
2787 Directory *dir = checked_calloc(sizeof(Directory));
2789 dir->dir = opendir(dir_name);
2791 if (dir->dir != NULL)
2793 dir->filename = getStringCopy(dir_name);
2798 #if defined(PLATFORM_ANDROID)
2799 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2801 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2803 checked_free(asset_toc_filename);
2805 if (dir->asset_toc_file != NULL)
2807 dir->directory_is_asset = TRUE;
2808 dir->filename = getStringCopy(dir_name);
2819 int closeDirectory(Directory *dir)
2826 #if defined(PLATFORM_ANDROID)
2827 if (dir->asset_toc_file)
2828 result = SDL_RWclose(dir->asset_toc_file);
2832 result = closedir(dir->dir);
2835 freeDirectoryEntry(dir->dir_entry);
2837 checked_free(dir->filename);
2843 DirectoryEntry *readDirectory(Directory *dir)
2846 freeDirectoryEntry(dir->dir_entry);
2848 dir->dir_entry = NULL;
2850 #if defined(PLATFORM_ANDROID)
2851 if (dir->directory_is_asset)
2853 char line[MAX_LINE_LEN];
2854 char *line_ptr = line;
2855 int num_bytes_read = 0;
2857 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2858 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2867 if (strlen(line) == 0)
2870 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2872 dir->dir_entry->is_directory = FALSE;
2873 if (line[strlen(line) - 1] == '/')
2875 dir->dir_entry->is_directory = TRUE;
2877 line[strlen(line) - 1] = '\0';
2880 dir->dir_entry->basename = getStringCopy(line);
2881 dir->dir_entry->filename = getPath2(dir->filename, line);
2883 return dir->dir_entry;
2887 struct dirent *dir_entry = readdir(dir->dir);
2889 if (dir_entry == NULL)
2892 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2894 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2895 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2897 struct stat file_status;
2899 dir->dir_entry->is_directory =
2900 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2901 S_ISDIR(file_status.st_mode));
2903 return dir->dir_entry;
2906 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2908 if (dir_entry == NULL)
2911 checked_free(dir_entry->basename);
2912 checked_free(dir_entry->filename);
2913 checked_free(dir_entry);
2917 // ----------------------------------------------------------------------------
2918 // functions for checking files and filenames
2919 // ----------------------------------------------------------------------------
2921 boolean directoryExists(char *dir_name)
2923 if (dir_name == NULL)
2926 struct stat file_status;
2927 boolean success = (stat(dir_name, &file_status) == 0 &&
2928 S_ISDIR(file_status.st_mode));
2930 #if defined(PLATFORM_ANDROID)
2933 // this might be an asset directory; check by trying to open toc file
2934 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2935 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2937 checked_free(asset_toc_filename);
2939 success = (file != NULL);
2949 boolean fileExists(char *filename)
2951 if (filename == NULL)
2954 boolean success = (access(filename, F_OK) == 0);
2956 #if defined(PLATFORM_ANDROID)
2959 // this might be an asset file; check by trying to open it
2960 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2962 success = (file != NULL);
2973 static boolean fileHasPrefix(char *basename, char *prefix)
2975 static char *basename_lower = NULL;
2976 int basename_length, prefix_length;
2978 checked_free(basename_lower);
2980 if (basename == NULL || prefix == NULL)
2983 basename_lower = getStringToLower(basename);
2984 basename_length = strlen(basename_lower);
2985 prefix_length = strlen(prefix);
2987 if (basename_length > prefix_length + 1 &&
2988 basename_lower[prefix_length] == '.' &&
2989 strncmp(basename_lower, prefix, prefix_length) == 0)
2996 static boolean fileHasSuffix(char *basename, char *suffix)
2998 static char *basename_lower = NULL;
2999 int basename_length, suffix_length;
3001 checked_free(basename_lower);
3003 if (basename == NULL || suffix == NULL)
3006 basename_lower = getStringToLower(basename);
3007 basename_length = strlen(basename_lower);
3008 suffix_length = strlen(suffix);
3010 if (basename_length > suffix_length + 1 &&
3011 basename_lower[basename_length - suffix_length - 1] == '.' &&
3012 strEqual(&basename_lower[basename_length - suffix_length], suffix))
3018 static boolean FileCouldBeArtwork(char *filename)
3020 char *basename = getBaseNamePtr(filename);
3022 return (!strEqual(basename, ".") &&
3023 !strEqual(basename, "..") &&
3024 !fileHasSuffix(basename, "txt") &&
3025 !fileHasSuffix(basename, "conf") &&
3026 !directoryExists(filename));
3029 boolean FileIsGraphic(char *filename)
3031 return FileCouldBeArtwork(filename);
3034 boolean FileIsSound(char *filename)
3036 return FileCouldBeArtwork(filename);
3039 boolean FileIsMusic(char *filename)
3041 return FileCouldBeArtwork(filename);
3044 boolean FileIsArtworkType(char *filename, int type)
3046 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3047 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3048 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3054 // ----------------------------------------------------------------------------
3055 // functions for loading artwork configuration information
3056 // ----------------------------------------------------------------------------
3058 char *get_mapped_token(char *token)
3060 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3061 static char *map_token_prefix[][2] =
3063 { "char_procent", "char_percent" },
3064 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
3065 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
3066 { "bd_butterfly_left", "bd_butterfly.left" },
3067 { "bd_butterfly_right", "bd_butterfly.right" },
3068 { "bd_butterfly_up", "bd_butterfly.up" },
3069 { "bd_butterfly_down", "bd_butterfly.down" },
3070 { "bd_firefly_left", "bd_firefly.left" },
3071 { "bd_firefly_right", "bd_firefly.right" },
3072 { "bd_firefly_up", "bd_firefly.up" },
3073 { "bd_firefly_down", "bd_firefly.down" },
3079 for (i = 0; map_token_prefix[i][0] != NULL; i++)
3081 int len_token_prefix = strlen(map_token_prefix[i][0]);
3083 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3084 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3087 // change tokens containing ".gfx" by moving the "gfx" part to the very left
3088 char *gfx_substring = ".gfx";
3089 char *gfx_prefix = "gfx.";
3090 if (strstr(token, gfx_substring) != NULL)
3092 char *token_prefix = getStringCopy(token);
3093 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3094 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3097 // cut off token string at ".gfx" substring position
3098 *token_gfx_pos = '\0';
3100 // put together prefix "gfx." and token prefix and suffix without ".gfx"
3101 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3105 return mapped_token;
3111 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3114 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3115 static struct ConfigTypeInfo prefix_list[] =
3117 { "global.anim_1" },
3118 { "global.anim_2" },
3119 { "global.anim_3" },
3120 { "global.anim_4" },
3121 { "global.anim_5" },
3122 { "global.anim_6" },
3123 { "global.anim_7" },
3124 { "global.anim_8" },
3125 { "global.anim_9" },
3126 { "global.anim_10" },
3127 { "global.anim_11" },
3128 { "global.anim_12" },
3129 { "global.anim_13" },
3130 { "global.anim_14" },
3131 { "global.anim_15" },
3132 { "global.anim_16" },
3133 { "global.anim_17" },
3134 { "global.anim_18" },
3135 { "global.anim_19" },
3136 { "global.anim_20" },
3137 { "global.anim_21" },
3138 { "global.anim_22" },
3139 { "global.anim_23" },
3140 { "global.anim_24" },
3141 { "global.anim_25" },
3142 { "global.anim_26" },
3143 { "global.anim_27" },
3144 { "global.anim_28" },
3145 { "global.anim_29" },
3146 { "global.anim_30" },
3147 { "global.anim_31" },
3148 { "global.anim_32" },
3152 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3153 boolean prefix_found = FALSE;
3157 // search for prefix to check if base token has to be created
3158 for (i = 0; prefix_list[i].token != NULL; i++)
3159 if (strPrefix(token, prefix_list[i].token))
3160 prefix_found = TRUE;
3165 // search for suffix (parameter) to determine base token length
3166 for (i = 0; suffix_list[i].token != NULL; i++)
3167 if (strSuffix(token, suffix_list[i].token))
3168 len_suffix = strlen(suffix_list[i].token);
3170 return getStringCopyN(token, strlen(token) - len_suffix);
3173 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3174 struct ListNodeInfo ***, int *);
3176 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3177 struct ConfigTypeInfo *suffix_list,
3178 char **ignore_tokens,
3179 int num_file_list_entries)
3181 SetupFileHash *ignore_tokens_hash;
3182 struct FileInfo *file_list;
3183 int num_file_list_entries_found = 0;
3184 int num_suffix_list_entries = 0;
3188 // create hash from list of tokens to be ignored (for quick access)
3189 ignore_tokens_hash = newSetupFileHash();
3190 for (i = 0; ignore_tokens[i] != NULL; i++)
3191 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3193 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3195 for (i = 0; suffix_list[i].token != NULL; i++)
3196 num_suffix_list_entries++;
3198 // always start with reliable default values
3199 for (i = 0; i < num_file_list_entries; i++)
3201 file_list[i].token = NULL;
3203 file_list[i].default_filename = NULL;
3204 file_list[i].filename = NULL;
3206 if (num_suffix_list_entries > 0)
3208 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3210 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3211 file_list[i].parameter = checked_calloc(parameter_array_size);
3213 for (j = 0; j < num_suffix_list_entries; j++)
3215 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3216 setString(&file_list[i].parameter[j], suffix_list[j].value);
3219 file_list[i].redefined = FALSE;
3220 file_list[i].fallback_to_default = FALSE;
3221 file_list[i].default_is_cloned = FALSE;
3227 for (i = 0; config_list[i].token != NULL; i++)
3229 int len_config_token = strlen(config_list[i].token);
3230 boolean is_file_entry = TRUE;
3232 for (j = 0; suffix_list[j].token != NULL; j++)
3234 int len_suffix = strlen(suffix_list[j].token);
3236 if (len_suffix < len_config_token &&
3237 strEqual(&config_list[i].token[len_config_token - len_suffix],
3238 suffix_list[j].token))
3240 setString(&file_list[list_pos].default_parameter[j],
3241 config_list[i].value);
3243 is_file_entry = FALSE;
3249 // the following tokens are no file definitions, but other config tokens
3250 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3251 is_file_entry = FALSE;
3258 if (list_pos >= num_file_list_entries)
3261 file_list[list_pos].token = config_list[i].token;
3262 file_list[list_pos].default_filename = config_list[i].value;
3265 if (strSuffix(config_list[i].token, ".clone_from"))
3266 file_list[list_pos].default_is_cloned = TRUE;
3269 num_file_list_entries_found = list_pos + 1;
3270 if (num_file_list_entries_found != num_file_list_entries)
3273 Error("inconsistant config list information:");
3274 Error("- should be: %d (according to 'src/conf_xxx.h')",
3275 num_file_list_entries);
3276 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3277 num_file_list_entries_found);
3282 freeSetupFileHash(ignore_tokens_hash);
3287 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3289 int len_token = strlen(token);
3290 int len_suffix = strlen(suffix);
3292 if (start_pos < 0) // compare suffix from end of string
3293 start_pos += len_token;
3295 if (start_pos < 0 || start_pos + len_suffix > len_token)
3298 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3301 if (token[start_pos + len_suffix] == '\0')
3304 if (token[start_pos + len_suffix] == '.')
3310 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3312 static void read_token_parameters(SetupFileHash *setup_file_hash,
3313 struct ConfigTypeInfo *suffix_list,
3314 struct FileInfo *file_list_entry)
3316 // check for config token that is the base token without any suffixes
3317 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3318 char *known_token_value = KNOWN_TOKEN_VALUE;
3321 if (filename != NULL)
3323 setString(&file_list_entry->filename, filename);
3325 // when file definition found, set all parameters to default values
3326 for (i = 0; suffix_list[i].token != NULL; i++)
3327 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3329 file_list_entry->redefined = TRUE;
3331 // mark config file token as well known from default config
3332 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3335 // check for config tokens that can be build by base token and suffixes
3336 for (i = 0; suffix_list[i].token != NULL; i++)
3338 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3339 char *value = getHashEntry(setup_file_hash, token);
3343 setString(&file_list_entry->parameter[i], value);
3345 // mark config file token as well known from default config
3346 setHashEntry(setup_file_hash, token, known_token_value);
3353 static void add_dynamic_file_list_entry(struct FileInfo **list,
3354 int *num_list_entries,
3355 SetupFileHash *extra_file_hash,
3356 struct ConfigTypeInfo *suffix_list,
3357 int num_suffix_list_entries,
3360 struct FileInfo *new_list_entry;
3361 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3363 (*num_list_entries)++;
3364 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3365 new_list_entry = &(*list)[*num_list_entries - 1];
3367 new_list_entry->token = getStringCopy(token);
3368 new_list_entry->default_filename = NULL;
3369 new_list_entry->filename = NULL;
3370 new_list_entry->parameter = checked_calloc(parameter_array_size);
3372 new_list_entry->redefined = FALSE;
3373 new_list_entry->fallback_to_default = FALSE;
3374 new_list_entry->default_is_cloned = FALSE;
3376 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3379 static void add_property_mapping(struct PropertyMapping **list,
3380 int *num_list_entries,
3381 int base_index, int ext1_index,
3382 int ext2_index, int ext3_index,
3385 struct PropertyMapping *new_list_entry;
3387 (*num_list_entries)++;
3388 *list = checked_realloc(*list,
3389 *num_list_entries * sizeof(struct PropertyMapping));
3390 new_list_entry = &(*list)[*num_list_entries - 1];
3392 new_list_entry->base_index = base_index;
3393 new_list_entry->ext1_index = ext1_index;
3394 new_list_entry->ext2_index = ext2_index;
3395 new_list_entry->ext3_index = ext3_index;
3397 new_list_entry->artwork_index = artwork_index;
3400 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3403 struct FileInfo *file_list = artwork_info->file_list;
3404 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3405 char **base_prefixes = artwork_info->base_prefixes;
3406 char **ext1_suffixes = artwork_info->ext1_suffixes;
3407 char **ext2_suffixes = artwork_info->ext2_suffixes;
3408 char **ext3_suffixes = artwork_info->ext3_suffixes;
3409 char **ignore_tokens = artwork_info->ignore_tokens;
3410 int num_file_list_entries = artwork_info->num_file_list_entries;
3411 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3412 int num_base_prefixes = artwork_info->num_base_prefixes;
3413 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3414 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3415 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3416 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3417 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3418 SetupFileHash *extra_file_hash, *empty_file_hash;
3419 char *known_token_value = KNOWN_TOKEN_VALUE;
3420 char *base_token_value = UNDEFINED_FILENAME;
3423 if (filename == NULL)
3426 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3429 // separate valid (defined) from empty (undefined) config token values
3430 valid_file_hash = newSetupFileHash();
3431 empty_file_hash = newSetupFileHash();
3432 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3434 char *value = HASH_ITERATION_VALUE(itr);
3436 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3437 HASH_ITERATION_TOKEN(itr), value);
3439 END_HASH_ITERATION(setup_file_hash, itr)
3441 // at this point, we do not need the setup file hash anymore -- free it
3442 freeSetupFileHash(setup_file_hash);
3444 // prevent changing hash while iterating over it by using a temporary copy
3445 valid_file_hash_tmp = newSetupFileHash();
3446 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3448 setHashEntry(valid_file_hash_tmp,
3449 HASH_ITERATION_TOKEN(itr),
3450 HASH_ITERATION_VALUE(itr));
3452 END_HASH_ITERATION(valid_file_hash, itr)
3454 // (iterate over same temporary hash, as modifications are independent)
3456 // map deprecated to current tokens (using prefix match and replace)
3457 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3459 char *token = HASH_ITERATION_TOKEN(itr);
3460 char *mapped_token = get_mapped_token(token);
3462 if (mapped_token != NULL)
3464 char *value = HASH_ITERATION_VALUE(itr);
3467 setHashEntry(valid_file_hash, mapped_token, value);
3469 // ignore old token (by setting it to "known" keyword)
3470 setHashEntry(valid_file_hash, token, known_token_value);
3475 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3477 // add special base tokens (using prefix match and replace)
3478 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3480 char *token = HASH_ITERATION_TOKEN(itr);
3481 char *base_token = get_special_base_token(artwork_info, token);
3483 if (base_token != NULL)
3485 // add base token only if it does not already exist
3486 if (getHashEntry(valid_file_hash, base_token) == NULL)
3487 setHashEntry(valid_file_hash, base_token, base_token_value);
3492 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3494 // free temporary hash used for iteration
3495 freeSetupFileHash(valid_file_hash_tmp);
3497 // read parameters for all known config file tokens
3498 for (i = 0; i < num_file_list_entries; i++)
3499 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3501 // set all tokens that can be ignored here to "known" keyword
3502 for (i = 0; i < num_ignore_tokens; i++)
3503 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3505 // copy all unknown config file tokens to extra config hash
3506 extra_file_hash = newSetupFileHash();
3507 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3509 char *value = HASH_ITERATION_VALUE(itr);
3511 if (!strEqual(value, known_token_value))
3512 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3514 END_HASH_ITERATION(valid_file_hash, itr)
3516 // at this point, we do not need the valid file hash anymore -- free it
3517 freeSetupFileHash(valid_file_hash);
3519 // now try to determine valid, dynamically defined config tokens
3521 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3523 struct FileInfo **dynamic_file_list =
3524 &artwork_info->dynamic_file_list;
3525 int *num_dynamic_file_list_entries =
3526 &artwork_info->num_dynamic_file_list_entries;
3527 struct PropertyMapping **property_mapping =
3528 &artwork_info->property_mapping;
3529 int *num_property_mapping_entries =
3530 &artwork_info->num_property_mapping_entries;
3531 int current_summarized_file_list_entry =
3532 artwork_info->num_file_list_entries +
3533 artwork_info->num_dynamic_file_list_entries;
3534 char *token = HASH_ITERATION_TOKEN(itr);
3535 int len_token = strlen(token);
3537 boolean base_prefix_found = FALSE;
3538 boolean parameter_suffix_found = FALSE;
3540 // skip all parameter definitions (handled by read_token_parameters())
3541 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3543 int len_suffix = strlen(suffix_list[i].token);
3545 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3546 parameter_suffix_found = TRUE;
3549 if (parameter_suffix_found)
3552 // ---------- step 0: search for matching base prefix ----------
3555 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3557 char *base_prefix = base_prefixes[i];
3558 int len_base_prefix = strlen(base_prefix);
3559 boolean ext1_suffix_found = FALSE;
3560 boolean ext2_suffix_found = FALSE;
3561 boolean ext3_suffix_found = FALSE;
3562 boolean exact_match = FALSE;
3563 int base_index = -1;
3564 int ext1_index = -1;
3565 int ext2_index = -1;
3566 int ext3_index = -1;
3568 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3570 if (!base_prefix_found)
3575 if (start_pos + len_base_prefix == len_token) // exact match
3579 add_dynamic_file_list_entry(dynamic_file_list,
3580 num_dynamic_file_list_entries,
3583 num_suffix_list_entries,
3585 add_property_mapping(property_mapping,
3586 num_property_mapping_entries,
3587 base_index, -1, -1, -1,
3588 current_summarized_file_list_entry);
3592 // ---------- step 1: search for matching first suffix ----------
3594 start_pos += len_base_prefix;
3595 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3597 char *ext1_suffix = ext1_suffixes[j];
3598 int len_ext1_suffix = strlen(ext1_suffix);
3600 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3602 if (!ext1_suffix_found)
3607 if (start_pos + len_ext1_suffix == len_token) // exact match
3611 add_dynamic_file_list_entry(dynamic_file_list,
3612 num_dynamic_file_list_entries,
3615 num_suffix_list_entries,
3617 add_property_mapping(property_mapping,
3618 num_property_mapping_entries,
3619 base_index, ext1_index, -1, -1,
3620 current_summarized_file_list_entry);
3624 start_pos += len_ext1_suffix;
3630 // ---------- step 2: search for matching second suffix ----------
3632 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3634 char *ext2_suffix = ext2_suffixes[k];
3635 int len_ext2_suffix = strlen(ext2_suffix);
3637 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3639 if (!ext2_suffix_found)
3644 if (start_pos + len_ext2_suffix == len_token) // exact match
3648 add_dynamic_file_list_entry(dynamic_file_list,
3649 num_dynamic_file_list_entries,
3652 num_suffix_list_entries,
3654 add_property_mapping(property_mapping,
3655 num_property_mapping_entries,
3656 base_index, ext1_index, ext2_index, -1,
3657 current_summarized_file_list_entry);
3661 start_pos += len_ext2_suffix;
3667 // ---------- step 3: search for matching third suffix ----------
3669 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3671 char *ext3_suffix = ext3_suffixes[l];
3672 int len_ext3_suffix = strlen(ext3_suffix);
3674 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3676 if (!ext3_suffix_found)
3681 if (start_pos + len_ext3_suffix == len_token) // exact match
3685 add_dynamic_file_list_entry(dynamic_file_list,
3686 num_dynamic_file_list_entries,
3689 num_suffix_list_entries,
3691 add_property_mapping(property_mapping,
3692 num_property_mapping_entries,
3693 base_index, ext1_index, ext2_index, ext3_index,
3694 current_summarized_file_list_entry);
3700 END_HASH_ITERATION(extra_file_hash, itr)
3702 if (artwork_info->num_dynamic_file_list_entries > 0)
3704 artwork_info->dynamic_artwork_list =
3705 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3706 artwork_info->sizeof_artwork_list_entry);
3709 if (options.verbose && IS_PARENT_PROCESS())
3711 SetupFileList *setup_file_list, *list;
3712 boolean dynamic_tokens_found = FALSE;
3713 boolean unknown_tokens_found = FALSE;
3714 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3716 // list may be NULL for empty artwork config files
3717 setup_file_list = loadSetupFileList(filename);
3719 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3721 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3722 dynamic_tokens_found = TRUE;
3724 unknown_tokens_found = TRUE;
3726 END_HASH_ITERATION(extra_file_hash, itr)
3728 if (options.debug && dynamic_tokens_found)
3730 Debug("config", "---");
3731 Debug("config", "dynamic token(s) found in config file:");
3732 Debug("config", "- config file: '%s'", filename);
3734 for (list = setup_file_list; list != NULL; list = list->next)
3736 char *value = getHashEntry(extra_file_hash, list->token);
3738 if (value != NULL && strEqual(value, known_token_value))
3739 Debug("config", "- dynamic token: '%s'", list->token);
3742 Debug("config", "---");
3745 if (unknown_tokens_found)
3748 Warn("unknown token(s) found in config file:");
3749 Warn("- config file: '%s'", filename);
3751 for (list = setup_file_list; list != NULL; list = list->next)
3753 char *value = getHashEntry(extra_file_hash, list->token);
3755 if (value != NULL && !strEqual(value, known_token_value))
3756 Warn("- dynamic token: '%s'", list->token);
3762 if (undefined_values_found)
3765 Warn("undefined values found in config file:");
3766 Warn("- config file: '%s'", filename);
3768 for (list = setup_file_list; list != NULL; list = list->next)
3770 char *value = getHashEntry(empty_file_hash, list->token);
3773 Warn("- undefined value for token: '%s'", list->token);
3779 freeSetupFileList(setup_file_list);
3782 freeSetupFileHash(extra_file_hash);
3783 freeSetupFileHash(empty_file_hash);
3786 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3788 struct FileInfo *file_list = artwork_info->file_list;
3789 int num_file_list_entries = artwork_info->num_file_list_entries;
3790 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3791 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3794 DrawInitText("Loading artwork config", 120, FC_GREEN);
3795 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3797 // always start with reliable default values
3798 for (i = 0; i < num_file_list_entries; i++)
3800 setString(&file_list[i].filename, file_list[i].default_filename);
3802 for (j = 0; j < num_suffix_list_entries; j++)
3803 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3805 file_list[i].redefined = FALSE;
3806 file_list[i].fallback_to_default = FALSE;
3809 // free previous dynamic artwork file array
3810 if (artwork_info->dynamic_file_list != NULL)
3812 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3814 free(artwork_info->dynamic_file_list[i].token);
3815 free(artwork_info->dynamic_file_list[i].filename);
3816 free(artwork_info->dynamic_file_list[i].parameter);
3819 free(artwork_info->dynamic_file_list);
3820 artwork_info->dynamic_file_list = NULL;
3822 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3823 &artwork_info->num_dynamic_file_list_entries);
3826 // free previous property mapping
3827 if (artwork_info->property_mapping != NULL)
3829 free(artwork_info->property_mapping);
3831 artwork_info->property_mapping = NULL;
3832 artwork_info->num_property_mapping_entries = 0;
3835 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3837 // first look for special artwork configured in level series config
3838 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3840 if (fileExists(filename_base))
3841 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3844 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3846 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3847 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3850 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3851 struct ListNodeInfo **listnode)
3855 char *filename = (*listnode)->source_filename;
3857 if (--(*listnode)->num_references <= 0)
3858 deleteNodeFromList(&artwork_info->content_list, filename,
3859 artwork_info->free_artwork);
3865 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3866 struct ListNodeInfo **listnode,
3867 struct FileInfo *file_list_entry)
3877 char *basename = file_list_entry->filename;
3878 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3880 // mark all images from non-default graphics directory as "redefined"
3881 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
3882 !strPrefix(filename, options.graphics_directory))
3883 file_list_entry->redefined = TRUE;
3885 if (filename == NULL)
3887 Warn("cannot find artwork file '%s'", basename);
3889 basename = file_list_entry->default_filename;
3891 // fail for cloned default artwork that has no default filename defined
3892 if (file_list_entry->default_is_cloned &&
3893 strEqual(basename, UNDEFINED_FILENAME))
3895 void (*error_func)(char *, ...) = Warn;
3897 // we can get away without sounds and music, but not without graphics
3898 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3901 error_func("token '%s' was cloned and has no default filename",
3902 file_list_entry->token);
3907 // dynamic artwork has no default filename / skip empty default artwork
3908 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3911 file_list_entry->fallback_to_default = TRUE;
3913 Warn("trying default artwork file '%s'", basename);
3915 filename = getCustomArtworkFilename(basename, artwork_info->type);
3917 if (filename == NULL)
3919 void (*error_func)(char *, ...) = Warn;
3921 // we can get away without sounds and music, but not without graphics
3922 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3925 error_func("cannot find default artwork file '%s'", basename);
3931 // check if the old and the new artwork file are the same
3932 if (*listnode && strEqual((*listnode)->source_filename, filename))
3934 // The old and new artwork are the same (have the same filename and path).
3935 // This usually means that this artwork does not exist in this artwork set
3936 // and a fallback to the existing artwork is done.
3941 // delete existing artwork file entry
3942 deleteArtworkListEntry(artwork_info, listnode);
3944 // check if the new artwork file already exists in the list of artwork
3945 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3947 *listnode = (struct ListNodeInfo *)node->content;
3948 (*listnode)->num_references++;
3953 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3954 DrawInitText(basename, 150, FC_YELLOW);
3956 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3958 // add new artwork file entry to the list of artwork files
3959 (*listnode)->num_references = 1;
3960 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3965 void (*error_func)(char *, ...) = Warn;
3967 // we can get away without sounds and music, but not without graphics
3968 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3971 error_func("cannot load artwork file '%s'", basename);
3977 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3978 struct ListNodeInfo **listnode,
3979 struct FileInfo *file_list_entry)
3981 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3983 deleteArtworkListEntry(artwork_info, listnode);
3988 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3991 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3993 struct FileInfo *file_list = artwork_info->file_list;
3994 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3995 int num_file_list_entries = artwork_info->num_file_list_entries;
3996 int num_dynamic_file_list_entries =
3997 artwork_info->num_dynamic_file_list_entries;
4000 print_timestamp_init("ReloadCustomArtworkList");
4002 for (i = 0; i < num_file_list_entries; i++)
4003 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4006 for (i = 0; i < num_dynamic_file_list_entries; i++)
4007 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4008 &dynamic_file_list[i]);
4010 print_timestamp_done("ReloadCustomArtworkList");
4013 dumpList(artwork_info->content_list);
4017 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4018 struct ListNodeInfo ***list,
4019 int *num_list_entries)
4026 for (i = 0; i < *num_list_entries; i++)
4027 deleteArtworkListEntry(artwork_info, &(*list)[i]);
4031 *num_list_entries = 0;
4034 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4036 if (artwork_info == NULL)
4039 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4040 &artwork_info->num_file_list_entries);
4042 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4043 &artwork_info->num_dynamic_file_list_entries);
4047 // ----------------------------------------------------------------------------
4048 // functions only needed for non-Unix (non-command-line) systems
4049 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4050 // (now also added for Windows, to create files in user data directory)
4051 // ----------------------------------------------------------------------------
4053 char *getLogFilename(char *basename)
4055 return getPath2(getMainUserGameDataDir(), basename);
4058 void OpenLogFiles(void)
4062 InitMainUserDataDirectory();
4064 for (i = 0; i < NUM_LOGS; i++)
4066 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
4069 program.log_file[i] = program.log_file_default[i]; // reset to default
4071 Warn("cannot open file '%s' for writing: %s",
4072 program.log_filename[i], strerror(errno));
4075 // output should be unbuffered so it is not truncated in a crash
4076 setbuf(program.log_file[i], NULL);
4080 void CloseLogFiles(void)
4084 for (i = 0; i < NUM_LOGS; i++)
4085 if (program.log_file[i] != program.log_file_default[i])
4086 fclose(program.log_file[i]);
4089 void DumpLogFile(int nr)
4091 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
4093 if (log_file == NULL)
4096 while (!feof(log_file))
4097 fputc(fgetc(log_file), stdout);
4102 void NotifyUserAboutErrorFile(void)
4104 #if defined(PLATFORM_WIN32)
4105 char *title_text = getStringCat2(program.program_title, " Error Message");
4106 char *error_text = getStringCat2("The program was aborted due to an error; "
4107 "for details, see the following error file:"
4109 program.log_filename[LOG_ERR_ID]);
4111 MessageBox(NULL, error_text, title_text, MB_OK);
4116 // ----------------------------------------------------------------------------
4117 // the following is only for debugging purpose and normally not used
4118 // ----------------------------------------------------------------------------
4122 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4123 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4125 #define DEBUG_NUM_TIMESTAMPS 10
4126 #define DEBUG_TIME_IN_MICROSECONDS 0
4128 #if DEBUG_TIME_IN_MICROSECONDS
4129 static double Counter_Microseconds(void)
4131 static struct timeval base_time = { 0, 0 };
4132 struct timeval current_time;
4135 gettimeofday(¤t_time, NULL);
4137 // reset base time in case of wrap-around
4138 if (current_time.tv_sec < base_time.tv_sec)
4139 base_time = current_time;
4142 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4143 ((double)(current_time.tv_usec - base_time.tv_usec));
4145 return counter; // return microseconds since last init
4149 static char *debug_print_timestamp_get_padding(int padding_size)
4151 static char *padding = NULL;
4152 int max_padding_size = 100;
4154 if (padding == NULL)
4156 padding = checked_calloc(max_padding_size + 1);
4157 memset(padding, ' ', max_padding_size);
4160 return &padding[MAX(0, max_padding_size - padding_size)];
4163 void debug_print_timestamp(int counter_nr, char *message)
4165 int indent_size = 8;
4166 int padding_size = 40;
4167 float timestamp_interval;
4170 Fail("debugging: invalid negative counter");
4171 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4172 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4174 #if DEBUG_TIME_IN_MICROSECONDS
4175 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4178 counter[counter_nr][0] = Counter_Microseconds();
4180 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4183 counter[counter_nr][0] = Counter();
4186 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4187 counter[counter_nr][1] = counter[counter_nr][0];
4190 Debug("time:init", "%s%s%s %.3f %s",
4191 debug_print_timestamp_get_padding(counter_nr * indent_size),
4193 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4194 timestamp_interval / 1000,
4199 static void debug_print_parent_only(char *format, ...)
4201 if (!IS_PARENT_PROCESS())
4208 va_start(ap, format);
4209 vprintf(format, ap);
4219 static void print_timestamp_ext(char *message, char *mode)
4221 #if DEBUG_PRINT_INIT_TIMESTAMPS
4222 static char *debug_message = NULL;
4223 static char *last_message = NULL;
4224 static int counter_nr = 0;
4225 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4227 checked_free(debug_message);
4228 debug_message = getStringCat3(mode, " ", message);
4230 if (strEqual(mode, "INIT"))
4232 debug_print_timestamp(counter_nr, NULL);
4234 if (counter_nr + 1 < max_depth)
4235 debug_print_timestamp(counter_nr, debug_message);
4239 debug_print_timestamp(counter_nr, NULL);
4241 else if (strEqual(mode, "DONE"))
4245 if (counter_nr + 1 < max_depth ||
4246 (counter_nr == 0 && max_depth == 1))
4248 last_message = message;
4250 if (counter_nr == 0 && max_depth == 1)
4252 checked_free(debug_message);
4253 debug_message = getStringCat3("TIME", " ", message);
4256 debug_print_timestamp(counter_nr, debug_message);
4259 else if (!strEqual(mode, "TIME") ||
4260 !strEqual(message, last_message))
4262 if (counter_nr < max_depth)
4263 debug_print_timestamp(counter_nr, debug_message);
4268 void print_timestamp_init(char *message)
4270 print_timestamp_ext(message, "INIT");
4273 void print_timestamp_time(char *message)
4275 print_timestamp_ext(message, "TIME");
4278 void print_timestamp_done(char *message)
4280 print_timestamp_ext(message, "DONE");