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 SDL_Delay(milliseconds_delay);
363 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
365 sleep_milliseconds(delay);
368 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
369 unsigned int actual_counter)
371 if (actual_counter >= *counter_var &&
372 actual_counter < *counter_var + delay)
375 *counter_var = actual_counter;
380 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
382 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
385 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
387 return DelayReachedExt(counter_var, delay, Counter());
390 void ResetDelayCounterExt(unsigned int *counter_var,
391 unsigned int actual_counter)
393 DelayReachedExt(counter_var, 0, actual_counter);
396 void ResetFrameCounter(unsigned int *frame_counter_var)
398 FrameReached(frame_counter_var, 0);
401 void ResetDelayCounter(unsigned int *counter_var)
403 DelayReached(counter_var, 0);
406 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
408 unsigned int actual_counter;
413 actual_counter = Counter();
415 if (actual_counter >= *counter_var &&
416 actual_counter < *counter_var + delay)
417 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
422 if (*counter_var != 0 &&
424 actual_counter >= *counter_var + delay)
426 int lag = actual_counter - (*counter_var + delay);
427 int delay2 = (delay + 1) / 2;
430 skip_frames = (lag + delay2) / delay;
433 *counter_var = actual_counter;
438 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
439 int *loop_var, int last_loop_value)
441 int skip_frames = WaitUntilDelayReached(counter_var, delay);
445 printf("::: %d: %d ms", *loop_var, delay);
447 printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
452 if (skip_frames == 0)
455 // when skipping frames, make sure to never skip the last frame, as
456 // this may be needed for animations to reach a defined end state;
457 // furthermore, we assume that this function is called at the end
458 // of a "for" loop, which continues by incrementing the loop variable
459 // by one before checking the loop condition again; therefore we have
460 // to check against the last loop value minus one here
464 if (*loop_var < last_loop_value) // never skip the last frame
466 *loop_var += skip_frames;
468 if (*loop_var > last_loop_value) // never skip the last frame
469 *loop_var = last_loop_value;
474 /* ------------------------------------------------------------------------- */
475 /* random generator functions */
476 /* ------------------------------------------------------------------------- */
478 unsigned int init_random_number(int nr, int seed)
480 if (seed == NEW_RANDOMIZE)
482 /* default random seed */
483 seed = (int)time(NULL); // seconds since the epoch
485 #if !defined(PLATFORM_WIN32)
486 /* add some more randomness */
487 struct timeval current_time;
489 gettimeofday(¤t_time, NULL);
491 seed += (int)current_time.tv_usec; // microseconds since the epoch
494 /* add some more randomness */
495 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
497 /* add some more randomness */
498 seed += GetSimpleRandom(1000000);
501 srandom_linux_libc(nr, (unsigned int) seed);
503 return (unsigned int) seed;
506 unsigned int get_random_number(int nr, int max)
508 return (max > 0 ? random_linux_libc(nr) % max : 0);
512 /* ------------------------------------------------------------------------- */
513 /* system info functions */
514 /* ------------------------------------------------------------------------- */
516 #if !defined(PLATFORM_ANDROID)
517 static char *get_corrected_real_name(char *real_name)
519 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
520 char *from_ptr = real_name;
521 char *to_ptr = real_name_new;
523 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
524 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
526 /* the name field read from "passwd" file may also contain additional
527 user information, separated by commas, which will be removed here */
528 if (*from_ptr == ',')
531 /* the user's real name may contain 'german sharp s' characters,
532 which have no equivalent in upper case letters (used by our fonts) */
533 if (*from_ptr == CHAR_BYTE_SHARP_S)
540 *to_ptr++ = *from_ptr++;
545 return real_name_new;
551 static char *login_name = NULL;
553 #if defined(PLATFORM_WIN32)
554 if (login_name == NULL)
556 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
557 login_name = checked_malloc(buffer_size);
559 if (GetUserName(login_name, &buffer_size) == 0)
560 strcpy(login_name, ANONYMOUS_NAME);
563 if (login_name == NULL)
567 if ((pwd = getpwuid(getuid())) == NULL)
568 login_name = ANONYMOUS_NAME;
570 login_name = getStringCopy(pwd->pw_name);
579 static char *real_name = NULL;
581 #if defined(PLATFORM_WIN32)
582 if (real_name == NULL)
584 static char buffer[MAX_USERNAME_LEN + 1];
585 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
587 if (GetUserName(buffer, &buffer_size) != 0)
588 real_name = get_corrected_real_name(buffer);
590 real_name = ANONYMOUS_NAME;
592 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
593 if (real_name == NULL)
597 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
598 real_name = get_corrected_real_name(pwd->pw_gecos);
600 real_name = ANONYMOUS_NAME;
603 real_name = ANONYMOUS_NAME;
609 time_t getFileTimestampEpochSeconds(char *filename)
611 struct stat file_status;
613 if (stat(filename, &file_status) != 0) /* cannot stat file */
616 return file_status.st_mtime;
620 /* ------------------------------------------------------------------------- */
621 /* path manipulation functions */
622 /* ------------------------------------------------------------------------- */
624 static char *getLastPathSeparatorPtr(char *filename)
626 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
628 if (last_separator == NULL) /* also try DOS/Windows variant */
629 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
631 return last_separator;
634 char *getBaseNamePtr(char *filename)
636 char *last_separator = getLastPathSeparatorPtr(filename);
638 if (last_separator != NULL)
639 return last_separator + 1; /* separator found: strip base path */
641 return filename; /* no separator found: filename has no path */
644 char *getBaseName(char *filename)
646 return getStringCopy(getBaseNamePtr(filename));
649 char *getBaseNameNoSuffix(char *filename)
651 char *basename = getStringCopy(getBaseNamePtr(filename));
653 // remove trailing suffix (separated by dot or hyphen)
654 if (basename[0] != '.' && basename[0] != '-')
656 if (strchr(basename, '.') != NULL)
657 *strchr(basename, '.') = '\0';
659 if (strchr(basename, '-') != NULL)
660 *strchr(basename, '-') = '\0';
666 char *getBasePath(char *filename)
668 char *basepath = getStringCopy(filename);
669 char *last_separator = getLastPathSeparatorPtr(basepath);
671 if (last_separator != NULL)
672 *last_separator = '\0'; /* separator found: strip basename */
674 basepath = "."; /* no separator found: use current path */
679 static char *getProgramMainDataPath()
681 char *main_data_path = getStringCopy(program.command_basepath);
683 #if defined(PLATFORM_MACOSX)
684 static char *main_data_binary_subdir = NULL;
686 if (main_data_binary_subdir == NULL)
688 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
690 strlen(MAC_APP_BINARY_SUBDIR) + 1);
692 sprintf(main_data_binary_subdir, "%s.app/%s",
693 program.program_title, MAC_APP_BINARY_SUBDIR);
696 // cut relative path to Mac OS X application binary directory from path
697 if (strSuffix(main_data_path, main_data_binary_subdir))
698 main_data_path[strlen(main_data_path) -
699 strlen(main_data_binary_subdir)] = '\0';
701 // cut trailing path separator from path (but not if path is root directory)
702 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
703 main_data_path[strlen(main_data_path) - 1] = '\0';
705 // replace empty path with current directory
706 if (strEqual(main_data_path, ""))
707 main_data_path = ".";
710 return main_data_path;
714 /* ------------------------------------------------------------------------- */
715 /* various string functions */
716 /* ------------------------------------------------------------------------- */
718 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
720 if (s1 == NULL || s2 == NULL || sep == NULL)
723 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
726 sprintf(complete_string, "%s%s%s", s1, sep, s2);
728 return complete_string;
731 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
733 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
736 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
737 strlen(s2) + strlen(sep) +
740 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
742 return complete_string;
745 char *getStringCat2(char *s1, char *s2)
747 return getStringCat2WithSeparator(s1, s2, "");
750 char *getStringCat3(char *s1, char *s2, char *s3)
752 return getStringCat3WithSeparator(s1, s2, s3, "");
755 char *getPath2(char *path1, char *path2)
757 #if defined(PLATFORM_ANDROID)
758 // workaround for reading from assets directory -- skip "." subdirs in path
759 if (strEqual(path1, "."))
760 return getStringCopy(path2);
761 else if (strEqual(path2, "."))
762 return getStringCopy(path1);
765 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
768 char *getPath3(char *path1, char *path2, char *path3)
770 #if defined(PLATFORM_ANDROID)
771 // workaround for reading from assets directory -- skip "." subdirs in path
772 if (strEqual(path1, "."))
773 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
774 else if (strEqual(path2, "."))
775 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
776 else if (strEqual(path3, "."))
777 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
780 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
783 static char *getPngOrPcxIfNotExists(char *filename)
785 // switch from PNG to PCX file and vice versa, if file does not exist
786 // (backwards compatibility with PCX files used in previous versions)
788 if (!fileExists(filename) && strSuffix(filename, ".png"))
789 strcpy(&filename[strlen(filename) - 3], "pcx");
790 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
791 strcpy(&filename[strlen(filename) - 3], "png");
796 char *getImg2(char *path1, char *path2)
798 return getPngOrPcxIfNotExists(getPath2(path1, path2));
801 char *getImg3(char *path1, char *path2, char *path3)
803 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
806 char *getStringCopy(const char *s)
813 s_copy = checked_malloc(strlen(s) + 1);
819 char *getStringCopyN(const char *s, int n)
822 int s_len = MAX(0, n);
827 s_copy = checked_malloc(s_len + 1);
828 strncpy(s_copy, s, s_len);
829 s_copy[s_len] = '\0';
834 char *getStringCopyNStatic(const char *s, int n)
836 static char *s_copy = NULL;
838 checked_free(s_copy);
840 s_copy = getStringCopyN(s, n);
845 char *getStringToLower(const char *s)
847 char *s_copy = checked_malloc(strlen(s) + 1);
848 char *s_ptr = s_copy;
851 *s_ptr++ = tolower(*s++);
857 void setString(char **old_value, char *new_value)
859 checked_free(*old_value);
861 *old_value = getStringCopy(new_value);
864 boolean strEqual(char *s1, char *s2)
866 return (s1 == NULL && s2 == NULL ? TRUE :
867 s1 == NULL && s2 != NULL ? FALSE :
868 s1 != NULL && s2 == NULL ? FALSE :
869 strcmp(s1, s2) == 0);
872 boolean strEqualN(char *s1, char *s2, int n)
874 return (s1 == NULL && s2 == NULL ? TRUE :
875 s1 == NULL && s2 != NULL ? FALSE :
876 s1 != NULL && s2 == NULL ? FALSE :
877 strncmp(s1, s2, n) == 0);
880 boolean strPrefix(char *s, char *prefix)
882 return (s == NULL && prefix == NULL ? TRUE :
883 s == NULL && prefix != NULL ? FALSE :
884 s != NULL && prefix == NULL ? FALSE :
885 strncmp(s, prefix, strlen(prefix)) == 0);
888 boolean strSuffix(char *s, char *suffix)
890 return (s == NULL && suffix == NULL ? TRUE :
891 s == NULL && suffix != NULL ? FALSE :
892 s != NULL && suffix == NULL ? FALSE :
893 strlen(s) < strlen(suffix) ? FALSE :
894 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
897 boolean strPrefixLower(char *s, char *prefix)
899 char *s_lower = getStringToLower(s);
900 boolean match = strPrefix(s_lower, prefix);
907 boolean strSuffixLower(char *s, char *suffix)
909 char *s_lower = getStringToLower(s);
910 boolean match = strSuffix(s_lower, suffix);
918 /* ------------------------------------------------------------------------- */
919 /* command line option handling functions */
920 /* ------------------------------------------------------------------------- */
922 void GetOptions(int argc, char *argv[],
923 void (*print_usage_function)(void),
924 void (*print_version_function)(void))
926 char *ro_base_path = RO_BASE_PATH;
927 char *rw_base_path = RW_BASE_PATH;
928 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
929 char **options_left = &argvplus[1];
931 /* replace original "argv" with null-terminated array of string pointers */
933 argvplus[argc] = argv[argc];
935 /* if the program is configured to start from current directory (default),
936 determine program package directory from program binary (some versions
937 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
938 set the current working directory to the program package directory) */
940 if (strEqual(ro_base_path, "."))
941 ro_base_path = getProgramMainDataPath();
942 if (strEqual(rw_base_path, "."))
943 rw_base_path = getProgramMainDataPath();
945 /* initialize global program options */
946 options.server_host = NULL;
947 options.server_port = 0;
949 options.ro_base_directory = ro_base_path;
950 options.rw_base_directory = rw_base_path;
951 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
952 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
953 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
954 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
955 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
957 options.execute_command = NULL;
958 options.special_flags = NULL;
960 options.mytapes = FALSE;
961 options.serveronly = FALSE;
962 options.network = FALSE;
963 options.verbose = FALSE;
964 options.debug = FALSE;
967 options.verbose = TRUE;
969 #if !defined(PLATFORM_UNIX)
970 if (*options_left == NULL) /* no options given -- enable verbose mode */
971 options.verbose = TRUE;
975 while (*options_left)
977 char option_str[MAX_OPTION_LEN];
978 char *option = options_left[0];
979 char *next_option = options_left[1];
980 char *option_arg = NULL;
981 int option_len = strlen(option);
983 if (option_len >= MAX_OPTION_LEN)
984 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
986 strcpy(option_str, option); /* copy argument into buffer */
989 if (strEqual(option, "--")) /* stop scanning arguments */
992 if (strPrefix(option, "--")) /* treat '--' like '-' */
995 option_arg = strchr(option, '=');
996 if (option_arg == NULL) /* no '=' in option */
997 option_arg = next_option;
1000 *option_arg++ = '\0'; /* cut argument from option */
1001 if (*option_arg == '\0') /* no argument after '=' */
1002 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1005 option_len = strlen(option);
1007 if (strEqual(option, "-"))
1009 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1011 else if (strncmp(option, "-help", option_len) == 0)
1013 print_usage_function();
1017 else if (strncmp(option, "-basepath", option_len) == 0)
1019 if (option_arg == NULL)
1020 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1022 /* this should be extended to separate options for ro and rw data */
1023 options.ro_base_directory = ro_base_path = option_arg;
1024 options.rw_base_directory = rw_base_path = option_arg;
1025 if (option_arg == next_option)
1028 /* adjust paths for sub-directories in base directory accordingly */
1029 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1030 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1031 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1032 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1033 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1035 else if (strncmp(option, "-levels", option_len) == 0)
1037 if (option_arg == NULL)
1038 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1040 options.level_directory = option_arg;
1041 if (option_arg == next_option)
1044 else if (strncmp(option, "-graphics", option_len) == 0)
1046 if (option_arg == NULL)
1047 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1049 options.graphics_directory = option_arg;
1050 if (option_arg == next_option)
1053 else if (strncmp(option, "-sounds", option_len) == 0)
1055 if (option_arg == NULL)
1056 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1058 options.sounds_directory = option_arg;
1059 if (option_arg == next_option)
1062 else if (strncmp(option, "-music", option_len) == 0)
1064 if (option_arg == NULL)
1065 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1067 options.music_directory = option_arg;
1068 if (option_arg == next_option)
1071 else if (strncmp(option, "-mytapes", option_len) == 0)
1073 options.mytapes = TRUE;
1075 else if (strncmp(option, "-network", option_len) == 0)
1077 options.network = TRUE;
1079 else if (strncmp(option, "-serveronly", option_len) == 0)
1081 options.serveronly = TRUE;
1083 else if (strncmp(option, "-debug", option_len) == 0)
1085 options.debug = TRUE;
1087 else if (strncmp(option, "-verbose", option_len) == 0)
1089 options.verbose = TRUE;
1091 else if (strncmp(option, "-version", option_len) == 0 ||
1092 strncmp(option, "-V", option_len) == 0)
1094 print_version_function();
1098 else if (strPrefix(option, "-D"))
1100 options.special_flags = getStringCopy(&option[2]);
1102 else if (strncmp(option, "-execute", option_len) == 0)
1104 if (option_arg == NULL)
1105 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1107 options.execute_command = option_arg;
1108 if (option_arg == next_option)
1111 /* when doing batch processing, always enable verbose mode (warnings) */
1112 options.verbose = TRUE;
1114 #if defined(PLATFORM_MACOSX)
1115 else if (strPrefix(option, "-psn"))
1117 /* ignore process serial number when launched via GUI on Mac OS X */
1120 else if (*option == '-')
1122 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1124 else if (options.server_host == NULL)
1126 options.server_host = *options_left;
1128 else if (options.server_port == 0)
1130 options.server_port = atoi(*options_left);
1131 if (options.server_port < 1024)
1132 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1135 Error(ERR_EXIT_HELP, "too many arguments");
1142 /* ------------------------------------------------------------------------- */
1143 /* error handling functions */
1144 /* ------------------------------------------------------------------------- */
1146 #define MAX_INTERNAL_ERROR_SIZE 1024
1148 /* used by SetError() and GetError() to store internal error messages */
1149 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1151 void SetError(char *format, ...)
1155 va_start(ap, format);
1156 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1162 return internal_error;
1165 void Error(int mode, char *format, ...)
1167 static boolean last_line_was_separator = FALSE;
1168 char *process_name = "";
1170 if (program.log_file[LOG_ERR_ID] == NULL)
1173 #if defined(PLATFORM_ANDROID)
1174 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1175 mode & ERR_INFO ? ANDROID_LOG_INFO :
1176 mode & ERR_WARN ? ANDROID_LOG_WARN :
1177 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1178 ANDROID_LOG_UNKNOWN);
1181 /* display warnings only when running in verbose mode */
1182 if (mode & ERR_WARN && !options.verbose)
1185 if (mode == ERR_INFO_LINE)
1187 if (!last_line_was_separator)
1188 printf_log_line(format, 79);
1190 last_line_was_separator = TRUE;
1195 last_line_was_separator = FALSE;
1197 if (mode & ERR_SOUND_SERVER)
1198 process_name = " sound server";
1199 else if (mode & ERR_NETWORK_SERVER)
1200 process_name = " network server";
1201 else if (mode & ERR_NETWORK_CLIENT)
1202 process_name = " network client **";
1206 #if !defined(PLATFORM_ANDROID)
1207 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1210 if (mode & ERR_WARN)
1211 printf_log_nonewline("warning: ");
1213 if (mode & ERR_EXIT)
1214 printf_log_nonewline("fatal error: ");
1218 va_start(ap, format);
1219 vprintf_log(format, ap);
1222 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1224 va_start(ap, format);
1225 program.exit_message_function(format, ap);
1230 if (mode & ERR_HELP)
1231 printf_log("%s: Try option '--help' for more information.",
1232 program.command_basename);
1234 if (mode & ERR_EXIT)
1235 printf_log("%s%s: aborting", program.command_basename, process_name);
1237 if (mode & ERR_EXIT)
1239 if (mode & ERR_FROM_SERVER)
1240 exit(1); /* child process: normal exit */
1242 program.exit_function(1); /* main process: clean up stuff */
1247 /* ------------------------------------------------------------------------- */
1248 /* checked memory allocation and freeing functions */
1249 /* ------------------------------------------------------------------------- */
1251 void *checked_malloc(unsigned int size)
1258 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1263 void *checked_calloc(unsigned int size)
1267 ptr = calloc(1, size);
1270 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1275 void *checked_realloc(void *ptr, unsigned int size)
1277 ptr = realloc(ptr, size);
1280 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1285 void checked_free(void *ptr)
1287 if (ptr != NULL) /* this check should be done by free() anyway */
1291 void clear_mem(void *ptr, unsigned int size)
1293 #if defined(PLATFORM_WIN32)
1294 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1295 char *cptr = (char *)ptr;
1300 memset(ptr, 0, size);
1305 /* ------------------------------------------------------------------------- */
1306 /* various helper functions */
1307 /* ------------------------------------------------------------------------- */
1309 void swap_numbers(int *i1, int *i2)
1317 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1329 /* the "put" variants of the following file access functions check for the file
1330 pointer being != NULL and return the number of bytes they have or would have
1331 written; this allows for chunk writing functions to first determine the size
1332 of the (not yet written) chunk, write the correct chunk size and finally
1333 write the chunk itself */
1335 int getFile8BitInteger(File *file)
1337 return getByteFromFile(file);
1340 int putFile8BitInteger(FILE *file, int value)
1348 int getFile16BitInteger(File *file, int byte_order)
1350 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1351 return ((getByteFromFile(file) << 8) |
1352 (getByteFromFile(file) << 0));
1353 else /* BYTE_ORDER_LITTLE_ENDIAN */
1354 return ((getByteFromFile(file) << 0) |
1355 (getByteFromFile(file) << 8));
1358 int putFile16BitInteger(FILE *file, int value, int byte_order)
1362 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1364 fputc((value >> 8) & 0xff, file);
1365 fputc((value >> 0) & 0xff, file);
1367 else /* BYTE_ORDER_LITTLE_ENDIAN */
1369 fputc((value >> 0) & 0xff, file);
1370 fputc((value >> 8) & 0xff, file);
1377 int getFile32BitInteger(File *file, int byte_order)
1379 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1380 return ((getByteFromFile(file) << 24) |
1381 (getByteFromFile(file) << 16) |
1382 (getByteFromFile(file) << 8) |
1383 (getByteFromFile(file) << 0));
1384 else /* BYTE_ORDER_LITTLE_ENDIAN */
1385 return ((getByteFromFile(file) << 0) |
1386 (getByteFromFile(file) << 8) |
1387 (getByteFromFile(file) << 16) |
1388 (getByteFromFile(file) << 24));
1391 int putFile32BitInteger(FILE *file, int value, int byte_order)
1395 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1397 fputc((value >> 24) & 0xff, file);
1398 fputc((value >> 16) & 0xff, file);
1399 fputc((value >> 8) & 0xff, file);
1400 fputc((value >> 0) & 0xff, file);
1402 else /* BYTE_ORDER_LITTLE_ENDIAN */
1404 fputc((value >> 0) & 0xff, file);
1405 fputc((value >> 8) & 0xff, file);
1406 fputc((value >> 16) & 0xff, file);
1407 fputc((value >> 24) & 0xff, file);
1414 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1417 const int chunk_name_length = 4;
1419 /* read chunk name */
1420 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1423 if (chunk_size != NULL)
1425 /* read chunk size */
1426 *chunk_size = getFile32BitInteger(file, byte_order);
1429 return (checkEndOfFile(file) ? FALSE : TRUE);
1432 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1437 /* write chunk name */
1439 fputs(chunk_name, file);
1441 num_bytes += strlen(chunk_name);
1443 if (chunk_size >= 0)
1445 /* write chunk size */
1447 putFile32BitInteger(file, chunk_size, byte_order);
1455 int getFileVersion(File *file)
1457 int version_major = getByteFromFile(file);
1458 int version_minor = getByteFromFile(file);
1459 int version_patch = getByteFromFile(file);
1460 int version_build = getByteFromFile(file);
1462 return VERSION_IDENT(version_major, version_minor, version_patch,
1466 int putFileVersion(FILE *file, int version)
1470 int version_major = VERSION_MAJOR(version);
1471 int version_minor = VERSION_MINOR(version);
1472 int version_patch = VERSION_PATCH(version);
1473 int version_build = VERSION_BUILD(version);
1475 fputc(version_major, file);
1476 fputc(version_minor, file);
1477 fputc(version_patch, file);
1478 fputc(version_build, file);
1484 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1488 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1489 buffer[i] = getByteFromFile(file);
1492 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1496 for(i = 0; i < bytes; i++)
1497 fputc(buffer[i], file);
1500 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1502 while (bytes-- && !checkEndOfFile(file))
1503 getByteFromFile(file);
1506 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1513 /* ------------------------------------------------------------------------- */
1514 /* functions to translate key identifiers between different format */
1515 /* ------------------------------------------------------------------------- */
1517 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1518 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1519 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1520 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1522 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1531 /* normal cursor keys */
1532 { KSYM_Left, "XK_Left", "cursor left" },
1533 { KSYM_Right, "XK_Right", "cursor right" },
1534 { KSYM_Up, "XK_Up", "cursor up" },
1535 { KSYM_Down, "XK_Down", "cursor down" },
1537 /* keypad cursor keys */
1539 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1540 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1541 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1542 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1545 /* other keypad keys */
1546 #ifdef KSYM_KP_Enter
1547 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1548 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1549 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1550 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1551 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1552 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1556 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1557 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1558 { KSYM_Control_L, "XK_Control_L", "left control" },
1559 { KSYM_Control_R, "XK_Control_R", "right control" },
1560 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1561 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1562 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1563 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1564 #if !defined(TARGET_SDL2)
1565 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1566 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1568 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1569 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1571 /* some special keys */
1572 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1573 { KSYM_Delete, "XK_Delete", "delete" },
1574 { KSYM_Insert, "XK_Insert", "insert" },
1575 { KSYM_Tab, "XK_Tab", "tab" },
1576 { KSYM_Home, "XK_Home", "home" },
1577 { KSYM_End, "XK_End", "end" },
1578 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1579 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1581 #if defined(TARGET_SDL2)
1582 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1583 { KSYM_Back, "XK_Back", "back" }, /* back key */
1586 /* ASCII 0x20 to 0x40 keys (except numbers) */
1587 { KSYM_space, "XK_space", "space" },
1588 { KSYM_exclam, "XK_exclam", "!" },
1589 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1590 { KSYM_numbersign, "XK_numbersign", "#" },
1591 { KSYM_dollar, "XK_dollar", "$" },
1592 { KSYM_percent, "XK_percent", "%" },
1593 { KSYM_ampersand, "XK_ampersand", "&" },
1594 { KSYM_apostrophe, "XK_apostrophe", "'" },
1595 { KSYM_parenleft, "XK_parenleft", "(" },
1596 { KSYM_parenright, "XK_parenright", ")" },
1597 { KSYM_asterisk, "XK_asterisk", "*" },
1598 { KSYM_plus, "XK_plus", "+" },
1599 { KSYM_comma, "XK_comma", "," },
1600 { KSYM_minus, "XK_minus", "-" },
1601 { KSYM_period, "XK_period", "." },
1602 { KSYM_slash, "XK_slash", "/" },
1603 { KSYM_colon, "XK_colon", ":" },
1604 { KSYM_semicolon, "XK_semicolon", ";" },
1605 { KSYM_less, "XK_less", "<" },
1606 { KSYM_equal, "XK_equal", "=" },
1607 { KSYM_greater, "XK_greater", ">" },
1608 { KSYM_question, "XK_question", "?" },
1609 { KSYM_at, "XK_at", "@" },
1611 /* more ASCII keys */
1612 { KSYM_bracketleft, "XK_bracketleft", "[" },
1613 { KSYM_backslash, "XK_backslash", "\\" },
1614 { KSYM_bracketright,"XK_bracketright", "]" },
1615 { KSYM_asciicircum, "XK_asciicircum", "^" },
1616 { KSYM_underscore, "XK_underscore", "_" },
1617 { KSYM_grave, "XK_grave", "grave" },
1618 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1619 { KSYM_braceleft, "XK_braceleft", "brace left" },
1620 { KSYM_bar, "XK_bar", "bar" },
1621 { KSYM_braceright, "XK_braceright", "brace right" },
1622 { KSYM_asciitilde, "XK_asciitilde", "~" },
1624 /* special (non-ASCII) keys */
1625 { KSYM_degree, "XK_degree", "degree" },
1626 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1627 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1628 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1629 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1630 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1631 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1632 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1634 #if defined(TARGET_SDL2)
1635 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1636 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1637 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1638 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1639 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1640 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1641 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1642 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1643 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1645 /* other keys (for reverse mapping only) */
1646 { KSYM_space, "XK_space", " " },
1649 #if defined(TARGET_SDL2)
1650 /* keypad keys are not in numerical order in SDL2 */
1651 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1652 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1653 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1654 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1655 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1656 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1657 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1658 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1659 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1660 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1663 /* end-of-array identifier */
1669 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1671 static char name_buffer[30];
1674 if (key >= KSYM_A && key <= KSYM_Z)
1675 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1676 else if (key >= KSYM_a && key <= KSYM_z)
1677 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1678 else if (key >= KSYM_0 && key <= KSYM_9)
1679 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1680 #if !defined(TARGET_SDL2)
1681 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1682 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1684 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1685 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1686 else if (key == KSYM_UNDEFINED)
1687 strcpy(name_buffer, "(undefined)");
1694 if (key == translate_key[i].key)
1696 strcpy(name_buffer, translate_key[i].name);
1700 while (translate_key[++i].name);
1702 if (!translate_key[i].name)
1703 strcpy(name_buffer, "(unknown)");
1706 *name = name_buffer;
1708 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1710 static char name_buffer[30];
1713 if (key >= KSYM_A && key <= KSYM_Z)
1714 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1715 else if (key >= KSYM_a && key <= KSYM_z)
1716 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1717 else if (key >= KSYM_0 && key <= KSYM_9)
1718 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1719 #if !defined(TARGET_SDL2)
1720 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1721 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1723 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1724 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1725 else if (key == KSYM_UNDEFINED)
1726 strcpy(name_buffer, "[undefined]");
1733 if (key == translate_key[i].key)
1735 strcpy(name_buffer, translate_key[i].x11name);
1739 while (translate_key[++i].x11name);
1741 if (!translate_key[i].x11name)
1742 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1745 *x11name = name_buffer;
1747 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1749 Key key = KSYM_UNDEFINED;
1750 char *name_ptr = *name;
1752 if (strlen(*name) == 1)
1754 char c = name_ptr[0];
1756 if (c >= 'A' && c <= 'Z')
1757 key = KSYM_A + (Key)(c - 'A');
1758 else if (c >= 'a' && c <= 'z')
1759 key = KSYM_a + (Key)(c - 'a');
1760 else if (c >= '0' && c <= '9')
1761 key = KSYM_0 + (Key)(c - '0');
1764 if (key == KSYM_UNDEFINED)
1770 if (strEqual(translate_key[i].name, *name))
1772 key = translate_key[i].key;
1776 while (translate_key[++i].x11name);
1779 if (key == KSYM_UNDEFINED)
1780 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1784 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1786 Key key = KSYM_UNDEFINED;
1787 char *name_ptr = *x11name;
1789 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1791 char c = name_ptr[3];
1793 if (c >= 'A' && c <= 'Z')
1794 key = KSYM_A + (Key)(c - 'A');
1795 else if (c >= 'a' && c <= 'z')
1796 key = KSYM_a + (Key)(c - 'a');
1797 else if (c >= '0' && c <= '9')
1798 key = KSYM_0 + (Key)(c - '0');
1800 #if !defined(TARGET_SDL2)
1801 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1803 char c = name_ptr[6];
1805 if (c >= '0' && c <= '9')
1806 key = KSYM_KP_0 + (Key)(c - '0');
1809 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1811 char c1 = name_ptr[4];
1812 char c2 = name_ptr[5];
1815 if ((c1 >= '0' && c1 <= '9') &&
1816 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1817 d = atoi(&name_ptr[4]);
1819 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1820 key = KSYM_F1 + (Key)(d - 1);
1822 else if (strPrefix(name_ptr, "XK_"))
1828 if (strEqual(name_ptr, translate_key[i].x11name))
1830 key = translate_key[i].key;
1834 while (translate_key[++i].x11name);
1836 else if (strPrefix(name_ptr, "0x"))
1838 unsigned int value = 0;
1844 char c = *name_ptr++;
1847 if (c >= '0' && c <= '9')
1849 else if (c >= 'a' && c <= 'f')
1850 d = (int)(c - 'a' + 10);
1851 else if (c >= 'A' && c <= 'F')
1852 d = (int)(c - 'A' + 10);
1860 value = value * 16 + d;
1871 char *getKeyNameFromKey(Key key)
1875 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1879 char *getX11KeyNameFromKey(Key key)
1883 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1887 Key getKeyFromKeyName(char *name)
1891 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1895 Key getKeyFromX11KeyName(char *x11name)
1899 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1903 char getCharFromKey(Key key)
1909 } translate_key_char[] =
1911 /* special (non-ASCII) keys (ISO-8859-1) */
1912 { KSYM_degree, CHAR_BYTE_DEGREE },
1913 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1914 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1915 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1916 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1917 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1918 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1919 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1921 /* end-of-array identifier */
1925 char *keyname = getKeyNameFromKey(key);
1928 if (strlen(keyname) == 1)
1930 else if (strEqual(keyname, "space"))
1938 if (key == translate_key_char[i].key)
1940 c = translate_key_char[i].key_char;
1945 while (translate_key_char[++i].key_char);
1951 char getValidConfigValueChar(char c)
1953 if (c == '#' || /* used to mark comments */
1954 c == '\\') /* used to mark continued lines */
1961 /* ------------------------------------------------------------------------- */
1962 /* functions to translate string identifiers to integer or boolean value */
1963 /* ------------------------------------------------------------------------- */
1965 int get_integer_from_string(char *s)
1967 static char *number_text[][3] =
1969 { "0", "zero", "null", },
1970 { "1", "one", "first" },
1971 { "2", "two", "second" },
1972 { "3", "three", "third" },
1973 { "4", "four", "fourth" },
1974 { "5", "five", "fifth" },
1975 { "6", "six", "sixth" },
1976 { "7", "seven", "seventh" },
1977 { "8", "eight", "eighth" },
1978 { "9", "nine", "ninth" },
1979 { "10", "ten", "tenth" },
1980 { "11", "eleven", "eleventh" },
1981 { "12", "twelve", "twelfth" },
1983 { NULL, NULL, NULL },
1987 char *s_lower = getStringToLower(s);
1990 for (i = 0; number_text[i][0] != NULL; i++)
1991 for (j = 0; j < 3; j++)
1992 if (strEqual(s_lower, number_text[i][j]))
1997 if (strEqual(s_lower, "false") ||
1998 strEqual(s_lower, "no") ||
1999 strEqual(s_lower, "off"))
2001 else if (strEqual(s_lower, "true") ||
2002 strEqual(s_lower, "yes") ||
2003 strEqual(s_lower, "on"))
2014 boolean get_boolean_from_string(char *s)
2016 char *s_lower = getStringToLower(s);
2017 boolean result = FALSE;
2019 if (strEqual(s_lower, "true") ||
2020 strEqual(s_lower, "yes") ||
2021 strEqual(s_lower, "on") ||
2022 get_integer_from_string(s) == 1)
2030 int get_switch3_from_string(char *s)
2032 char *s_lower = getStringToLower(s);
2035 if (strEqual(s_lower, "true") ||
2036 strEqual(s_lower, "yes") ||
2037 strEqual(s_lower, "on") ||
2038 get_integer_from_string(s) == 1)
2040 else if (strEqual(s_lower, "auto"))
2049 /* ------------------------------------------------------------------------- */
2050 /* functions for generic lists */
2051 /* ------------------------------------------------------------------------- */
2053 ListNode *newListNode()
2055 return checked_calloc(sizeof(ListNode));
2058 void addNodeToList(ListNode **node_first, char *key, void *content)
2060 ListNode *node_new = newListNode();
2062 node_new->key = getStringCopy(key);
2063 node_new->content = content;
2064 node_new->next = *node_first;
2067 (*node_first)->prev = node_new;
2069 *node_first = node_new;
2072 void deleteNodeFromList(ListNode **node_first, char *key,
2073 void (*destructor_function)(void *))
2075 if (node_first == NULL || *node_first == NULL)
2078 if (strEqual((*node_first)->key, key))
2080 // after first recursion, (*node_first)->prev->next == *node_first,
2081 // so *node_first would be overwritten with (*node_first)->next
2082 // => use a copy of *node_first (and later of (*node_first)->next)
2083 ListNode *node = *node_first;
2084 ListNode *node_next = node->next;
2086 checked_free(node->key);
2088 if (destructor_function)
2089 destructor_function(node->content);
2092 node->prev->next = node->next;
2095 node->next->prev = node->prev;
2099 // after removing node, set list pointer to next valid list node
2100 // (this is important if the first node of the list was deleted)
2101 *node_first = node_next;
2105 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2109 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2111 if (node_first == NULL)
2114 if (strEqual(node_first->key, key))
2117 return getNodeFromKey(node_first->next, key);
2120 int getNumNodes(ListNode *node_first)
2122 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2125 void dumpList(ListNode *node_first)
2127 ListNode *node = node_first;
2131 printf("['%s' (%d)]\n", node->key,
2132 ((struct ListNodeInfo *)node->content)->num_references);
2136 printf("[%d nodes]\n", getNumNodes(node_first));
2140 /* ------------------------------------------------------------------------- */
2141 /* functions for file handling */
2142 /* ------------------------------------------------------------------------- */
2144 File *openFile(char *filename, char *mode)
2146 File *file = checked_calloc(sizeof(File));
2148 file->file = fopen(filename, mode);
2150 if (file->file != NULL)
2152 file->filename = getStringCopy(filename);
2157 #if defined(PLATFORM_ANDROID)
2158 file->asset_file = SDL_RWFromFile(filename, mode);
2160 if (file->asset_file != NULL)
2162 file->file_is_asset = TRUE;
2163 file->filename = getStringCopy(filename);
2174 int closeFile(File *file)
2181 #if defined(PLATFORM_ANDROID)
2182 if (file->asset_file)
2183 result = SDL_RWclose(file->asset_file);
2187 result = fclose(file->file);
2189 checked_free(file->filename);
2195 int checkEndOfFile(File *file)
2197 #if defined(PLATFORM_ANDROID)
2198 if (file->file_is_asset)
2199 return file->end_of_file;
2202 return feof(file->file);
2205 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2207 #if defined(PLATFORM_ANDROID)
2208 if (file->file_is_asset)
2210 if (file->end_of_file)
2213 size_t num_items_read =
2214 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2216 if (num_items_read < num_items)
2217 file->end_of_file = TRUE;
2219 return num_items_read;
2223 return fread(buffer, item_size, num_items, file->file);
2226 int seekFile(File *file, long offset, int whence)
2228 #if defined(PLATFORM_ANDROID)
2229 if (file->file_is_asset)
2231 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2232 whence == SEEK_CUR ? RW_SEEK_CUR :
2233 whence == SEEK_END ? RW_SEEK_END : 0);
2235 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2239 return fseek(file->file, offset, whence);
2242 int getByteFromFile(File *file)
2244 #if defined(PLATFORM_ANDROID)
2245 if (file->file_is_asset)
2247 if (file->end_of_file)
2251 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2253 if (num_bytes_read < 1)
2254 file->end_of_file = TRUE;
2256 return (file->end_of_file ? EOF : (int)c);
2260 return fgetc(file->file);
2263 char *getStringFromFile(File *file, char *line, int size)
2265 #if defined(PLATFORM_ANDROID)
2266 if (file->file_is_asset)
2268 if (file->end_of_file)
2271 char *line_ptr = line;
2272 int num_bytes_read = 0;
2274 while (num_bytes_read < size - 1 &&
2275 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2276 *line_ptr++ != '\n')
2281 if (strlen(line) == 0)
2283 file->end_of_file = TRUE;
2292 return fgets(line, size, file->file);
2296 /* ------------------------------------------------------------------------- */
2297 /* functions for directory handling */
2298 /* ------------------------------------------------------------------------- */
2300 Directory *openDirectory(char *dir_name)
2302 Directory *dir = checked_calloc(sizeof(Directory));
2304 dir->dir = opendir(dir_name);
2306 if (dir->dir != NULL)
2308 dir->filename = getStringCopy(dir_name);
2313 #if defined(PLATFORM_ANDROID)
2314 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2316 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2318 checked_free(asset_toc_filename);
2320 if (dir->asset_toc_file != NULL)
2322 dir->directory_is_asset = TRUE;
2323 dir->filename = getStringCopy(dir_name);
2334 int closeDirectory(Directory *dir)
2341 #if defined(PLATFORM_ANDROID)
2342 if (dir->asset_toc_file)
2343 result = SDL_RWclose(dir->asset_toc_file);
2347 result = closedir(dir->dir);
2350 freeDirectoryEntry(dir->dir_entry);
2352 checked_free(dir->filename);
2358 DirectoryEntry *readDirectory(Directory *dir)
2361 freeDirectoryEntry(dir->dir_entry);
2363 dir->dir_entry = NULL;
2365 #if defined(PLATFORM_ANDROID)
2366 if (dir->directory_is_asset)
2368 char line[MAX_LINE_LEN];
2369 char *line_ptr = line;
2370 int num_bytes_read = 0;
2372 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2373 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2382 if (strlen(line) == 0)
2385 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2387 dir->dir_entry->is_directory = FALSE;
2388 if (line[strlen(line) - 1] == '/')
2390 dir->dir_entry->is_directory = TRUE;
2392 line[strlen(line) - 1] = '\0';
2395 dir->dir_entry->basename = getStringCopy(line);
2396 dir->dir_entry->filename = getPath2(dir->filename, line);
2398 return dir->dir_entry;
2402 struct dirent *dir_entry = readdir(dir->dir);
2404 if (dir_entry == NULL)
2407 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2409 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2410 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2412 struct stat file_status;
2414 dir->dir_entry->is_directory =
2415 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2416 S_ISDIR(file_status.st_mode));
2418 return dir->dir_entry;
2421 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2423 if (dir_entry == NULL)
2426 checked_free(dir_entry->basename);
2427 checked_free(dir_entry->filename);
2428 checked_free(dir_entry);
2432 /* ------------------------------------------------------------------------- */
2433 /* functions for checking files and filenames */
2434 /* ------------------------------------------------------------------------- */
2436 boolean directoryExists(char *dir_name)
2438 if (dir_name == NULL)
2441 struct stat file_status;
2442 boolean success = (stat(dir_name, &file_status) == 0 &&
2443 S_ISDIR(file_status.st_mode));
2445 #if defined(PLATFORM_ANDROID)
2448 // this might be an asset directory; check by trying to open toc file
2449 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2450 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2452 checked_free(asset_toc_filename);
2454 success = (file != NULL);
2464 boolean fileExists(char *filename)
2466 if (filename == NULL)
2469 boolean success = (access(filename, F_OK) == 0);
2471 #if defined(PLATFORM_ANDROID)
2474 // this might be an asset file; check by trying to open it
2475 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2477 success = (file != NULL);
2487 boolean fileHasPrefix(char *basename, char *prefix)
2489 static char *basename_lower = NULL;
2490 int basename_length, prefix_length;
2492 checked_free(basename_lower);
2494 if (basename == NULL || prefix == NULL)
2497 basename_lower = getStringToLower(basename);
2498 basename_length = strlen(basename_lower);
2499 prefix_length = strlen(prefix);
2501 if (basename_length > prefix_length + 1 &&
2502 basename_lower[prefix_length] == '.' &&
2503 strncmp(basename_lower, prefix, prefix_length) == 0)
2509 boolean fileHasSuffix(char *basename, char *suffix)
2511 static char *basename_lower = NULL;
2512 int basename_length, suffix_length;
2514 checked_free(basename_lower);
2516 if (basename == NULL || suffix == NULL)
2519 basename_lower = getStringToLower(basename);
2520 basename_length = strlen(basename_lower);
2521 suffix_length = strlen(suffix);
2523 if (basename_length > suffix_length + 1 &&
2524 basename_lower[basename_length - suffix_length - 1] == '.' &&
2525 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2531 static boolean FileCouldBeArtwork(char *filename)
2533 char *basename = getBaseNamePtr(filename);
2535 return (!strEqual(basename, ".") &&
2536 !strEqual(basename, "..") &&
2537 !fileHasSuffix(basename, "txt") &&
2538 !fileHasSuffix(basename, "conf") &&
2539 !directoryExists(filename));
2542 boolean FileIsGraphic(char *filename)
2544 return FileCouldBeArtwork(filename);
2547 boolean FileIsSound(char *filename)
2549 return FileCouldBeArtwork(filename);
2552 boolean FileIsMusic(char *filename)
2554 return FileCouldBeArtwork(filename);
2557 boolean FileIsArtworkType(char *filename, int type)
2559 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2560 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2561 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2567 /* ------------------------------------------------------------------------- */
2568 /* functions for loading artwork configuration information */
2569 /* ------------------------------------------------------------------------- */
2571 char *get_mapped_token(char *token)
2573 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2574 static char *map_token_prefix[][2] =
2576 { "char_procent", "char_percent" },
2581 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2583 int len_token_prefix = strlen(map_token_prefix[i][0]);
2585 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2586 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2589 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2590 char *gfx_substring = ".gfx";
2591 char *gfx_prefix = "gfx.";
2592 if (strstr(token, gfx_substring) != NULL)
2594 char *token_prefix = getStringCopy(token);
2595 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2596 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2599 // cut off token string at ".gfx" substring position
2600 *token_gfx_pos = '\0';
2602 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2603 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2607 return mapped_token;
2613 char *get_special_base_token(struct ArtworkListInfo *artwork_info, char *token)
2615 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2616 static struct ConfigTypeInfo prefix_list[] =
2618 { "global.anim_1" },
2619 { "global.anim_2" },
2620 { "global.anim_3" },
2621 { "global.anim_4" },
2622 { "global.anim_5" },
2623 { "global.anim_6" },
2624 { "global.anim_7" },
2625 { "global.anim_8" },
2629 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2630 boolean prefix_found = FALSE;
2634 /* search for prefix to check if base token has to be created */
2635 for (i = 0; prefix_list[i].token != NULL; i++)
2636 if (strPrefix(token, prefix_list[i].token))
2637 prefix_found = TRUE;
2642 /* search for suffix (parameter) to determine base token length */
2643 for (i = 0; suffix_list[i].token != NULL; i++)
2644 if (strSuffix(token, suffix_list[i].token))
2645 len_suffix = strlen(suffix_list[i].token);
2647 return getStringCopyN(token, strlen(token) - len_suffix);
2650 /* This function checks if a string <s> of the format "string1, string2, ..."
2651 exactly contains a string <s_contained>. */
2653 static boolean string_has_parameter(char *s, char *s_contained)
2657 if (s == NULL || s_contained == NULL)
2660 if (strlen(s_contained) > strlen(s))
2663 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2665 char next_char = s[strlen(s_contained)];
2667 /* check if next character is delimiter or whitespace */
2668 return (next_char == ',' || next_char == '\0' ||
2669 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2672 /* check if string contains another parameter string after a comma */
2673 substring = strchr(s, ',');
2674 if (substring == NULL) /* string does not contain a comma */
2677 /* advance string pointer to next character after the comma */
2680 /* skip potential whitespaces after the comma */
2681 while (*substring == ' ' || *substring == '\t')
2684 return string_has_parameter(substring, s_contained);
2687 int get_parameter_value(char *value_raw, char *suffix, int type)
2689 char *value = getStringToLower(value_raw);
2690 int result = 0; /* probably a save default value */
2692 if (strEqual(suffix, ".direction"))
2694 result = (strEqual(value, "left") ? MV_LEFT :
2695 strEqual(value, "right") ? MV_RIGHT :
2696 strEqual(value, "up") ? MV_UP :
2697 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2699 else if (strEqual(suffix, ".position"))
2701 result = (strEqual(value, "left") ? POS_LEFT :
2702 strEqual(value, "right") ? POS_RIGHT :
2703 strEqual(value, "top") ? POS_TOP :
2704 strEqual(value, "upper") ? POS_UPPER :
2705 strEqual(value, "middle") ? POS_MIDDLE :
2706 strEqual(value, "lower") ? POS_LOWER :
2707 strEqual(value, "bottom") ? POS_BOTTOM :
2708 strEqual(value, "any") ? POS_ANY : POS_UNDEFINED);
2710 else if (strEqual(suffix, ".align"))
2712 result = (strEqual(value, "left") ? ALIGN_LEFT :
2713 strEqual(value, "right") ? ALIGN_RIGHT :
2714 strEqual(value, "center") ? ALIGN_CENTER :
2715 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2717 else if (strEqual(suffix, ".valign"))
2719 result = (strEqual(value, "top") ? VALIGN_TOP :
2720 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2721 strEqual(value, "middle") ? VALIGN_MIDDLE :
2722 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2724 else if (strEqual(suffix, ".anim_mode"))
2726 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2727 string_has_parameter(value, "loop") ? ANIM_LOOP :
2728 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2729 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2730 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2731 string_has_parameter(value, "random") ? ANIM_RANDOM :
2732 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2733 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2734 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2735 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2736 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2737 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2738 string_has_parameter(value, "all") ? ANIM_ALL :
2741 if (string_has_parameter(value, "once"))
2742 result |= ANIM_ONCE;
2744 if (string_has_parameter(value, "reverse"))
2745 result |= ANIM_REVERSE;
2747 if (string_has_parameter(value, "opaque_player"))
2748 result |= ANIM_OPAQUE_PLAYER;
2750 if (string_has_parameter(value, "static_panel"))
2751 result |= ANIM_STATIC_PANEL;
2753 else if (strEqual(suffix, ".class"))
2755 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2756 get_hash_from_key(value));
2758 else if (strEqual(suffix, ".style"))
2760 result = STYLE_DEFAULT;
2762 if (string_has_parameter(value, "accurate_borders"))
2763 result |= STYLE_ACCURATE_BORDERS;
2765 if (string_has_parameter(value, "inner_corners"))
2766 result |= STYLE_INNER_CORNERS;
2768 else if (strEqual(suffix, ".fade_mode"))
2770 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2771 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2772 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2773 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2774 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
2777 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2779 result = gfx.get_font_from_token_function(value);
2781 else /* generic parameter of type integer or boolean */
2783 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2784 type == TYPE_INTEGER ? get_integer_from_string(value) :
2785 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2786 ARG_UNDEFINED_VALUE);
2794 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2795 struct ListNodeInfo ***, int *);
2797 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2798 struct ConfigTypeInfo *suffix_list,
2799 char **ignore_tokens,
2800 int num_file_list_entries)
2802 SetupFileHash *ignore_tokens_hash;
2803 struct FileInfo *file_list;
2804 int num_file_list_entries_found = 0;
2805 int num_suffix_list_entries = 0;
2809 /* create hash from list of tokens to be ignored (for quick access) */
2810 ignore_tokens_hash = newSetupFileHash();
2811 for (i = 0; ignore_tokens[i] != NULL; i++)
2812 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2814 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2816 for (i = 0; suffix_list[i].token != NULL; i++)
2817 num_suffix_list_entries++;
2819 /* always start with reliable default values */
2820 for (i = 0; i < num_file_list_entries; i++)
2822 file_list[i].token = NULL;
2824 file_list[i].default_filename = NULL;
2825 file_list[i].filename = NULL;
2827 if (num_suffix_list_entries > 0)
2829 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2831 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2832 file_list[i].parameter = checked_calloc(parameter_array_size);
2834 for (j = 0; j < num_suffix_list_entries; j++)
2836 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2837 setString(&file_list[i].parameter[j], suffix_list[j].value);
2840 file_list[i].redefined = FALSE;
2841 file_list[i].fallback_to_default = FALSE;
2842 file_list[i].default_is_cloned = FALSE;
2848 for (i = 0; config_list[i].token != NULL; i++)
2850 int len_config_token = strlen(config_list[i].token);
2851 boolean is_file_entry = TRUE;
2853 for (j = 0; suffix_list[j].token != NULL; j++)
2855 int len_suffix = strlen(suffix_list[j].token);
2857 if (len_suffix < len_config_token &&
2858 strEqual(&config_list[i].token[len_config_token - len_suffix],
2859 suffix_list[j].token))
2861 setString(&file_list[list_pos].default_parameter[j],
2862 config_list[i].value);
2864 is_file_entry = FALSE;
2870 /* the following tokens are no file definitions, but other config tokens */
2871 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
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");
2902 freeSetupFileHash(ignore_tokens_hash);
2907 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2909 int len_token = strlen(token);
2910 int len_suffix = strlen(suffix);
2912 if (start_pos < 0) /* compare suffix from end of string */
2913 start_pos += len_token;
2915 if (start_pos < 0 || start_pos + len_suffix > len_token)
2918 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2921 if (token[start_pos + len_suffix] == '\0')
2924 if (token[start_pos + len_suffix] == '.')
2930 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2932 static void read_token_parameters(SetupFileHash *setup_file_hash,
2933 struct ConfigTypeInfo *suffix_list,
2934 struct FileInfo *file_list_entry)
2936 /* check for config token that is the base token without any suffixes */
2937 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2938 char *known_token_value = KNOWN_TOKEN_VALUE;
2941 if (filename != NULL)
2943 setString(&file_list_entry->filename, filename);
2945 /* when file definition found, set all parameters to default values */
2946 for (i = 0; suffix_list[i].token != NULL; i++)
2947 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2949 file_list_entry->redefined = TRUE;
2951 /* mark config file token as well known from default config */
2952 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2955 /* check for config tokens that can be build by base token and suffixes */
2956 for (i = 0; suffix_list[i].token != NULL; i++)
2958 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2959 char *value = getHashEntry(setup_file_hash, token);
2963 setString(&file_list_entry->parameter[i], value);
2965 /* mark config file token as well known from default config */
2966 setHashEntry(setup_file_hash, token, known_token_value);
2973 static void add_dynamic_file_list_entry(struct FileInfo **list,
2974 int *num_list_entries,
2975 SetupFileHash *extra_file_hash,
2976 struct ConfigTypeInfo *suffix_list,
2977 int num_suffix_list_entries,
2980 struct FileInfo *new_list_entry;
2981 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2983 (*num_list_entries)++;
2984 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2985 new_list_entry = &(*list)[*num_list_entries - 1];
2987 new_list_entry->token = getStringCopy(token);
2988 new_list_entry->default_filename = NULL;
2989 new_list_entry->filename = NULL;
2990 new_list_entry->parameter = checked_calloc(parameter_array_size);
2992 new_list_entry->redefined = FALSE;
2993 new_list_entry->fallback_to_default = FALSE;
2994 new_list_entry->default_is_cloned = FALSE;
2996 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2999 static void add_property_mapping(struct PropertyMapping **list,
3000 int *num_list_entries,
3001 int base_index, int ext1_index,
3002 int ext2_index, int ext3_index,
3005 struct PropertyMapping *new_list_entry;
3007 (*num_list_entries)++;
3008 *list = checked_realloc(*list,
3009 *num_list_entries * sizeof(struct PropertyMapping));
3010 new_list_entry = &(*list)[*num_list_entries - 1];
3012 new_list_entry->base_index = base_index;
3013 new_list_entry->ext1_index = ext1_index;
3014 new_list_entry->ext2_index = ext2_index;
3015 new_list_entry->ext3_index = ext3_index;
3017 new_list_entry->artwork_index = artwork_index;
3020 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3023 struct FileInfo *file_list = artwork_info->file_list;
3024 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3025 char **base_prefixes = artwork_info->base_prefixes;
3026 char **ext1_suffixes = artwork_info->ext1_suffixes;
3027 char **ext2_suffixes = artwork_info->ext2_suffixes;
3028 char **ext3_suffixes = artwork_info->ext3_suffixes;
3029 char **ignore_tokens = artwork_info->ignore_tokens;
3030 int num_file_list_entries = artwork_info->num_file_list_entries;
3031 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3032 int num_base_prefixes = artwork_info->num_base_prefixes;
3033 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3034 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3035 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3036 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3037 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3038 SetupFileHash *extra_file_hash, *empty_file_hash;
3039 char *known_token_value = KNOWN_TOKEN_VALUE;
3040 char *base_token_value = UNDEFINED_FILENAME;
3043 if (filename == NULL)
3046 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3049 /* separate valid (defined) from empty (undefined) config token values */
3050 valid_file_hash = newSetupFileHash();
3051 empty_file_hash = newSetupFileHash();
3052 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3054 char *value = HASH_ITERATION_VALUE(itr);
3056 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3057 HASH_ITERATION_TOKEN(itr), value);
3059 END_HASH_ITERATION(setup_file_hash, itr)
3061 /* at this point, we do not need the setup file hash anymore -- free it */
3062 freeSetupFileHash(setup_file_hash);
3064 /* prevent changing hash while iterating over it by using a temporary copy */
3065 valid_file_hash_tmp = newSetupFileHash();
3066 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3068 setHashEntry(valid_file_hash_tmp,
3069 HASH_ITERATION_TOKEN(itr),
3070 HASH_ITERATION_VALUE(itr));
3072 END_HASH_ITERATION(valid_file_hash, itr)
3074 /* (iterate over same temporary hash, as modifications are independent) */
3076 /* map deprecated to current tokens (using prefix match and replace) */
3077 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3079 char *token = HASH_ITERATION_TOKEN(itr);
3080 char *mapped_token = get_mapped_token(token);
3082 if (mapped_token != NULL)
3084 char *value = HASH_ITERATION_VALUE(itr);
3086 /* add mapped token */
3087 setHashEntry(valid_file_hash, mapped_token, value);
3089 /* ignore old token (by setting it to "known" keyword) */
3090 setHashEntry(valid_file_hash, token, known_token_value);
3095 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3097 /* add special base tokens (using prefix match and replace) */
3098 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3100 char *token = HASH_ITERATION_TOKEN(itr);
3101 char *base_token = get_special_base_token(artwork_info, token);
3103 if (base_token != NULL)
3105 /* add base token only if it does not already exist */
3106 if (getHashEntry(valid_file_hash, base_token) == NULL)
3107 setHashEntry(valid_file_hash, base_token, base_token_value);
3112 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3114 /* free temporary hash used for iteration */
3115 freeSetupFileHash(valid_file_hash_tmp);
3117 /* read parameters for all known config file tokens */
3118 for (i = 0; i < num_file_list_entries; i++)
3119 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3121 /* set all tokens that can be ignored here to "known" keyword */
3122 for (i = 0; i < num_ignore_tokens; i++)
3123 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3125 /* copy all unknown config file tokens to extra config hash */
3126 extra_file_hash = newSetupFileHash();
3127 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3129 char *value = HASH_ITERATION_VALUE(itr);
3131 if (!strEqual(value, known_token_value))
3132 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3134 END_HASH_ITERATION(valid_file_hash, itr)
3136 /* at this point, we do not need the valid file hash anymore -- free it */
3137 freeSetupFileHash(valid_file_hash);
3139 /* now try to determine valid, dynamically defined config tokens */
3141 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3143 struct FileInfo **dynamic_file_list =
3144 &artwork_info->dynamic_file_list;
3145 int *num_dynamic_file_list_entries =
3146 &artwork_info->num_dynamic_file_list_entries;
3147 struct PropertyMapping **property_mapping =
3148 &artwork_info->property_mapping;
3149 int *num_property_mapping_entries =
3150 &artwork_info->num_property_mapping_entries;
3151 int current_summarized_file_list_entry =
3152 artwork_info->num_file_list_entries +
3153 artwork_info->num_dynamic_file_list_entries;
3154 char *token = HASH_ITERATION_TOKEN(itr);
3155 int len_token = strlen(token);
3157 boolean base_prefix_found = FALSE;
3158 boolean parameter_suffix_found = FALSE;
3160 /* skip all parameter definitions (handled by read_token_parameters()) */
3161 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3163 int len_suffix = strlen(suffix_list[i].token);
3165 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3166 parameter_suffix_found = TRUE;
3169 if (parameter_suffix_found)
3172 /* ---------- step 0: search for matching base prefix ---------- */
3175 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3177 char *base_prefix = base_prefixes[i];
3178 int len_base_prefix = strlen(base_prefix);
3179 boolean ext1_suffix_found = FALSE;
3180 boolean ext2_suffix_found = FALSE;
3181 boolean ext3_suffix_found = FALSE;
3182 boolean exact_match = FALSE;
3183 int base_index = -1;
3184 int ext1_index = -1;
3185 int ext2_index = -1;
3186 int ext3_index = -1;
3188 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3190 if (!base_prefix_found)
3195 if (start_pos + len_base_prefix == len_token) /* exact match */
3199 add_dynamic_file_list_entry(dynamic_file_list,
3200 num_dynamic_file_list_entries,
3203 num_suffix_list_entries,
3205 add_property_mapping(property_mapping,
3206 num_property_mapping_entries,
3207 base_index, -1, -1, -1,
3208 current_summarized_file_list_entry);
3212 /* ---------- step 1: search for matching first suffix ---------- */
3214 start_pos += len_base_prefix;
3215 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3217 char *ext1_suffix = ext1_suffixes[j];
3218 int len_ext1_suffix = strlen(ext1_suffix);
3220 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3222 if (!ext1_suffix_found)
3227 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3231 add_dynamic_file_list_entry(dynamic_file_list,
3232 num_dynamic_file_list_entries,
3235 num_suffix_list_entries,
3237 add_property_mapping(property_mapping,
3238 num_property_mapping_entries,
3239 base_index, ext1_index, -1, -1,
3240 current_summarized_file_list_entry);
3244 start_pos += len_ext1_suffix;
3250 /* ---------- step 2: search for matching second suffix ---------- */
3252 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3254 char *ext2_suffix = ext2_suffixes[k];
3255 int len_ext2_suffix = strlen(ext2_suffix);
3257 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3259 if (!ext2_suffix_found)
3264 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3268 add_dynamic_file_list_entry(dynamic_file_list,
3269 num_dynamic_file_list_entries,
3272 num_suffix_list_entries,
3274 add_property_mapping(property_mapping,
3275 num_property_mapping_entries,
3276 base_index, ext1_index, ext2_index, -1,
3277 current_summarized_file_list_entry);
3281 start_pos += len_ext2_suffix;
3287 /* ---------- step 3: search for matching third suffix ---------- */
3289 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3291 char *ext3_suffix = ext3_suffixes[l];
3292 int len_ext3_suffix = strlen(ext3_suffix);
3294 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3296 if (!ext3_suffix_found)
3301 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3305 add_dynamic_file_list_entry(dynamic_file_list,
3306 num_dynamic_file_list_entries,
3309 num_suffix_list_entries,
3311 add_property_mapping(property_mapping,
3312 num_property_mapping_entries,
3313 base_index, ext1_index, ext2_index, ext3_index,
3314 current_summarized_file_list_entry);
3320 END_HASH_ITERATION(extra_file_hash, itr)
3322 if (artwork_info->num_dynamic_file_list_entries > 0)
3324 artwork_info->dynamic_artwork_list =
3325 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3326 artwork_info->sizeof_artwork_list_entry);
3329 if (options.verbose && IS_PARENT_PROCESS())
3331 SetupFileList *setup_file_list, *list;
3332 boolean dynamic_tokens_found = FALSE;
3333 boolean unknown_tokens_found = FALSE;
3334 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3336 /* list may be NULL for empty artwork config files */
3337 setup_file_list = loadSetupFileList(filename);
3339 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3341 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3342 dynamic_tokens_found = TRUE;
3344 unknown_tokens_found = TRUE;
3346 END_HASH_ITERATION(extra_file_hash, itr)
3348 if (options.debug && dynamic_tokens_found)
3350 Error(ERR_INFO_LINE, "-");
3351 Error(ERR_INFO, "dynamic token(s) found in config file:");
3352 Error(ERR_INFO, "- config file: '%s'", filename);
3354 for (list = setup_file_list; list != NULL; list = list->next)
3356 char *value = getHashEntry(extra_file_hash, list->token);
3358 if (value != NULL && strEqual(value, known_token_value))
3359 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3362 Error(ERR_INFO_LINE, "-");
3365 if (unknown_tokens_found)
3367 Error(ERR_INFO_LINE, "-");
3368 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3369 Error(ERR_INFO, "- config file: '%s'", filename);
3371 for (list = setup_file_list; list != NULL; list = list->next)
3373 char *value = getHashEntry(extra_file_hash, list->token);
3375 if (value != NULL && !strEqual(value, known_token_value))
3376 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3379 Error(ERR_INFO_LINE, "-");
3382 if (undefined_values_found)
3384 Error(ERR_INFO_LINE, "-");
3385 Error(ERR_INFO, "warning: undefined values found in config file:");
3386 Error(ERR_INFO, "- config file: '%s'", filename);
3388 for (list = setup_file_list; list != NULL; list = list->next)
3390 char *value = getHashEntry(empty_file_hash, list->token);
3393 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3396 Error(ERR_INFO_LINE, "-");
3399 freeSetupFileList(setup_file_list);
3402 freeSetupFileHash(extra_file_hash);
3403 freeSetupFileHash(empty_file_hash);
3406 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3408 struct FileInfo *file_list = artwork_info->file_list;
3409 int num_file_list_entries = artwork_info->num_file_list_entries;
3410 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3411 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3414 DrawInitText("Loading artwork config", 120, FC_GREEN);
3415 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3417 /* always start with reliable default values */
3418 for (i = 0; i < num_file_list_entries; i++)
3420 setString(&file_list[i].filename, file_list[i].default_filename);
3422 for (j = 0; j < num_suffix_list_entries; j++)
3423 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3425 file_list[i].redefined = FALSE;
3426 file_list[i].fallback_to_default = FALSE;
3429 /* free previous dynamic artwork file array */
3430 if (artwork_info->dynamic_file_list != NULL)
3432 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3434 free(artwork_info->dynamic_file_list[i].token);
3435 free(artwork_info->dynamic_file_list[i].filename);
3436 free(artwork_info->dynamic_file_list[i].parameter);
3439 free(artwork_info->dynamic_file_list);
3440 artwork_info->dynamic_file_list = NULL;
3442 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3443 &artwork_info->num_dynamic_file_list_entries);
3446 /* free previous property mapping */
3447 if (artwork_info->property_mapping != NULL)
3449 free(artwork_info->property_mapping);
3451 artwork_info->property_mapping = NULL;
3452 artwork_info->num_property_mapping_entries = 0;
3455 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3457 /* first look for special artwork configured in level series config */
3458 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3460 if (fileExists(filename_base))
3461 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3464 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3466 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3467 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3470 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3471 struct ListNodeInfo **listnode)
3475 char *filename = (*listnode)->source_filename;
3477 if (--(*listnode)->num_references <= 0)
3478 deleteNodeFromList(&artwork_info->content_list, filename,
3479 artwork_info->free_artwork);
3485 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3486 struct ListNodeInfo **listnode,
3487 struct FileInfo *file_list_entry)
3497 char *basename = file_list_entry->filename;
3498 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3500 if (filename == NULL)
3502 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3504 basename = file_list_entry->default_filename;
3506 /* fail for cloned default artwork that has no default filename defined */
3507 if (file_list_entry->default_is_cloned &&
3508 strEqual(basename, UNDEFINED_FILENAME))
3510 int error_mode = ERR_WARN;
3512 /* we can get away without sounds and music, but not without graphics */
3513 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3514 error_mode = ERR_EXIT;
3516 Error(error_mode, "token '%s' was cloned and has no default filename",
3517 file_list_entry->token);
3522 /* dynamic artwork has no default filename / skip empty default artwork */
3523 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3526 file_list_entry->fallback_to_default = TRUE;
3528 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3530 filename = getCustomArtworkFilename(basename, artwork_info->type);
3532 if (filename == NULL)
3534 int error_mode = ERR_WARN;
3536 /* we can get away without sounds and music, but not without graphics */
3537 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3538 error_mode = ERR_EXIT;
3540 Error(error_mode, "cannot find default artwork file '%s'", basename);
3546 /* check if the old and the new artwork file are the same */
3547 if (*listnode && strEqual((*listnode)->source_filename, filename))
3549 /* The old and new artwork are the same (have the same filename and path).
3550 This usually means that this artwork does not exist in this artwork set
3551 and a fallback to the existing artwork is done. */
3556 /* delete existing artwork file entry */
3557 deleteArtworkListEntry(artwork_info, listnode);
3559 /* check if the new artwork file already exists in the list of artwork */
3560 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3562 *listnode = (struct ListNodeInfo *)node->content;
3563 (*listnode)->num_references++;
3568 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3569 DrawInitText(basename, 150, FC_YELLOW);
3571 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3573 /* add new artwork file entry to the list of artwork files */
3574 (*listnode)->num_references = 1;
3575 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3580 int error_mode = ERR_WARN;
3582 /* we can get away without sounds and music, but not without graphics */
3583 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3584 error_mode = ERR_EXIT;
3586 Error(error_mode, "cannot load artwork file '%s'", basename);
3592 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3593 struct ListNodeInfo **listnode,
3594 struct FileInfo *file_list_entry)
3596 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3598 deleteArtworkListEntry(artwork_info, listnode);
3603 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3606 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3608 struct FileInfo *file_list = artwork_info->file_list;
3609 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3610 int num_file_list_entries = artwork_info->num_file_list_entries;
3611 int num_dynamic_file_list_entries =
3612 artwork_info->num_dynamic_file_list_entries;
3615 print_timestamp_init("ReloadCustomArtworkList");
3617 for (i = 0; i < num_file_list_entries; i++)
3618 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3621 for (i = 0; i < num_dynamic_file_list_entries; i++)
3622 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3623 &dynamic_file_list[i]);
3625 print_timestamp_done("ReloadCustomArtworkList");
3628 dumpList(artwork_info->content_list);
3632 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3633 struct ListNodeInfo ***list,
3634 int *num_list_entries)
3641 for (i = 0; i < *num_list_entries; i++)
3642 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3646 *num_list_entries = 0;
3649 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3651 if (artwork_info == NULL)
3654 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3655 &artwork_info->num_file_list_entries);
3657 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3658 &artwork_info->num_dynamic_file_list_entries);
3662 /* ------------------------------------------------------------------------- */
3663 /* functions only needed for non-Unix (non-command-line) systems */
3664 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3665 /* (now also added for Windows, to create files in user data directory) */
3666 /* ------------------------------------------------------------------------- */
3668 char *getLogFilename(char *basename)
3670 return getPath2(getUserGameDataDir(), basename);
3677 InitUserDataDirectory();
3679 for (i = 0; i < NUM_LOGS; i++)
3681 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3684 program.log_file[i] = program.log_file_default[i]; // reset to default
3686 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3687 program.log_filename[i], strerror(errno));
3690 /* output should be unbuffered so it is not truncated in a crash */
3691 setbuf(program.log_file[i], NULL);
3695 void CloseLogFiles()
3699 for (i = 0; i < NUM_LOGS; i++)
3700 if (program.log_file[i] != program.log_file_default[i])
3701 fclose(program.log_file[i]);
3704 void DumpLogFile(int nr)
3706 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3708 if (log_file == NULL)
3711 while (!feof(log_file))
3712 fputc(fgetc(log_file), stdout);
3717 void NotifyUserAboutErrorFile()
3719 #if defined(PLATFORM_WIN32)
3720 char *title_text = getStringCat2(program.program_title, " Error Message");
3721 char *error_text = getStringCat2("The program was aborted due to an error; "
3722 "for details, see the following error file:"
3724 program.log_filename[LOG_ERR_ID]);
3726 MessageBox(NULL, error_text, title_text, MB_OK);
3731 /* ------------------------------------------------------------------------- */
3732 /* the following is only for debugging purpose and normally not used */
3733 /* ------------------------------------------------------------------------- */
3737 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3738 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3740 #define DEBUG_NUM_TIMESTAMPS 10
3741 #define DEBUG_TIME_IN_MICROSECONDS 0
3743 #if DEBUG_TIME_IN_MICROSECONDS
3744 static double Counter_Microseconds()
3746 static struct timeval base_time = { 0, 0 };
3747 struct timeval current_time;
3750 gettimeofday(¤t_time, NULL);
3752 /* reset base time in case of wrap-around */
3753 if (current_time.tv_sec < base_time.tv_sec)
3754 base_time = current_time;
3757 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3758 ((double)(current_time.tv_usec - base_time.tv_usec));
3760 return counter; /* return microseconds since last init */
3764 char *debug_print_timestamp_get_padding(int padding_size)
3766 static char *padding = NULL;
3767 int max_padding_size = 100;
3769 if (padding == NULL)
3771 padding = checked_calloc(max_padding_size + 1);
3772 memset(padding, ' ', max_padding_size);
3775 return &padding[MAX(0, max_padding_size - padding_size)];
3778 void debug_print_timestamp(int counter_nr, char *message)
3780 int indent_size = 8;
3781 int padding_size = 40;
3782 float timestamp_interval;
3785 Error(ERR_EXIT, "debugging: invalid negative counter");
3786 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3787 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3789 #if DEBUG_TIME_IN_MICROSECONDS
3790 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3793 counter[counter_nr][0] = Counter_Microseconds();
3795 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3798 counter[counter_nr][0] = Counter();
3801 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3802 counter[counter_nr][1] = counter[counter_nr][0];
3805 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3806 debug_print_timestamp_get_padding(counter_nr * indent_size),
3808 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3809 timestamp_interval / 1000,
3813 void debug_print_parent_only(char *format, ...)
3815 if (!IS_PARENT_PROCESS())
3822 va_start(ap, format);
3823 vprintf(format, ap);
3832 void print_timestamp_ext(char *message, char *mode)
3834 #if DEBUG_PRINT_INIT_TIMESTAMPS
3835 static char *debug_message = NULL;
3836 static char *last_message = NULL;
3837 static int counter_nr = 0;
3838 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3840 checked_free(debug_message);
3841 debug_message = getStringCat3(mode, " ", message);
3843 if (strEqual(mode, "INIT"))
3845 debug_print_timestamp(counter_nr, NULL);
3847 if (counter_nr + 1 < max_depth)
3848 debug_print_timestamp(counter_nr, debug_message);
3852 debug_print_timestamp(counter_nr, NULL);
3854 else if (strEqual(mode, "DONE"))
3858 if (counter_nr + 1 < max_depth ||
3859 (counter_nr == 0 && max_depth == 1))
3861 last_message = message;
3863 if (counter_nr == 0 && max_depth == 1)
3865 checked_free(debug_message);
3866 debug_message = getStringCat3("TIME", " ", message);
3869 debug_print_timestamp(counter_nr, debug_message);
3872 else if (!strEqual(mode, "TIME") ||
3873 !strEqual(message, last_message))
3875 if (counter_nr < max_depth)
3876 debug_print_timestamp(counter_nr, debug_message);
3881 void print_timestamp_init(char *message)
3883 print_timestamp_ext(message, "INIT");
3886 void print_timestamp_time(char *message)
3888 print_timestamp_ext(message, "TIME");
3891 void print_timestamp_done(char *message)
3893 print_timestamp_ext(message, "DONE");