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 PrintNoLog(char *format, ...)
227 FILE *file = program.log_file_default[LOG_OUT_ID];
230 va_start(ap, format);
231 vfprintf(file, format, ap);
237 void PrintLine(char *line_chars, int line_length)
241 for (i = 0; i < line_length; i++)
247 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
250 PrintLine(line_chars, line_length);
254 /* ------------------------------------------------------------------------- */
255 /* string functions */
256 /* ------------------------------------------------------------------------- */
258 /* int2str() returns a number converted to a string;
259 the used memory is static, but will be overwritten by later calls,
260 so if you want to save the result, copy it to a private string buffer;
261 there can be 10 local calls of int2str() without buffering the result --
262 the 11th call will then destroy the result from the first call and so on.
265 char *int2str(int number, int size)
267 static char shift_array[10][40];
268 static int shift_counter = 0;
269 char *s = shift_array[shift_counter];
271 shift_counter = (shift_counter + 1) % 10;
278 sprintf(s, " %09d", number);
279 return &s[strlen(s) - size];
283 sprintf(s, "%d", number);
289 /* something similar to "int2str()" above, but allocates its own memory
290 and has a different interface; we cannot use "itoa()", because this
291 seems to be already defined when cross-compiling to the win32 target */
293 char *i_to_a(unsigned int i)
295 static char *a = NULL;
299 if (i > 2147483647) /* yes, this is a kludge */
302 a = checked_malloc(10 + 1);
310 /* calculate base-2 logarithm of argument (rounded down to integer;
311 this function returns the number of the highest bit set in argument) */
313 int log_2(unsigned int x)
319 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
326 boolean getTokenValueFromString(char *string, char **token, char **value)
328 return getTokenValueFromSetupLine(string, token, value);
332 /* ------------------------------------------------------------------------- */
333 /* counter functions */
334 /* ------------------------------------------------------------------------- */
336 /* maximal allowed length of a command line option */
337 #define MAX_OPTION_LEN 256
339 static unsigned int getCurrentMS()
341 return SDL_GetTicks();
344 static unsigned int mainCounter(int mode)
346 static unsigned int base_ms = 0;
347 unsigned int current_ms;
349 /* get current system milliseconds */
350 current_ms = getCurrentMS();
352 /* reset base timestamp in case of counter reset or wrap-around */
353 if (mode == INIT_COUNTER || current_ms < base_ms)
354 base_ms = current_ms;
356 /* return milliseconds since last counter reset */
357 return current_ms - base_ms;
360 void InitCounter() /* set counter back to zero */
362 mainCounter(INIT_COUNTER);
365 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
367 return mainCounter(READ_COUNTER);
370 static void sleep_milliseconds(unsigned int milliseconds_delay)
372 SDL_Delay(milliseconds_delay);
375 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
377 sleep_milliseconds(delay);
380 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
381 unsigned int actual_counter)
383 if (actual_counter >= *counter_var &&
384 actual_counter < *counter_var + delay)
387 *counter_var = actual_counter;
392 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
394 return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
397 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
399 return DelayReachedExt(counter_var, delay, Counter());
402 void ResetDelayCounterExt(unsigned int *counter_var,
403 unsigned int actual_counter)
405 DelayReachedExt(counter_var, 0, actual_counter);
408 void ResetFrameCounter(unsigned int *frame_counter_var)
410 FrameReached(frame_counter_var, 0);
413 void ResetDelayCounter(unsigned int *counter_var)
415 DelayReached(counter_var, 0);
418 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
420 unsigned int actual_counter;
425 actual_counter = Counter();
427 if (actual_counter >= *counter_var &&
428 actual_counter < *counter_var + delay)
429 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
434 if (*counter_var != 0 &&
436 actual_counter >= *counter_var + delay)
438 int lag = actual_counter - (*counter_var + delay);
439 int delay2 = (delay + 1) / 2;
442 skip_frames = (lag + delay2) / delay;
445 *counter_var = actual_counter;
450 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
451 int *loop_var, int last_loop_value)
453 int skip_frames = WaitUntilDelayReached(counter_var, delay);
457 printf("::: %d: %d ms", *loop_var, delay);
459 printf(" -> SKIP %d FRAME(S) [%d ms]", skip_frames, skip_frames * delay);
464 if (skip_frames == 0)
467 // when skipping frames, make sure to never skip the last frame, as
468 // this may be needed for animations to reach a defined end state;
469 // furthermore, we assume that this function is called at the end
470 // of a "for" loop, which continues by incrementing the loop variable
471 // by one before checking the loop condition again; therefore we have
472 // to check against the last loop value minus one here
476 if (*loop_var < last_loop_value) // never skip the last frame
478 *loop_var += skip_frames;
480 if (*loop_var > last_loop_value) // never skip the last frame
481 *loop_var = last_loop_value;
486 /* ------------------------------------------------------------------------- */
487 /* random generator functions */
488 /* ------------------------------------------------------------------------- */
490 unsigned int init_random_number(int nr, int seed)
492 if (seed == NEW_RANDOMIZE)
494 /* default random seed */
495 seed = (int)time(NULL); // seconds since the epoch
497 #if !defined(PLATFORM_WIN32)
498 /* add some more randomness */
499 struct timeval current_time;
501 gettimeofday(¤t_time, NULL);
503 seed += (int)current_time.tv_usec; // microseconds since the epoch
506 /* add some more randomness */
507 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
509 /* add some more randomness */
510 seed += GetSimpleRandom(1000000);
513 srandom_linux_libc(nr, (unsigned int) seed);
515 return (unsigned int) seed;
518 unsigned int get_random_number(int nr, int max)
520 return (max > 0 ? random_linux_libc(nr) % max : 0);
524 /* ------------------------------------------------------------------------- */
525 /* system info functions */
526 /* ------------------------------------------------------------------------- */
528 #if !defined(PLATFORM_ANDROID)
529 static char *get_corrected_real_name(char *real_name)
531 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
532 char *from_ptr = real_name;
533 char *to_ptr = real_name_new;
535 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
536 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
538 /* the name field read from "passwd" file may also contain additional
539 user information, separated by commas, which will be removed here */
540 if (*from_ptr == ',')
543 /* the user's real name may contain 'german sharp s' characters,
544 which have no equivalent in upper case letters (used by our fonts) */
545 if (*from_ptr == CHAR_BYTE_SHARP_S)
552 *to_ptr++ = *from_ptr++;
557 return real_name_new;
563 static char *login_name = NULL;
565 #if defined(PLATFORM_WIN32)
566 if (login_name == NULL)
568 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
569 login_name = checked_malloc(buffer_size);
571 if (GetUserName(login_name, &buffer_size) == 0)
572 strcpy(login_name, ANONYMOUS_NAME);
575 if (login_name == NULL)
579 if ((pwd = getpwuid(getuid())) == NULL)
580 login_name = ANONYMOUS_NAME;
582 login_name = getStringCopy(pwd->pw_name);
591 static char *real_name = NULL;
593 #if defined(PLATFORM_WIN32)
594 if (real_name == NULL)
596 static char buffer[MAX_USERNAME_LEN + 1];
597 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
599 if (GetUserName(buffer, &buffer_size) != 0)
600 real_name = get_corrected_real_name(buffer);
602 real_name = ANONYMOUS_NAME;
604 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
605 if (real_name == NULL)
609 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
610 real_name = get_corrected_real_name(pwd->pw_gecos);
612 real_name = ANONYMOUS_NAME;
615 real_name = ANONYMOUS_NAME;
621 time_t getFileTimestampEpochSeconds(char *filename)
623 struct stat file_status;
625 if (stat(filename, &file_status) != 0) /* cannot stat file */
628 return file_status.st_mtime;
632 /* ------------------------------------------------------------------------- */
633 /* path manipulation functions */
634 /* ------------------------------------------------------------------------- */
636 static char *getLastPathSeparatorPtr(char *filename)
638 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
640 if (last_separator == NULL) /* also try DOS/Windows variant */
641 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
643 return last_separator;
646 char *getBaseNamePtr(char *filename)
648 char *last_separator = getLastPathSeparatorPtr(filename);
650 if (last_separator != NULL)
651 return last_separator + 1; /* separator found: strip base path */
653 return filename; /* no separator found: filename has no path */
656 char *getBaseName(char *filename)
658 return getStringCopy(getBaseNamePtr(filename));
661 char *getBaseNameNoSuffix(char *filename)
663 char *basename = getStringCopy(getBaseNamePtr(filename));
665 // remove trailing suffix (separated by dot or hyphen)
666 if (basename[0] != '.' && basename[0] != '-')
668 if (strchr(basename, '.') != NULL)
669 *strchr(basename, '.') = '\0';
671 if (strchr(basename, '-') != NULL)
672 *strchr(basename, '-') = '\0';
678 char *getBasePath(char *filename)
680 char *basepath = getStringCopy(filename);
681 char *last_separator = getLastPathSeparatorPtr(basepath);
683 if (last_separator != NULL)
684 *last_separator = '\0'; /* separator found: strip basename */
686 basepath = "."; /* no separator found: use current path */
691 static char *getProgramMainDataPath()
693 char *main_data_path = getStringCopy(program.command_basepath);
695 #if defined(PLATFORM_MACOSX)
696 static char *main_data_binary_subdir = NULL;
697 static char *main_data_files_subdir = NULL;
699 if (main_data_binary_subdir == NULL)
701 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
703 strlen(MAC_APP_BINARY_SUBDIR) + 1);
705 sprintf(main_data_binary_subdir, "%s.app/%s",
706 program.program_title, MAC_APP_BINARY_SUBDIR);
709 if (main_data_files_subdir == NULL)
711 main_data_files_subdir = checked_malloc(strlen(program.program_title) + 1 +
713 strlen(MAC_APP_FILES_SUBDIR) + 1);
715 sprintf(main_data_files_subdir, "%s.app/%s",
716 program.program_title, MAC_APP_FILES_SUBDIR);
719 if (strSuffix(main_data_path, main_data_binary_subdir))
721 char *main_data_path_old = main_data_path;
723 // cut relative path to Mac OS X application binary directory from path
724 main_data_path[strlen(main_data_path) -
725 strlen(main_data_binary_subdir)] = '\0';
727 // cut trailing path separator from path (but not if path is root directory)
728 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
729 main_data_path[strlen(main_data_path) - 1] = '\0';
731 // replace empty path with current directory
732 if (strEqual(main_data_path, ""))
733 main_data_path = ".";
735 // add relative path to Mac OS X application resources directory to path
736 main_data_path = getPath2(main_data_path, main_data_files_subdir);
738 free(main_data_path_old);
742 return main_data_path;
746 /* ------------------------------------------------------------------------- */
747 /* various string functions */
748 /* ------------------------------------------------------------------------- */
750 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
752 if (s1 == NULL || s2 == NULL || sep == NULL)
755 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
758 sprintf(complete_string, "%s%s%s", s1, sep, s2);
760 return complete_string;
763 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
765 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
768 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
769 strlen(s2) + strlen(sep) +
772 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
774 return complete_string;
777 char *getStringCat2(char *s1, char *s2)
779 return getStringCat2WithSeparator(s1, s2, "");
782 char *getStringCat3(char *s1, char *s2, char *s3)
784 return getStringCat3WithSeparator(s1, s2, s3, "");
787 char *getPath2(char *path1, char *path2)
789 #if defined(PLATFORM_ANDROID)
790 // workaround for reading from assets directory -- skip "." subdirs in path
791 if (strEqual(path1, "."))
792 return getStringCopy(path2);
793 else if (strEqual(path2, "."))
794 return getStringCopy(path1);
797 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
800 char *getPath3(char *path1, char *path2, char *path3)
802 #if defined(PLATFORM_ANDROID)
803 // workaround for reading from assets directory -- skip "." subdirs in path
804 if (strEqual(path1, "."))
805 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
806 else if (strEqual(path2, "."))
807 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
808 else if (strEqual(path3, "."))
809 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
812 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
815 static char *getPngOrPcxIfNotExists(char *filename)
817 // switch from PNG to PCX file and vice versa, if file does not exist
818 // (backwards compatibility with PCX files used in previous versions)
820 if (!fileExists(filename) && strSuffix(filename, ".png"))
821 strcpy(&filename[strlen(filename) - 3], "pcx");
822 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
823 strcpy(&filename[strlen(filename) - 3], "png");
828 char *getImg2(char *path1, char *path2)
830 return getPngOrPcxIfNotExists(getPath2(path1, path2));
833 char *getImg3(char *path1, char *path2, char *path3)
835 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
838 char *getStringCopy(const char *s)
845 s_copy = checked_malloc(strlen(s) + 1);
851 char *getStringCopyN(const char *s, int n)
854 int s_len = MAX(0, n);
859 s_copy = checked_malloc(s_len + 1);
860 strncpy(s_copy, s, s_len);
861 s_copy[s_len] = '\0';
866 char *getStringCopyNStatic(const char *s, int n)
868 static char *s_copy = NULL;
870 checked_free(s_copy);
872 s_copy = getStringCopyN(s, n);
877 char *getStringToLower(const char *s)
879 char *s_copy = checked_malloc(strlen(s) + 1);
880 char *s_ptr = s_copy;
883 *s_ptr++ = tolower(*s++);
889 void setString(char **old_value, char *new_value)
891 checked_free(*old_value);
893 *old_value = getStringCopy(new_value);
896 boolean strEqual(char *s1, char *s2)
898 return (s1 == NULL && s2 == NULL ? TRUE :
899 s1 == NULL && s2 != NULL ? FALSE :
900 s1 != NULL && s2 == NULL ? FALSE :
901 strcmp(s1, s2) == 0);
904 boolean strEqualN(char *s1, char *s2, int n)
906 return (s1 == NULL && s2 == NULL ? TRUE :
907 s1 == NULL && s2 != NULL ? FALSE :
908 s1 != NULL && s2 == NULL ? FALSE :
909 strncmp(s1, s2, n) == 0);
912 boolean strPrefix(char *s, char *prefix)
914 return (s == NULL && prefix == NULL ? TRUE :
915 s == NULL && prefix != NULL ? FALSE :
916 s != NULL && prefix == NULL ? FALSE :
917 strncmp(s, prefix, strlen(prefix)) == 0);
920 boolean strSuffix(char *s, char *suffix)
922 return (s == NULL && suffix == NULL ? TRUE :
923 s == NULL && suffix != NULL ? FALSE :
924 s != NULL && suffix == NULL ? FALSE :
925 strlen(s) < strlen(suffix) ? FALSE :
926 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
929 boolean strPrefixLower(char *s, char *prefix)
931 char *s_lower = getStringToLower(s);
932 boolean match = strPrefix(s_lower, prefix);
939 boolean strSuffixLower(char *s, char *suffix)
941 char *s_lower = getStringToLower(s);
942 boolean match = strSuffix(s_lower, suffix);
950 /* ------------------------------------------------------------------------- */
951 /* command line option handling functions */
952 /* ------------------------------------------------------------------------- */
954 void GetOptions(int argc, char *argv[],
955 void (*print_usage_function)(void),
956 void (*print_version_function)(void))
958 char *ro_base_path = RO_BASE_PATH;
959 char *rw_base_path = RW_BASE_PATH;
960 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
961 char **options_left = &argvplus[1];
963 /* replace original "argv" with null-terminated array of string pointers */
965 argvplus[argc] = argv[argc];
967 /* if the program is configured to start from current directory (default),
968 determine program package directory from program binary (some versions
969 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
970 set the current working directory to the program package directory) */
972 if (strEqual(ro_base_path, "."))
973 ro_base_path = getProgramMainDataPath();
974 if (strEqual(rw_base_path, "."))
975 rw_base_path = getProgramMainDataPath();
977 /* initialize global program options */
978 options.server_host = NULL;
979 options.server_port = 0;
981 options.ro_base_directory = ro_base_path;
982 options.rw_base_directory = rw_base_path;
983 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
984 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
985 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
986 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
987 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
989 options.execute_command = NULL;
990 options.special_flags = NULL;
992 options.mytapes = FALSE;
993 options.serveronly = FALSE;
994 options.network = FALSE;
995 options.verbose = FALSE;
996 options.debug = FALSE;
999 options.verbose = TRUE;
1001 #if !defined(PLATFORM_UNIX)
1002 if (*options_left == NULL) /* no options given -- enable verbose mode */
1003 options.verbose = TRUE;
1007 while (*options_left)
1009 char option_str[MAX_OPTION_LEN];
1010 char *option = options_left[0];
1011 char *next_option = options_left[1];
1012 char *option_arg = NULL;
1013 int option_len = strlen(option);
1015 if (option_len >= MAX_OPTION_LEN)
1016 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1018 strcpy(option_str, option); /* copy argument into buffer */
1019 option = option_str;
1021 if (strEqual(option, "--")) /* stop scanning arguments */
1024 if (strPrefix(option, "--")) /* treat '--' like '-' */
1027 option_arg = strchr(option, '=');
1028 if (option_arg == NULL) /* no '=' in option */
1029 option_arg = next_option;
1032 *option_arg++ = '\0'; /* cut argument from option */
1033 if (*option_arg == '\0') /* no argument after '=' */
1034 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1037 option_len = strlen(option);
1039 if (strEqual(option, "-"))
1041 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1043 else if (strncmp(option, "-help", option_len) == 0)
1045 print_usage_function();
1049 else if (strncmp(option, "-basepath", option_len) == 0)
1051 if (option_arg == NULL)
1052 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1054 /* this should be extended to separate options for ro and rw data */
1055 options.ro_base_directory = ro_base_path = option_arg;
1056 options.rw_base_directory = rw_base_path = option_arg;
1057 if (option_arg == next_option)
1060 /* adjust paths for sub-directories in base directory accordingly */
1061 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1062 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1063 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1064 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1065 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1067 else if (strncmp(option, "-levels", option_len) == 0)
1069 if (option_arg == NULL)
1070 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1072 options.level_directory = option_arg;
1073 if (option_arg == next_option)
1076 else if (strncmp(option, "-graphics", option_len) == 0)
1078 if (option_arg == NULL)
1079 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1081 options.graphics_directory = option_arg;
1082 if (option_arg == next_option)
1085 else if (strncmp(option, "-sounds", option_len) == 0)
1087 if (option_arg == NULL)
1088 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1090 options.sounds_directory = option_arg;
1091 if (option_arg == next_option)
1094 else if (strncmp(option, "-music", option_len) == 0)
1096 if (option_arg == NULL)
1097 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1099 options.music_directory = option_arg;
1100 if (option_arg == next_option)
1103 else if (strncmp(option, "-mytapes", option_len) == 0)
1105 options.mytapes = TRUE;
1107 else if (strncmp(option, "-network", option_len) == 0)
1109 options.network = TRUE;
1111 else if (strncmp(option, "-serveronly", option_len) == 0)
1113 options.serveronly = TRUE;
1115 else if (strncmp(option, "-debug", option_len) == 0)
1117 options.debug = TRUE;
1119 else if (strncmp(option, "-verbose", option_len) == 0)
1121 options.verbose = TRUE;
1123 else if (strncmp(option, "-version", option_len) == 0 ||
1124 strncmp(option, "-V", option_len) == 0)
1126 print_version_function();
1130 else if (strPrefix(option, "-D"))
1132 options.special_flags = getStringCopy(&option[2]);
1134 else if (strncmp(option, "-execute", option_len) == 0)
1136 if (option_arg == NULL)
1137 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1139 options.execute_command = option_arg;
1140 if (option_arg == next_option)
1143 /* when doing batch processing, always enable verbose mode (warnings) */
1144 options.verbose = TRUE;
1146 #if defined(PLATFORM_MACOSX)
1147 else if (strPrefix(option, "-psn"))
1149 /* ignore process serial number when launched via GUI on Mac OS X */
1152 else if (*option == '-')
1154 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1156 else if (options.server_host == NULL)
1158 options.server_host = *options_left;
1160 else if (options.server_port == 0)
1162 options.server_port = atoi(*options_left);
1163 if (options.server_port < 1024)
1164 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1167 Error(ERR_EXIT_HELP, "too many arguments");
1174 /* ------------------------------------------------------------------------- */
1175 /* error handling functions */
1176 /* ------------------------------------------------------------------------- */
1178 #define MAX_INTERNAL_ERROR_SIZE 1024
1180 /* used by SetError() and GetError() to store internal error messages */
1181 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1183 void SetError(char *format, ...)
1187 va_start(ap, format);
1188 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1194 return internal_error;
1197 void Error(int mode, char *format, ...)
1199 static boolean last_line_was_separator = FALSE;
1200 char *process_name = "";
1202 if (program.log_file[LOG_ERR_ID] == NULL)
1205 #if defined(PLATFORM_ANDROID)
1206 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1207 mode & ERR_INFO ? ANDROID_LOG_INFO :
1208 mode & ERR_WARN ? ANDROID_LOG_WARN :
1209 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1210 ANDROID_LOG_UNKNOWN);
1213 /* display warnings only when running in verbose mode */
1214 if (mode & ERR_WARN && !options.verbose)
1217 if (mode == ERR_INFO_LINE)
1219 if (!last_line_was_separator)
1220 printf_log_line(format, 79);
1222 last_line_was_separator = TRUE;
1227 last_line_was_separator = FALSE;
1229 if (mode & ERR_SOUND_SERVER)
1230 process_name = " sound server";
1231 else if (mode & ERR_NETWORK_SERVER)
1232 process_name = " network server";
1233 else if (mode & ERR_NETWORK_CLIENT)
1234 process_name = " network client **";
1238 #if !defined(PLATFORM_ANDROID)
1239 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1242 if (mode & ERR_WARN)
1243 printf_log_nonewline("warning: ");
1245 if (mode & ERR_EXIT)
1246 printf_log_nonewline("fatal error: ");
1250 va_start(ap, format);
1251 vprintf_log(format, ap);
1254 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1256 va_start(ap, format);
1257 program.exit_message_function(format, ap);
1262 if (mode & ERR_HELP)
1263 printf_log("%s: Try option '--help' for more information.",
1264 program.command_basename);
1266 if (mode & ERR_EXIT)
1267 printf_log("%s%s: aborting", program.command_basename, process_name);
1269 if (mode & ERR_EXIT)
1271 if (mode & ERR_FROM_SERVER)
1272 exit(1); /* child process: normal exit */
1274 program.exit_function(1); /* main process: clean up stuff */
1279 /* ------------------------------------------------------------------------- */
1280 /* checked memory allocation and freeing functions */
1281 /* ------------------------------------------------------------------------- */
1283 void *checked_malloc(unsigned int size)
1290 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1295 void *checked_calloc(unsigned int size)
1299 ptr = calloc(1, size);
1302 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1307 void *checked_realloc(void *ptr, unsigned int size)
1309 ptr = realloc(ptr, size);
1312 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1317 void checked_free(void *ptr)
1319 if (ptr != NULL) /* this check should be done by free() anyway */
1323 void clear_mem(void *ptr, unsigned int size)
1325 #if defined(PLATFORM_WIN32)
1326 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1327 char *cptr = (char *)ptr;
1332 memset(ptr, 0, size);
1337 /* ------------------------------------------------------------------------- */
1338 /* various helper functions */
1339 /* ------------------------------------------------------------------------- */
1341 void swap_numbers(int *i1, int *i2)
1349 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1361 /* the "put" variants of the following file access functions check for the file
1362 pointer being != NULL and return the number of bytes they have or would have
1363 written; this allows for chunk writing functions to first determine the size
1364 of the (not yet written) chunk, write the correct chunk size and finally
1365 write the chunk itself */
1367 int getFile8BitInteger(File *file)
1369 return getByteFromFile(file);
1372 int putFile8BitInteger(FILE *file, int value)
1380 int getFile16BitInteger(File *file, int byte_order)
1382 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1383 return ((getByteFromFile(file) << 8) |
1384 (getByteFromFile(file) << 0));
1385 else /* BYTE_ORDER_LITTLE_ENDIAN */
1386 return ((getByteFromFile(file) << 0) |
1387 (getByteFromFile(file) << 8));
1390 int putFile16BitInteger(FILE *file, int value, int byte_order)
1394 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1396 fputc((value >> 8) & 0xff, file);
1397 fputc((value >> 0) & 0xff, file);
1399 else /* BYTE_ORDER_LITTLE_ENDIAN */
1401 fputc((value >> 0) & 0xff, file);
1402 fputc((value >> 8) & 0xff, file);
1409 int getFile32BitInteger(File *file, int byte_order)
1411 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1412 return ((getByteFromFile(file) << 24) |
1413 (getByteFromFile(file) << 16) |
1414 (getByteFromFile(file) << 8) |
1415 (getByteFromFile(file) << 0));
1416 else /* BYTE_ORDER_LITTLE_ENDIAN */
1417 return ((getByteFromFile(file) << 0) |
1418 (getByteFromFile(file) << 8) |
1419 (getByteFromFile(file) << 16) |
1420 (getByteFromFile(file) << 24));
1423 int putFile32BitInteger(FILE *file, int value, int byte_order)
1427 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1429 fputc((value >> 24) & 0xff, file);
1430 fputc((value >> 16) & 0xff, file);
1431 fputc((value >> 8) & 0xff, file);
1432 fputc((value >> 0) & 0xff, file);
1434 else /* BYTE_ORDER_LITTLE_ENDIAN */
1436 fputc((value >> 0) & 0xff, file);
1437 fputc((value >> 8) & 0xff, file);
1438 fputc((value >> 16) & 0xff, file);
1439 fputc((value >> 24) & 0xff, file);
1446 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1449 const int chunk_name_length = 4;
1451 /* read chunk name */
1452 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1455 if (chunk_size != NULL)
1457 /* read chunk size */
1458 *chunk_size = getFile32BitInteger(file, byte_order);
1461 return (checkEndOfFile(file) ? FALSE : TRUE);
1464 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1469 /* write chunk name */
1471 fputs(chunk_name, file);
1473 num_bytes += strlen(chunk_name);
1475 if (chunk_size >= 0)
1477 /* write chunk size */
1479 putFile32BitInteger(file, chunk_size, byte_order);
1487 int getFileVersion(File *file)
1489 int version_major = getByteFromFile(file);
1490 int version_minor = getByteFromFile(file);
1491 int version_patch = getByteFromFile(file);
1492 int version_build = getByteFromFile(file);
1494 return VERSION_IDENT(version_major, version_minor, version_patch,
1498 int putFileVersion(FILE *file, int version)
1502 int version_major = VERSION_MAJOR(version);
1503 int version_minor = VERSION_MINOR(version);
1504 int version_patch = VERSION_PATCH(version);
1505 int version_build = VERSION_BUILD(version);
1507 fputc(version_major, file);
1508 fputc(version_minor, file);
1509 fputc(version_patch, file);
1510 fputc(version_build, file);
1516 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1520 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1521 buffer[i] = getByteFromFile(file);
1524 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1528 for(i = 0; i < bytes; i++)
1529 fputc(buffer[i], file);
1532 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1534 while (bytes-- && !checkEndOfFile(file))
1535 getByteFromFile(file);
1538 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1545 /* ------------------------------------------------------------------------- */
1546 /* functions to translate key identifiers between different format */
1547 /* ------------------------------------------------------------------------- */
1549 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1550 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1551 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1552 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1554 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1563 /* normal cursor keys */
1564 { KSYM_Left, "XK_Left", "cursor left" },
1565 { KSYM_Right, "XK_Right", "cursor right" },
1566 { KSYM_Up, "XK_Up", "cursor up" },
1567 { KSYM_Down, "XK_Down", "cursor down" },
1569 /* keypad cursor keys */
1571 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1572 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1573 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1574 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1577 /* other keypad keys */
1578 #ifdef KSYM_KP_Enter
1579 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1580 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1581 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1582 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1583 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1584 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1588 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1589 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1590 { KSYM_Control_L, "XK_Control_L", "left control" },
1591 { KSYM_Control_R, "XK_Control_R", "right control" },
1592 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1593 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1594 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1595 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1596 #if !defined(TARGET_SDL2)
1597 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1598 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1600 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1601 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1603 /* some special keys */
1604 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1605 { KSYM_Delete, "XK_Delete", "delete" },
1606 { KSYM_Insert, "XK_Insert", "insert" },
1607 { KSYM_Tab, "XK_Tab", "tab" },
1608 { KSYM_Home, "XK_Home", "home" },
1609 { KSYM_End, "XK_End", "end" },
1610 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1611 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1613 #if defined(TARGET_SDL2)
1614 { KSYM_Select, "XK_Select", "select" },
1615 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1616 { KSYM_Back, "XK_Back", "back" }, /* back key */
1617 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1618 #if defined(PLATFORM_ANDROID)
1619 { KSYM_Rewind, "XK_Rewind", "rewind" },
1620 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1624 /* ASCII 0x20 to 0x40 keys (except numbers) */
1625 { KSYM_space, "XK_space", "space" },
1626 { KSYM_exclam, "XK_exclam", "!" },
1627 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1628 { KSYM_numbersign, "XK_numbersign", "#" },
1629 { KSYM_dollar, "XK_dollar", "$" },
1630 { KSYM_percent, "XK_percent", "%" },
1631 { KSYM_ampersand, "XK_ampersand", "&" },
1632 { KSYM_apostrophe, "XK_apostrophe", "'" },
1633 { KSYM_parenleft, "XK_parenleft", "(" },
1634 { KSYM_parenright, "XK_parenright", ")" },
1635 { KSYM_asterisk, "XK_asterisk", "*" },
1636 { KSYM_plus, "XK_plus", "+" },
1637 { KSYM_comma, "XK_comma", "," },
1638 { KSYM_minus, "XK_minus", "-" },
1639 { KSYM_period, "XK_period", "." },
1640 { KSYM_slash, "XK_slash", "/" },
1641 { KSYM_colon, "XK_colon", ":" },
1642 { KSYM_semicolon, "XK_semicolon", ";" },
1643 { KSYM_less, "XK_less", "<" },
1644 { KSYM_equal, "XK_equal", "=" },
1645 { KSYM_greater, "XK_greater", ">" },
1646 { KSYM_question, "XK_question", "?" },
1647 { KSYM_at, "XK_at", "@" },
1649 /* more ASCII keys */
1650 { KSYM_bracketleft, "XK_bracketleft", "[" },
1651 { KSYM_backslash, "XK_backslash", "\\" },
1652 { KSYM_bracketright,"XK_bracketright", "]" },
1653 { KSYM_asciicircum, "XK_asciicircum", "^" },
1654 { KSYM_underscore, "XK_underscore", "_" },
1655 { KSYM_grave, "XK_grave", "grave" },
1656 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1657 { KSYM_braceleft, "XK_braceleft", "brace left" },
1658 { KSYM_bar, "XK_bar", "bar" },
1659 { KSYM_braceright, "XK_braceright", "brace right" },
1660 { KSYM_asciitilde, "XK_asciitilde", "~" },
1662 /* special (non-ASCII) keys */
1663 { KSYM_degree, "XK_degree", "degree" },
1664 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1665 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1666 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1667 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1668 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1669 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1670 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1672 #if defined(TARGET_SDL2)
1673 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1674 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1675 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1676 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1677 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1678 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1679 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1680 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1681 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1683 /* other keys (for reverse mapping only) */
1684 { KSYM_space, "XK_space", " " },
1687 #if defined(TARGET_SDL2)
1688 /* keypad keys are not in numerical order in SDL2 */
1689 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1690 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1691 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1692 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1693 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1694 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1695 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1696 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1697 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1698 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1701 /* end-of-array identifier */
1707 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1709 static char name_buffer[30];
1712 if (key >= KSYM_A && key <= KSYM_Z)
1713 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1714 else if (key >= KSYM_a && key <= KSYM_z)
1715 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1716 else if (key >= KSYM_0 && key <= KSYM_9)
1717 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1718 #if !defined(TARGET_SDL2)
1719 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1720 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1722 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1723 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1724 else if (key == KSYM_UNDEFINED)
1725 strcpy(name_buffer, "(undefined)");
1732 if (key == translate_key[i].key)
1734 strcpy(name_buffer, translate_key[i].name);
1738 while (translate_key[++i].name);
1740 if (!translate_key[i].name)
1741 strcpy(name_buffer, "(unknown)");
1744 *name = name_buffer;
1746 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1748 static char name_buffer[30];
1751 if (key >= KSYM_A && key <= KSYM_Z)
1752 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1753 else if (key >= KSYM_a && key <= KSYM_z)
1754 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1755 else if (key >= KSYM_0 && key <= KSYM_9)
1756 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1757 #if !defined(TARGET_SDL2)
1758 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1759 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1761 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1762 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1763 else if (key == KSYM_UNDEFINED)
1764 strcpy(name_buffer, "[undefined]");
1771 if (key == translate_key[i].key)
1773 strcpy(name_buffer, translate_key[i].x11name);
1777 while (translate_key[++i].x11name);
1779 if (!translate_key[i].x11name)
1780 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1783 *x11name = name_buffer;
1785 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1787 Key key = KSYM_UNDEFINED;
1788 char *name_ptr = *name;
1790 if (strlen(*name) == 1)
1792 char c = name_ptr[0];
1794 if (c >= 'A' && c <= 'Z')
1795 key = KSYM_A + (Key)(c - 'A');
1796 else if (c >= 'a' && c <= 'z')
1797 key = KSYM_a + (Key)(c - 'a');
1798 else if (c >= '0' && c <= '9')
1799 key = KSYM_0 + (Key)(c - '0');
1802 if (key == KSYM_UNDEFINED)
1808 if (strEqual(translate_key[i].name, *name))
1810 key = translate_key[i].key;
1814 while (translate_key[++i].x11name);
1817 if (key == KSYM_UNDEFINED)
1818 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1822 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1824 Key key = KSYM_UNDEFINED;
1825 char *name_ptr = *x11name;
1827 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1829 char c = name_ptr[3];
1831 if (c >= 'A' && c <= 'Z')
1832 key = KSYM_A + (Key)(c - 'A');
1833 else if (c >= 'a' && c <= 'z')
1834 key = KSYM_a + (Key)(c - 'a');
1835 else if (c >= '0' && c <= '9')
1836 key = KSYM_0 + (Key)(c - '0');
1838 #if !defined(TARGET_SDL2)
1839 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1841 char c = name_ptr[6];
1843 if (c >= '0' && c <= '9')
1844 key = KSYM_KP_0 + (Key)(c - '0');
1847 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1849 char c1 = name_ptr[4];
1850 char c2 = name_ptr[5];
1853 if ((c1 >= '0' && c1 <= '9') &&
1854 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1855 d = atoi(&name_ptr[4]);
1857 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1858 key = KSYM_F1 + (Key)(d - 1);
1860 else if (strPrefix(name_ptr, "XK_"))
1866 if (strEqual(name_ptr, translate_key[i].x11name))
1868 key = translate_key[i].key;
1872 while (translate_key[++i].x11name);
1874 else if (strPrefix(name_ptr, "0x"))
1876 unsigned int value = 0;
1882 char c = *name_ptr++;
1885 if (c >= '0' && c <= '9')
1887 else if (c >= 'a' && c <= 'f')
1888 d = (int)(c - 'a' + 10);
1889 else if (c >= 'A' && c <= 'F')
1890 d = (int)(c - 'A' + 10);
1898 value = value * 16 + d;
1909 char *getKeyNameFromKey(Key key)
1913 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1917 char *getX11KeyNameFromKey(Key key)
1921 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1925 Key getKeyFromKeyName(char *name)
1929 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1933 Key getKeyFromX11KeyName(char *x11name)
1937 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1941 char getCharFromKey(Key key)
1947 } translate_key_char[] =
1949 /* special (non-ASCII) keys (ISO-8859-1) */
1950 { KSYM_degree, CHAR_BYTE_DEGREE },
1951 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1952 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1953 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1954 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1955 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1956 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1957 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1959 /* end-of-array identifier */
1963 char *keyname = getKeyNameFromKey(key);
1966 if (strlen(keyname) == 1)
1968 else if (strEqual(keyname, "space"))
1976 if (key == translate_key_char[i].key)
1978 c = translate_key_char[i].key_char;
1983 while (translate_key_char[++i].key_char);
1989 char getValidConfigValueChar(char c)
1991 if (c == '#' || /* used to mark comments */
1992 c == '\\') /* used to mark continued lines */
1999 /* ------------------------------------------------------------------------- */
2000 /* functions to translate string identifiers to integer or boolean value */
2001 /* ------------------------------------------------------------------------- */
2003 int get_integer_from_string(char *s)
2005 static char *number_text[][3] =
2007 { "0", "zero", "null", },
2008 { "1", "one", "first" },
2009 { "2", "two", "second" },
2010 { "3", "three", "third" },
2011 { "4", "four", "fourth" },
2012 { "5", "five", "fifth" },
2013 { "6", "six", "sixth" },
2014 { "7", "seven", "seventh" },
2015 { "8", "eight", "eighth" },
2016 { "9", "nine", "ninth" },
2017 { "10", "ten", "tenth" },
2018 { "11", "eleven", "eleventh" },
2019 { "12", "twelve", "twelfth" },
2021 { NULL, NULL, NULL },
2025 char *s_lower = getStringToLower(s);
2028 for (i = 0; number_text[i][0] != NULL; i++)
2029 for (j = 0; j < 3; j++)
2030 if (strEqual(s_lower, number_text[i][j]))
2035 if (strEqual(s_lower, "false") ||
2036 strEqual(s_lower, "no") ||
2037 strEqual(s_lower, "off"))
2039 else if (strEqual(s_lower, "true") ||
2040 strEqual(s_lower, "yes") ||
2041 strEqual(s_lower, "on"))
2052 boolean get_boolean_from_string(char *s)
2054 char *s_lower = getStringToLower(s);
2055 boolean result = FALSE;
2057 if (strEqual(s_lower, "true") ||
2058 strEqual(s_lower, "yes") ||
2059 strEqual(s_lower, "on") ||
2060 get_integer_from_string(s) == 1)
2068 int get_switch3_from_string(char *s)
2070 char *s_lower = getStringToLower(s);
2073 if (strEqual(s_lower, "true") ||
2074 strEqual(s_lower, "yes") ||
2075 strEqual(s_lower, "on") ||
2076 get_integer_from_string(s) == 1)
2078 else if (strEqual(s_lower, "auto"))
2087 /* ------------------------------------------------------------------------- */
2088 /* functions for generic lists */
2089 /* ------------------------------------------------------------------------- */
2091 ListNode *newListNode()
2093 return checked_calloc(sizeof(ListNode));
2096 void addNodeToList(ListNode **node_first, char *key, void *content)
2098 ListNode *node_new = newListNode();
2100 node_new->key = getStringCopy(key);
2101 node_new->content = content;
2102 node_new->next = *node_first;
2105 (*node_first)->prev = node_new;
2107 *node_first = node_new;
2110 void deleteNodeFromList(ListNode **node_first, char *key,
2111 void (*destructor_function)(void *))
2113 if (node_first == NULL || *node_first == NULL)
2116 if (strEqual((*node_first)->key, key))
2118 // after first recursion, (*node_first)->prev->next == *node_first,
2119 // so *node_first would be overwritten with (*node_first)->next
2120 // => use a copy of *node_first (and later of (*node_first)->next)
2121 ListNode *node = *node_first;
2122 ListNode *node_next = node->next;
2124 checked_free(node->key);
2126 if (destructor_function)
2127 destructor_function(node->content);
2130 node->prev->next = node->next;
2133 node->next->prev = node->prev;
2137 // after removing node, set list pointer to next valid list node
2138 // (this is important if the first node of the list was deleted)
2139 *node_first = node_next;
2143 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2147 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2149 if (node_first == NULL)
2152 if (strEqual(node_first->key, key))
2155 return getNodeFromKey(node_first->next, key);
2158 int getNumNodes(ListNode *node_first)
2160 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2163 void dumpList(ListNode *node_first)
2165 ListNode *node = node_first;
2169 printf("['%s' (%d)]\n", node->key,
2170 ((struct ListNodeInfo *)node->content)->num_references);
2174 printf("[%d nodes]\n", getNumNodes(node_first));
2178 /* ------------------------------------------------------------------------- */
2179 /* functions for file handling */
2180 /* ------------------------------------------------------------------------- */
2182 File *openFile(char *filename, char *mode)
2184 File *file = checked_calloc(sizeof(File));
2186 file->file = fopen(filename, mode);
2188 if (file->file != NULL)
2190 file->filename = getStringCopy(filename);
2195 #if defined(PLATFORM_ANDROID)
2196 file->asset_file = SDL_RWFromFile(filename, mode);
2198 if (file->asset_file != NULL)
2200 file->file_is_asset = TRUE;
2201 file->filename = getStringCopy(filename);
2212 int closeFile(File *file)
2219 #if defined(PLATFORM_ANDROID)
2220 if (file->asset_file)
2221 result = SDL_RWclose(file->asset_file);
2225 result = fclose(file->file);
2227 checked_free(file->filename);
2233 int checkEndOfFile(File *file)
2235 #if defined(PLATFORM_ANDROID)
2236 if (file->file_is_asset)
2237 return file->end_of_file;
2240 return feof(file->file);
2243 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2245 #if defined(PLATFORM_ANDROID)
2246 if (file->file_is_asset)
2248 if (file->end_of_file)
2251 size_t num_items_read =
2252 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2254 if (num_items_read < num_items)
2255 file->end_of_file = TRUE;
2257 return num_items_read;
2261 return fread(buffer, item_size, num_items, file->file);
2264 int seekFile(File *file, long offset, int whence)
2266 #if defined(PLATFORM_ANDROID)
2267 if (file->file_is_asset)
2269 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2270 whence == SEEK_CUR ? RW_SEEK_CUR :
2271 whence == SEEK_END ? RW_SEEK_END : 0);
2273 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2277 return fseek(file->file, offset, whence);
2280 int getByteFromFile(File *file)
2282 #if defined(PLATFORM_ANDROID)
2283 if (file->file_is_asset)
2285 if (file->end_of_file)
2289 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2291 if (num_bytes_read < 1)
2292 file->end_of_file = TRUE;
2294 return (file->end_of_file ? EOF : (int)c);
2298 return fgetc(file->file);
2301 char *getStringFromFile(File *file, char *line, int size)
2303 #if defined(PLATFORM_ANDROID)
2304 if (file->file_is_asset)
2306 if (file->end_of_file)
2309 char *line_ptr = line;
2310 int num_bytes_read = 0;
2312 while (num_bytes_read < size - 1 &&
2313 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2314 *line_ptr++ != '\n')
2319 if (strlen(line) == 0)
2321 file->end_of_file = TRUE;
2330 return fgets(line, size, file->file);
2334 /* ------------------------------------------------------------------------- */
2335 /* functions for directory handling */
2336 /* ------------------------------------------------------------------------- */
2338 Directory *openDirectory(char *dir_name)
2340 Directory *dir = checked_calloc(sizeof(Directory));
2342 dir->dir = opendir(dir_name);
2344 if (dir->dir != NULL)
2346 dir->filename = getStringCopy(dir_name);
2351 #if defined(PLATFORM_ANDROID)
2352 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2354 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2356 checked_free(asset_toc_filename);
2358 if (dir->asset_toc_file != NULL)
2360 dir->directory_is_asset = TRUE;
2361 dir->filename = getStringCopy(dir_name);
2372 int closeDirectory(Directory *dir)
2379 #if defined(PLATFORM_ANDROID)
2380 if (dir->asset_toc_file)
2381 result = SDL_RWclose(dir->asset_toc_file);
2385 result = closedir(dir->dir);
2388 freeDirectoryEntry(dir->dir_entry);
2390 checked_free(dir->filename);
2396 DirectoryEntry *readDirectory(Directory *dir)
2399 freeDirectoryEntry(dir->dir_entry);
2401 dir->dir_entry = NULL;
2403 #if defined(PLATFORM_ANDROID)
2404 if (dir->directory_is_asset)
2406 char line[MAX_LINE_LEN];
2407 char *line_ptr = line;
2408 int num_bytes_read = 0;
2410 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2411 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2420 if (strlen(line) == 0)
2423 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2425 dir->dir_entry->is_directory = FALSE;
2426 if (line[strlen(line) - 1] == '/')
2428 dir->dir_entry->is_directory = TRUE;
2430 line[strlen(line) - 1] = '\0';
2433 dir->dir_entry->basename = getStringCopy(line);
2434 dir->dir_entry->filename = getPath2(dir->filename, line);
2436 return dir->dir_entry;
2440 struct dirent *dir_entry = readdir(dir->dir);
2442 if (dir_entry == NULL)
2445 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2447 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2448 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2450 struct stat file_status;
2452 dir->dir_entry->is_directory =
2453 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2454 S_ISDIR(file_status.st_mode));
2456 return dir->dir_entry;
2459 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2461 if (dir_entry == NULL)
2464 checked_free(dir_entry->basename);
2465 checked_free(dir_entry->filename);
2466 checked_free(dir_entry);
2470 /* ------------------------------------------------------------------------- */
2471 /* functions for checking files and filenames */
2472 /* ------------------------------------------------------------------------- */
2474 boolean directoryExists(char *dir_name)
2476 if (dir_name == NULL)
2479 struct stat file_status;
2480 boolean success = (stat(dir_name, &file_status) == 0 &&
2481 S_ISDIR(file_status.st_mode));
2483 #if defined(PLATFORM_ANDROID)
2486 // this might be an asset directory; check by trying to open toc file
2487 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2488 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2490 checked_free(asset_toc_filename);
2492 success = (file != NULL);
2502 boolean fileExists(char *filename)
2504 if (filename == NULL)
2507 boolean success = (access(filename, F_OK) == 0);
2509 #if defined(PLATFORM_ANDROID)
2512 // this might be an asset file; check by trying to open it
2513 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2515 success = (file != NULL);
2525 boolean fileHasPrefix(char *basename, char *prefix)
2527 static char *basename_lower = NULL;
2528 int basename_length, prefix_length;
2530 checked_free(basename_lower);
2532 if (basename == NULL || prefix == NULL)
2535 basename_lower = getStringToLower(basename);
2536 basename_length = strlen(basename_lower);
2537 prefix_length = strlen(prefix);
2539 if (basename_length > prefix_length + 1 &&
2540 basename_lower[prefix_length] == '.' &&
2541 strncmp(basename_lower, prefix, prefix_length) == 0)
2547 boolean fileHasSuffix(char *basename, char *suffix)
2549 static char *basename_lower = NULL;
2550 int basename_length, suffix_length;
2552 checked_free(basename_lower);
2554 if (basename == NULL || suffix == NULL)
2557 basename_lower = getStringToLower(basename);
2558 basename_length = strlen(basename_lower);
2559 suffix_length = strlen(suffix);
2561 if (basename_length > suffix_length + 1 &&
2562 basename_lower[basename_length - suffix_length - 1] == '.' &&
2563 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2569 static boolean FileCouldBeArtwork(char *filename)
2571 char *basename = getBaseNamePtr(filename);
2573 return (!strEqual(basename, ".") &&
2574 !strEqual(basename, "..") &&
2575 !fileHasSuffix(basename, "txt") &&
2576 !fileHasSuffix(basename, "conf") &&
2577 !directoryExists(filename));
2580 boolean FileIsGraphic(char *filename)
2582 return FileCouldBeArtwork(filename);
2585 boolean FileIsSound(char *filename)
2587 return FileCouldBeArtwork(filename);
2590 boolean FileIsMusic(char *filename)
2592 return FileCouldBeArtwork(filename);
2595 boolean FileIsArtworkType(char *filename, int type)
2597 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2598 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2599 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2605 /* ------------------------------------------------------------------------- */
2606 /* functions for loading artwork configuration information */
2607 /* ------------------------------------------------------------------------- */
2609 char *get_mapped_token(char *token)
2611 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2612 static char *map_token_prefix[][2] =
2614 { "char_procent", "char_percent" },
2619 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2621 int len_token_prefix = strlen(map_token_prefix[i][0]);
2623 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2624 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2627 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2628 char *gfx_substring = ".gfx";
2629 char *gfx_prefix = "gfx.";
2630 if (strstr(token, gfx_substring) != NULL)
2632 char *token_prefix = getStringCopy(token);
2633 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2634 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2637 // cut off token string at ".gfx" substring position
2638 *token_gfx_pos = '\0';
2640 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2641 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2645 return mapped_token;
2651 char *get_special_base_token(struct ArtworkListInfo *artwork_info, char *token)
2653 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2654 static struct ConfigTypeInfo prefix_list[] =
2656 { "global.anim_1" },
2657 { "global.anim_2" },
2658 { "global.anim_3" },
2659 { "global.anim_4" },
2660 { "global.anim_5" },
2661 { "global.anim_6" },
2662 { "global.anim_7" },
2663 { "global.anim_8" },
2664 { "global.anim_9" },
2665 { "global.anim_10" },
2666 { "global.anim_11" },
2667 { "global.anim_12" },
2668 { "global.anim_13" },
2669 { "global.anim_14" },
2670 { "global.anim_15" },
2671 { "global.anim_16" },
2672 { "global.anim_17" },
2673 { "global.anim_18" },
2674 { "global.anim_19" },
2675 { "global.anim_20" },
2676 { "global.anim_21" },
2677 { "global.anim_22" },
2678 { "global.anim_23" },
2679 { "global.anim_24" },
2680 { "global.anim_25" },
2681 { "global.anim_26" },
2682 { "global.anim_27" },
2683 { "global.anim_28" },
2684 { "global.anim_29" },
2685 { "global.anim_30" },
2686 { "global.anim_31" },
2687 { "global.anim_32" },
2691 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2692 boolean prefix_found = FALSE;
2696 /* search for prefix to check if base token has to be created */
2697 for (i = 0; prefix_list[i].token != NULL; i++)
2698 if (strPrefix(token, prefix_list[i].token))
2699 prefix_found = TRUE;
2704 /* search for suffix (parameter) to determine base token length */
2705 for (i = 0; suffix_list[i].token != NULL; i++)
2706 if (strSuffix(token, suffix_list[i].token))
2707 len_suffix = strlen(suffix_list[i].token);
2709 return getStringCopyN(token, strlen(token) - len_suffix);
2712 /* This function checks if a string <s> of the format "string1, string2, ..."
2713 exactly contains a string <s_contained>. */
2715 static boolean string_has_parameter(char *s, char *s_contained)
2719 if (s == NULL || s_contained == NULL)
2722 if (strlen(s_contained) > strlen(s))
2725 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2727 char next_char = s[strlen(s_contained)];
2729 /* check if next character is delimiter or whitespace */
2730 return (next_char == ',' || next_char == '\0' ||
2731 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2734 /* check if string contains another parameter string after a comma */
2735 substring = strchr(s, ',');
2736 if (substring == NULL) /* string does not contain a comma */
2739 /* advance string pointer to next character after the comma */
2742 /* skip potential whitespaces after the comma */
2743 while (*substring == ' ' || *substring == '\t')
2746 return string_has_parameter(substring, s_contained);
2749 int get_anim_parameter_value(char *s)
2751 char *pattern_1 = "click:anim_";
2752 char *pattern_2 = ".part_";
2753 char *matching_char = NULL;
2755 int result = ANIM_EVENT_NONE;
2757 matching_char = strstr(s_ptr, pattern_1);
2758 if (matching_char == NULL)
2759 return ANIM_EVENT_NONE;
2761 s_ptr = matching_char + strlen(pattern_1);
2763 // check for main animation number ("anim_X" or "anim_XX")
2764 if (*s_ptr >= '0' && *s_ptr <= '9')
2766 int gic_anim_nr = (*s_ptr++ - '0');
2768 if (*s_ptr >= '0' && *s_ptr <= '9')
2769 gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
2771 if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
2772 return ANIM_EVENT_NONE;
2774 result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
2778 // invalid main animation number specified
2780 return ANIM_EVENT_NONE;
2783 // check for animation part number ("part_X" or "part_XX") (optional)
2784 if (strPrefix(s_ptr, pattern_2))
2786 s_ptr += strlen(pattern_2);
2788 if (*s_ptr >= '0' && *s_ptr <= '9')
2790 int gic_part_nr = (*s_ptr++ - '0');
2792 if (*s_ptr >= '0' && *s_ptr <= '9')
2793 gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
2795 if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
2796 return ANIM_EVENT_NONE;
2798 result |= gic_part_nr << ANIM_EVENT_PART_BIT;
2802 // invalid animation part number specified
2804 return ANIM_EVENT_NONE;
2808 /* discard result if next character is neither delimiter nor whitespace */
2809 if (!(*s_ptr == ',' || *s_ptr == '\0' ||
2810 *s_ptr == ' ' || *s_ptr == '\t'))
2811 return ANIM_EVENT_NONE;
2816 int get_parameter_value(char *value_raw, char *suffix, int type)
2818 char *value = getStringToLower(value_raw);
2819 int result = 0; /* probably a save default value */
2821 if (strEqual(suffix, ".direction"))
2823 result = (strEqual(value, "left") ? MV_LEFT :
2824 strEqual(value, "right") ? MV_RIGHT :
2825 strEqual(value, "up") ? MV_UP :
2826 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2828 else if (strEqual(suffix, ".position"))
2830 result = (strEqual(value, "left") ? POS_LEFT :
2831 strEqual(value, "right") ? POS_RIGHT :
2832 strEqual(value, "top") ? POS_TOP :
2833 strEqual(value, "upper") ? POS_UPPER :
2834 strEqual(value, "middle") ? POS_MIDDLE :
2835 strEqual(value, "lower") ? POS_LOWER :
2836 strEqual(value, "bottom") ? POS_BOTTOM :
2837 strEqual(value, "any") ? POS_ANY :
2838 strEqual(value, "last") ? POS_LAST : POS_UNDEFINED);
2840 else if (strEqual(suffix, ".align"))
2842 result = (strEqual(value, "left") ? ALIGN_LEFT :
2843 strEqual(value, "right") ? ALIGN_RIGHT :
2844 strEqual(value, "center") ? ALIGN_CENTER :
2845 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2847 else if (strEqual(suffix, ".valign"))
2849 result = (strEqual(value, "top") ? VALIGN_TOP :
2850 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2851 strEqual(value, "middle") ? VALIGN_MIDDLE :
2852 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2854 else if (strEqual(suffix, ".anim_mode"))
2856 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2857 string_has_parameter(value, "loop") ? ANIM_LOOP :
2858 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2859 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2860 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2861 string_has_parameter(value, "random") ? ANIM_RANDOM :
2862 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2863 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2864 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2865 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2866 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2867 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2868 string_has_parameter(value, "all") ? ANIM_ALL :
2871 if (string_has_parameter(value, "once"))
2872 result |= ANIM_ONCE;
2874 if (string_has_parameter(value, "reverse"))
2875 result |= ANIM_REVERSE;
2877 if (string_has_parameter(value, "opaque_player"))
2878 result |= ANIM_OPAQUE_PLAYER;
2880 if (string_has_parameter(value, "static_panel"))
2881 result |= ANIM_STATIC_PANEL;
2883 else if (strEqual(suffix, ".init_event") ||
2884 strEqual(suffix, ".anim_event"))
2886 result = ANIM_EVENT_DEFAULT;
2888 if (string_has_parameter(value, "any"))
2889 result |= ANIM_EVENT_ANY;
2891 if (string_has_parameter(value, "click"))
2892 result |= ANIM_EVENT_SELF;
2894 // add optional "click:anim_X" or "click:anim_X.part_X" parameter
2895 result |= get_anim_parameter_value(value);
2897 else if (strEqual(suffix, ".class"))
2899 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2900 get_hash_from_key(value));
2902 else if (strEqual(suffix, ".style"))
2904 result = STYLE_DEFAULT;
2906 if (string_has_parameter(value, "accurate_borders"))
2907 result |= STYLE_ACCURATE_BORDERS;
2909 if (string_has_parameter(value, "inner_corners"))
2910 result |= STYLE_INNER_CORNERS;
2912 else if (strEqual(suffix, ".fade_mode"))
2914 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2915 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2916 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2917 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2918 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
2921 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2923 result = gfx.get_font_from_token_function(value);
2925 else /* generic parameter of type integer or boolean */
2927 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2928 type == TYPE_INTEGER ? get_integer_from_string(value) :
2929 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2930 ARG_UNDEFINED_VALUE);
2938 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2939 struct ListNodeInfo ***, int *);
2941 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2942 struct ConfigTypeInfo *suffix_list,
2943 char **ignore_tokens,
2944 int num_file_list_entries)
2946 SetupFileHash *ignore_tokens_hash;
2947 struct FileInfo *file_list;
2948 int num_file_list_entries_found = 0;
2949 int num_suffix_list_entries = 0;
2953 /* create hash from list of tokens to be ignored (for quick access) */
2954 ignore_tokens_hash = newSetupFileHash();
2955 for (i = 0; ignore_tokens[i] != NULL; i++)
2956 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2958 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2960 for (i = 0; suffix_list[i].token != NULL; i++)
2961 num_suffix_list_entries++;
2963 /* always start with reliable default values */
2964 for (i = 0; i < num_file_list_entries; i++)
2966 file_list[i].token = NULL;
2968 file_list[i].default_filename = NULL;
2969 file_list[i].filename = NULL;
2971 if (num_suffix_list_entries > 0)
2973 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2975 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2976 file_list[i].parameter = checked_calloc(parameter_array_size);
2978 for (j = 0; j < num_suffix_list_entries; j++)
2980 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2981 setString(&file_list[i].parameter[j], suffix_list[j].value);
2984 file_list[i].redefined = FALSE;
2985 file_list[i].fallback_to_default = FALSE;
2986 file_list[i].default_is_cloned = FALSE;
2992 for (i = 0; config_list[i].token != NULL; i++)
2994 int len_config_token = strlen(config_list[i].token);
2995 boolean is_file_entry = TRUE;
2997 for (j = 0; suffix_list[j].token != NULL; j++)
2999 int len_suffix = strlen(suffix_list[j].token);
3001 if (len_suffix < len_config_token &&
3002 strEqual(&config_list[i].token[len_config_token - len_suffix],
3003 suffix_list[j].token))
3005 setString(&file_list[list_pos].default_parameter[j],
3006 config_list[i].value);
3008 is_file_entry = FALSE;
3014 /* the following tokens are no file definitions, but other config tokens */
3015 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3016 is_file_entry = FALSE;
3023 if (list_pos >= num_file_list_entries)
3026 file_list[list_pos].token = config_list[i].token;
3027 file_list[list_pos].default_filename = config_list[i].value;
3030 if (strSuffix(config_list[i].token, ".clone_from"))
3031 file_list[list_pos].default_is_cloned = TRUE;
3034 num_file_list_entries_found = list_pos + 1;
3035 if (num_file_list_entries_found != num_file_list_entries)
3037 Error(ERR_INFO_LINE, "-");
3038 Error(ERR_INFO, "inconsistant config list information:");
3039 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
3040 num_file_list_entries);
3041 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
3042 num_file_list_entries_found);
3043 Error(ERR_EXIT, "please fix");
3046 freeSetupFileHash(ignore_tokens_hash);
3051 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3053 int len_token = strlen(token);
3054 int len_suffix = strlen(suffix);
3056 if (start_pos < 0) /* compare suffix from end of string */
3057 start_pos += len_token;
3059 if (start_pos < 0 || start_pos + len_suffix > len_token)
3062 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3065 if (token[start_pos + len_suffix] == '\0')
3068 if (token[start_pos + len_suffix] == '.')
3074 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3076 static void read_token_parameters(SetupFileHash *setup_file_hash,
3077 struct ConfigTypeInfo *suffix_list,
3078 struct FileInfo *file_list_entry)
3080 /* check for config token that is the base token without any suffixes */
3081 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3082 char *known_token_value = KNOWN_TOKEN_VALUE;
3085 if (filename != NULL)
3087 setString(&file_list_entry->filename, filename);
3089 /* when file definition found, set all parameters to default values */
3090 for (i = 0; suffix_list[i].token != NULL; i++)
3091 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3093 file_list_entry->redefined = TRUE;
3095 /* mark config file token as well known from default config */
3096 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3099 /* check for config tokens that can be build by base token and suffixes */
3100 for (i = 0; suffix_list[i].token != NULL; i++)
3102 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3103 char *value = getHashEntry(setup_file_hash, token);
3107 setString(&file_list_entry->parameter[i], value);
3109 /* mark config file token as well known from default config */
3110 setHashEntry(setup_file_hash, token, known_token_value);
3117 static void add_dynamic_file_list_entry(struct FileInfo **list,
3118 int *num_list_entries,
3119 SetupFileHash *extra_file_hash,
3120 struct ConfigTypeInfo *suffix_list,
3121 int num_suffix_list_entries,
3124 struct FileInfo *new_list_entry;
3125 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3127 (*num_list_entries)++;
3128 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3129 new_list_entry = &(*list)[*num_list_entries - 1];
3131 new_list_entry->token = getStringCopy(token);
3132 new_list_entry->default_filename = NULL;
3133 new_list_entry->filename = NULL;
3134 new_list_entry->parameter = checked_calloc(parameter_array_size);
3136 new_list_entry->redefined = FALSE;
3137 new_list_entry->fallback_to_default = FALSE;
3138 new_list_entry->default_is_cloned = FALSE;
3140 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3143 static void add_property_mapping(struct PropertyMapping **list,
3144 int *num_list_entries,
3145 int base_index, int ext1_index,
3146 int ext2_index, int ext3_index,
3149 struct PropertyMapping *new_list_entry;
3151 (*num_list_entries)++;
3152 *list = checked_realloc(*list,
3153 *num_list_entries * sizeof(struct PropertyMapping));
3154 new_list_entry = &(*list)[*num_list_entries - 1];
3156 new_list_entry->base_index = base_index;
3157 new_list_entry->ext1_index = ext1_index;
3158 new_list_entry->ext2_index = ext2_index;
3159 new_list_entry->ext3_index = ext3_index;
3161 new_list_entry->artwork_index = artwork_index;
3164 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3167 struct FileInfo *file_list = artwork_info->file_list;
3168 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3169 char **base_prefixes = artwork_info->base_prefixes;
3170 char **ext1_suffixes = artwork_info->ext1_suffixes;
3171 char **ext2_suffixes = artwork_info->ext2_suffixes;
3172 char **ext3_suffixes = artwork_info->ext3_suffixes;
3173 char **ignore_tokens = artwork_info->ignore_tokens;
3174 int num_file_list_entries = artwork_info->num_file_list_entries;
3175 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3176 int num_base_prefixes = artwork_info->num_base_prefixes;
3177 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3178 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3179 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3180 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3181 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3182 SetupFileHash *extra_file_hash, *empty_file_hash;
3183 char *known_token_value = KNOWN_TOKEN_VALUE;
3184 char *base_token_value = UNDEFINED_FILENAME;
3187 if (filename == NULL)
3190 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3193 /* separate valid (defined) from empty (undefined) config token values */
3194 valid_file_hash = newSetupFileHash();
3195 empty_file_hash = newSetupFileHash();
3196 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3198 char *value = HASH_ITERATION_VALUE(itr);
3200 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3201 HASH_ITERATION_TOKEN(itr), value);
3203 END_HASH_ITERATION(setup_file_hash, itr)
3205 /* at this point, we do not need the setup file hash anymore -- free it */
3206 freeSetupFileHash(setup_file_hash);
3208 /* prevent changing hash while iterating over it by using a temporary copy */
3209 valid_file_hash_tmp = newSetupFileHash();
3210 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3212 setHashEntry(valid_file_hash_tmp,
3213 HASH_ITERATION_TOKEN(itr),
3214 HASH_ITERATION_VALUE(itr));
3216 END_HASH_ITERATION(valid_file_hash, itr)
3218 /* (iterate over same temporary hash, as modifications are independent) */
3220 /* map deprecated to current tokens (using prefix match and replace) */
3221 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3223 char *token = HASH_ITERATION_TOKEN(itr);
3224 char *mapped_token = get_mapped_token(token);
3226 if (mapped_token != NULL)
3228 char *value = HASH_ITERATION_VALUE(itr);
3230 /* add mapped token */
3231 setHashEntry(valid_file_hash, mapped_token, value);
3233 /* ignore old token (by setting it to "known" keyword) */
3234 setHashEntry(valid_file_hash, token, known_token_value);
3239 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3241 /* add special base tokens (using prefix match and replace) */
3242 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3244 char *token = HASH_ITERATION_TOKEN(itr);
3245 char *base_token = get_special_base_token(artwork_info, token);
3247 if (base_token != NULL)
3249 /* add base token only if it does not already exist */
3250 if (getHashEntry(valid_file_hash, base_token) == NULL)
3251 setHashEntry(valid_file_hash, base_token, base_token_value);
3256 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3258 /* free temporary hash used for iteration */
3259 freeSetupFileHash(valid_file_hash_tmp);
3261 /* read parameters for all known config file tokens */
3262 for (i = 0; i < num_file_list_entries; i++)
3263 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3265 /* set all tokens that can be ignored here to "known" keyword */
3266 for (i = 0; i < num_ignore_tokens; i++)
3267 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3269 /* copy all unknown config file tokens to extra config hash */
3270 extra_file_hash = newSetupFileHash();
3271 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3273 char *value = HASH_ITERATION_VALUE(itr);
3275 if (!strEqual(value, known_token_value))
3276 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3278 END_HASH_ITERATION(valid_file_hash, itr)
3280 /* at this point, we do not need the valid file hash anymore -- free it */
3281 freeSetupFileHash(valid_file_hash);
3283 /* now try to determine valid, dynamically defined config tokens */
3285 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3287 struct FileInfo **dynamic_file_list =
3288 &artwork_info->dynamic_file_list;
3289 int *num_dynamic_file_list_entries =
3290 &artwork_info->num_dynamic_file_list_entries;
3291 struct PropertyMapping **property_mapping =
3292 &artwork_info->property_mapping;
3293 int *num_property_mapping_entries =
3294 &artwork_info->num_property_mapping_entries;
3295 int current_summarized_file_list_entry =
3296 artwork_info->num_file_list_entries +
3297 artwork_info->num_dynamic_file_list_entries;
3298 char *token = HASH_ITERATION_TOKEN(itr);
3299 int len_token = strlen(token);
3301 boolean base_prefix_found = FALSE;
3302 boolean parameter_suffix_found = FALSE;
3304 /* skip all parameter definitions (handled by read_token_parameters()) */
3305 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3307 int len_suffix = strlen(suffix_list[i].token);
3309 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3310 parameter_suffix_found = TRUE;
3313 if (parameter_suffix_found)
3316 /* ---------- step 0: search for matching base prefix ---------- */
3319 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3321 char *base_prefix = base_prefixes[i];
3322 int len_base_prefix = strlen(base_prefix);
3323 boolean ext1_suffix_found = FALSE;
3324 boolean ext2_suffix_found = FALSE;
3325 boolean ext3_suffix_found = FALSE;
3326 boolean exact_match = FALSE;
3327 int base_index = -1;
3328 int ext1_index = -1;
3329 int ext2_index = -1;
3330 int ext3_index = -1;
3332 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3334 if (!base_prefix_found)
3339 if (start_pos + len_base_prefix == len_token) /* exact match */
3343 add_dynamic_file_list_entry(dynamic_file_list,
3344 num_dynamic_file_list_entries,
3347 num_suffix_list_entries,
3349 add_property_mapping(property_mapping,
3350 num_property_mapping_entries,
3351 base_index, -1, -1, -1,
3352 current_summarized_file_list_entry);
3356 /* ---------- step 1: search for matching first suffix ---------- */
3358 start_pos += len_base_prefix;
3359 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3361 char *ext1_suffix = ext1_suffixes[j];
3362 int len_ext1_suffix = strlen(ext1_suffix);
3364 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3366 if (!ext1_suffix_found)
3371 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3375 add_dynamic_file_list_entry(dynamic_file_list,
3376 num_dynamic_file_list_entries,
3379 num_suffix_list_entries,
3381 add_property_mapping(property_mapping,
3382 num_property_mapping_entries,
3383 base_index, ext1_index, -1, -1,
3384 current_summarized_file_list_entry);
3388 start_pos += len_ext1_suffix;
3394 /* ---------- step 2: search for matching second suffix ---------- */
3396 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3398 char *ext2_suffix = ext2_suffixes[k];
3399 int len_ext2_suffix = strlen(ext2_suffix);
3401 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3403 if (!ext2_suffix_found)
3408 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3412 add_dynamic_file_list_entry(dynamic_file_list,
3413 num_dynamic_file_list_entries,
3416 num_suffix_list_entries,
3418 add_property_mapping(property_mapping,
3419 num_property_mapping_entries,
3420 base_index, ext1_index, ext2_index, -1,
3421 current_summarized_file_list_entry);
3425 start_pos += len_ext2_suffix;
3431 /* ---------- step 3: search for matching third suffix ---------- */
3433 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3435 char *ext3_suffix = ext3_suffixes[l];
3436 int len_ext3_suffix = strlen(ext3_suffix);
3438 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3440 if (!ext3_suffix_found)
3445 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3449 add_dynamic_file_list_entry(dynamic_file_list,
3450 num_dynamic_file_list_entries,
3453 num_suffix_list_entries,
3455 add_property_mapping(property_mapping,
3456 num_property_mapping_entries,
3457 base_index, ext1_index, ext2_index, ext3_index,
3458 current_summarized_file_list_entry);
3464 END_HASH_ITERATION(extra_file_hash, itr)
3466 if (artwork_info->num_dynamic_file_list_entries > 0)
3468 artwork_info->dynamic_artwork_list =
3469 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3470 artwork_info->sizeof_artwork_list_entry);
3473 if (options.verbose && IS_PARENT_PROCESS())
3475 SetupFileList *setup_file_list, *list;
3476 boolean dynamic_tokens_found = FALSE;
3477 boolean unknown_tokens_found = FALSE;
3478 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3480 /* list may be NULL for empty artwork config files */
3481 setup_file_list = loadSetupFileList(filename);
3483 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3485 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3486 dynamic_tokens_found = TRUE;
3488 unknown_tokens_found = TRUE;
3490 END_HASH_ITERATION(extra_file_hash, itr)
3492 if (options.debug && dynamic_tokens_found)
3494 Error(ERR_INFO_LINE, "-");
3495 Error(ERR_INFO, "dynamic token(s) found in config file:");
3496 Error(ERR_INFO, "- config file: '%s'", filename);
3498 for (list = setup_file_list; list != NULL; list = list->next)
3500 char *value = getHashEntry(extra_file_hash, list->token);
3502 if (value != NULL && strEqual(value, known_token_value))
3503 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3506 Error(ERR_INFO_LINE, "-");
3509 if (unknown_tokens_found)
3511 Error(ERR_INFO_LINE, "-");
3512 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3513 Error(ERR_INFO, "- config file: '%s'", filename);
3515 for (list = setup_file_list; list != NULL; list = list->next)
3517 char *value = getHashEntry(extra_file_hash, list->token);
3519 if (value != NULL && !strEqual(value, known_token_value))
3520 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3523 Error(ERR_INFO_LINE, "-");
3526 if (undefined_values_found)
3528 Error(ERR_INFO_LINE, "-");
3529 Error(ERR_INFO, "warning: undefined values found in config file:");
3530 Error(ERR_INFO, "- config file: '%s'", filename);
3532 for (list = setup_file_list; list != NULL; list = list->next)
3534 char *value = getHashEntry(empty_file_hash, list->token);
3537 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3540 Error(ERR_INFO_LINE, "-");
3543 freeSetupFileList(setup_file_list);
3546 freeSetupFileHash(extra_file_hash);
3547 freeSetupFileHash(empty_file_hash);
3550 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3552 struct FileInfo *file_list = artwork_info->file_list;
3553 int num_file_list_entries = artwork_info->num_file_list_entries;
3554 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3555 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3558 DrawInitText("Loading artwork config", 120, FC_GREEN);
3559 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3561 /* always start with reliable default values */
3562 for (i = 0; i < num_file_list_entries; i++)
3564 setString(&file_list[i].filename, file_list[i].default_filename);
3566 for (j = 0; j < num_suffix_list_entries; j++)
3567 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3569 file_list[i].redefined = FALSE;
3570 file_list[i].fallback_to_default = FALSE;
3573 /* free previous dynamic artwork file array */
3574 if (artwork_info->dynamic_file_list != NULL)
3576 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3578 free(artwork_info->dynamic_file_list[i].token);
3579 free(artwork_info->dynamic_file_list[i].filename);
3580 free(artwork_info->dynamic_file_list[i].parameter);
3583 free(artwork_info->dynamic_file_list);
3584 artwork_info->dynamic_file_list = NULL;
3586 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3587 &artwork_info->num_dynamic_file_list_entries);
3590 /* free previous property mapping */
3591 if (artwork_info->property_mapping != NULL)
3593 free(artwork_info->property_mapping);
3595 artwork_info->property_mapping = NULL;
3596 artwork_info->num_property_mapping_entries = 0;
3599 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3601 /* first look for special artwork configured in level series config */
3602 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3604 if (fileExists(filename_base))
3605 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3608 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3610 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3611 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3614 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3615 struct ListNodeInfo **listnode)
3619 char *filename = (*listnode)->source_filename;
3621 if (--(*listnode)->num_references <= 0)
3622 deleteNodeFromList(&artwork_info->content_list, filename,
3623 artwork_info->free_artwork);
3629 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3630 struct ListNodeInfo **listnode,
3631 struct FileInfo *file_list_entry)
3641 char *basename = file_list_entry->filename;
3642 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3644 if (filename == NULL)
3646 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3648 basename = file_list_entry->default_filename;
3650 /* fail for cloned default artwork that has no default filename defined */
3651 if (file_list_entry->default_is_cloned &&
3652 strEqual(basename, UNDEFINED_FILENAME))
3654 int error_mode = ERR_WARN;
3656 /* we can get away without sounds and music, but not without graphics */
3657 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3658 error_mode = ERR_EXIT;
3660 Error(error_mode, "token '%s' was cloned and has no default filename",
3661 file_list_entry->token);
3666 /* dynamic artwork has no default filename / skip empty default artwork */
3667 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3670 file_list_entry->fallback_to_default = TRUE;
3672 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3674 filename = getCustomArtworkFilename(basename, artwork_info->type);
3676 if (filename == NULL)
3678 int error_mode = ERR_WARN;
3680 /* we can get away without sounds and music, but not without graphics */
3681 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3682 error_mode = ERR_EXIT;
3684 Error(error_mode, "cannot find default artwork file '%s'", basename);
3690 /* check if the old and the new artwork file are the same */
3691 if (*listnode && strEqual((*listnode)->source_filename, filename))
3693 /* The old and new artwork are the same (have the same filename and path).
3694 This usually means that this artwork does not exist in this artwork set
3695 and a fallback to the existing artwork is done. */
3700 /* delete existing artwork file entry */
3701 deleteArtworkListEntry(artwork_info, listnode);
3703 /* check if the new artwork file already exists in the list of artwork */
3704 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3706 *listnode = (struct ListNodeInfo *)node->content;
3707 (*listnode)->num_references++;
3712 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3713 DrawInitText(basename, 150, FC_YELLOW);
3715 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3717 /* add new artwork file entry to the list of artwork files */
3718 (*listnode)->num_references = 1;
3719 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3724 int error_mode = ERR_WARN;
3726 /* we can get away without sounds and music, but not without graphics */
3727 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3728 error_mode = ERR_EXIT;
3730 Error(error_mode, "cannot load artwork file '%s'", basename);
3736 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3737 struct ListNodeInfo **listnode,
3738 struct FileInfo *file_list_entry)
3740 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3742 deleteArtworkListEntry(artwork_info, listnode);
3747 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3750 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3752 struct FileInfo *file_list = artwork_info->file_list;
3753 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3754 int num_file_list_entries = artwork_info->num_file_list_entries;
3755 int num_dynamic_file_list_entries =
3756 artwork_info->num_dynamic_file_list_entries;
3759 print_timestamp_init("ReloadCustomArtworkList");
3761 for (i = 0; i < num_file_list_entries; i++)
3762 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3765 for (i = 0; i < num_dynamic_file_list_entries; i++)
3766 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3767 &dynamic_file_list[i]);
3769 print_timestamp_done("ReloadCustomArtworkList");
3772 dumpList(artwork_info->content_list);
3776 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3777 struct ListNodeInfo ***list,
3778 int *num_list_entries)
3785 for (i = 0; i < *num_list_entries; i++)
3786 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3790 *num_list_entries = 0;
3793 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3795 if (artwork_info == NULL)
3798 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3799 &artwork_info->num_file_list_entries);
3801 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3802 &artwork_info->num_dynamic_file_list_entries);
3806 /* ------------------------------------------------------------------------- */
3807 /* functions only needed for non-Unix (non-command-line) systems */
3808 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3809 /* (now also added for Windows, to create files in user data directory) */
3810 /* ------------------------------------------------------------------------- */
3812 char *getLogFilename(char *basename)
3814 return getPath2(getUserGameDataDir(), basename);
3821 InitUserDataDirectory();
3823 for (i = 0; i < NUM_LOGS; i++)
3825 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3828 program.log_file[i] = program.log_file_default[i]; // reset to default
3830 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3831 program.log_filename[i], strerror(errno));
3834 /* output should be unbuffered so it is not truncated in a crash */
3835 setbuf(program.log_file[i], NULL);
3839 void CloseLogFiles()
3843 for (i = 0; i < NUM_LOGS; i++)
3844 if (program.log_file[i] != program.log_file_default[i])
3845 fclose(program.log_file[i]);
3848 void DumpLogFile(int nr)
3850 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3852 if (log_file == NULL)
3855 while (!feof(log_file))
3856 fputc(fgetc(log_file), stdout);
3861 void NotifyUserAboutErrorFile()
3863 #if defined(PLATFORM_WIN32)
3864 char *title_text = getStringCat2(program.program_title, " Error Message");
3865 char *error_text = getStringCat2("The program was aborted due to an error; "
3866 "for details, see the following error file:"
3868 program.log_filename[LOG_ERR_ID]);
3870 MessageBox(NULL, error_text, title_text, MB_OK);
3875 /* ------------------------------------------------------------------------- */
3876 /* the following is only for debugging purpose and normally not used */
3877 /* ------------------------------------------------------------------------- */
3881 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3882 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3884 #define DEBUG_NUM_TIMESTAMPS 10
3885 #define DEBUG_TIME_IN_MICROSECONDS 0
3887 #if DEBUG_TIME_IN_MICROSECONDS
3888 static double Counter_Microseconds()
3890 static struct timeval base_time = { 0, 0 };
3891 struct timeval current_time;
3894 gettimeofday(¤t_time, NULL);
3896 /* reset base time in case of wrap-around */
3897 if (current_time.tv_sec < base_time.tv_sec)
3898 base_time = current_time;
3901 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3902 ((double)(current_time.tv_usec - base_time.tv_usec));
3904 return counter; /* return microseconds since last init */
3908 char *debug_print_timestamp_get_padding(int padding_size)
3910 static char *padding = NULL;
3911 int max_padding_size = 100;
3913 if (padding == NULL)
3915 padding = checked_calloc(max_padding_size + 1);
3916 memset(padding, ' ', max_padding_size);
3919 return &padding[MAX(0, max_padding_size - padding_size)];
3922 void debug_print_timestamp(int counter_nr, char *message)
3924 int indent_size = 8;
3925 int padding_size = 40;
3926 float timestamp_interval;
3929 Error(ERR_EXIT, "debugging: invalid negative counter");
3930 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3931 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3933 #if DEBUG_TIME_IN_MICROSECONDS
3934 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3937 counter[counter_nr][0] = Counter_Microseconds();
3939 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3942 counter[counter_nr][0] = Counter();
3945 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3946 counter[counter_nr][1] = counter[counter_nr][0];
3949 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3950 debug_print_timestamp_get_padding(counter_nr * indent_size),
3952 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3953 timestamp_interval / 1000,
3957 void debug_print_parent_only(char *format, ...)
3959 if (!IS_PARENT_PROCESS())
3966 va_start(ap, format);
3967 vprintf(format, ap);
3976 void print_timestamp_ext(char *message, char *mode)
3978 #if DEBUG_PRINT_INIT_TIMESTAMPS
3979 static char *debug_message = NULL;
3980 static char *last_message = NULL;
3981 static int counter_nr = 0;
3982 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3984 checked_free(debug_message);
3985 debug_message = getStringCat3(mode, " ", message);
3987 if (strEqual(mode, "INIT"))
3989 debug_print_timestamp(counter_nr, NULL);
3991 if (counter_nr + 1 < max_depth)
3992 debug_print_timestamp(counter_nr, debug_message);
3996 debug_print_timestamp(counter_nr, NULL);
3998 else if (strEqual(mode, "DONE"))
4002 if (counter_nr + 1 < max_depth ||
4003 (counter_nr == 0 && max_depth == 1))
4005 last_message = message;
4007 if (counter_nr == 0 && max_depth == 1)
4009 checked_free(debug_message);
4010 debug_message = getStringCat3("TIME", " ", message);
4013 debug_print_timestamp(counter_nr, debug_message);
4016 else if (!strEqual(mode, "TIME") ||
4017 !strEqual(message, last_message))
4019 if (counter_nr < max_depth)
4020 debug_print_timestamp(counter_nr, debug_message);
4025 void print_timestamp_init(char *message)
4027 print_timestamp_ext(message, "INIT");
4030 void print_timestamp_time(char *message)
4032 print_timestamp_ext(message, "TIME");
4035 void print_timestamp_done(char *message)
4037 print_timestamp_ext(message, "DONE");