1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
14 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ========================================================================= */
37 /* some generic helper functions */
38 /* ========================================================================= */
40 /* ------------------------------------------------------------------------- */
41 /* logging functions */
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 PrintLine(char *line_chars, int line_length)
229 for (i = 0; i < line_length; i++)
235 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
238 PrintLine(line_chars, line_length);
242 /* ------------------------------------------------------------------------- */
243 /* string functions */
244 /* ------------------------------------------------------------------------- */
246 /* int2str() returns a number converted to a string;
247 the used memory is static, but will be overwritten by later calls,
248 so if you want to save the result, copy it to a private string buffer;
249 there can be 10 local calls of int2str() without buffering the result --
250 the 11th call will then destroy the result from the first call and so on.
253 char *int2str(int number, int size)
255 static char shift_array[10][40];
256 static int shift_counter = 0;
257 char *s = shift_array[shift_counter];
259 shift_counter = (shift_counter + 1) % 10;
266 sprintf(s, " %09d", number);
267 return &s[strlen(s) - size];
271 sprintf(s, "%d", number);
277 /* something similar to "int2str()" above, but allocates its own memory
278 and has a different interface; we cannot use "itoa()", because this
279 seems to be already defined when cross-compiling to the win32 target */
281 char *i_to_a(unsigned int i)
283 static char *a = NULL;
287 if (i > 2147483647) /* yes, this is a kludge */
290 a = checked_malloc(10 + 1);
298 /* calculate base-2 logarithm of argument (rounded down to integer;
299 this function returns the number of the highest bit set in argument) */
301 int log_2(unsigned int x)
307 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
314 boolean getTokenValueFromString(char *string, char **token, char **value)
316 return getTokenValueFromSetupLine(string, token, value);
320 /* ------------------------------------------------------------------------- */
321 /* counter functions */
322 /* ------------------------------------------------------------------------- */
324 /* maximal allowed length of a command line option */
325 #define MAX_OPTION_LEN 256
327 static unsigned int getCurrentMS()
329 return SDL_GetTicks();
332 static unsigned int mainCounter(int mode)
334 static unsigned int base_ms = 0;
335 unsigned int current_ms;
337 /* get current system milliseconds */
338 current_ms = getCurrentMS();
340 /* reset base timestamp in case of counter reset or wrap-around */
341 if (mode == INIT_COUNTER || current_ms < base_ms)
342 base_ms = current_ms;
344 /* return milliseconds since last counter reset */
345 return current_ms - base_ms;
348 void InitCounter() /* set counter back to zero */
350 mainCounter(INIT_COUNTER);
353 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
355 return mainCounter(READ_COUNTER);
358 static void sleep_milliseconds(unsigned int milliseconds_delay)
360 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
364 /* we want to wait only a few ms -- if we assume that we have a
365 kernel timer resolution of 10 ms, we would wait far too long;
366 therefore it's better to do a short interval of busy waiting
367 to get our sleeping time more accurate */
369 unsigned int base_counter = Counter(), actual_counter = Counter();
371 while (actual_counter < base_counter + milliseconds_delay &&
372 actual_counter >= base_counter)
373 actual_counter = Counter();
377 SDL_Delay(milliseconds_delay);
381 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
383 sleep_milliseconds(delay);
386 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
387 unsigned int actual_counter)
389 if (actual_counter >= *counter_var &&
390 actual_counter < *counter_var + delay)
393 *counter_var = actual_counter;
398 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
400 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
403 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
405 return DelayReachedExt(counter_var, delay, Counter());
408 void ResetDelayCounterExt(unsigned int *counter_var,
409 unsigned int actual_counter)
411 DelayReachedExt(counter_var, 0, actual_counter);
414 void ResetFrameCounter(unsigned int *frame_counter_var)
416 FrameReached(frame_counter_var, 0);
419 void ResetDelayCounter(unsigned int *counter_var)
421 DelayReached(counter_var, 0);
424 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
426 unsigned int actual_counter;
431 actual_counter = Counter();
433 if (actual_counter >= *counter_var &&
434 actual_counter < *counter_var + delay)
435 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
440 if (*counter_var != 0 &&
442 actual_counter >= *counter_var + delay)
444 int lag = actual_counter - (*counter_var + delay);
445 int delay2 = (delay + 1) / 2;
448 skip_frames = (lag + delay2) / delay;
451 *counter_var = actual_counter;
456 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
457 int *loop_var, int last_loop_value)
459 int skip_frames = WaitUntilDelayReached(counter_var, delay);
463 printf("::: %d: %d ms", *loop_var, delay);
465 printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
470 if (skip_frames == 0)
473 // when skipping frames, make sure to never skip the last frame, as
474 // this may be needed for animations to reach a defined end state;
475 // furthermore, we assume that this function is called at the end
476 // of a "for" loop, which continues by incrementing the loop variable
477 // by one before checking the loop condition again; therefore we have
478 // to check against the last loop value minus one here
482 if (*loop_var < last_loop_value) // never skip the last frame
484 *loop_var += skip_frames;
486 if (*loop_var > last_loop_value) // never skip the last frame
487 *loop_var = last_loop_value;
492 /* ------------------------------------------------------------------------- */
493 /* random generator functions */
494 /* ------------------------------------------------------------------------- */
496 unsigned int init_random_number(int nr, int seed)
498 if (seed == NEW_RANDOMIZE)
500 /* default random seed */
501 seed = (int)time(NULL); // seconds since the epoch
503 #if !defined(PLATFORM_WIN32)
504 /* add some more randomness */
505 struct timeval current_time;
507 gettimeofday(¤t_time, NULL);
509 seed += (int)current_time.tv_usec; // microseconds since the epoch
512 /* add some more randomness */
513 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
515 /* add some more randomness */
516 seed += GetSimpleRandom(1000000);
519 srandom_linux_libc(nr, (unsigned int) seed);
521 return (unsigned int) seed;
524 unsigned int get_random_number(int nr, int max)
526 return (max > 0 ? random_linux_libc(nr) % max : 0);
530 /* ------------------------------------------------------------------------- */
531 /* system info functions */
532 /* ------------------------------------------------------------------------- */
534 #if !defined(PLATFORM_ANDROID)
535 static char *get_corrected_real_name(char *real_name)
537 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
538 char *from_ptr = real_name;
539 char *to_ptr = real_name_new;
541 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
542 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
544 /* the name field read from "passwd" file may also contain additional
545 user information, separated by commas, which will be removed here */
546 if (*from_ptr == ',')
549 /* the user's real name may contain 'german sharp s' characters,
550 which have no equivalent in upper case letters (used by our fonts) */
551 if (*from_ptr == CHAR_BYTE_SHARP_S)
558 *to_ptr++ = *from_ptr++;
563 return real_name_new;
569 static char *login_name = NULL;
571 #if defined(PLATFORM_WIN32)
572 if (login_name == NULL)
574 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
575 login_name = checked_malloc(buffer_size);
577 if (GetUserName(login_name, &buffer_size) == 0)
578 strcpy(login_name, ANONYMOUS_NAME);
581 if (login_name == NULL)
585 if ((pwd = getpwuid(getuid())) == NULL)
586 login_name = ANONYMOUS_NAME;
588 login_name = getStringCopy(pwd->pw_name);
597 static char *real_name = NULL;
599 #if defined(PLATFORM_WIN32)
600 if (real_name == NULL)
602 static char buffer[MAX_USERNAME_LEN + 1];
603 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
605 if (GetUserName(buffer, &buffer_size) != 0)
606 real_name = get_corrected_real_name(buffer);
608 real_name = ANONYMOUS_NAME;
610 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
611 if (real_name == NULL)
615 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
616 real_name = get_corrected_real_name(pwd->pw_gecos);
618 real_name = ANONYMOUS_NAME;
621 real_name = ANONYMOUS_NAME;
627 time_t getFileTimestampEpochSeconds(char *filename)
629 struct stat file_status;
631 if (stat(filename, &file_status) != 0) /* cannot stat file */
634 return file_status.st_mtime;
638 /* ------------------------------------------------------------------------- */
639 /* path manipulation functions */
640 /* ------------------------------------------------------------------------- */
642 static char *getLastPathSeparatorPtr(char *filename)
644 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
646 if (last_separator == NULL) /* also try DOS/Windows variant */
647 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
649 return last_separator;
652 char *getBaseNamePtr(char *filename)
654 char *last_separator = getLastPathSeparatorPtr(filename);
656 if (last_separator != NULL)
657 return last_separator + 1; /* separator found: strip base path */
659 return filename; /* no separator found: filename has no path */
662 char *getBaseName(char *filename)
664 return getStringCopy(getBaseNamePtr(filename));
667 char *getBaseNameNoSuffix(char *filename)
669 char *basename = getStringCopy(getBaseNamePtr(filename));
671 // remove trailing suffix (separated by dot or hyphen)
672 if (basename[0] != '.' && basename[0] != '-')
674 if (strchr(basename, '.') != NULL)
675 *strchr(basename, '.') = '\0';
677 if (strchr(basename, '-') != NULL)
678 *strchr(basename, '-') = '\0';
684 char *getBasePath(char *filename)
686 char *basepath = getStringCopy(filename);
687 char *last_separator = getLastPathSeparatorPtr(basepath);
689 if (last_separator != NULL)
690 *last_separator = '\0'; /* separator found: strip basename */
692 basepath = "."; /* no separator found: use current path */
697 static char *getProgramMainDataPath()
699 char *main_data_path = getStringCopy(program.command_basepath);
701 #if defined(PLATFORM_MACOSX)
702 static char *main_data_binary_subdir = NULL;
704 if (main_data_binary_subdir == NULL)
706 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
708 strlen(MAC_APP_BINARY_SUBDIR) + 1);
710 sprintf(main_data_binary_subdir, "%s.app/%s",
711 program.program_title, MAC_APP_BINARY_SUBDIR);
714 // cut relative path to Mac OS X application binary directory from path
715 if (strSuffix(main_data_path, main_data_binary_subdir))
716 main_data_path[strlen(main_data_path) -
717 strlen(main_data_binary_subdir)] = '\0';
719 // cut trailing path separator from path (but not if path is root directory)
720 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
721 main_data_path[strlen(main_data_path) - 1] = '\0';
724 return main_data_path;
728 /* ------------------------------------------------------------------------- */
729 /* various string functions */
730 /* ------------------------------------------------------------------------- */
732 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
734 if (s1 == NULL || s2 == NULL || sep == NULL)
737 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
740 sprintf(complete_string, "%s%s%s", s1, sep, s2);
742 return complete_string;
745 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
747 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
750 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
751 strlen(s2) + strlen(sep) +
754 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
756 return complete_string;
759 char *getStringCat2(char *s1, char *s2)
761 return getStringCat2WithSeparator(s1, s2, "");
764 char *getStringCat3(char *s1, char *s2, char *s3)
766 return getStringCat3WithSeparator(s1, s2, s3, "");
769 char *getPath2(char *path1, char *path2)
771 #if defined(PLATFORM_ANDROID)
772 // workaround for reading from assets directory -- skip "." subdirs in path
773 if (strEqual(path1, "."))
774 return getStringCopy(path2);
775 else if (strEqual(path2, "."))
776 return getStringCopy(path1);
779 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
782 char *getPath3(char *path1, char *path2, char *path3)
784 #if defined(PLATFORM_ANDROID)
785 // workaround for reading from assets directory -- skip "." subdirs in path
786 if (strEqual(path1, "."))
787 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
788 else if (strEqual(path2, "."))
789 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
790 else if (strEqual(path3, "."))
791 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
794 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
797 char *getImg2(char *path1, char *path2)
799 char *filename = getPath2(path1, path2);
801 if (!fileExists(filename) && strSuffix(path2, ".png"))
803 // backward compatibility: if PNG file not found, check for PCX file
804 char *path2pcx = getStringCopy(path2);
806 strcpy(&path2pcx[strlen(path2pcx) - 3], "pcx");
810 filename = getPath2(path1, path2pcx);
818 char *getImg3(char *path1, char *path2, char *path3)
820 char *filename = getPath3(path1, path2, path3);
822 if (!fileExists(filename) && strSuffix(path3, ".png"))
824 // backward compatibility: if PNG file not found, check for PCX file
825 char *path3pcx = getStringCopy(path3);
827 strcpy(&path3pcx[strlen(path3pcx) - 3], "pcx");
831 filename = getPath3(path1, path2, path3pcx);
839 char *getStringCopy(const char *s)
846 s_copy = checked_malloc(strlen(s) + 1);
852 char *getStringCopyN(const char *s, int n)
855 int s_len = MAX(0, n);
860 s_copy = checked_malloc(s_len + 1);
861 strncpy(s_copy, s, s_len);
862 s_copy[s_len] = '\0';
867 char *getStringCopyNStatic(const char *s, int n)
869 static char *s_copy = NULL;
871 checked_free(s_copy);
873 s_copy = getStringCopyN(s, n);
878 char *getStringToLower(const char *s)
880 char *s_copy = checked_malloc(strlen(s) + 1);
881 char *s_ptr = s_copy;
884 *s_ptr++ = tolower(*s++);
890 void setString(char **old_value, char *new_value)
892 checked_free(*old_value);
894 *old_value = getStringCopy(new_value);
897 boolean strEqual(char *s1, char *s2)
899 return (s1 == NULL && s2 == NULL ? TRUE :
900 s1 == NULL && s2 != NULL ? FALSE :
901 s1 != NULL && s2 == NULL ? FALSE :
902 strcmp(s1, s2) == 0);
905 boolean strEqualN(char *s1, char *s2, int n)
907 return (s1 == NULL && s2 == NULL ? TRUE :
908 s1 == NULL && s2 != NULL ? FALSE :
909 s1 != NULL && s2 == NULL ? FALSE :
910 strncmp(s1, s2, n) == 0);
913 boolean strPrefix(char *s, char *prefix)
915 return (s == NULL && prefix == NULL ? TRUE :
916 s == NULL && prefix != NULL ? FALSE :
917 s != NULL && prefix == NULL ? FALSE :
918 strncmp(s, prefix, strlen(prefix)) == 0);
921 boolean strSuffix(char *s, char *suffix)
923 return (s == NULL && suffix == NULL ? TRUE :
924 s == NULL && suffix != NULL ? FALSE :
925 s != NULL && suffix == NULL ? FALSE :
926 strlen(s) < strlen(suffix) ? FALSE :
927 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
930 boolean strPrefixLower(char *s, char *prefix)
932 char *s_lower = getStringToLower(s);
933 boolean match = strPrefix(s_lower, prefix);
940 boolean strSuffixLower(char *s, char *suffix)
942 char *s_lower = getStringToLower(s);
943 boolean match = strSuffix(s_lower, suffix);
951 /* ------------------------------------------------------------------------- */
952 /* command line option handling functions */
953 /* ------------------------------------------------------------------------- */
955 void GetOptions(int argc, char *argv[],
956 void (*print_usage_function)(void),
957 void (*print_version_function)(void))
959 char *ro_base_path = RO_BASE_PATH;
960 char *rw_base_path = RW_BASE_PATH;
961 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
962 char **options_left = &argvplus[1];
964 /* replace original "argv" with null-terminated array of string pointers */
966 argvplus[argc] = argv[argc];
968 /* if the program is configured to start from current directory (default),
969 determine program package directory from program binary (some versions
970 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
971 set the current working directory to the program package directory) */
973 if (strEqual(ro_base_path, "."))
974 ro_base_path = getProgramMainDataPath();
975 if (strEqual(rw_base_path, "."))
976 rw_base_path = getProgramMainDataPath();
978 /* initialize global program options */
979 options.display_name = NULL;
980 options.server_host = NULL;
981 options.server_port = 0;
983 options.ro_base_directory = ro_base_path;
984 options.rw_base_directory = rw_base_path;
985 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
986 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
987 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
988 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
989 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
991 options.execute_command = NULL;
992 options.special_flags = NULL;
994 options.serveronly = FALSE;
995 options.network = FALSE;
996 options.verbose = FALSE;
997 options.debug = FALSE;
1000 options.verbose = TRUE;
1002 #if !defined(PLATFORM_UNIX)
1003 if (*options_left == NULL) /* no options given -- enable verbose mode */
1004 options.verbose = TRUE;
1008 while (*options_left)
1010 char option_str[MAX_OPTION_LEN];
1011 char *option = options_left[0];
1012 char *next_option = options_left[1];
1013 char *option_arg = NULL;
1014 int option_len = strlen(option);
1016 if (option_len >= MAX_OPTION_LEN)
1017 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1019 strcpy(option_str, option); /* copy argument into buffer */
1020 option = option_str;
1022 if (strEqual(option, "--")) /* stop scanning arguments */
1025 if (strPrefix(option, "--")) /* treat '--' like '-' */
1028 option_arg = strchr(option, '=');
1029 if (option_arg == NULL) /* no '=' in option */
1030 option_arg = next_option;
1033 *option_arg++ = '\0'; /* cut argument from option */
1034 if (*option_arg == '\0') /* no argument after '=' */
1035 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1038 option_len = strlen(option);
1040 if (strEqual(option, "-"))
1042 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1044 else if (strncmp(option, "-help", option_len) == 0)
1046 print_usage_function();
1050 else if (strncmp(option, "-display", option_len) == 0)
1052 if (option_arg == NULL)
1053 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1055 options.display_name = option_arg;
1056 if (option_arg == next_option)
1059 else if (strncmp(option, "-basepath", option_len) == 0)
1061 if (option_arg == NULL)
1062 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1064 /* this should be extended to separate options for ro and rw data */
1065 options.ro_base_directory = ro_base_path = option_arg;
1066 options.rw_base_directory = rw_base_path = option_arg;
1067 if (option_arg == next_option)
1070 /* adjust paths for sub-directories in base directory accordingly */
1071 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1072 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1073 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1074 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1075 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1077 else if (strncmp(option, "-levels", option_len) == 0)
1079 if (option_arg == NULL)
1080 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1082 options.level_directory = option_arg;
1083 if (option_arg == next_option)
1086 else if (strncmp(option, "-graphics", option_len) == 0)
1088 if (option_arg == NULL)
1089 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1091 options.graphics_directory = option_arg;
1092 if (option_arg == next_option)
1095 else if (strncmp(option, "-sounds", option_len) == 0)
1097 if (option_arg == NULL)
1098 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1100 options.sounds_directory = option_arg;
1101 if (option_arg == next_option)
1104 else if (strncmp(option, "-music", option_len) == 0)
1106 if (option_arg == NULL)
1107 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1109 options.music_directory = option_arg;
1110 if (option_arg == next_option)
1113 else if (strncmp(option, "-network", option_len) == 0)
1115 options.network = TRUE;
1117 else if (strncmp(option, "-serveronly", option_len) == 0)
1119 options.serveronly = TRUE;
1121 else if (strncmp(option, "-debug", option_len) == 0)
1123 options.debug = TRUE;
1125 else if (strncmp(option, "-verbose", option_len) == 0)
1127 options.verbose = TRUE;
1129 else if (strncmp(option, "-version", option_len) == 0 ||
1130 strncmp(option, "-V", option_len) == 0)
1132 print_version_function();
1136 else if (strPrefix(option, "-D"))
1138 options.special_flags = getStringCopy(&option[2]);
1140 else if (strncmp(option, "-execute", option_len) == 0)
1142 if (option_arg == NULL)
1143 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1145 options.execute_command = option_arg;
1146 if (option_arg == next_option)
1149 /* when doing batch processing, always enable verbose mode (warnings) */
1150 options.verbose = TRUE;
1152 #if defined(PLATFORM_MACOSX)
1153 else if (strPrefix(option, "-psn"))
1155 /* ignore process serial number when launched via GUI on Mac OS X */
1158 else if (*option == '-')
1160 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1162 else if (options.server_host == NULL)
1164 options.server_host = *options_left;
1166 else if (options.server_port == 0)
1168 options.server_port = atoi(*options_left);
1169 if (options.server_port < 1024)
1170 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1173 Error(ERR_EXIT_HELP, "too many arguments");
1180 /* ------------------------------------------------------------------------- */
1181 /* error handling functions */
1182 /* ------------------------------------------------------------------------- */
1184 #define MAX_INTERNAL_ERROR_SIZE 1024
1186 /* used by SetError() and GetError() to store internal error messages */
1187 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1189 void SetError(char *format, ...)
1193 va_start(ap, format);
1194 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1200 return internal_error;
1203 void Error(int mode, char *format, ...)
1205 static boolean last_line_was_separator = FALSE;
1206 char *process_name = "";
1208 if (program.log_file[LOG_ERR_ID] == NULL)
1211 #if defined(PLATFORM_ANDROID)
1212 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1213 mode & ERR_INFO ? ANDROID_LOG_INFO :
1214 mode & ERR_WARN ? ANDROID_LOG_WARN :
1215 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1216 ANDROID_LOG_UNKNOWN);
1219 /* display warnings only when running in verbose mode */
1220 if (mode & ERR_WARN && !options.verbose)
1223 if (mode == ERR_INFO_LINE)
1225 if (!last_line_was_separator)
1226 printf_log_line(format, 79);
1228 last_line_was_separator = TRUE;
1233 last_line_was_separator = FALSE;
1235 if (mode & ERR_SOUND_SERVER)
1236 process_name = " sound server";
1237 else if (mode & ERR_NETWORK_SERVER)
1238 process_name = " network server";
1239 else if (mode & ERR_NETWORK_CLIENT)
1240 process_name = " network client **";
1244 #if !defined(PLATFORM_ANDROID)
1245 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1248 if (mode & ERR_WARN)
1249 printf_log_nonewline("warning: ");
1251 if (mode & ERR_EXIT)
1252 printf_log_nonewline("fatal error: ");
1256 va_start(ap, format);
1257 vprintf_log(format, ap);
1260 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1262 va_start(ap, format);
1263 program.exit_message_function(format, ap);
1268 if (mode & ERR_HELP)
1269 printf_log("%s: Try option '--help' for more information.",
1270 program.command_basename);
1272 if (mode & ERR_EXIT)
1273 printf_log("%s%s: aborting", program.command_basename, process_name);
1275 if (mode & ERR_EXIT)
1277 if (mode & ERR_FROM_SERVER)
1278 exit(1); /* child process: normal exit */
1280 program.exit_function(1); /* main process: clean up stuff */
1285 /* ------------------------------------------------------------------------- */
1286 /* checked memory allocation and freeing functions */
1287 /* ------------------------------------------------------------------------- */
1289 void *checked_malloc(unsigned int size)
1296 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1301 void *checked_calloc(unsigned int size)
1305 ptr = calloc(1, size);
1308 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1313 void *checked_realloc(void *ptr, unsigned int size)
1315 ptr = realloc(ptr, size);
1318 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1323 void checked_free(void *ptr)
1325 if (ptr != NULL) /* this check should be done by free() anyway */
1329 void clear_mem(void *ptr, unsigned int size)
1331 #if defined(PLATFORM_WIN32)
1332 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1333 char *cptr = (char *)ptr;
1338 memset(ptr, 0, size);
1343 /* ------------------------------------------------------------------------- */
1344 /* various helper functions */
1345 /* ------------------------------------------------------------------------- */
1347 void swap_numbers(int *i1, int *i2)
1355 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1367 /* the "put" variants of the following file access functions check for the file
1368 pointer being != NULL and return the number of bytes they have or would have
1369 written; this allows for chunk writing functions to first determine the size
1370 of the (not yet written) chunk, write the correct chunk size and finally
1371 write the chunk itself */
1373 int getFile8BitInteger(File *file)
1375 return getByteFromFile(file);
1378 int putFile8BitInteger(FILE *file, int value)
1386 int getFile16BitInteger(File *file, int byte_order)
1388 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1389 return ((getByteFromFile(file) << 8) |
1390 (getByteFromFile(file) << 0));
1391 else /* BYTE_ORDER_LITTLE_ENDIAN */
1392 return ((getByteFromFile(file) << 0) |
1393 (getByteFromFile(file) << 8));
1396 int putFile16BitInteger(FILE *file, int value, int byte_order)
1400 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1402 fputc((value >> 8) & 0xff, file);
1403 fputc((value >> 0) & 0xff, file);
1405 else /* BYTE_ORDER_LITTLE_ENDIAN */
1407 fputc((value >> 0) & 0xff, file);
1408 fputc((value >> 8) & 0xff, file);
1415 int getFile32BitInteger(File *file, int byte_order)
1417 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1418 return ((getByteFromFile(file) << 24) |
1419 (getByteFromFile(file) << 16) |
1420 (getByteFromFile(file) << 8) |
1421 (getByteFromFile(file) << 0));
1422 else /* BYTE_ORDER_LITTLE_ENDIAN */
1423 return ((getByteFromFile(file) << 0) |
1424 (getByteFromFile(file) << 8) |
1425 (getByteFromFile(file) << 16) |
1426 (getByteFromFile(file) << 24));
1429 int putFile32BitInteger(FILE *file, int value, int byte_order)
1433 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1435 fputc((value >> 24) & 0xff, file);
1436 fputc((value >> 16) & 0xff, file);
1437 fputc((value >> 8) & 0xff, file);
1438 fputc((value >> 0) & 0xff, file);
1440 else /* BYTE_ORDER_LITTLE_ENDIAN */
1442 fputc((value >> 0) & 0xff, file);
1443 fputc((value >> 8) & 0xff, file);
1444 fputc((value >> 16) & 0xff, file);
1445 fputc((value >> 24) & 0xff, file);
1452 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1455 const int chunk_name_length = 4;
1457 /* read chunk name */
1458 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1461 if (chunk_size != NULL)
1463 /* read chunk size */
1464 *chunk_size = getFile32BitInteger(file, byte_order);
1467 return (checkEndOfFile(file) ? FALSE : TRUE);
1470 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1475 /* write chunk name */
1477 fputs(chunk_name, file);
1479 num_bytes += strlen(chunk_name);
1481 if (chunk_size >= 0)
1483 /* write chunk size */
1485 putFile32BitInteger(file, chunk_size, byte_order);
1493 int getFileVersion(File *file)
1495 int version_major = getByteFromFile(file);
1496 int version_minor = getByteFromFile(file);
1497 int version_patch = getByteFromFile(file);
1498 int version_build = getByteFromFile(file);
1500 return VERSION_IDENT(version_major, version_minor, version_patch,
1504 int putFileVersion(FILE *file, int version)
1508 int version_major = VERSION_MAJOR(version);
1509 int version_minor = VERSION_MINOR(version);
1510 int version_patch = VERSION_PATCH(version);
1511 int version_build = VERSION_BUILD(version);
1513 fputc(version_major, file);
1514 fputc(version_minor, file);
1515 fputc(version_patch, file);
1516 fputc(version_build, file);
1522 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1526 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1527 buffer[i] = getByteFromFile(file);
1530 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1534 for(i = 0; i < bytes; i++)
1535 fputc(buffer[i], file);
1538 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1540 while (bytes-- && !checkEndOfFile(file))
1541 getByteFromFile(file);
1544 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1551 /* ------------------------------------------------------------------------- */
1552 /* functions to translate key identifiers between different format */
1553 /* ------------------------------------------------------------------------- */
1555 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1556 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1557 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1558 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1560 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1569 /* normal cursor keys */
1570 { KSYM_Left, "XK_Left", "cursor left" },
1571 { KSYM_Right, "XK_Right", "cursor right" },
1572 { KSYM_Up, "XK_Up", "cursor up" },
1573 { KSYM_Down, "XK_Down", "cursor down" },
1575 /* keypad cursor keys */
1577 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1578 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1579 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1580 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1583 /* other keypad keys */
1584 #ifdef KSYM_KP_Enter
1585 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1586 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1587 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1588 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1589 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1590 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1594 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1595 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1596 { KSYM_Control_L, "XK_Control_L", "left control" },
1597 { KSYM_Control_R, "XK_Control_R", "right control" },
1598 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1599 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1600 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1601 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1602 #if !defined(TARGET_SDL2)
1603 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1604 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1606 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1607 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1609 /* some special keys */
1610 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1611 { KSYM_Delete, "XK_Delete", "delete" },
1612 { KSYM_Insert, "XK_Insert", "insert" },
1613 { KSYM_Tab, "XK_Tab", "tab" },
1614 { KSYM_Home, "XK_Home", "home" },
1615 { KSYM_End, "XK_End", "end" },
1616 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1617 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1619 #if defined(TARGET_SDL2)
1620 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1621 { KSYM_Back, "XK_Back", "back" }, /* back key */
1624 /* ASCII 0x20 to 0x40 keys (except numbers) */
1625 { KSYM_space, "XK_space", "space" },
1626 { KSYM_exclam, "XK_exclam", "!" },
1627 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1628 { KSYM_numbersign, "XK_numbersign", "#" },
1629 { KSYM_dollar, "XK_dollar", "$" },
1630 { KSYM_percent, "XK_percent", "%" },
1631 { KSYM_ampersand, "XK_ampersand", "&" },
1632 { KSYM_apostrophe, "XK_apostrophe", "'" },
1633 { KSYM_parenleft, "XK_parenleft", "(" },
1634 { KSYM_parenright, "XK_parenright", ")" },
1635 { KSYM_asterisk, "XK_asterisk", "*" },
1636 { KSYM_plus, "XK_plus", "+" },
1637 { KSYM_comma, "XK_comma", "," },
1638 { KSYM_minus, "XK_minus", "-" },
1639 { KSYM_period, "XK_period", "." },
1640 { KSYM_slash, "XK_slash", "/" },
1641 { KSYM_colon, "XK_colon", ":" },
1642 { KSYM_semicolon, "XK_semicolon", ";" },
1643 { KSYM_less, "XK_less", "<" },
1644 { KSYM_equal, "XK_equal", "=" },
1645 { KSYM_greater, "XK_greater", ">" },
1646 { KSYM_question, "XK_question", "?" },
1647 { KSYM_at, "XK_at", "@" },
1649 /* more ASCII keys */
1650 { KSYM_bracketleft, "XK_bracketleft", "[" },
1651 { KSYM_backslash, "XK_backslash", "\\" },
1652 { KSYM_bracketright,"XK_bracketright", "]" },
1653 { KSYM_asciicircum, "XK_asciicircum", "^" },
1654 { KSYM_underscore, "XK_underscore", "_" },
1655 { KSYM_grave, "XK_grave", "grave" },
1656 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1657 { KSYM_braceleft, "XK_braceleft", "brace left" },
1658 { KSYM_bar, "XK_bar", "bar" },
1659 { KSYM_braceright, "XK_braceright", "brace right" },
1660 { KSYM_asciitilde, "XK_asciitilde", "~" },
1662 /* special (non-ASCII) keys */
1663 { KSYM_degree, "XK_degree", "degree" },
1664 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1665 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1666 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1667 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1668 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1669 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1670 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1672 #if defined(TARGET_SDL2)
1673 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1674 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1675 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1676 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1677 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1678 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1679 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1680 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1681 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1683 /* other keys (for reverse mapping only) */
1684 { KSYM_space, "XK_space", " " },
1687 #if defined(TARGET_SDL2)
1688 /* keypad keys are not in numerical order in SDL2 */
1689 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1690 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1691 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1692 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1693 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1694 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1695 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1696 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1697 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1698 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1701 /* end-of-array identifier */
1707 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1709 static char name_buffer[30];
1712 if (key >= KSYM_A && key <= KSYM_Z)
1713 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1714 else if (key >= KSYM_a && key <= KSYM_z)
1715 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1716 else if (key >= KSYM_0 && key <= KSYM_9)
1717 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1718 #if !defined(TARGET_SDL2)
1719 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1720 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1722 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1723 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1724 else if (key == KSYM_UNDEFINED)
1725 strcpy(name_buffer, "(undefined)");
1732 if (key == translate_key[i].key)
1734 strcpy(name_buffer, translate_key[i].name);
1738 while (translate_key[++i].name);
1740 if (!translate_key[i].name)
1741 strcpy(name_buffer, "(unknown)");
1744 *name = name_buffer;
1746 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1748 static char name_buffer[30];
1751 if (key >= KSYM_A && key <= KSYM_Z)
1752 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1753 else if (key >= KSYM_a && key <= KSYM_z)
1754 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1755 else if (key >= KSYM_0 && key <= KSYM_9)
1756 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1757 #if !defined(TARGET_SDL2)
1758 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1759 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1761 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1762 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1763 else if (key == KSYM_UNDEFINED)
1764 strcpy(name_buffer, "[undefined]");
1771 if (key == translate_key[i].key)
1773 strcpy(name_buffer, translate_key[i].x11name);
1777 while (translate_key[++i].x11name);
1779 if (!translate_key[i].x11name)
1780 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1783 *x11name = name_buffer;
1785 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1787 Key key = KSYM_UNDEFINED;
1788 char *name_ptr = *name;
1790 if (strlen(*name) == 1)
1792 char c = name_ptr[0];
1794 if (c >= 'A' && c <= 'Z')
1795 key = KSYM_A + (Key)(c - 'A');
1796 else if (c >= 'a' && c <= 'z')
1797 key = KSYM_a + (Key)(c - 'a');
1798 else if (c >= '0' && c <= '9')
1799 key = KSYM_0 + (Key)(c - '0');
1802 if (key == KSYM_UNDEFINED)
1808 if (strEqual(translate_key[i].name, *name))
1810 key = translate_key[i].key;
1814 while (translate_key[++i].x11name);
1817 if (key == KSYM_UNDEFINED)
1818 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1822 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1824 Key key = KSYM_UNDEFINED;
1825 char *name_ptr = *x11name;
1827 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1829 char c = name_ptr[3];
1831 if (c >= 'A' && c <= 'Z')
1832 key = KSYM_A + (Key)(c - 'A');
1833 else if (c >= 'a' && c <= 'z')
1834 key = KSYM_a + (Key)(c - 'a');
1835 else if (c >= '0' && c <= '9')
1836 key = KSYM_0 + (Key)(c - '0');
1838 #if !defined(TARGET_SDL2)
1839 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1841 char c = name_ptr[6];
1843 if (c >= '0' && c <= '9')
1844 key = KSYM_KP_0 + (Key)(c - '0');
1847 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1849 char c1 = name_ptr[4];
1850 char c2 = name_ptr[5];
1853 if ((c1 >= '0' && c1 <= '9') &&
1854 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1855 d = atoi(&name_ptr[4]);
1857 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1858 key = KSYM_F1 + (Key)(d - 1);
1860 else if (strPrefix(name_ptr, "XK_"))
1866 if (strEqual(name_ptr, translate_key[i].x11name))
1868 key = translate_key[i].key;
1872 while (translate_key[++i].x11name);
1874 else if (strPrefix(name_ptr, "0x"))
1876 unsigned int value = 0;
1882 char c = *name_ptr++;
1885 if (c >= '0' && c <= '9')
1887 else if (c >= 'a' && c <= 'f')
1888 d = (int)(c - 'a' + 10);
1889 else if (c >= 'A' && c <= 'F')
1890 d = (int)(c - 'A' + 10);
1898 value = value * 16 + d;
1909 char *getKeyNameFromKey(Key key)
1913 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1917 char *getX11KeyNameFromKey(Key key)
1921 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1925 Key getKeyFromKeyName(char *name)
1929 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1933 Key getKeyFromX11KeyName(char *x11name)
1937 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1941 char getCharFromKey(Key key)
1947 } translate_key_char[] =
1949 /* special (non-ASCII) keys (ISO-8859-1) */
1950 { KSYM_degree, CHAR_BYTE_DEGREE },
1951 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1952 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1953 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1954 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1955 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1956 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1957 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1959 /* end-of-array identifier */
1963 char *keyname = getKeyNameFromKey(key);
1966 if (strlen(keyname) == 1)
1968 else if (strEqual(keyname, "space"))
1976 if (key == translate_key_char[i].key)
1978 c = translate_key_char[i].key_char;
1983 while (translate_key_char[++i].key_char);
1989 char getValidConfigValueChar(char c)
1991 if (c == '#' || /* used to mark comments */
1992 c == '\\') /* used to mark continued lines */
1999 /* ------------------------------------------------------------------------- */
2000 /* functions to translate string identifiers to integer or boolean value */
2001 /* ------------------------------------------------------------------------- */
2003 int get_integer_from_string(char *s)
2005 static char *number_text[][3] =
2007 { "0", "zero", "null", },
2008 { "1", "one", "first" },
2009 { "2", "two", "second" },
2010 { "3", "three", "third" },
2011 { "4", "four", "fourth" },
2012 { "5", "five", "fifth" },
2013 { "6", "six", "sixth" },
2014 { "7", "seven", "seventh" },
2015 { "8", "eight", "eighth" },
2016 { "9", "nine", "ninth" },
2017 { "10", "ten", "tenth" },
2018 { "11", "eleven", "eleventh" },
2019 { "12", "twelve", "twelfth" },
2021 { NULL, NULL, NULL },
2025 char *s_lower = getStringToLower(s);
2028 for (i = 0; number_text[i][0] != NULL; i++)
2029 for (j = 0; j < 3; j++)
2030 if (strEqual(s_lower, number_text[i][j]))
2035 if (strEqual(s_lower, "false") ||
2036 strEqual(s_lower, "no") ||
2037 strEqual(s_lower, "off"))
2039 else if (strEqual(s_lower, "true") ||
2040 strEqual(s_lower, "yes") ||
2041 strEqual(s_lower, "on"))
2052 boolean get_boolean_from_string(char *s)
2054 char *s_lower = getStringToLower(s);
2055 boolean result = FALSE;
2057 if (strEqual(s_lower, "true") ||
2058 strEqual(s_lower, "yes") ||
2059 strEqual(s_lower, "on") ||
2060 get_integer_from_string(s) == 1)
2068 int get_switch3_from_string(char *s)
2070 char *s_lower = getStringToLower(s);
2073 if (strEqual(s_lower, "true") ||
2074 strEqual(s_lower, "yes") ||
2075 strEqual(s_lower, "on") ||
2076 get_integer_from_string(s) == 1)
2078 else if (strEqual(s_lower, "auto"))
2087 /* ------------------------------------------------------------------------- */
2088 /* functions for generic lists */
2089 /* ------------------------------------------------------------------------- */
2091 ListNode *newListNode()
2093 return checked_calloc(sizeof(ListNode));
2096 void addNodeToList(ListNode **node_first, char *key, void *content)
2098 ListNode *node_new = newListNode();
2100 node_new->key = getStringCopy(key);
2101 node_new->content = content;
2102 node_new->next = *node_first;
2105 (*node_first)->prev = node_new;
2107 *node_first = node_new;
2110 void deleteNodeFromList(ListNode **node_first, char *key,
2111 void (*destructor_function)(void *))
2113 if (node_first == NULL || *node_first == NULL)
2116 if (strEqual((*node_first)->key, key))
2118 checked_free((*node_first)->key);
2120 if (destructor_function)
2121 destructor_function((*node_first)->content);
2123 if ((*node_first)->next)
2124 (*node_first)->next->prev = (*node_first)->prev;
2126 checked_free(*node_first);
2128 *node_first = (*node_first)->next;
2131 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2134 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2136 if (node_first == NULL)
2139 if (strEqual(node_first->key, key))
2142 return getNodeFromKey(node_first->next, key);
2145 int getNumNodes(ListNode *node_first)
2147 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2150 void dumpList(ListNode *node_first)
2152 ListNode *node = node_first;
2156 printf("['%s' (%d)]\n", node->key,
2157 ((struct ListNodeInfo *)node->content)->num_references);
2161 printf("[%d nodes]\n", getNumNodes(node_first));
2165 /* ------------------------------------------------------------------------- */
2166 /* functions for file handling */
2167 /* ------------------------------------------------------------------------- */
2169 File *openFile(char *filename, char *mode)
2171 File *file = checked_calloc(sizeof(File));
2173 file->file = fopen(filename, mode);
2175 if (file->file != NULL)
2177 file->filename = getStringCopy(filename);
2182 #if defined(PLATFORM_ANDROID)
2183 file->asset_file = SDL_RWFromFile(filename, mode);
2185 if (file->asset_file != NULL)
2187 file->file_is_asset = TRUE;
2188 file->filename = getStringCopy(filename);
2199 int closeFile(File *file)
2206 #if defined(PLATFORM_ANDROID)
2207 if (file->asset_file)
2208 result = SDL_RWclose(file->asset_file);
2212 result = fclose(file->file);
2214 checked_free(file->filename);
2220 int checkEndOfFile(File *file)
2222 #if defined(PLATFORM_ANDROID)
2223 if (file->file_is_asset)
2224 return file->end_of_file;
2227 return feof(file->file);
2230 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2232 #if defined(PLATFORM_ANDROID)
2233 if (file->file_is_asset)
2235 if (file->end_of_file)
2238 size_t num_items_read =
2239 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2241 if (num_items_read < num_items)
2242 file->end_of_file = TRUE;
2244 return num_items_read;
2248 return fread(buffer, item_size, num_items, file->file);
2251 int seekFile(File *file, long offset, int whence)
2253 #if defined(PLATFORM_ANDROID)
2254 if (file->file_is_asset)
2256 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2257 whence == SEEK_CUR ? RW_SEEK_CUR :
2258 whence == SEEK_END ? RW_SEEK_END : 0);
2260 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2264 return fseek(file->file, offset, whence);
2267 int getByteFromFile(File *file)
2269 #if defined(PLATFORM_ANDROID)
2270 if (file->file_is_asset)
2272 if (file->end_of_file)
2276 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2278 if (num_bytes_read < 1)
2279 file->end_of_file = TRUE;
2281 return (file->end_of_file ? EOF : (int)c);
2285 return fgetc(file->file);
2288 char *getStringFromFile(File *file, char *line, int size)
2290 #if defined(PLATFORM_ANDROID)
2291 if (file->file_is_asset)
2293 if (file->end_of_file)
2296 char *line_ptr = line;
2297 int num_bytes_read = 0;
2299 while (num_bytes_read < size - 1 &&
2300 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2301 *line_ptr++ != '\n')
2306 if (strlen(line) == 0)
2308 file->end_of_file = TRUE;
2317 return fgets(line, size, file->file);
2321 /* ------------------------------------------------------------------------- */
2322 /* functions for directory handling */
2323 /* ------------------------------------------------------------------------- */
2325 Directory *openDirectory(char *dir_name)
2327 Directory *dir = checked_calloc(sizeof(Directory));
2329 dir->dir = opendir(dir_name);
2331 if (dir->dir != NULL)
2333 dir->filename = getStringCopy(dir_name);
2338 #if defined(PLATFORM_ANDROID)
2339 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2341 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2343 checked_free(asset_toc_filename);
2345 if (dir->asset_toc_file != NULL)
2347 dir->directory_is_asset = TRUE;
2348 dir->filename = getStringCopy(dir_name);
2359 int closeDirectory(Directory *dir)
2366 #if defined(PLATFORM_ANDROID)
2367 if (dir->asset_toc_file)
2368 result = SDL_RWclose(dir->asset_toc_file);
2372 result = closedir(dir->dir);
2375 freeDirectoryEntry(dir->dir_entry);
2377 checked_free(dir->filename);
2383 DirectoryEntry *readDirectory(Directory *dir)
2386 freeDirectoryEntry(dir->dir_entry);
2388 dir->dir_entry = NULL;
2390 #if defined(PLATFORM_ANDROID)
2391 if (dir->directory_is_asset)
2393 char line[MAX_LINE_LEN];
2394 char *line_ptr = line;
2395 int num_bytes_read = 0;
2397 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2398 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2407 if (strlen(line) == 0)
2410 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2412 dir->dir_entry->is_directory = FALSE;
2413 if (line[strlen(line) - 1] == '/')
2415 dir->dir_entry->is_directory = TRUE;
2417 line[strlen(line) - 1] = '\0';
2420 dir->dir_entry->basename = getStringCopy(line);
2421 dir->dir_entry->filename = getPath2(dir->filename, line);
2423 return dir->dir_entry;
2427 struct dirent *dir_entry = readdir(dir->dir);
2429 if (dir_entry == NULL)
2432 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2434 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2435 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2437 struct stat file_status;
2439 dir->dir_entry->is_directory =
2440 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2441 S_ISDIR(file_status.st_mode));
2443 return dir->dir_entry;
2446 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2448 if (dir_entry == NULL)
2451 checked_free(dir_entry->basename);
2452 checked_free(dir_entry->filename);
2453 checked_free(dir_entry);
2457 /* ------------------------------------------------------------------------- */
2458 /* functions for checking files and filenames */
2459 /* ------------------------------------------------------------------------- */
2461 boolean directoryExists(char *dir_name)
2463 if (dir_name == NULL)
2466 struct stat file_status;
2467 boolean success = (stat(dir_name, &file_status) == 0 &&
2468 S_ISDIR(file_status.st_mode));
2470 #if defined(PLATFORM_ANDROID)
2473 // this might be an asset directory; check by trying to open toc file
2474 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2475 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2477 checked_free(asset_toc_filename);
2479 success = (file != NULL);
2489 boolean fileExists(char *filename)
2491 if (filename == NULL)
2494 boolean success = (access(filename, F_OK) == 0);
2496 #if defined(PLATFORM_ANDROID)
2499 // this might be an asset file; check by trying to open it
2500 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2502 success = (file != NULL);
2512 boolean fileHasPrefix(char *basename, char *prefix)
2514 static char *basename_lower = NULL;
2515 int basename_length, prefix_length;
2517 checked_free(basename_lower);
2519 if (basename == NULL || prefix == NULL)
2522 basename_lower = getStringToLower(basename);
2523 basename_length = strlen(basename_lower);
2524 prefix_length = strlen(prefix);
2526 if (basename_length > prefix_length + 1 &&
2527 basename_lower[prefix_length] == '.' &&
2528 strncmp(basename_lower, prefix, prefix_length) == 0)
2534 boolean fileHasSuffix(char *basename, char *suffix)
2536 static char *basename_lower = NULL;
2537 int basename_length, suffix_length;
2539 checked_free(basename_lower);
2541 if (basename == NULL || suffix == NULL)
2544 basename_lower = getStringToLower(basename);
2545 basename_length = strlen(basename_lower);
2546 suffix_length = strlen(suffix);
2548 if (basename_length > suffix_length + 1 &&
2549 basename_lower[basename_length - suffix_length - 1] == '.' &&
2550 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2556 static boolean FileCouldBeArtwork(char *filename)
2558 char *basename = getBaseNamePtr(filename);
2560 return (!strEqual(basename, ".") &&
2561 !strEqual(basename, "..") &&
2562 !fileHasSuffix(basename, "txt") &&
2563 !fileHasSuffix(basename, "conf") &&
2564 !directoryExists(filename));
2567 boolean FileIsGraphic(char *filename)
2569 return FileCouldBeArtwork(filename);
2572 boolean FileIsSound(char *filename)
2574 return FileCouldBeArtwork(filename);
2577 boolean FileIsMusic(char *filename)
2579 return FileCouldBeArtwork(filename);
2582 boolean FileIsArtworkType(char *filename, int type)
2584 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2585 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2586 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2592 /* ------------------------------------------------------------------------- */
2593 /* functions for loading artwork configuration information */
2594 /* ------------------------------------------------------------------------- */
2596 char *get_mapped_token(char *token)
2598 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2599 static char *map_token_prefix[][2] =
2601 { "char_procent", "char_percent" },
2606 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2608 int len_token_prefix = strlen(map_token_prefix[i][0]);
2610 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2611 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2617 /* This function checks if a string <s> of the format "string1, string2, ..."
2618 exactly contains a string <s_contained>. */
2620 static boolean string_has_parameter(char *s, char *s_contained)
2624 if (s == NULL || s_contained == NULL)
2627 if (strlen(s_contained) > strlen(s))
2630 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2632 char next_char = s[strlen(s_contained)];
2634 /* check if next character is delimiter or whitespace */
2635 return (next_char == ',' || next_char == '\0' ||
2636 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2639 /* check if string contains another parameter string after a comma */
2640 substring = strchr(s, ',');
2641 if (substring == NULL) /* string does not contain a comma */
2644 /* advance string pointer to next character after the comma */
2647 /* skip potential whitespaces after the comma */
2648 while (*substring == ' ' || *substring == '\t')
2651 return string_has_parameter(substring, s_contained);
2654 int get_parameter_value(char *value_raw, char *suffix, int type)
2656 char *value = getStringToLower(value_raw);
2657 int result = 0; /* probably a save default value */
2659 if (strEqual(suffix, ".direction"))
2661 result = (strEqual(value, "left") ? MV_LEFT :
2662 strEqual(value, "right") ? MV_RIGHT :
2663 strEqual(value, "up") ? MV_UP :
2664 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2666 else if (strEqual(suffix, ".position"))
2668 result = (strEqual(value, "left") ? POS_LEFT :
2669 strEqual(value, "right") ? POS_RIGHT :
2670 strEqual(value, "top") ? POS_TOP :
2671 strEqual(value, "upper") ? POS_UPPER :
2672 strEqual(value, "middle") ? POS_MIDDLE :
2673 strEqual(value, "lower") ? POS_LOWER :
2674 strEqual(value, "bottom") ? POS_BOTTOM :
2675 strEqual(value, "any") ? POS_ANY : POS_UNDEFINED);
2677 else if (strEqual(suffix, ".align"))
2679 result = (strEqual(value, "left") ? ALIGN_LEFT :
2680 strEqual(value, "right") ? ALIGN_RIGHT :
2681 strEqual(value, "center") ? ALIGN_CENTER :
2682 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2684 else if (strEqual(suffix, ".valign"))
2686 result = (strEqual(value, "top") ? VALIGN_TOP :
2687 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2688 strEqual(value, "middle") ? VALIGN_MIDDLE :
2689 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2691 else if (strEqual(suffix, ".anim_mode"))
2693 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2694 string_has_parameter(value, "loop") ? ANIM_LOOP :
2695 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2696 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2697 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2698 string_has_parameter(value, "random") ? ANIM_RANDOM :
2699 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2700 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2701 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2702 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2703 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2704 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2705 string_has_parameter(value, "all") ? ANIM_ALL :
2708 if (string_has_parameter(value, "reverse"))
2709 result |= ANIM_REVERSE;
2711 if (string_has_parameter(value, "opaque_player"))
2712 result |= ANIM_OPAQUE_PLAYER;
2714 if (string_has_parameter(value, "static_panel"))
2715 result |= ANIM_STATIC_PANEL;
2717 else if (strEqual(suffix, ".class"))
2719 result = get_hash_from_key(value);
2721 else if (strEqual(suffix, ".style"))
2723 result = STYLE_DEFAULT;
2725 if (string_has_parameter(value, "accurate_borders"))
2726 result |= STYLE_ACCURATE_BORDERS;
2728 if (string_has_parameter(value, "inner_corners"))
2729 result |= STYLE_INNER_CORNERS;
2731 else if (strEqual(suffix, ".fade_mode"))
2733 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2734 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2735 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2736 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2737 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
2740 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2742 result = gfx.get_font_from_token_function(value);
2744 else /* generic parameter of type integer or boolean */
2746 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2747 type == TYPE_INTEGER ? get_integer_from_string(value) :
2748 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2749 ARG_UNDEFINED_VALUE);
2757 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2759 static struct ScreenModeInfo screen_mode;
2760 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2761 char *screen_mode_string_copy;
2762 char *screen_mode_string_pos_w;
2763 char *screen_mode_string_pos_h;
2765 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2768 screen_mode_string_copy = getStringCopy(screen_mode_string);
2770 screen_mode_string_pos_w = screen_mode_string_copy;
2771 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2772 *screen_mode_string_pos_h++ = '\0';
2774 screen_mode.width = atoi(screen_mode_string_pos_w);
2775 screen_mode.height = atoi(screen_mode_string_pos_h);
2777 return &screen_mode;
2780 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2783 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2784 float aspect_ratio_new;
2789 *x = i * aspect_ratio + 0.000001;
2792 aspect_ratio_new = (float)*x / (float)*y;
2796 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2799 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2800 struct ListNodeInfo ***, int *);
2802 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2803 struct ConfigTypeInfo *suffix_list,
2804 char **ignore_tokens,
2805 int num_file_list_entries)
2807 struct FileInfo *file_list;
2808 int num_file_list_entries_found = 0;
2809 int num_suffix_list_entries = 0;
2813 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2815 for (i = 0; suffix_list[i].token != NULL; i++)
2816 num_suffix_list_entries++;
2818 /* always start with reliable default values */
2819 for (i = 0; i < num_file_list_entries; i++)
2821 file_list[i].token = NULL;
2823 file_list[i].default_filename = NULL;
2824 file_list[i].filename = NULL;
2826 if (num_suffix_list_entries > 0)
2828 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2830 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2831 file_list[i].parameter = checked_calloc(parameter_array_size);
2833 for (j = 0; j < num_suffix_list_entries; j++)
2835 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2836 setString(&file_list[i].parameter[j], suffix_list[j].value);
2839 file_list[i].redefined = FALSE;
2840 file_list[i].fallback_to_default = FALSE;
2841 file_list[i].default_is_cloned = FALSE;
2847 for (i = 0; config_list[i].token != NULL; i++)
2849 int len_config_token = strlen(config_list[i].token);
2850 boolean is_file_entry = TRUE;
2852 for (j = 0; suffix_list[j].token != NULL; j++)
2854 int len_suffix = strlen(suffix_list[j].token);
2856 if (len_suffix < len_config_token &&
2857 strEqual(&config_list[i].token[len_config_token - len_suffix],
2858 suffix_list[j].token))
2860 setString(&file_list[list_pos].default_parameter[j],
2861 config_list[i].value);
2863 is_file_entry = FALSE;
2869 /* the following tokens are no file definitions, but other config tokens */
2870 for (j = 0; ignore_tokens[j] != NULL; j++)
2871 if (strEqual(config_list[i].token, ignore_tokens[j]))
2872 is_file_entry = FALSE;
2879 if (list_pos >= num_file_list_entries)
2882 file_list[list_pos].token = config_list[i].token;
2883 file_list[list_pos].default_filename = config_list[i].value;
2886 if (strSuffix(config_list[i].token, ".clone_from"))
2887 file_list[list_pos].default_is_cloned = TRUE;
2890 num_file_list_entries_found = list_pos + 1;
2891 if (num_file_list_entries_found != num_file_list_entries)
2893 Error(ERR_INFO_LINE, "-");
2894 Error(ERR_INFO, "inconsistant config list information:");
2895 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2896 num_file_list_entries);
2897 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2898 num_file_list_entries_found);
2899 Error(ERR_EXIT, "please fix");
2905 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2907 int len_token = strlen(token);
2908 int len_suffix = strlen(suffix);
2910 if (start_pos < 0) /* compare suffix from end of string */
2911 start_pos += len_token;
2913 if (start_pos < 0 || start_pos + len_suffix > len_token)
2916 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2919 if (token[start_pos + len_suffix] == '\0')
2922 if (token[start_pos + len_suffix] == '.')
2928 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2930 static void read_token_parameters(SetupFileHash *setup_file_hash,
2931 struct ConfigTypeInfo *suffix_list,
2932 struct FileInfo *file_list_entry)
2934 /* check for config token that is the base token without any suffixes */
2935 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2936 char *known_token_value = KNOWN_TOKEN_VALUE;
2939 if (filename != NULL)
2941 setString(&file_list_entry->filename, filename);
2943 /* when file definition found, set all parameters to default values */
2944 for (i = 0; suffix_list[i].token != NULL; i++)
2945 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2947 file_list_entry->redefined = TRUE;
2949 /* mark config file token as well known from default config */
2950 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2953 /* check for config tokens that can be build by base token and suffixes */
2954 for (i = 0; suffix_list[i].token != NULL; i++)
2956 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2957 char *value = getHashEntry(setup_file_hash, token);
2961 setString(&file_list_entry->parameter[i], value);
2963 /* mark config file token as well known from default config */
2964 setHashEntry(setup_file_hash, token, known_token_value);
2971 static void add_dynamic_file_list_entry(struct FileInfo **list,
2972 int *num_list_entries,
2973 SetupFileHash *extra_file_hash,
2974 struct ConfigTypeInfo *suffix_list,
2975 int num_suffix_list_entries,
2978 struct FileInfo *new_list_entry;
2979 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2981 (*num_list_entries)++;
2982 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2983 new_list_entry = &(*list)[*num_list_entries - 1];
2985 new_list_entry->token = getStringCopy(token);
2986 new_list_entry->default_filename = NULL;
2987 new_list_entry->filename = NULL;
2988 new_list_entry->parameter = checked_calloc(parameter_array_size);
2990 new_list_entry->redefined = FALSE;
2991 new_list_entry->fallback_to_default = FALSE;
2992 new_list_entry->default_is_cloned = FALSE;
2994 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2997 static void add_property_mapping(struct PropertyMapping **list,
2998 int *num_list_entries,
2999 int base_index, int ext1_index,
3000 int ext2_index, int ext3_index,
3003 struct PropertyMapping *new_list_entry;
3005 (*num_list_entries)++;
3006 *list = checked_realloc(*list,
3007 *num_list_entries * sizeof(struct PropertyMapping));
3008 new_list_entry = &(*list)[*num_list_entries - 1];
3010 new_list_entry->base_index = base_index;
3011 new_list_entry->ext1_index = ext1_index;
3012 new_list_entry->ext2_index = ext2_index;
3013 new_list_entry->ext3_index = ext3_index;
3015 new_list_entry->artwork_index = artwork_index;
3018 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3021 struct FileInfo *file_list = artwork_info->file_list;
3022 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3023 char **base_prefixes = artwork_info->base_prefixes;
3024 char **ext1_suffixes = artwork_info->ext1_suffixes;
3025 char **ext2_suffixes = artwork_info->ext2_suffixes;
3026 char **ext3_suffixes = artwork_info->ext3_suffixes;
3027 char **ignore_tokens = artwork_info->ignore_tokens;
3028 int num_file_list_entries = artwork_info->num_file_list_entries;
3029 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3030 int num_base_prefixes = artwork_info->num_base_prefixes;
3031 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3032 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3033 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3034 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3035 SetupFileHash *setup_file_hash, *valid_file_hash;
3036 SetupFileHash *extra_file_hash, *empty_file_hash;
3037 char *known_token_value = KNOWN_TOKEN_VALUE;
3040 if (filename == NULL)
3043 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3046 /* separate valid (defined) from empty (undefined) config token values */
3047 valid_file_hash = newSetupFileHash();
3048 empty_file_hash = newSetupFileHash();
3049 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3051 char *value = HASH_ITERATION_VALUE(itr);
3053 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3054 HASH_ITERATION_TOKEN(itr), value);
3056 END_HASH_ITERATION(setup_file_hash, itr)
3058 /* at this point, we do not need the setup file hash anymore -- free it */
3059 freeSetupFileHash(setup_file_hash);
3061 /* map deprecated to current tokens (using prefix match and replace) */
3062 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3064 char *token = HASH_ITERATION_TOKEN(itr);
3065 char *mapped_token = get_mapped_token(token);
3067 if (mapped_token != NULL)
3069 char *value = HASH_ITERATION_VALUE(itr);
3071 /* add mapped token */
3072 setHashEntry(valid_file_hash, mapped_token, value);
3074 /* ignore old token (by setting it to "known" keyword) */
3075 setHashEntry(valid_file_hash, token, known_token_value);
3080 END_HASH_ITERATION(valid_file_hash, itr)
3082 /* read parameters for all known config file tokens */
3083 for (i = 0; i < num_file_list_entries; i++)
3084 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3086 /* set all tokens that can be ignored here to "known" keyword */
3087 for (i = 0; i < num_ignore_tokens; i++)
3088 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3090 /* copy all unknown config file tokens to extra config hash */
3091 extra_file_hash = newSetupFileHash();
3092 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3094 char *value = HASH_ITERATION_VALUE(itr);
3096 if (!strEqual(value, known_token_value))
3097 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3099 END_HASH_ITERATION(valid_file_hash, itr)
3101 /* at this point, we do not need the valid file hash anymore -- free it */
3102 freeSetupFileHash(valid_file_hash);
3104 /* now try to determine valid, dynamically defined config tokens */
3106 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3108 struct FileInfo **dynamic_file_list =
3109 &artwork_info->dynamic_file_list;
3110 int *num_dynamic_file_list_entries =
3111 &artwork_info->num_dynamic_file_list_entries;
3112 struct PropertyMapping **property_mapping =
3113 &artwork_info->property_mapping;
3114 int *num_property_mapping_entries =
3115 &artwork_info->num_property_mapping_entries;
3116 int current_summarized_file_list_entry =
3117 artwork_info->num_file_list_entries +
3118 artwork_info->num_dynamic_file_list_entries;
3119 char *token = HASH_ITERATION_TOKEN(itr);
3120 int len_token = strlen(token);
3122 boolean base_prefix_found = FALSE;
3123 boolean parameter_suffix_found = FALSE;
3125 /* skip all parameter definitions (handled by read_token_parameters()) */
3126 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3128 int len_suffix = strlen(suffix_list[i].token);
3130 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3131 parameter_suffix_found = TRUE;
3134 if (parameter_suffix_found)
3137 /* ---------- step 0: search for matching base prefix ---------- */
3140 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3142 char *base_prefix = base_prefixes[i];
3143 int len_base_prefix = strlen(base_prefix);
3144 boolean ext1_suffix_found = FALSE;
3145 boolean ext2_suffix_found = FALSE;
3146 boolean ext3_suffix_found = FALSE;
3147 boolean exact_match = FALSE;
3148 int base_index = -1;
3149 int ext1_index = -1;
3150 int ext2_index = -1;
3151 int ext3_index = -1;
3153 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3155 if (!base_prefix_found)
3160 if (start_pos + len_base_prefix == len_token) /* exact match */
3164 add_dynamic_file_list_entry(dynamic_file_list,
3165 num_dynamic_file_list_entries,
3168 num_suffix_list_entries,
3170 add_property_mapping(property_mapping,
3171 num_property_mapping_entries,
3172 base_index, -1, -1, -1,
3173 current_summarized_file_list_entry);
3177 /* ---------- step 1: search for matching first suffix ---------- */
3179 start_pos += len_base_prefix;
3180 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3182 char *ext1_suffix = ext1_suffixes[j];
3183 int len_ext1_suffix = strlen(ext1_suffix);
3185 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3187 if (!ext1_suffix_found)
3192 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3196 add_dynamic_file_list_entry(dynamic_file_list,
3197 num_dynamic_file_list_entries,
3200 num_suffix_list_entries,
3202 add_property_mapping(property_mapping,
3203 num_property_mapping_entries,
3204 base_index, ext1_index, -1, -1,
3205 current_summarized_file_list_entry);
3209 start_pos += len_ext1_suffix;
3215 /* ---------- step 2: search for matching second suffix ---------- */
3217 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3219 char *ext2_suffix = ext2_suffixes[k];
3220 int len_ext2_suffix = strlen(ext2_suffix);
3222 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3224 if (!ext2_suffix_found)
3229 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3233 add_dynamic_file_list_entry(dynamic_file_list,
3234 num_dynamic_file_list_entries,
3237 num_suffix_list_entries,
3239 add_property_mapping(property_mapping,
3240 num_property_mapping_entries,
3241 base_index, ext1_index, ext2_index, -1,
3242 current_summarized_file_list_entry);
3246 start_pos += len_ext2_suffix;
3252 /* ---------- step 3: search for matching third suffix ---------- */
3254 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3256 char *ext3_suffix = ext3_suffixes[l];
3257 int len_ext3_suffix = strlen(ext3_suffix);
3259 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3261 if (!ext3_suffix_found)
3266 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3270 add_dynamic_file_list_entry(dynamic_file_list,
3271 num_dynamic_file_list_entries,
3274 num_suffix_list_entries,
3276 add_property_mapping(property_mapping,
3277 num_property_mapping_entries,
3278 base_index, ext1_index, ext2_index, ext3_index,
3279 current_summarized_file_list_entry);
3285 END_HASH_ITERATION(extra_file_hash, itr)
3287 if (artwork_info->num_dynamic_file_list_entries > 0)
3289 artwork_info->dynamic_artwork_list =
3290 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3291 artwork_info->sizeof_artwork_list_entry);
3294 if (options.verbose && IS_PARENT_PROCESS())
3296 SetupFileList *setup_file_list, *list;
3297 boolean dynamic_tokens_found = FALSE;
3298 boolean unknown_tokens_found = FALSE;
3299 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3301 /* list may be NULL for empty artwork config files */
3302 setup_file_list = loadSetupFileList(filename);
3304 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3306 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3307 dynamic_tokens_found = TRUE;
3309 unknown_tokens_found = TRUE;
3311 END_HASH_ITERATION(extra_file_hash, itr)
3313 if (options.debug && dynamic_tokens_found)
3315 Error(ERR_INFO_LINE, "-");
3316 Error(ERR_INFO, "dynamic token(s) found in config file:");
3317 Error(ERR_INFO, "- config file: '%s'", filename);
3319 for (list = setup_file_list; list != NULL; list = list->next)
3321 char *value = getHashEntry(extra_file_hash, list->token);
3323 if (value != NULL && strEqual(value, known_token_value))
3324 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3327 Error(ERR_INFO_LINE, "-");
3330 if (unknown_tokens_found)
3332 Error(ERR_INFO_LINE, "-");
3333 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3334 Error(ERR_INFO, "- config file: '%s'", filename);
3336 for (list = setup_file_list; list != NULL; list = list->next)
3338 char *value = getHashEntry(extra_file_hash, list->token);
3340 if (value != NULL && !strEqual(value, known_token_value))
3341 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3344 Error(ERR_INFO_LINE, "-");
3347 if (undefined_values_found)
3349 Error(ERR_INFO_LINE, "-");
3350 Error(ERR_INFO, "warning: undefined values found in config file:");
3351 Error(ERR_INFO, "- config file: '%s'", filename);
3353 for (list = setup_file_list; list != NULL; list = list->next)
3355 char *value = getHashEntry(empty_file_hash, list->token);
3358 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3361 Error(ERR_INFO_LINE, "-");
3364 freeSetupFileList(setup_file_list);
3367 freeSetupFileHash(extra_file_hash);
3368 freeSetupFileHash(empty_file_hash);
3371 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3373 struct FileInfo *file_list = artwork_info->file_list;
3374 int num_file_list_entries = artwork_info->num_file_list_entries;
3375 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3376 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3379 DrawInitText("Loading artwork config", 120, FC_GREEN);
3380 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3382 /* always start with reliable default values */
3383 for (i = 0; i < num_file_list_entries; i++)
3385 setString(&file_list[i].filename, file_list[i].default_filename);
3387 for (j = 0; j < num_suffix_list_entries; j++)
3388 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3390 file_list[i].redefined = FALSE;
3391 file_list[i].fallback_to_default = FALSE;
3394 /* free previous dynamic artwork file array */
3395 if (artwork_info->dynamic_file_list != NULL)
3397 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3399 free(artwork_info->dynamic_file_list[i].token);
3400 free(artwork_info->dynamic_file_list[i].filename);
3401 free(artwork_info->dynamic_file_list[i].parameter);
3404 free(artwork_info->dynamic_file_list);
3405 artwork_info->dynamic_file_list = NULL;
3407 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3408 &artwork_info->num_dynamic_file_list_entries);
3411 /* free previous property mapping */
3412 if (artwork_info->property_mapping != NULL)
3414 free(artwork_info->property_mapping);
3416 artwork_info->property_mapping = NULL;
3417 artwork_info->num_property_mapping_entries = 0;
3420 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3422 /* first look for special artwork configured in level series config */
3423 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3425 if (fileExists(filename_base))
3426 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3429 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3431 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3432 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3435 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3436 struct ListNodeInfo **listnode)
3440 char *filename = (*listnode)->source_filename;
3442 if (--(*listnode)->num_references <= 0)
3443 deleteNodeFromList(&artwork_info->content_list, filename,
3444 artwork_info->free_artwork);
3450 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3451 struct ListNodeInfo **listnode,
3452 struct FileInfo *file_list_entry)
3462 char *basename = file_list_entry->filename;
3463 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3465 if (filename == NULL)
3467 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3469 basename = file_list_entry->default_filename;
3471 /* fail for cloned default artwork that has no default filename defined */
3472 if (file_list_entry->default_is_cloned &&
3473 strEqual(basename, UNDEFINED_FILENAME))
3475 int error_mode = ERR_WARN;
3477 /* we can get away without sounds and music, but not without graphics */
3478 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3479 error_mode = ERR_EXIT;
3481 Error(error_mode, "token '%s' was cloned and has no default filename",
3482 file_list_entry->token);
3487 /* dynamic artwork has no default filename / skip empty default artwork */
3488 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3491 file_list_entry->fallback_to_default = TRUE;
3493 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3495 filename = getCustomArtworkFilename(basename, artwork_info->type);
3497 if (filename == NULL)
3499 int error_mode = ERR_WARN;
3501 /* we can get away without sounds and music, but not without graphics */
3502 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3503 error_mode = ERR_EXIT;
3505 Error(error_mode, "cannot find default artwork file '%s'", basename);
3511 /* check if the old and the new artwork file are the same */
3512 if (*listnode && strEqual((*listnode)->source_filename, filename))
3514 /* The old and new artwork are the same (have the same filename and path).
3515 This usually means that this artwork does not exist in this artwork set
3516 and a fallback to the existing artwork is done. */
3521 /* delete existing artwork file entry */
3522 deleteArtworkListEntry(artwork_info, listnode);
3524 /* check if the new artwork file already exists in the list of artwork */
3525 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3527 *listnode = (struct ListNodeInfo *)node->content;
3528 (*listnode)->num_references++;
3533 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3534 DrawInitText(basename, 150, FC_YELLOW);
3536 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3538 /* add new artwork file entry to the list of artwork files */
3539 (*listnode)->num_references = 1;
3540 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3545 int error_mode = ERR_WARN;
3547 /* we can get away without sounds and music, but not without graphics */
3548 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3549 error_mode = ERR_EXIT;
3551 Error(error_mode, "cannot load artwork file '%s'", basename);
3557 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3558 struct ListNodeInfo **listnode,
3559 struct FileInfo *file_list_entry)
3561 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3563 deleteArtworkListEntry(artwork_info, listnode);
3568 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3571 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3573 struct FileInfo *file_list = artwork_info->file_list;
3574 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3575 int num_file_list_entries = artwork_info->num_file_list_entries;
3576 int num_dynamic_file_list_entries =
3577 artwork_info->num_dynamic_file_list_entries;
3580 print_timestamp_init("ReloadCustomArtworkList");
3582 for (i = 0; i < num_file_list_entries; i++)
3583 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3586 for (i = 0; i < num_dynamic_file_list_entries; i++)
3587 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3588 &dynamic_file_list[i]);
3590 print_timestamp_done("ReloadCustomArtworkList");
3593 dumpList(artwork_info->content_list);
3597 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3598 struct ListNodeInfo ***list,
3599 int *num_list_entries)
3606 for (i = 0; i < *num_list_entries; i++)
3607 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3611 *num_list_entries = 0;
3614 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3616 if (artwork_info == NULL)
3619 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3620 &artwork_info->num_file_list_entries);
3622 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3623 &artwork_info->num_dynamic_file_list_entries);
3627 /* ------------------------------------------------------------------------- */
3628 /* functions only needed for non-Unix (non-command-line) systems */
3629 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3630 /* (now also added for Windows, to create files in user data directory) */
3631 /* ------------------------------------------------------------------------- */
3633 char *getLogFilename(char *basename)
3635 return getPath2(getUserGameDataDir(), basename);
3642 InitUserDataDirectory();
3644 for (i = 0; i < NUM_LOGS; i++)
3646 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3649 program.log_file[i] = program.log_file_default[i]; // reset to default
3651 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3652 program.log_filename[i], strerror(errno));
3655 /* output should be unbuffered so it is not truncated in a crash */
3656 setbuf(program.log_file[i], NULL);
3660 void CloseLogFiles()
3664 for (i = 0; i < NUM_LOGS; i++)
3665 if (program.log_file[i] != program.log_file_default[i])
3666 fclose(program.log_file[i]);
3669 void DumpLogFile(int nr)
3671 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3673 if (log_file == NULL)
3676 while (!feof(log_file))
3677 fputc(fgetc(log_file), stdout);
3682 void NotifyUserAboutErrorFile()
3684 #if defined(PLATFORM_WIN32)
3685 char *title_text = getStringCat2(program.program_title, " Error Message");
3686 char *error_text = getStringCat2("The program was aborted due to an error; "
3687 "for details, see the following error file:"
3689 program.log_filename[LOG_ERR_ID]);
3691 MessageBox(NULL, error_text, title_text, MB_OK);
3696 /* ------------------------------------------------------------------------- */
3697 /* the following is only for debugging purpose and normally not used */
3698 /* ------------------------------------------------------------------------- */
3702 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3703 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3705 #define DEBUG_NUM_TIMESTAMPS 10
3706 #define DEBUG_TIME_IN_MICROSECONDS 0
3708 #if DEBUG_TIME_IN_MICROSECONDS
3709 static double Counter_Microseconds()
3711 static struct timeval base_time = { 0, 0 };
3712 struct timeval current_time;
3715 gettimeofday(¤t_time, NULL);
3717 /* reset base time in case of wrap-around */
3718 if (current_time.tv_sec < base_time.tv_sec)
3719 base_time = current_time;
3722 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3723 ((double)(current_time.tv_usec - base_time.tv_usec));
3725 return counter; /* return microseconds since last init */
3729 char *debug_print_timestamp_get_padding(int padding_size)
3731 static char *padding = NULL;
3732 int max_padding_size = 100;
3734 if (padding == NULL)
3736 padding = checked_calloc(max_padding_size + 1);
3737 memset(padding, ' ', max_padding_size);
3740 return &padding[MAX(0, max_padding_size - padding_size)];
3743 void debug_print_timestamp(int counter_nr, char *message)
3745 int indent_size = 8;
3746 int padding_size = 40;
3747 float timestamp_interval;
3750 Error(ERR_EXIT, "debugging: invalid negative counter");
3751 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3752 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3754 #if DEBUG_TIME_IN_MICROSECONDS
3755 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3758 counter[counter_nr][0] = Counter_Microseconds();
3760 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3763 counter[counter_nr][0] = Counter();
3766 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3767 counter[counter_nr][1] = counter[counter_nr][0];
3770 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3771 debug_print_timestamp_get_padding(counter_nr * indent_size),
3773 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3774 timestamp_interval / 1000,
3778 void debug_print_parent_only(char *format, ...)
3780 if (!IS_PARENT_PROCESS())
3787 va_start(ap, format);
3788 vprintf(format, ap);
3797 void print_timestamp_ext(char *message, char *mode)
3799 #if DEBUG_PRINT_INIT_TIMESTAMPS
3800 static char *debug_message = NULL;
3801 static char *last_message = NULL;
3802 static int counter_nr = 0;
3803 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3805 checked_free(debug_message);
3806 debug_message = getStringCat3(mode, " ", message);
3808 if (strEqual(mode, "INIT"))
3810 debug_print_timestamp(counter_nr, NULL);
3812 if (counter_nr + 1 < max_depth)
3813 debug_print_timestamp(counter_nr, debug_message);
3817 debug_print_timestamp(counter_nr, NULL);
3819 else if (strEqual(mode, "DONE"))
3823 if (counter_nr + 1 < max_depth ||
3824 (counter_nr == 0 && max_depth == 1))
3826 last_message = message;
3828 if (counter_nr == 0 && max_depth == 1)
3830 checked_free(debug_message);
3831 debug_message = getStringCat3("TIME", " ", message);
3834 debug_print_timestamp(counter_nr, debug_message);
3837 else if (!strEqual(mode, "TIME") ||
3838 !strEqual(message, last_message))
3840 if (counter_nr < max_depth)
3841 debug_print_timestamp(counter_nr, debug_message);
3846 void print_timestamp_init(char *message)
3848 print_timestamp_ext(message, "INIT");
3851 void print_timestamp_time(char *message)
3853 print_timestamp_ext(message, "TIME");
3856 void print_timestamp_done(char *message)
3858 print_timestamp_ext(message, "DONE");