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 // maximal allowed length of a command line option
557 #define MAX_OPTION_LEN 256
559 static unsigned int getCurrentMS(void)
561 return SDL_GetTicks();
564 static unsigned int mainCounter(int mode)
566 static unsigned int base_ms = 0;
567 unsigned int current_ms;
569 // get current system milliseconds
570 current_ms = getCurrentMS();
572 // reset base timestamp in case of counter reset or wrap-around
573 if (mode == INIT_COUNTER || current_ms < base_ms)
574 base_ms = current_ms;
576 // return milliseconds since last counter reset
577 return current_ms - base_ms;
580 void InitCounter() // set counter back to zero
582 mainCounter(INIT_COUNTER);
585 unsigned int Counter() // get milliseconds since last call of InitCounter()
587 return mainCounter(READ_COUNTER);
590 static void sleep_milliseconds(unsigned int milliseconds_delay)
592 SDL_Delay(milliseconds_delay);
595 void Delay(unsigned int delay) // Sleep specified number of milliseconds
597 sleep_milliseconds(delay);
600 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
601 unsigned int actual_counter)
603 if (actual_counter >= *counter_var &&
604 actual_counter < *counter_var + delay)
607 *counter_var = actual_counter;
612 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
614 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
617 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
619 return DelayReachedExt(counter_var, delay, Counter());
622 void ResetDelayCounterExt(unsigned int *counter_var,
623 unsigned int actual_counter)
625 DelayReachedExt(counter_var, 0, actual_counter);
628 void ResetFrameCounter(unsigned int *frame_counter_var)
630 FrameReached(frame_counter_var, 0);
633 void ResetDelayCounter(unsigned int *counter_var)
635 DelayReached(counter_var, 0);
638 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
640 unsigned int actual_counter;
645 actual_counter = Counter();
647 if (actual_counter >= *counter_var &&
648 actual_counter < *counter_var + delay)
649 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
654 if (*counter_var != 0 &&
656 actual_counter >= *counter_var + delay)
658 int lag = actual_counter - (*counter_var + delay);
659 int delay2 = (delay + 1) / 2;
662 skip_frames = (lag + delay2) / delay;
665 *counter_var = actual_counter;
670 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
671 int *loop_var, int last_loop_value)
673 int skip_frames = WaitUntilDelayReached(counter_var, delay);
678 Debug("internal:SkipUntilDelayReached",
679 "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
681 skip_frames, skip_frames * delay);
683 Debug("internal:SkipUntilDelayReached",
689 if (skip_frames == 0)
692 // when skipping frames, make sure to never skip the last frame, as
693 // this may be needed for animations to reach a defined end state;
694 // furthermore, we assume that this function is called at the end
695 // of a "for" loop, which continues by incrementing the loop variable
696 // by one before checking the loop condition again; therefore we have
697 // to check against the last loop value minus one here
701 if (*loop_var < last_loop_value) // never skip the last frame
703 *loop_var += skip_frames;
705 if (*loop_var > last_loop_value) // never skip the last frame
706 *loop_var = last_loop_value;
711 // ----------------------------------------------------------------------------
712 // random generator functions
713 // ----------------------------------------------------------------------------
715 unsigned int init_random_number(int nr, int seed)
717 if (seed == NEW_RANDOMIZE)
719 // default random seed
720 seed = (int)time(NULL); // seconds since the epoch
722 #if !defined(PLATFORM_WIN32)
723 // add some more randomness
724 struct timeval current_time;
726 gettimeofday(¤t_time, NULL);
728 seed += (int)current_time.tv_usec; // microseconds since the epoch
731 // add some more randomness
732 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
734 // add some more randomness
735 seed += GetSimpleRandom(1000000);
738 srandom_linux_libc(nr, (unsigned int) seed);
740 return (unsigned int) seed;
743 unsigned int get_random_number(int nr, int max)
745 return (max > 0 ? random_linux_libc(nr) % max : 0);
749 // ----------------------------------------------------------------------------
750 // system info functions
751 // ----------------------------------------------------------------------------
753 #if !defined(PLATFORM_ANDROID)
754 static char *get_corrected_real_name(char *real_name)
756 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
757 char *from_ptr = real_name;
758 char *to_ptr = real_name_new;
760 // copy the name string, but not more than MAX_USERNAME_LEN characters
761 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
763 // the name field read from "passwd" file may also contain additional
764 // user information, separated by commas, which will be removed here
765 if (*from_ptr == ',')
768 // the user's real name may contain 'german sharp s' characters,
769 // which have no equivalent in upper case letters (used by our fonts)
770 if (*from_ptr == CHAR_BYTE_SHARP_S)
777 *to_ptr++ = *from_ptr++;
782 return real_name_new;
786 #if defined(PLATFORM_UNIX)
787 static struct passwd *getPasswdEntry(void)
789 #if defined(PLATFORM_EMSCRIPTEN)
790 // currently not fully supported; force fallback to default values
793 return getpwuid(getuid());
797 char *getUnixLoginName(void)
799 struct passwd *pwd = getPasswdEntry();
801 if (pwd != NULL && strlen(pwd->pw_name) != 0)
807 char *getUnixRealName(void)
809 struct passwd *pwd = getPasswdEntry();
811 if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
812 return pwd->pw_gecos;
817 char *getUnixHomeDir(void)
819 struct passwd *pwd = getPasswdEntry();
821 if (pwd != NULL && strlen(pwd->pw_dir) != 0)
828 char *getLoginName(void)
830 static char *login_name = NULL;
832 #if defined(PLATFORM_WIN32)
833 if (login_name == NULL)
835 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
837 login_name = checked_malloc(buffer_size);
839 if (GetUserName(login_name, &buffer_size) == 0)
840 strcpy(login_name, ANONYMOUS_NAME);
842 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
843 if (login_name == NULL)
845 char *name = getUnixLoginName();
848 login_name = getStringCopy(name);
850 login_name = ANONYMOUS_NAME;
853 login_name = ANONYMOUS_NAME;
859 char *getRealName(void)
861 static char *real_name = NULL;
863 #if defined(PLATFORM_WIN32)
864 if (real_name == NULL)
866 static char buffer[MAX_USERNAME_LEN + 1];
867 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
869 if (GetUserName(buffer, &buffer_size) != 0)
870 real_name = get_corrected_real_name(buffer);
872 real_name = ANONYMOUS_NAME;
874 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
875 if (real_name == NULL)
877 char *name = getUnixRealName();
880 real_name = get_corrected_real_name(name);
882 real_name = ANONYMOUS_NAME;
885 real_name = ANONYMOUS_NAME;
891 char *getFixedUserName(char *name)
893 // needed because player name must be a fixed length string
894 char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
896 strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
897 name_new[MAX_PLAYER_NAME_LEN] = '\0';
899 if (strlen(name) > MAX_PLAYER_NAME_LEN) // name has been cut
900 if (strchr(name_new, ' '))
901 *strchr(name_new, ' ') = '\0';
906 char *getDefaultUserName(int nr)
908 static char *user_name[MAX_PLAYER_NAMES] = { NULL };
910 nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
912 if (user_name[nr] == NULL)
914 user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
915 user_name[nr] = getFixedUserName(user_name[nr]);
918 return user_name[nr];
921 char *getTimestampFromEpoch(time_t epoch_seconds)
923 struct tm *now = localtime(&epoch_seconds);
924 static char timestamp[20];
926 sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
927 now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
928 now->tm_hour, now->tm_min, now->tm_sec);
933 char *getCurrentTimestamp(void)
935 return getTimestampFromEpoch(time(NULL));
938 time_t getFileTimestampEpochSeconds(char *filename)
940 struct stat file_status;
942 if (stat(filename, &file_status) != 0) // cannot stat file
945 return file_status.st_mtime;
949 // ----------------------------------------------------------------------------
950 // path manipulation functions
951 // ----------------------------------------------------------------------------
953 static char *getLastPathSeparatorPtr(char *filename)
955 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
957 if (last_separator == NULL) // also try DOS/Windows variant
958 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
960 return last_separator;
963 char *getBaseNamePtr(char *filename)
965 char *last_separator = getLastPathSeparatorPtr(filename);
967 if (last_separator != NULL)
968 return last_separator + 1; // separator found: strip base path
970 return filename; // no separator found: filename has no path
973 char *getBaseName(char *filename)
975 return getStringCopy(getBaseNamePtr(filename));
978 char *getBaseNameNoSuffix(char *filename)
980 char *basename = getStringCopy(getBaseNamePtr(filename));
982 // remove trailing suffix (separated by dot or hyphen)
983 if (basename[0] != '.' && basename[0] != '-')
985 if (strchr(basename, '.') != NULL)
986 *strchr(basename, '.') = '\0';
988 if (strchr(basename, '-') != NULL)
989 *strchr(basename, '-') = '\0';
995 char *getBasePath(char *filename)
997 char *basepath = getStringCopy(filename);
998 char *last_separator = getLastPathSeparatorPtr(basepath);
1000 // if no separator was found, use current directory
1001 if (last_separator == NULL)
1005 return getStringCopy(".");
1008 // separator found: strip basename
1009 *last_separator = '\0';
1015 // ----------------------------------------------------------------------------
1016 // various string functions
1017 // ----------------------------------------------------------------------------
1019 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1021 if (s1 == NULL || s2 == NULL || sep == NULL)
1024 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1027 sprintf(complete_string, "%s%s%s", s1, sep, s2);
1029 return complete_string;
1032 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1034 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1037 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1038 strlen(s2) + strlen(sep) +
1041 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1043 return complete_string;
1046 char *getStringCat2(char *s1, char *s2)
1048 return getStringCat2WithSeparator(s1, s2, "");
1051 char *getStringCat3(char *s1, char *s2, char *s3)
1053 return getStringCat3WithSeparator(s1, s2, s3, "");
1056 char *getPath2(char *path1, char *path2)
1058 #if defined(PLATFORM_ANDROID)
1059 // workaround for reading from assets directory -- skip "." subdirs in path
1060 if (strEqual(path1, "."))
1061 return getStringCopy(path2);
1062 else if (strEqual(path2, "."))
1063 return getStringCopy(path1);
1066 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1069 char *getPath3(char *path1, char *path2, char *path3)
1071 #if defined(PLATFORM_ANDROID)
1072 // workaround for reading from assets directory -- skip "." subdirs in path
1073 if (strEqual(path1, "."))
1074 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1075 else if (strEqual(path2, "."))
1076 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1077 else if (strEqual(path3, "."))
1078 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1081 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1084 static char *getPngOrPcxIfNotExists(char *filename)
1086 // switch from PNG to PCX file and vice versa, if file does not exist
1087 // (backwards compatibility with PCX files used in previous versions)
1089 if (!fileExists(filename) && strSuffix(filename, ".png"))
1090 strcpy(&filename[strlen(filename) - 3], "pcx");
1091 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1092 strcpy(&filename[strlen(filename) - 3], "png");
1097 char *getImg2(char *path1, char *path2)
1099 return getPngOrPcxIfNotExists(getPath2(path1, path2));
1102 char *getImg3(char *path1, char *path2, char *path3)
1104 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1107 char *getStringCopy(const char *s)
1114 s_copy = checked_malloc(strlen(s) + 1);
1120 char *getStringCopyN(const char *s, int n)
1123 int s_len = MAX(0, n);
1128 s_copy = checked_malloc(s_len + 1);
1129 strncpy(s_copy, s, s_len);
1130 s_copy[s_len] = '\0';
1135 char *getStringCopyNStatic(const char *s, int n)
1137 static char *s_copy = NULL;
1139 checked_free(s_copy);
1141 s_copy = getStringCopyN(s, n);
1146 char *getStringToLower(const char *s)
1148 char *s_copy = checked_malloc(strlen(s) + 1);
1149 char *s_ptr = s_copy;
1152 *s_ptr++ = tolower(*s++);
1158 void setString(char **old_value, char *new_value)
1160 checked_free(*old_value);
1162 *old_value = getStringCopy(new_value);
1165 boolean strEqual(char *s1, char *s2)
1167 return (s1 == NULL && s2 == NULL ? TRUE :
1168 s1 == NULL && s2 != NULL ? FALSE :
1169 s1 != NULL && s2 == NULL ? FALSE :
1170 strcmp(s1, s2) == 0);
1173 boolean strEqualN(char *s1, char *s2, int n)
1175 return (s1 == NULL && s2 == NULL ? TRUE :
1176 s1 == NULL && s2 != NULL ? FALSE :
1177 s1 != NULL && s2 == NULL ? FALSE :
1178 strncmp(s1, s2, n) == 0);
1181 boolean strEqualCase(char *s1, char *s2)
1183 return (s1 == NULL && s2 == NULL ? TRUE :
1184 s1 == NULL && s2 != NULL ? FALSE :
1185 s1 != NULL && s2 == NULL ? FALSE :
1186 strcasecmp(s1, s2) == 0);
1189 boolean strEqualCaseN(char *s1, char *s2, int n)
1191 return (s1 == NULL && s2 == NULL ? TRUE :
1192 s1 == NULL && s2 != NULL ? FALSE :
1193 s1 != NULL && s2 == NULL ? FALSE :
1194 strncasecmp(s1, s2, n) == 0);
1197 boolean strPrefix(char *s, char *prefix)
1199 return (s == NULL && prefix == NULL ? TRUE :
1200 s == NULL && prefix != NULL ? FALSE :
1201 s != NULL && prefix == NULL ? FALSE :
1202 strncmp(s, prefix, strlen(prefix)) == 0);
1205 boolean strSuffix(char *s, char *suffix)
1207 return (s == NULL && suffix == NULL ? TRUE :
1208 s == NULL && suffix != NULL ? FALSE :
1209 s != NULL && suffix == NULL ? FALSE :
1210 strlen(s) < strlen(suffix) ? FALSE :
1211 strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1214 boolean strPrefixLower(char *s, char *prefix)
1216 char *s_lower = getStringToLower(s);
1217 boolean match = strPrefix(s_lower, prefix);
1224 boolean strSuffixLower(char *s, char *suffix)
1226 char *s_lower = getStringToLower(s);
1227 boolean match = strSuffix(s_lower, suffix);
1235 // ----------------------------------------------------------------------------
1236 // command line option handling functions
1237 // ----------------------------------------------------------------------------
1239 void GetOptions(int argc, char *argv[],
1240 void (*print_usage_function)(void),
1241 void (*print_version_function)(void))
1243 char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1244 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1245 char **options_left = &argvplus[1];
1247 // replace original "argv" with null-terminated array of string pointers
1249 argvplus[argc] = argv[argc];
1251 // initialize global program options
1252 options.server_host = NULL;
1253 options.server_port = 0;
1255 options.base_directory = base_path;
1257 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1258 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1259 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1260 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1261 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1262 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1264 options.execute_command = NULL;
1265 options.special_flags = NULL;
1266 options.debug_mode = NULL;
1268 options.mytapes = FALSE;
1269 options.serveronly = FALSE;
1270 options.network = FALSE;
1271 options.verbose = FALSE;
1272 options.debug = FALSE;
1275 options.verbose = TRUE;
1277 #if !defined(PLATFORM_UNIX)
1278 if (*options_left == NULL) // no options given -- enable verbose mode
1279 options.verbose = TRUE;
1284 #if defined(PLATFORM_ANDROID)
1285 options.debug = TRUE;
1289 while (*options_left)
1291 char option_str[MAX_OPTION_LEN];
1292 char *option = options_left[0];
1293 char *next_option = options_left[1];
1294 char *option_arg = NULL;
1295 int option_len = strlen(option);
1297 if (option_len >= MAX_OPTION_LEN)
1298 FailWithHelp("unrecognized option '%s'", option);
1300 strcpy(option_str, option); // copy argument into buffer
1301 option = option_str;
1303 if (strEqual(option, "--")) // stop scanning arguments
1306 if (strPrefix(option, "--")) // treat '--' like '-'
1309 option_arg = strchr(option, '=');
1310 if (option_arg == NULL) // no '=' in option
1311 option_arg = next_option;
1314 *option_arg++ = '\0'; // cut argument from option
1315 if (*option_arg == '\0') // no argument after '='
1316 FailWithHelp("option '%s' has invalid argument", option_str);
1319 option_len = strlen(option);
1321 if (strEqual(option, "-"))
1323 FailWithHelp("unrecognized option '%s'", option);
1325 else if (strncmp(option, "-help", option_len) == 0)
1327 print_usage_function();
1331 else if (strncmp(option, "-basepath", option_len) == 0)
1333 if (option_arg == NULL)
1334 FailWithHelp("option '%s' requires an argument", option_str);
1336 options.base_directory = base_path = getStringCopy(option_arg);
1337 if (option_arg == next_option)
1340 // adjust paths for sub-directories in base directory accordingly
1341 options.level_directory = getPath2(base_path, LEVELS_DIRECTORY);
1342 options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1343 options.sounds_directory = getPath2(base_path, SOUNDS_DIRECTORY);
1344 options.music_directory = getPath2(base_path, MUSIC_DIRECTORY);
1345 options.docs_directory = getPath2(base_path, DOCS_DIRECTORY);
1346 options.conf_directory = getPath2(base_path, CONF_DIRECTORY);
1348 else if (strncmp(option, "-levels", option_len) == 0)
1350 if (option_arg == NULL)
1351 FailWithHelp("option '%s' requires an argument", option_str);
1353 options.level_directory = getStringCopy(option_arg);
1354 if (option_arg == next_option)
1357 else if (strncmp(option, "-graphics", option_len) == 0)
1359 if (option_arg == NULL)
1360 FailWithHelp("option '%s' requires an argument", option_str);
1362 options.graphics_directory = getStringCopy(option_arg);
1363 if (option_arg == next_option)
1366 else if (strncmp(option, "-sounds", option_len) == 0)
1368 if (option_arg == NULL)
1369 FailWithHelp("option '%s' requires an argument", option_str);
1371 options.sounds_directory = getStringCopy(option_arg);
1372 if (option_arg == next_option)
1375 else if (strncmp(option, "-music", option_len) == 0)
1377 if (option_arg == NULL)
1378 FailWithHelp("option '%s' requires an argument", option_str);
1380 options.music_directory = getStringCopy(option_arg);
1381 if (option_arg == next_option)
1384 else if (strncmp(option, "-mytapes", option_len) == 0)
1386 options.mytapes = TRUE;
1388 else if (strncmp(option, "-network", option_len) == 0)
1390 options.network = TRUE;
1392 else if (strncmp(option, "-serveronly", option_len) == 0)
1394 options.serveronly = TRUE;
1396 else if (strncmp(option, "-debug", option_len) == 0)
1398 options.debug = TRUE;
1400 // optionally, debug output can be limited to a specific debug mode
1401 if (option_arg != next_option)
1402 options.debug_mode = getStringCopy(option_arg);
1404 else if (strncmp(option, "-verbose", option_len) == 0)
1406 options.verbose = TRUE;
1408 else if (strncmp(option, "-version", option_len) == 0 ||
1409 strncmp(option, "-V", option_len) == 0)
1411 print_version_function();
1415 else if (strPrefix(option, "-D"))
1417 options.special_flags = getStringCopy(&option[2]);
1419 else if (strncmp(option, "-execute", option_len) == 0)
1421 if (option_arg == NULL)
1422 FailWithHelp("option '%s' requires an argument", option_str);
1424 options.execute_command = getStringCopy(option_arg);
1425 if (option_arg == next_option)
1428 // when doing batch processing, always enable verbose mode (warnings)
1429 options.verbose = TRUE;
1431 #if defined(PLATFORM_MACOSX)
1432 else if (strPrefix(option, "-psn"))
1434 // ignore process serial number when launched via GUI on Mac OS X
1437 else if (*option == '-')
1439 FailWithHelp("unrecognized option '%s'", option_str);
1441 else if (options.server_host == NULL)
1443 options.server_host = *options_left;
1445 else if (options.server_port == 0)
1447 options.server_port = atoi(*options_left);
1448 if (options.server_port < 1024)
1449 FailWithHelp("bad port number '%d'", options.server_port);
1452 FailWithHelp("too many arguments");
1459 // ----------------------------------------------------------------------------
1460 // checked memory allocation and freeing functions
1461 // ----------------------------------------------------------------------------
1463 void *checked_malloc(unsigned int size)
1470 Fail("cannot allocate %d bytes -- out of memory", size);
1475 void *checked_calloc(unsigned int size)
1479 ptr = calloc(1, size);
1482 Fail("cannot allocate %d bytes -- out of memory", size);
1487 void *checked_realloc(void *ptr, unsigned int size)
1489 ptr = realloc(ptr, size);
1492 Fail("cannot allocate %d bytes -- out of memory", size);
1497 void checked_free(void *ptr)
1499 if (ptr != NULL) // this check should be done by free() anyway
1503 void clear_mem(void *ptr, unsigned int size)
1505 #if defined(PLATFORM_WIN32)
1506 // for unknown reason, memset() sometimes crashes when compiled with MinGW
1507 char *cptr = (char *)ptr;
1512 memset(ptr, 0, size);
1517 // ----------------------------------------------------------------------------
1518 // various helper functions
1519 // ----------------------------------------------------------------------------
1521 void swap_numbers(int *i1, int *i2)
1529 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1541 /* the "put" variants of the following file access functions check for the file
1542 pointer being != NULL and return the number of bytes they have or would have
1543 written; this allows for chunk writing functions to first determine the size
1544 of the (not yet written) chunk, write the correct chunk size and finally
1545 write the chunk itself */
1547 int getFile8BitInteger(File *file)
1549 return getByteFromFile(file);
1552 int putFile8BitInteger(FILE *file, int value)
1560 int getFile16BitInteger(File *file, int byte_order)
1562 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1563 return ((getByteFromFile(file) << 8) |
1564 (getByteFromFile(file) << 0));
1565 else // BYTE_ORDER_LITTLE_ENDIAN
1566 return ((getByteFromFile(file) << 0) |
1567 (getByteFromFile(file) << 8));
1570 int putFile16BitInteger(FILE *file, int value, int byte_order)
1574 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1576 fputc((value >> 8) & 0xff, file);
1577 fputc((value >> 0) & 0xff, file);
1579 else // BYTE_ORDER_LITTLE_ENDIAN
1581 fputc((value >> 0) & 0xff, file);
1582 fputc((value >> 8) & 0xff, file);
1589 int getFile32BitInteger(File *file, int byte_order)
1591 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1592 return ((getByteFromFile(file) << 24) |
1593 (getByteFromFile(file) << 16) |
1594 (getByteFromFile(file) << 8) |
1595 (getByteFromFile(file) << 0));
1596 else // BYTE_ORDER_LITTLE_ENDIAN
1597 return ((getByteFromFile(file) << 0) |
1598 (getByteFromFile(file) << 8) |
1599 (getByteFromFile(file) << 16) |
1600 (getByteFromFile(file) << 24));
1603 int putFile32BitInteger(FILE *file, int value, int byte_order)
1607 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1609 fputc((value >> 24) & 0xff, file);
1610 fputc((value >> 16) & 0xff, file);
1611 fputc((value >> 8) & 0xff, file);
1612 fputc((value >> 0) & 0xff, file);
1614 else // BYTE_ORDER_LITTLE_ENDIAN
1616 fputc((value >> 0) & 0xff, file);
1617 fputc((value >> 8) & 0xff, file);
1618 fputc((value >> 16) & 0xff, file);
1619 fputc((value >> 24) & 0xff, file);
1626 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1629 const int chunk_name_length = 4;
1632 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1635 if (chunk_size != NULL)
1638 *chunk_size = getFile32BitInteger(file, byte_order);
1641 return (checkEndOfFile(file) ? FALSE : TRUE);
1644 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1651 fputs(chunk_name, file);
1653 num_bytes += strlen(chunk_name);
1655 if (chunk_size >= 0)
1659 putFile32BitInteger(file, chunk_size, byte_order);
1667 int getFileVersion(File *file)
1669 int version_super = getByteFromFile(file);
1670 int version_major = getByteFromFile(file);
1671 int version_minor = getByteFromFile(file);
1672 int version_patch = getByteFromFile(file);
1674 return VERSION_IDENT(version_super, version_major, version_minor,
1678 int putFileVersion(FILE *file, int version)
1682 int version_super = VERSION_SUPER(version);
1683 int version_major = VERSION_MAJOR(version);
1684 int version_minor = VERSION_MINOR(version);
1685 int version_patch = VERSION_PATCH(version);
1687 fputc(version_super, file);
1688 fputc(version_major, file);
1689 fputc(version_minor, file);
1690 fputc(version_patch, file);
1696 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1700 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1701 buffer[i] = getByteFromFile(file);
1704 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1708 for (i = 0; i < bytes; i++)
1709 fputc(buffer[i], file);
1712 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1714 while (bytes-- && !checkEndOfFile(file))
1715 getByteFromFile(file);
1718 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1725 // ----------------------------------------------------------------------------
1726 // functions to convert between ISO-8859-1 and UTF-8
1727 // ----------------------------------------------------------------------------
1729 char *getUTF8FromLatin1(char *latin1)
1731 int max_utf8_size = 2 * strlen(latin1) + 1;
1732 char *utf8 = checked_calloc(max_utf8_size);
1733 unsigned char *src = (unsigned char *)latin1;
1734 unsigned char *dst = (unsigned char *)utf8;
1738 if (*src < 128) // pure 7-bit ASCII
1742 else if (*src >= 160) // non-ASCII characters
1744 *dst++ = 194 + (*src >= 192);
1745 *dst++ = 128 + (*src & 63);
1747 else // undefined in ISO-8859-1
1755 // only use the smallest possible string buffer size
1756 utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1761 char *getLatin1FromUTF8(char *utf8)
1763 int max_latin1_size = strlen(utf8) + 1;
1764 char *latin1 = checked_calloc(max_latin1_size);
1765 unsigned char *src = (unsigned char *)utf8;
1766 unsigned char *dst = (unsigned char *)latin1;
1770 if (*src < 128) // pure 7-bit ASCII
1774 else if (src[0] == 194 &&
1775 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1780 else if (src[0] == 195 &&
1781 src[1] >= 128 && src[1] < 192) // non-ASCII characters
1783 *dst++ = src[1] + 64;
1787 // all other UTF-8 characters are undefined in ISO-8859-1
1789 else if (src[0] >= 192 && src[0] < 224 &&
1790 src[1] >= 128 && src[1] < 192)
1795 else if (src[0] >= 224 && src[0] < 240 &&
1796 src[1] >= 128 && src[1] < 192 &&
1797 src[2] >= 128 && src[2] < 192)
1802 else if (src[0] >= 240 && src[0] < 248 &&
1803 src[1] >= 128 && src[1] < 192 &&
1804 src[2] >= 128 && src[2] < 192 &&
1805 src[3] >= 128 && src[3] < 192)
1810 else if (src[0] >= 248 && src[0] < 252 &&
1811 src[1] >= 128 && src[1] < 192 &&
1812 src[2] >= 128 && src[2] < 192 &&
1813 src[3] >= 128 && src[3] < 192 &&
1814 src[4] >= 128 && src[4] < 192)
1819 else if (src[0] >= 252 && src[0] < 254 &&
1820 src[1] >= 128 && src[1] < 192 &&
1821 src[2] >= 128 && src[2] < 192 &&
1822 src[3] >= 128 && src[3] < 192 &&
1823 src[4] >= 128 && src[4] < 192 &&
1824 src[5] >= 128 && src[5] < 192)
1836 // only use the smallest possible string buffer size
1837 latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1843 // ----------------------------------------------------------------------------
1844 // functions to translate key identifiers between different format
1845 // ----------------------------------------------------------------------------
1847 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1848 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1849 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1850 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1852 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1861 // return and escape keys
1862 { KSYM_Return, "XK_Return", "return" },
1863 { KSYM_Escape, "XK_Escape", "escape" },
1865 // normal cursor keys
1866 { KSYM_Left, "XK_Left", "cursor left" },
1867 { KSYM_Right, "XK_Right", "cursor right" },
1868 { KSYM_Up, "XK_Up", "cursor up" },
1869 { KSYM_Down, "XK_Down", "cursor down" },
1871 // keypad cursor keys
1873 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1874 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1875 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1876 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1879 // other keypad keys
1880 #ifdef KSYM_KP_Enter
1881 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1882 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1883 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1884 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1885 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1886 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1890 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1891 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1892 { KSYM_Control_L, "XK_Control_L", "left control" },
1893 { KSYM_Control_R, "XK_Control_R", "right control" },
1894 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1895 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1896 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1897 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1898 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, // Alt-R
1899 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, // Ctrl-R
1901 // some special keys
1902 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1903 { KSYM_Delete, "XK_Delete", "delete" },
1904 { KSYM_Insert, "XK_Insert", "insert" },
1905 { KSYM_Tab, "XK_Tab", "tab" },
1906 { KSYM_Home, "XK_Home", "home" },
1907 { KSYM_End, "XK_End", "end" },
1908 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1909 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1911 { KSYM_Select, "XK_Select", "select" },
1912 { KSYM_Menu, "XK_Menu", "menu" }, // menu key
1913 { KSYM_Back, "XK_Back", "back" }, // back key
1914 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1915 #if defined(PLATFORM_ANDROID)
1916 { KSYM_Rewind, "XK_Rewind", "rewind" },
1917 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1920 // ASCII 0x20 to 0x40 keys (except numbers)
1921 { KSYM_space, "XK_space", "space" },
1922 { KSYM_exclam, "XK_exclam", "!" },
1923 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1924 { KSYM_numbersign, "XK_numbersign", "#" },
1925 { KSYM_dollar, "XK_dollar", "$" },
1926 { KSYM_percent, "XK_percent", "%" },
1927 { KSYM_ampersand, "XK_ampersand", "&" },
1928 { KSYM_apostrophe, "XK_apostrophe", "'" },
1929 { KSYM_parenleft, "XK_parenleft", "(" },
1930 { KSYM_parenright, "XK_parenright", ")" },
1931 { KSYM_asterisk, "XK_asterisk", "*" },
1932 { KSYM_plus, "XK_plus", "+" },
1933 { KSYM_comma, "XK_comma", "," },
1934 { KSYM_minus, "XK_minus", "-" },
1935 { KSYM_period, "XK_period", "." },
1936 { KSYM_slash, "XK_slash", "/" },
1937 { KSYM_colon, "XK_colon", ":" },
1938 { KSYM_semicolon, "XK_semicolon", ";" },
1939 { KSYM_less, "XK_less", "<" },
1940 { KSYM_equal, "XK_equal", "=" },
1941 { KSYM_greater, "XK_greater", ">" },
1942 { KSYM_question, "XK_question", "?" },
1943 { KSYM_at, "XK_at", "@" },
1946 { KSYM_bracketleft, "XK_bracketleft", "[" },
1947 { KSYM_backslash, "XK_backslash", "\\" },
1948 { KSYM_bracketright,"XK_bracketright", "]" },
1949 { KSYM_asciicircum, "XK_asciicircum", "^" },
1950 { KSYM_underscore, "XK_underscore", "_" },
1951 { KSYM_grave, "XK_grave", "grave" },
1952 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1953 { KSYM_braceleft, "XK_braceleft", "brace left" },
1954 { KSYM_bar, "XK_bar", "bar" },
1955 { KSYM_braceright, "XK_braceright", "brace right" },
1956 { KSYM_asciitilde, "XK_asciitilde", "~" },
1958 // special (non-ASCII) keys
1959 { KSYM_degree, "XK_degree", "degree" },
1960 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1961 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1962 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1963 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1964 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1965 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1966 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1968 // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1969 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1970 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1971 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1972 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1973 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1974 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1975 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1976 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1978 // other keys (for reverse mapping only)
1979 { KSYM_space, "XK_space", " " },
1981 // keypad keys are not in numerical order in SDL2
1982 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1983 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1984 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1985 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1986 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1987 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1988 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1989 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1990 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1991 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1993 // end-of-array identifier
1999 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2001 static char name_buffer[30];
2004 if (key >= KSYM_A && key <= KSYM_Z)
2005 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2006 else if (key >= KSYM_a && key <= KSYM_z)
2007 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2008 else if (key >= KSYM_0 && key <= KSYM_9)
2009 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2010 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2011 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2012 else if (key == KSYM_UNDEFINED)
2013 strcpy(name_buffer, "(undefined)");
2020 if (key == translate_key[i].key)
2022 strcpy(name_buffer, translate_key[i].name);
2026 while (translate_key[++i].name);
2028 if (!translate_key[i].name)
2029 strcpy(name_buffer, "(unknown)");
2032 *name = name_buffer;
2034 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2036 static char name_buffer[30];
2039 if (key >= KSYM_A && key <= KSYM_Z)
2040 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2041 else if (key >= KSYM_a && key <= KSYM_z)
2042 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2043 else if (key >= KSYM_0 && key <= KSYM_9)
2044 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2045 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2046 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2047 else if (key == KSYM_UNDEFINED)
2048 strcpy(name_buffer, "[undefined]");
2055 if (key == translate_key[i].key)
2057 strcpy(name_buffer, translate_key[i].x11name);
2061 while (translate_key[++i].x11name);
2063 if (!translate_key[i].x11name)
2064 sprintf(name_buffer, "0x%04x", (unsigned int)key);
2067 *x11name = name_buffer;
2069 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2071 Key key = KSYM_UNDEFINED;
2072 char *name_ptr = *name;
2074 if (strlen(*name) == 1)
2076 char c = name_ptr[0];
2078 if (c >= 'A' && c <= 'Z')
2079 key = KSYM_A + (Key)(c - 'A');
2080 else if (c >= 'a' && c <= 'z')
2081 key = KSYM_a + (Key)(c - 'a');
2082 else if (c >= '0' && c <= '9')
2083 key = KSYM_0 + (Key)(c - '0');
2086 if (key == KSYM_UNDEFINED)
2092 if (strEqual(translate_key[i].name, *name))
2094 key = translate_key[i].key;
2098 while (translate_key[++i].x11name);
2101 if (key == KSYM_UNDEFINED)
2102 Warn("getKeyFromKeyName(): not completely implemented");
2106 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2108 Key key = KSYM_UNDEFINED;
2109 char *name_ptr = *x11name;
2111 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2113 char c = name_ptr[3];
2115 if (c >= 'A' && c <= 'Z')
2116 key = KSYM_A + (Key)(c - 'A');
2117 else if (c >= 'a' && c <= 'z')
2118 key = KSYM_a + (Key)(c - 'a');
2119 else if (c >= '0' && c <= '9')
2120 key = KSYM_0 + (Key)(c - '0');
2122 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2124 char c1 = name_ptr[4];
2125 char c2 = name_ptr[5];
2128 if ((c1 >= '0' && c1 <= '9') &&
2129 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2130 d = atoi(&name_ptr[4]);
2132 if (d >= 1 && d <= KSYM_NUM_FKEYS)
2133 key = KSYM_F1 + (Key)(d - 1);
2135 else if (strPrefix(name_ptr, "XK_"))
2141 if (strEqual(name_ptr, translate_key[i].x11name))
2143 key = translate_key[i].key;
2147 while (translate_key[++i].x11name);
2149 else if (strPrefix(name_ptr, "0x"))
2151 unsigned int value = 0;
2157 char c = *name_ptr++;
2160 if (c >= '0' && c <= '9')
2162 else if (c >= 'a' && c <= 'f')
2163 d = (int)(c - 'a' + 10);
2164 else if (c >= 'A' && c <= 'F')
2165 d = (int)(c - 'A' + 10);
2173 value = value * 16 + d;
2184 char *getKeyNameFromKey(Key key)
2188 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2192 char *getX11KeyNameFromKey(Key key)
2196 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2200 Key getKeyFromKeyName(char *name)
2204 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2208 Key getKeyFromX11KeyName(char *x11name)
2212 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2216 char getCharFromKey(Key key)
2222 } translate_key_char[] =
2224 // special (non-ASCII) keys (ISO-8859-1)
2225 { KSYM_degree, CHAR_BYTE_DEGREE },
2226 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
2227 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
2228 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
2229 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
2230 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
2231 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
2232 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
2234 // end-of-array identifier
2238 char *keyname = getKeyNameFromKey(key);
2241 if (strlen(keyname) == 1)
2243 else if (strEqual(keyname, "space"))
2251 if (key == translate_key_char[i].key)
2253 c = translate_key_char[i].key_char;
2258 while (translate_key_char[++i].key_char);
2264 char getValidConfigValueChar(char c)
2266 if (c == '#' || // used to mark comments
2267 c == '\\') // used to mark continued lines
2274 // ----------------------------------------------------------------------------
2275 // functions to translate string identifiers to integer or boolean value
2276 // ----------------------------------------------------------------------------
2278 int get_integer_from_string(char *s)
2280 static char *number_text[][3] =
2282 { "0", "zero", "null", },
2283 { "1", "one", "first" },
2284 { "2", "two", "second" },
2285 { "3", "three", "third" },
2286 { "4", "four", "fourth" },
2287 { "5", "five", "fifth" },
2288 { "6", "six", "sixth" },
2289 { "7", "seven", "seventh" },
2290 { "8", "eight", "eighth" },
2291 { "9", "nine", "ninth" },
2292 { "10", "ten", "tenth" },
2293 { "11", "eleven", "eleventh" },
2294 { "12", "twelve", "twelfth" },
2296 { NULL, NULL, NULL },
2300 char *s_lower = getStringToLower(s);
2303 for (i = 0; number_text[i][0] != NULL; i++)
2304 for (j = 0; j < 3; j++)
2305 if (strEqual(s_lower, number_text[i][j]))
2310 if (strEqual(s_lower, "false") ||
2311 strEqual(s_lower, "no") ||
2312 strEqual(s_lower, "off"))
2314 else if (strEqual(s_lower, "true") ||
2315 strEqual(s_lower, "yes") ||
2316 strEqual(s_lower, "on"))
2327 boolean get_boolean_from_string(char *s)
2329 char *s_lower = getStringToLower(s);
2330 boolean result = FALSE;
2332 if (strEqual(s_lower, "true") ||
2333 strEqual(s_lower, "yes") ||
2334 strEqual(s_lower, "on") ||
2335 get_integer_from_string(s) == 1)
2343 int get_switch3_from_string(char *s)
2345 char *s_lower = getStringToLower(s);
2348 if (strEqual(s_lower, "true") ||
2349 strEqual(s_lower, "yes") ||
2350 strEqual(s_lower, "on") ||
2351 get_integer_from_string(s) == 1)
2353 else if (strEqual(s_lower, "auto"))
2361 int get_player_nr_from_string(char *s)
2363 static char *player_text[] =
2373 char *s_lower = getStringToLower(s);
2377 for (i = 0; player_text[i] != NULL; i++)
2378 if (strEqual(s_lower, player_text[i]))
2387 // ----------------------------------------------------------------------------
2388 // functions for generic lists
2389 // ----------------------------------------------------------------------------
2391 ListNode *newListNode(void)
2393 return checked_calloc(sizeof(ListNode));
2396 void addNodeToList(ListNode **node_first, char *key, void *content)
2398 ListNode *node_new = newListNode();
2400 node_new->key = getStringCopy(key);
2401 node_new->content = content;
2402 node_new->next = *node_first;
2405 (*node_first)->prev = node_new;
2407 *node_first = node_new;
2410 void deleteNodeFromList(ListNode **node_first, char *key,
2411 void (*destructor_function)(void *))
2413 if (node_first == NULL || *node_first == NULL)
2416 if (strEqual((*node_first)->key, key))
2418 // after first recursion, (*node_first)->prev->next == *node_first,
2419 // so *node_first would be overwritten with (*node_first)->next
2420 // => use a copy of *node_first (and later of (*node_first)->next)
2421 ListNode *node = *node_first;
2422 ListNode *node_next = node->next;
2424 checked_free(node->key);
2426 if (destructor_function)
2427 destructor_function(node->content);
2430 node->prev->next = node->next;
2433 node->next->prev = node->prev;
2437 // after removing node, set list pointer to next valid list node
2438 // (this is important if the first node of the list was deleted)
2439 *node_first = node_next;
2443 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2447 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2449 if (node_first == NULL)
2452 if (strEqual(node_first->key, key))
2455 return getNodeFromKey(node_first->next, key);
2458 int getNumNodes(ListNode *node_first)
2460 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2464 static void dumpList(ListNode *node_first)
2466 ListNode *node = node_first;
2470 Debug("internal:dumpList", "['%s' (%d)]", node->key,
2471 ((struct ListNodeInfo *)node->content)->num_references);
2475 Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2480 // ----------------------------------------------------------------------------
2481 // functions for file handling
2482 // ----------------------------------------------------------------------------
2484 #define MAX_BUFFER_SIZE 4096
2486 File *openFile(char *filename, char *mode)
2488 File *file = checked_calloc(sizeof(File));
2490 file->file = fopen(filename, mode);
2492 if (file->file != NULL)
2494 file->filename = getStringCopy(filename);
2499 #if defined(PLATFORM_ANDROID)
2500 file->asset_file = SDL_RWFromFile(filename, mode);
2502 if (file->asset_file != NULL)
2504 file->file_is_asset = TRUE;
2505 file->filename = getStringCopy(filename);
2516 int closeFile(File *file)
2523 #if defined(PLATFORM_ANDROID)
2524 if (file->asset_file)
2525 result = SDL_RWclose(file->asset_file);
2529 result = fclose(file->file);
2531 checked_free(file->filename);
2537 int checkEndOfFile(File *file)
2539 #if defined(PLATFORM_ANDROID)
2540 if (file->file_is_asset)
2541 return file->end_of_file;
2544 return feof(file->file);
2547 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2549 #if defined(PLATFORM_ANDROID)
2550 if (file->file_is_asset)
2552 if (file->end_of_file)
2555 size_t num_items_read =
2556 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2558 if (num_items_read < num_items)
2559 file->end_of_file = TRUE;
2561 return num_items_read;
2565 return fread(buffer, item_size, num_items, file->file);
2568 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2570 return fwrite(buffer, item_size, num_items, file->file);
2573 int seekFile(File *file, long offset, int whence)
2575 #if defined(PLATFORM_ANDROID)
2576 if (file->file_is_asset)
2578 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2579 whence == SEEK_CUR ? RW_SEEK_CUR :
2580 whence == SEEK_END ? RW_SEEK_END : 0);
2582 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2586 return fseek(file->file, offset, whence);
2589 int getByteFromFile(File *file)
2591 #if defined(PLATFORM_ANDROID)
2592 if (file->file_is_asset)
2594 if (file->end_of_file)
2598 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2600 if (num_bytes_read < 1)
2601 file->end_of_file = TRUE;
2603 return (file->end_of_file ? EOF : (int)c);
2607 return fgetc(file->file);
2610 char *getStringFromFile(File *file, char *line, int size)
2612 #if defined(PLATFORM_ANDROID)
2613 if (file->file_is_asset)
2615 if (file->end_of_file)
2618 char *line_ptr = line;
2619 int num_bytes_read = 0;
2621 while (num_bytes_read < size - 1 &&
2622 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2623 *line_ptr++ != '\n')
2628 if (strlen(line) == 0)
2630 file->end_of_file = TRUE;
2639 return fgets(line, size, file->file);
2642 int copyFile(char *filename_from, char *filename_to)
2644 File *file_from, *file_to;
2646 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2651 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2653 closeFile(file_from);
2658 while (!checkEndOfFile(file_from))
2660 byte buffer[MAX_BUFFER_SIZE];
2661 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2663 writeFile(file_to, buffer, 1, bytes_read);
2666 closeFile(file_from);
2673 // ----------------------------------------------------------------------------
2674 // functions for directory handling
2675 // ----------------------------------------------------------------------------
2677 Directory *openDirectory(char *dir_name)
2679 Directory *dir = checked_calloc(sizeof(Directory));
2681 dir->dir = opendir(dir_name);
2683 if (dir->dir != NULL)
2685 dir->filename = getStringCopy(dir_name);
2690 #if defined(PLATFORM_ANDROID)
2691 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2693 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2695 checked_free(asset_toc_filename);
2697 if (dir->asset_toc_file != NULL)
2699 dir->directory_is_asset = TRUE;
2700 dir->filename = getStringCopy(dir_name);
2711 int closeDirectory(Directory *dir)
2718 #if defined(PLATFORM_ANDROID)
2719 if (dir->asset_toc_file)
2720 result = SDL_RWclose(dir->asset_toc_file);
2724 result = closedir(dir->dir);
2727 freeDirectoryEntry(dir->dir_entry);
2729 checked_free(dir->filename);
2735 DirectoryEntry *readDirectory(Directory *dir)
2738 freeDirectoryEntry(dir->dir_entry);
2740 dir->dir_entry = NULL;
2742 #if defined(PLATFORM_ANDROID)
2743 if (dir->directory_is_asset)
2745 char line[MAX_LINE_LEN];
2746 char *line_ptr = line;
2747 int num_bytes_read = 0;
2749 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2750 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2759 if (strlen(line) == 0)
2762 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2764 dir->dir_entry->is_directory = FALSE;
2765 if (line[strlen(line) - 1] == '/')
2767 dir->dir_entry->is_directory = TRUE;
2769 line[strlen(line) - 1] = '\0';
2772 dir->dir_entry->basename = getStringCopy(line);
2773 dir->dir_entry->filename = getPath2(dir->filename, line);
2775 return dir->dir_entry;
2779 struct dirent *dir_entry = readdir(dir->dir);
2781 if (dir_entry == NULL)
2784 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2786 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2787 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2789 struct stat file_status;
2791 dir->dir_entry->is_directory =
2792 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2793 S_ISDIR(file_status.st_mode));
2795 return dir->dir_entry;
2798 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2800 if (dir_entry == NULL)
2803 checked_free(dir_entry->basename);
2804 checked_free(dir_entry->filename);
2805 checked_free(dir_entry);
2809 // ----------------------------------------------------------------------------
2810 // functions for checking files and filenames
2811 // ----------------------------------------------------------------------------
2813 boolean directoryExists(char *dir_name)
2815 if (dir_name == NULL)
2818 struct stat file_status;
2819 boolean success = (stat(dir_name, &file_status) == 0 &&
2820 S_ISDIR(file_status.st_mode));
2822 #if defined(PLATFORM_ANDROID)
2825 // this might be an asset directory; check by trying to open toc file
2826 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2827 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2829 checked_free(asset_toc_filename);
2831 success = (file != NULL);
2841 boolean fileExists(char *filename)
2843 if (filename == NULL)
2846 boolean success = (access(filename, F_OK) == 0);
2848 #if defined(PLATFORM_ANDROID)
2851 // this might be an asset file; check by trying to open it
2852 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2854 success = (file != NULL);
2865 static boolean fileHasPrefix(char *basename, char *prefix)
2867 static char *basename_lower = NULL;
2868 int basename_length, prefix_length;
2870 checked_free(basename_lower);
2872 if (basename == NULL || prefix == NULL)
2875 basename_lower = getStringToLower(basename);
2876 basename_length = strlen(basename_lower);
2877 prefix_length = strlen(prefix);
2879 if (basename_length > prefix_length + 1 &&
2880 basename_lower[prefix_length] == '.' &&
2881 strncmp(basename_lower, prefix, prefix_length) == 0)
2888 static boolean fileHasSuffix(char *basename, char *suffix)
2890 static char *basename_lower = NULL;
2891 int basename_length, suffix_length;
2893 checked_free(basename_lower);
2895 if (basename == NULL || suffix == NULL)
2898 basename_lower = getStringToLower(basename);
2899 basename_length = strlen(basename_lower);
2900 suffix_length = strlen(suffix);
2902 if (basename_length > suffix_length + 1 &&
2903 basename_lower[basename_length - suffix_length - 1] == '.' &&
2904 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2910 static boolean FileCouldBeArtwork(char *filename)
2912 char *basename = getBaseNamePtr(filename);
2914 return (!strEqual(basename, ".") &&
2915 !strEqual(basename, "..") &&
2916 !fileHasSuffix(basename, "txt") &&
2917 !fileHasSuffix(basename, "conf") &&
2918 !directoryExists(filename));
2921 boolean FileIsGraphic(char *filename)
2923 return FileCouldBeArtwork(filename);
2926 boolean FileIsSound(char *filename)
2928 return FileCouldBeArtwork(filename);
2931 boolean FileIsMusic(char *filename)
2933 return FileCouldBeArtwork(filename);
2936 boolean FileIsArtworkType(char *filename, int type)
2938 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2939 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2940 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2946 // ----------------------------------------------------------------------------
2947 // functions for loading artwork configuration information
2948 // ----------------------------------------------------------------------------
2950 char *get_mapped_token(char *token)
2952 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2953 static char *map_token_prefix[][2] =
2955 { "char_procent", "char_percent" },
2956 { "bd_magic_wall_filling", "bd_magic_wall.filling" },
2957 { "bd_magic_wall_emptying", "bd_magic_wall.emptying" },
2958 { "bd_butterfly_left", "bd_butterfly.left" },
2959 { "bd_butterfly_right", "bd_butterfly.right" },
2960 { "bd_butterfly_up", "bd_butterfly.up" },
2961 { "bd_butterfly_down", "bd_butterfly.down" },
2962 { "bd_firefly_left", "bd_firefly.left" },
2963 { "bd_firefly_right", "bd_firefly.right" },
2964 { "bd_firefly_up", "bd_firefly.up" },
2965 { "bd_firefly_down", "bd_firefly.down" },
2971 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2973 int len_token_prefix = strlen(map_token_prefix[i][0]);
2975 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2976 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2979 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2980 char *gfx_substring = ".gfx";
2981 char *gfx_prefix = "gfx.";
2982 if (strstr(token, gfx_substring) != NULL)
2984 char *token_prefix = getStringCopy(token);
2985 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2986 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2989 // cut off token string at ".gfx" substring position
2990 *token_gfx_pos = '\0';
2992 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2993 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2997 return mapped_token;
3003 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3006 // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3007 static struct ConfigTypeInfo prefix_list[] =
3009 { "global.anim_1" },
3010 { "global.anim_2" },
3011 { "global.anim_3" },
3012 { "global.anim_4" },
3013 { "global.anim_5" },
3014 { "global.anim_6" },
3015 { "global.anim_7" },
3016 { "global.anim_8" },
3017 { "global.anim_9" },
3018 { "global.anim_10" },
3019 { "global.anim_11" },
3020 { "global.anim_12" },
3021 { "global.anim_13" },
3022 { "global.anim_14" },
3023 { "global.anim_15" },
3024 { "global.anim_16" },
3025 { "global.anim_17" },
3026 { "global.anim_18" },
3027 { "global.anim_19" },
3028 { "global.anim_20" },
3029 { "global.anim_21" },
3030 { "global.anim_22" },
3031 { "global.anim_23" },
3032 { "global.anim_24" },
3033 { "global.anim_25" },
3034 { "global.anim_26" },
3035 { "global.anim_27" },
3036 { "global.anim_28" },
3037 { "global.anim_29" },
3038 { "global.anim_30" },
3039 { "global.anim_31" },
3040 { "global.anim_32" },
3044 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3045 boolean prefix_found = FALSE;
3049 // search for prefix to check if base token has to be created
3050 for (i = 0; prefix_list[i].token != NULL; i++)
3051 if (strPrefix(token, prefix_list[i].token))
3052 prefix_found = TRUE;
3057 // search for suffix (parameter) to determine base token length
3058 for (i = 0; suffix_list[i].token != NULL; i++)
3059 if (strSuffix(token, suffix_list[i].token))
3060 len_suffix = strlen(suffix_list[i].token);
3062 return getStringCopyN(token, strlen(token) - len_suffix);
3065 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3066 struct ListNodeInfo ***, int *);
3068 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3069 struct ConfigTypeInfo *suffix_list,
3070 char **ignore_tokens,
3071 int num_file_list_entries)
3073 SetupFileHash *ignore_tokens_hash;
3074 struct FileInfo *file_list;
3075 int num_file_list_entries_found = 0;
3076 int num_suffix_list_entries = 0;
3080 // create hash from list of tokens to be ignored (for quick access)
3081 ignore_tokens_hash = newSetupFileHash();
3082 for (i = 0; ignore_tokens[i] != NULL; i++)
3083 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3085 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3087 for (i = 0; suffix_list[i].token != NULL; i++)
3088 num_suffix_list_entries++;
3090 // always start with reliable default values
3091 for (i = 0; i < num_file_list_entries; i++)
3093 file_list[i].token = NULL;
3095 file_list[i].default_filename = NULL;
3096 file_list[i].filename = NULL;
3098 if (num_suffix_list_entries > 0)
3100 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3102 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3103 file_list[i].parameter = checked_calloc(parameter_array_size);
3105 for (j = 0; j < num_suffix_list_entries; j++)
3107 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3108 setString(&file_list[i].parameter[j], suffix_list[j].value);
3111 file_list[i].redefined = FALSE;
3112 file_list[i].fallback_to_default = FALSE;
3113 file_list[i].default_is_cloned = FALSE;
3119 for (i = 0; config_list[i].token != NULL; i++)
3121 int len_config_token = strlen(config_list[i].token);
3122 boolean is_file_entry = TRUE;
3124 for (j = 0; suffix_list[j].token != NULL; j++)
3126 int len_suffix = strlen(suffix_list[j].token);
3128 if (len_suffix < len_config_token &&
3129 strEqual(&config_list[i].token[len_config_token - len_suffix],
3130 suffix_list[j].token))
3132 setString(&file_list[list_pos].default_parameter[j],
3133 config_list[i].value);
3135 is_file_entry = FALSE;
3141 // the following tokens are no file definitions, but other config tokens
3142 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3143 is_file_entry = FALSE;
3150 if (list_pos >= num_file_list_entries)
3153 file_list[list_pos].token = config_list[i].token;
3154 file_list[list_pos].default_filename = config_list[i].value;
3157 if (strSuffix(config_list[i].token, ".clone_from"))
3158 file_list[list_pos].default_is_cloned = TRUE;
3161 num_file_list_entries_found = list_pos + 1;
3162 if (num_file_list_entries_found != num_file_list_entries)
3165 Error("inconsistant config list information:");
3166 Error("- should be: %d (according to 'src/conf_xxx.h')",
3167 num_file_list_entries);
3168 Error("- found to be: %d (according to 'src/conf_xxx.c')",
3169 num_file_list_entries_found);
3174 freeSetupFileHash(ignore_tokens_hash);
3179 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3181 int len_token = strlen(token);
3182 int len_suffix = strlen(suffix);
3184 if (start_pos < 0) // compare suffix from end of string
3185 start_pos += len_token;
3187 if (start_pos < 0 || start_pos + len_suffix > len_token)
3190 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3193 if (token[start_pos + len_suffix] == '\0')
3196 if (token[start_pos + len_suffix] == '.')
3202 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3204 static void read_token_parameters(SetupFileHash *setup_file_hash,
3205 struct ConfigTypeInfo *suffix_list,
3206 struct FileInfo *file_list_entry)
3208 // check for config token that is the base token without any suffixes
3209 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3210 char *known_token_value = KNOWN_TOKEN_VALUE;
3213 if (filename != NULL)
3215 setString(&file_list_entry->filename, filename);
3217 // when file definition found, set all parameters to default values
3218 for (i = 0; suffix_list[i].token != NULL; i++)
3219 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3221 file_list_entry->redefined = TRUE;
3223 // mark config file token as well known from default config
3224 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3227 // check for config tokens that can be build by base token and suffixes
3228 for (i = 0; suffix_list[i].token != NULL; i++)
3230 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3231 char *value = getHashEntry(setup_file_hash, token);
3235 setString(&file_list_entry->parameter[i], value);
3237 // mark config file token as well known from default config
3238 setHashEntry(setup_file_hash, token, known_token_value);
3245 static void add_dynamic_file_list_entry(struct FileInfo **list,
3246 int *num_list_entries,
3247 SetupFileHash *extra_file_hash,
3248 struct ConfigTypeInfo *suffix_list,
3249 int num_suffix_list_entries,
3252 struct FileInfo *new_list_entry;
3253 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3255 (*num_list_entries)++;
3256 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3257 new_list_entry = &(*list)[*num_list_entries - 1];
3259 new_list_entry->token = getStringCopy(token);
3260 new_list_entry->default_filename = NULL;
3261 new_list_entry->filename = NULL;
3262 new_list_entry->parameter = checked_calloc(parameter_array_size);
3264 new_list_entry->redefined = FALSE;
3265 new_list_entry->fallback_to_default = FALSE;
3266 new_list_entry->default_is_cloned = FALSE;
3268 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3271 static void add_property_mapping(struct PropertyMapping **list,
3272 int *num_list_entries,
3273 int base_index, int ext1_index,
3274 int ext2_index, int ext3_index,
3277 struct PropertyMapping *new_list_entry;
3279 (*num_list_entries)++;
3280 *list = checked_realloc(*list,
3281 *num_list_entries * sizeof(struct PropertyMapping));
3282 new_list_entry = &(*list)[*num_list_entries - 1];
3284 new_list_entry->base_index = base_index;
3285 new_list_entry->ext1_index = ext1_index;
3286 new_list_entry->ext2_index = ext2_index;
3287 new_list_entry->ext3_index = ext3_index;
3289 new_list_entry->artwork_index = artwork_index;
3292 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3295 struct FileInfo *file_list = artwork_info->file_list;
3296 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3297 char **base_prefixes = artwork_info->base_prefixes;
3298 char **ext1_suffixes = artwork_info->ext1_suffixes;
3299 char **ext2_suffixes = artwork_info->ext2_suffixes;
3300 char **ext3_suffixes = artwork_info->ext3_suffixes;
3301 char **ignore_tokens = artwork_info->ignore_tokens;
3302 int num_file_list_entries = artwork_info->num_file_list_entries;
3303 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3304 int num_base_prefixes = artwork_info->num_base_prefixes;
3305 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3306 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3307 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3308 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3309 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3310 SetupFileHash *extra_file_hash, *empty_file_hash;
3311 char *known_token_value = KNOWN_TOKEN_VALUE;
3312 char *base_token_value = UNDEFINED_FILENAME;
3315 if (filename == NULL)
3318 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3321 // separate valid (defined) from empty (undefined) config token values
3322 valid_file_hash = newSetupFileHash();
3323 empty_file_hash = newSetupFileHash();
3324 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3326 char *value = HASH_ITERATION_VALUE(itr);
3328 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3329 HASH_ITERATION_TOKEN(itr), value);
3331 END_HASH_ITERATION(setup_file_hash, itr)
3333 // at this point, we do not need the setup file hash anymore -- free it
3334 freeSetupFileHash(setup_file_hash);
3336 // prevent changing hash while iterating over it by using a temporary copy
3337 valid_file_hash_tmp = newSetupFileHash();
3338 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3340 setHashEntry(valid_file_hash_tmp,
3341 HASH_ITERATION_TOKEN(itr),
3342 HASH_ITERATION_VALUE(itr));
3344 END_HASH_ITERATION(valid_file_hash, itr)
3346 // (iterate over same temporary hash, as modifications are independent)
3348 // map deprecated to current tokens (using prefix match and replace)
3349 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3351 char *token = HASH_ITERATION_TOKEN(itr);
3352 char *mapped_token = get_mapped_token(token);
3354 if (mapped_token != NULL)
3356 char *value = HASH_ITERATION_VALUE(itr);
3359 setHashEntry(valid_file_hash, mapped_token, value);
3361 // ignore old token (by setting it to "known" keyword)
3362 setHashEntry(valid_file_hash, token, known_token_value);
3367 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3369 // add special base tokens (using prefix match and replace)
3370 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3372 char *token = HASH_ITERATION_TOKEN(itr);
3373 char *base_token = get_special_base_token(artwork_info, token);
3375 if (base_token != NULL)
3377 // add base token only if it does not already exist
3378 if (getHashEntry(valid_file_hash, base_token) == NULL)
3379 setHashEntry(valid_file_hash, base_token, base_token_value);
3384 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3386 // free temporary hash used for iteration
3387 freeSetupFileHash(valid_file_hash_tmp);
3389 // read parameters for all known config file tokens
3390 for (i = 0; i < num_file_list_entries; i++)
3391 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3393 // set all tokens that can be ignored here to "known" keyword
3394 for (i = 0; i < num_ignore_tokens; i++)
3395 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3397 // copy all unknown config file tokens to extra config hash
3398 extra_file_hash = newSetupFileHash();
3399 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3401 char *value = HASH_ITERATION_VALUE(itr);
3403 if (!strEqual(value, known_token_value))
3404 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3406 END_HASH_ITERATION(valid_file_hash, itr)
3408 // at this point, we do not need the valid file hash anymore -- free it
3409 freeSetupFileHash(valid_file_hash);
3411 // now try to determine valid, dynamically defined config tokens
3413 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3415 struct FileInfo **dynamic_file_list =
3416 &artwork_info->dynamic_file_list;
3417 int *num_dynamic_file_list_entries =
3418 &artwork_info->num_dynamic_file_list_entries;
3419 struct PropertyMapping **property_mapping =
3420 &artwork_info->property_mapping;
3421 int *num_property_mapping_entries =
3422 &artwork_info->num_property_mapping_entries;
3423 int current_summarized_file_list_entry =
3424 artwork_info->num_file_list_entries +
3425 artwork_info->num_dynamic_file_list_entries;
3426 char *token = HASH_ITERATION_TOKEN(itr);
3427 int len_token = strlen(token);
3429 boolean base_prefix_found = FALSE;
3430 boolean parameter_suffix_found = FALSE;
3432 // skip all parameter definitions (handled by read_token_parameters())
3433 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3435 int len_suffix = strlen(suffix_list[i].token);
3437 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3438 parameter_suffix_found = TRUE;
3441 if (parameter_suffix_found)
3444 // ---------- step 0: search for matching base prefix ----------
3447 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3449 char *base_prefix = base_prefixes[i];
3450 int len_base_prefix = strlen(base_prefix);
3451 boolean ext1_suffix_found = FALSE;
3452 boolean ext2_suffix_found = FALSE;
3453 boolean ext3_suffix_found = FALSE;
3454 boolean exact_match = FALSE;
3455 int base_index = -1;
3456 int ext1_index = -1;
3457 int ext2_index = -1;
3458 int ext3_index = -1;
3460 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3462 if (!base_prefix_found)
3467 if (start_pos + len_base_prefix == len_token) // exact match
3471 add_dynamic_file_list_entry(dynamic_file_list,
3472 num_dynamic_file_list_entries,
3475 num_suffix_list_entries,
3477 add_property_mapping(property_mapping,
3478 num_property_mapping_entries,
3479 base_index, -1, -1, -1,
3480 current_summarized_file_list_entry);
3484 // ---------- step 1: search for matching first suffix ----------
3486 start_pos += len_base_prefix;
3487 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3489 char *ext1_suffix = ext1_suffixes[j];
3490 int len_ext1_suffix = strlen(ext1_suffix);
3492 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3494 if (!ext1_suffix_found)
3499 if (start_pos + len_ext1_suffix == len_token) // exact match
3503 add_dynamic_file_list_entry(dynamic_file_list,
3504 num_dynamic_file_list_entries,
3507 num_suffix_list_entries,
3509 add_property_mapping(property_mapping,
3510 num_property_mapping_entries,
3511 base_index, ext1_index, -1, -1,
3512 current_summarized_file_list_entry);
3516 start_pos += len_ext1_suffix;
3522 // ---------- step 2: search for matching second suffix ----------
3524 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3526 char *ext2_suffix = ext2_suffixes[k];
3527 int len_ext2_suffix = strlen(ext2_suffix);
3529 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3531 if (!ext2_suffix_found)
3536 if (start_pos + len_ext2_suffix == len_token) // exact match
3540 add_dynamic_file_list_entry(dynamic_file_list,
3541 num_dynamic_file_list_entries,
3544 num_suffix_list_entries,
3546 add_property_mapping(property_mapping,
3547 num_property_mapping_entries,
3548 base_index, ext1_index, ext2_index, -1,
3549 current_summarized_file_list_entry);
3553 start_pos += len_ext2_suffix;
3559 // ---------- step 3: search for matching third suffix ----------
3561 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3563 char *ext3_suffix = ext3_suffixes[l];
3564 int len_ext3_suffix = strlen(ext3_suffix);
3566 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3568 if (!ext3_suffix_found)
3573 if (start_pos + len_ext3_suffix == len_token) // exact match
3577 add_dynamic_file_list_entry(dynamic_file_list,
3578 num_dynamic_file_list_entries,
3581 num_suffix_list_entries,
3583 add_property_mapping(property_mapping,
3584 num_property_mapping_entries,
3585 base_index, ext1_index, ext2_index, ext3_index,
3586 current_summarized_file_list_entry);
3592 END_HASH_ITERATION(extra_file_hash, itr)
3594 if (artwork_info->num_dynamic_file_list_entries > 0)
3596 artwork_info->dynamic_artwork_list =
3597 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3598 artwork_info->sizeof_artwork_list_entry);
3601 if (options.verbose && IS_PARENT_PROCESS())
3603 SetupFileList *setup_file_list, *list;
3604 boolean dynamic_tokens_found = FALSE;
3605 boolean unknown_tokens_found = FALSE;
3606 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3608 // list may be NULL for empty artwork config files
3609 setup_file_list = loadSetupFileList(filename);
3611 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3613 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3614 dynamic_tokens_found = TRUE;
3616 unknown_tokens_found = TRUE;
3618 END_HASH_ITERATION(extra_file_hash, itr)
3620 if (options.debug && dynamic_tokens_found)
3622 Debug("config", "---");
3623 Debug("config", "dynamic token(s) found in config file:");
3624 Debug("config", "- config file: '%s'", filename);
3626 for (list = setup_file_list; list != NULL; list = list->next)
3628 char *value = getHashEntry(extra_file_hash, list->token);
3630 if (value != NULL && strEqual(value, known_token_value))
3631 Debug("config", "- dynamic token: '%s'", list->token);
3634 Debug("config", "---");
3637 if (unknown_tokens_found)
3640 Warn("unknown token(s) found in config file:");
3641 Warn("- config file: '%s'", filename);
3643 for (list = setup_file_list; list != NULL; list = list->next)
3645 char *value = getHashEntry(extra_file_hash, list->token);
3647 if (value != NULL && !strEqual(value, known_token_value))
3648 Warn("- dynamic token: '%s'", list->token);
3654 if (undefined_values_found)
3657 Warn("undefined values found in config file:");
3658 Warn("- config file: '%s'", filename);
3660 for (list = setup_file_list; list != NULL; list = list->next)
3662 char *value = getHashEntry(empty_file_hash, list->token);
3665 Warn("- undefined value for token: '%s'", list->token);
3671 freeSetupFileList(setup_file_list);
3674 freeSetupFileHash(extra_file_hash);
3675 freeSetupFileHash(empty_file_hash);
3678 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3680 struct FileInfo *file_list = artwork_info->file_list;
3681 int num_file_list_entries = artwork_info->num_file_list_entries;
3682 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3683 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3686 DrawInitText("Loading artwork config", 120, FC_GREEN);
3687 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3689 // always start with reliable default values
3690 for (i = 0; i < num_file_list_entries; i++)
3692 setString(&file_list[i].filename, file_list[i].default_filename);
3694 for (j = 0; j < num_suffix_list_entries; j++)
3695 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3697 file_list[i].redefined = FALSE;
3698 file_list[i].fallback_to_default = FALSE;
3701 // free previous dynamic artwork file array
3702 if (artwork_info->dynamic_file_list != NULL)
3704 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3706 free(artwork_info->dynamic_file_list[i].token);
3707 free(artwork_info->dynamic_file_list[i].filename);
3708 free(artwork_info->dynamic_file_list[i].parameter);
3711 free(artwork_info->dynamic_file_list);
3712 artwork_info->dynamic_file_list = NULL;
3714 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3715 &artwork_info->num_dynamic_file_list_entries);
3718 // free previous property mapping
3719 if (artwork_info->property_mapping != NULL)
3721 free(artwork_info->property_mapping);
3723 artwork_info->property_mapping = NULL;
3724 artwork_info->num_property_mapping_entries = 0;
3727 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3729 // first look for special artwork configured in level series config
3730 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3732 if (fileExists(filename_base))
3733 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3736 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3738 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3739 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3742 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3743 struct ListNodeInfo **listnode)
3747 char *filename = (*listnode)->source_filename;
3749 if (--(*listnode)->num_references <= 0)
3750 deleteNodeFromList(&artwork_info->content_list, filename,
3751 artwork_info->free_artwork);
3757 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3758 struct ListNodeInfo **listnode,
3759 struct FileInfo *file_list_entry)
3769 char *basename = file_list_entry->filename;
3770 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3772 // mark all images from non-default graphics directory as "redefined"
3773 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
3774 !strPrefix(filename, options.graphics_directory))
3775 file_list_entry->redefined = TRUE;
3777 if (filename == NULL)
3779 Warn("cannot find artwork file '%s'", basename);
3781 basename = file_list_entry->default_filename;
3783 // fail for cloned default artwork that has no default filename defined
3784 if (file_list_entry->default_is_cloned &&
3785 strEqual(basename, UNDEFINED_FILENAME))
3787 void (*error_func)(char *, ...) = Warn;
3789 // we can get away without sounds and music, but not without graphics
3790 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3793 error_func("token '%s' was cloned and has no default filename",
3794 file_list_entry->token);
3799 // dynamic artwork has no default filename / skip empty default artwork
3800 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3803 file_list_entry->fallback_to_default = TRUE;
3805 Warn("trying default artwork file '%s'", basename);
3807 filename = getCustomArtworkFilename(basename, artwork_info->type);
3809 if (filename == NULL)
3811 void (*error_func)(char *, ...) = Warn;
3813 // we can get away without sounds and music, but not without graphics
3814 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3817 error_func("cannot find default artwork file '%s'", basename);
3823 // check if the old and the new artwork file are the same
3824 if (*listnode && strEqual((*listnode)->source_filename, filename))
3826 // The old and new artwork are the same (have the same filename and path).
3827 // This usually means that this artwork does not exist in this artwork set
3828 // and a fallback to the existing artwork is done.
3833 // delete existing artwork file entry
3834 deleteArtworkListEntry(artwork_info, listnode);
3836 // check if the new artwork file already exists in the list of artwork
3837 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3839 *listnode = (struct ListNodeInfo *)node->content;
3840 (*listnode)->num_references++;
3845 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3846 DrawInitText(basename, 150, FC_YELLOW);
3848 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3850 // add new artwork file entry to the list of artwork files
3851 (*listnode)->num_references = 1;
3852 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3857 void (*error_func)(char *, ...) = Warn;
3859 // we can get away without sounds and music, but not without graphics
3860 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3863 error_func("cannot load artwork file '%s'", basename);
3869 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3870 struct ListNodeInfo **listnode,
3871 struct FileInfo *file_list_entry)
3873 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3875 deleteArtworkListEntry(artwork_info, listnode);
3880 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3883 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3885 struct FileInfo *file_list = artwork_info->file_list;
3886 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3887 int num_file_list_entries = artwork_info->num_file_list_entries;
3888 int num_dynamic_file_list_entries =
3889 artwork_info->num_dynamic_file_list_entries;
3892 print_timestamp_init("ReloadCustomArtworkList");
3894 for (i = 0; i < num_file_list_entries; i++)
3895 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3898 for (i = 0; i < num_dynamic_file_list_entries; i++)
3899 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3900 &dynamic_file_list[i]);
3902 print_timestamp_done("ReloadCustomArtworkList");
3905 dumpList(artwork_info->content_list);
3909 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3910 struct ListNodeInfo ***list,
3911 int *num_list_entries)
3918 for (i = 0; i < *num_list_entries; i++)
3919 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3923 *num_list_entries = 0;
3926 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3928 if (artwork_info == NULL)
3931 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3932 &artwork_info->num_file_list_entries);
3934 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3935 &artwork_info->num_dynamic_file_list_entries);
3939 // ----------------------------------------------------------------------------
3940 // functions only needed for non-Unix (non-command-line) systems
3941 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3942 // (now also added for Windows, to create files in user data directory)
3943 // ----------------------------------------------------------------------------
3945 char *getLogFilename(char *basename)
3947 return getPath2(getMainUserGameDataDir(), basename);
3950 void OpenLogFiles(void)
3954 InitMainUserDataDirectory();
3956 for (i = 0; i < NUM_LOGS; i++)
3958 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3961 program.log_file[i] = program.log_file_default[i]; // reset to default
3963 Warn("cannot open file '%s' for writing: %s",
3964 program.log_filename[i], strerror(errno));
3967 // output should be unbuffered so it is not truncated in a crash
3968 setbuf(program.log_file[i], NULL);
3972 void CloseLogFiles(void)
3976 for (i = 0; i < NUM_LOGS; i++)
3977 if (program.log_file[i] != program.log_file_default[i])
3978 fclose(program.log_file[i]);
3981 void DumpLogFile(int nr)
3983 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3985 if (log_file == NULL)
3988 while (!feof(log_file))
3989 fputc(fgetc(log_file), stdout);
3994 void NotifyUserAboutErrorFile(void)
3996 #if defined(PLATFORM_WIN32)
3997 char *title_text = getStringCat2(program.program_title, " Error Message");
3998 char *error_text = getStringCat2("The program was aborted due to an error; "
3999 "for details, see the following error file:"
4001 program.log_filename[LOG_ERR_ID]);
4003 MessageBox(NULL, error_text, title_text, MB_OK);
4008 // ----------------------------------------------------------------------------
4009 // the following is only for debugging purpose and normally not used
4010 // ----------------------------------------------------------------------------
4014 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
4015 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
4017 #define DEBUG_NUM_TIMESTAMPS 10
4018 #define DEBUG_TIME_IN_MICROSECONDS 0
4020 #if DEBUG_TIME_IN_MICROSECONDS
4021 static double Counter_Microseconds(void)
4023 static struct timeval base_time = { 0, 0 };
4024 struct timeval current_time;
4027 gettimeofday(¤t_time, NULL);
4029 // reset base time in case of wrap-around
4030 if (current_time.tv_sec < base_time.tv_sec)
4031 base_time = current_time;
4034 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
4035 ((double)(current_time.tv_usec - base_time.tv_usec));
4037 return counter; // return microseconds since last init
4041 static char *debug_print_timestamp_get_padding(int padding_size)
4043 static char *padding = NULL;
4044 int max_padding_size = 100;
4046 if (padding == NULL)
4048 padding = checked_calloc(max_padding_size + 1);
4049 memset(padding, ' ', max_padding_size);
4052 return &padding[MAX(0, max_padding_size - padding_size)];
4055 void debug_print_timestamp(int counter_nr, char *message)
4057 int indent_size = 8;
4058 int padding_size = 40;
4059 float timestamp_interval;
4062 Fail("debugging: invalid negative counter");
4063 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4064 Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4066 #if DEBUG_TIME_IN_MICROSECONDS
4067 static double counter[DEBUG_NUM_TIMESTAMPS][2];
4070 counter[counter_nr][0] = Counter_Microseconds();
4072 static int counter[DEBUG_NUM_TIMESTAMPS][2];
4075 counter[counter_nr][0] = Counter();
4078 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4079 counter[counter_nr][1] = counter[counter_nr][0];
4082 Debug("time:init", "%s%s%s %.3f %s",
4083 debug_print_timestamp_get_padding(counter_nr * indent_size),
4085 debug_print_timestamp_get_padding(padding_size - strlen(message)),
4086 timestamp_interval / 1000,
4091 static void debug_print_parent_only(char *format, ...)
4093 if (!IS_PARENT_PROCESS())
4100 va_start(ap, format);
4101 vprintf(format, ap);
4111 static void print_timestamp_ext(char *message, char *mode)
4113 #if DEBUG_PRINT_INIT_TIMESTAMPS
4114 static char *debug_message = NULL;
4115 static char *last_message = NULL;
4116 static int counter_nr = 0;
4117 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4119 checked_free(debug_message);
4120 debug_message = getStringCat3(mode, " ", message);
4122 if (strEqual(mode, "INIT"))
4124 debug_print_timestamp(counter_nr, NULL);
4126 if (counter_nr + 1 < max_depth)
4127 debug_print_timestamp(counter_nr, debug_message);
4131 debug_print_timestamp(counter_nr, NULL);
4133 else if (strEqual(mode, "DONE"))
4137 if (counter_nr + 1 < max_depth ||
4138 (counter_nr == 0 && max_depth == 1))
4140 last_message = message;
4142 if (counter_nr == 0 && max_depth == 1)
4144 checked_free(debug_message);
4145 debug_message = getStringCat3("TIME", " ", message);
4148 debug_print_timestamp(counter_nr, debug_message);
4151 else if (!strEqual(mode, "TIME") ||
4152 !strEqual(message, last_message))
4154 if (counter_nr < max_depth)
4155 debug_print_timestamp(counter_nr, debug_message);
4160 void print_timestamp_init(char *message)
4162 print_timestamp_ext(message, "INIT");
4165 void print_timestamp_time(char *message)
4167 print_timestamp_ext(message, "TIME");
4170 void print_timestamp_done(char *message)
4172 print_timestamp_ext(message, "DONE");