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);
574 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
575 if (login_name == NULL)
579 if ((pwd = getpwuid(getuid())) == NULL)
580 login_name = ANONYMOUS_NAME;
582 login_name = getStringCopy(pwd->pw_name);
585 login_name = ANONYMOUS_NAME;
593 static char *real_name = NULL;
595 #if defined(PLATFORM_WIN32)
596 if (real_name == NULL)
598 static char buffer[MAX_USERNAME_LEN + 1];
599 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
601 if (GetUserName(buffer, &buffer_size) != 0)
602 real_name = get_corrected_real_name(buffer);
604 real_name = ANONYMOUS_NAME;
606 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
607 if (real_name == NULL)
611 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
612 real_name = get_corrected_real_name(pwd->pw_gecos);
614 real_name = ANONYMOUS_NAME;
617 real_name = ANONYMOUS_NAME;
623 time_t getFileTimestampEpochSeconds(char *filename)
625 struct stat file_status;
627 if (stat(filename, &file_status) != 0) /* cannot stat file */
630 return file_status.st_mtime;
634 /* ------------------------------------------------------------------------- */
635 /* path manipulation functions */
636 /* ------------------------------------------------------------------------- */
638 static char *getLastPathSeparatorPtr(char *filename)
640 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
642 if (last_separator == NULL) /* also try DOS/Windows variant */
643 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
645 return last_separator;
648 char *getBaseNamePtr(char *filename)
650 char *last_separator = getLastPathSeparatorPtr(filename);
652 if (last_separator != NULL)
653 return last_separator + 1; /* separator found: strip base path */
655 return filename; /* no separator found: filename has no path */
658 char *getBaseName(char *filename)
660 return getStringCopy(getBaseNamePtr(filename));
663 char *getBaseNameNoSuffix(char *filename)
665 char *basename = getStringCopy(getBaseNamePtr(filename));
667 // remove trailing suffix (separated by dot or hyphen)
668 if (basename[0] != '.' && basename[0] != '-')
670 if (strchr(basename, '.') != NULL)
671 *strchr(basename, '.') = '\0';
673 if (strchr(basename, '-') != NULL)
674 *strchr(basename, '-') = '\0';
680 char *getBasePath(char *filename)
682 char *basepath = getStringCopy(filename);
683 char *last_separator = getLastPathSeparatorPtr(basepath);
685 /* if no separator was found, use current directory */
686 if (last_separator == NULL)
690 return getStringCopy(".");
693 /* separator found: strip basename */
694 *last_separator = '\0';
700 /* ------------------------------------------------------------------------- */
701 /* various string functions */
702 /* ------------------------------------------------------------------------- */
704 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
706 if (s1 == NULL || s2 == NULL || sep == NULL)
709 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
712 sprintf(complete_string, "%s%s%s", s1, sep, s2);
714 return complete_string;
717 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
719 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
722 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
723 strlen(s2) + strlen(sep) +
726 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
728 return complete_string;
731 char *getStringCat2(char *s1, char *s2)
733 return getStringCat2WithSeparator(s1, s2, "");
736 char *getStringCat3(char *s1, char *s2, char *s3)
738 return getStringCat3WithSeparator(s1, s2, s3, "");
741 char *getPath2(char *path1, char *path2)
743 #if defined(PLATFORM_ANDROID)
744 // workaround for reading from assets directory -- skip "." subdirs in path
745 if (strEqual(path1, "."))
746 return getStringCopy(path2);
747 else if (strEqual(path2, "."))
748 return getStringCopy(path1);
751 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
754 char *getPath3(char *path1, char *path2, char *path3)
756 #if defined(PLATFORM_ANDROID)
757 // workaround for reading from assets directory -- skip "." subdirs in path
758 if (strEqual(path1, "."))
759 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
760 else if (strEqual(path2, "."))
761 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
762 else if (strEqual(path3, "."))
763 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
766 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
769 static char *getPngOrPcxIfNotExists(char *filename)
771 // switch from PNG to PCX file and vice versa, if file does not exist
772 // (backwards compatibility with PCX files used in previous versions)
774 if (!fileExists(filename) && strSuffix(filename, ".png"))
775 strcpy(&filename[strlen(filename) - 3], "pcx");
776 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
777 strcpy(&filename[strlen(filename) - 3], "png");
782 char *getImg2(char *path1, char *path2)
784 return getPngOrPcxIfNotExists(getPath2(path1, path2));
787 char *getImg3(char *path1, char *path2, char *path3)
789 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
792 char *getStringCopy(const char *s)
799 s_copy = checked_malloc(strlen(s) + 1);
805 char *getStringCopyN(const char *s, int n)
808 int s_len = MAX(0, n);
813 s_copy = checked_malloc(s_len + 1);
814 strncpy(s_copy, s, s_len);
815 s_copy[s_len] = '\0';
820 char *getStringCopyNStatic(const char *s, int n)
822 static char *s_copy = NULL;
824 checked_free(s_copy);
826 s_copy = getStringCopyN(s, n);
831 char *getStringToLower(const char *s)
833 char *s_copy = checked_malloc(strlen(s) + 1);
834 char *s_ptr = s_copy;
837 *s_ptr++ = tolower(*s++);
843 void setString(char **old_value, char *new_value)
845 checked_free(*old_value);
847 *old_value = getStringCopy(new_value);
850 boolean strEqual(char *s1, char *s2)
852 return (s1 == NULL && s2 == NULL ? TRUE :
853 s1 == NULL && s2 != NULL ? FALSE :
854 s1 != NULL && s2 == NULL ? FALSE :
855 strcmp(s1, s2) == 0);
858 boolean strEqualN(char *s1, char *s2, int n)
860 return (s1 == NULL && s2 == NULL ? TRUE :
861 s1 == NULL && s2 != NULL ? FALSE :
862 s1 != NULL && s2 == NULL ? FALSE :
863 strncmp(s1, s2, n) == 0);
866 boolean strPrefix(char *s, char *prefix)
868 return (s == NULL && prefix == NULL ? TRUE :
869 s == NULL && prefix != NULL ? FALSE :
870 s != NULL && prefix == NULL ? FALSE :
871 strncmp(s, prefix, strlen(prefix)) == 0);
874 boolean strSuffix(char *s, char *suffix)
876 return (s == NULL && suffix == NULL ? TRUE :
877 s == NULL && suffix != NULL ? FALSE :
878 s != NULL && suffix == NULL ? FALSE :
879 strlen(s) < strlen(suffix) ? FALSE :
880 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
883 boolean strPrefixLower(char *s, char *prefix)
885 char *s_lower = getStringToLower(s);
886 boolean match = strPrefix(s_lower, prefix);
893 boolean strSuffixLower(char *s, char *suffix)
895 char *s_lower = getStringToLower(s);
896 boolean match = strSuffix(s_lower, suffix);
904 /* ------------------------------------------------------------------------- */
905 /* command line option handling functions */
906 /* ------------------------------------------------------------------------- */
908 void GetOptions(int argc, char *argv[],
909 void (*print_usage_function)(void),
910 void (*print_version_function)(void))
912 char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
913 char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
914 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
915 char **options_left = &argvplus[1];
917 /* replace original "argv" with null-terminated array of string pointers */
919 argvplus[argc] = argv[argc];
921 /* initialize global program options */
922 options.server_host = NULL;
923 options.server_port = 0;
925 options.ro_base_directory = ro_base_path;
926 options.rw_base_directory = rw_base_path;
927 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
928 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
929 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
930 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
931 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
932 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
934 options.execute_command = NULL;
935 options.special_flags = NULL;
937 options.mytapes = FALSE;
938 options.serveronly = FALSE;
939 options.network = FALSE;
940 options.verbose = FALSE;
941 options.debug = FALSE;
944 options.verbose = TRUE;
946 #if !defined(PLATFORM_UNIX)
947 if (*options_left == NULL) /* no options given -- enable verbose mode */
948 options.verbose = TRUE;
953 #if defined(PLATFORM_ANDROID)
954 options.debug = TRUE;
958 while (*options_left)
960 char option_str[MAX_OPTION_LEN];
961 char *option = options_left[0];
962 char *next_option = options_left[1];
963 char *option_arg = NULL;
964 int option_len = strlen(option);
966 if (option_len >= MAX_OPTION_LEN)
967 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
969 strcpy(option_str, option); /* copy argument into buffer */
972 if (strEqual(option, "--")) /* stop scanning arguments */
975 if (strPrefix(option, "--")) /* treat '--' like '-' */
978 option_arg = strchr(option, '=');
979 if (option_arg == NULL) /* no '=' in option */
980 option_arg = next_option;
983 *option_arg++ = '\0'; /* cut argument from option */
984 if (*option_arg == '\0') /* no argument after '=' */
985 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
988 option_len = strlen(option);
990 if (strEqual(option, "-"))
992 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
994 else if (strncmp(option, "-help", option_len) == 0)
996 print_usage_function();
1000 else if (strncmp(option, "-basepath", option_len) == 0)
1002 if (option_arg == NULL)
1003 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1005 /* this should be extended to separate options for ro and rw data */
1006 options.ro_base_directory = ro_base_path = option_arg;
1007 options.rw_base_directory = rw_base_path = option_arg;
1008 if (option_arg == next_option)
1011 /* adjust paths for sub-directories in base directory accordingly */
1012 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1013 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1014 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1015 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1016 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1017 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1019 else if (strncmp(option, "-levels", option_len) == 0)
1021 if (option_arg == NULL)
1022 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1024 options.level_directory = option_arg;
1025 if (option_arg == next_option)
1028 else if (strncmp(option, "-graphics", option_len) == 0)
1030 if (option_arg == NULL)
1031 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1033 options.graphics_directory = option_arg;
1034 if (option_arg == next_option)
1037 else if (strncmp(option, "-sounds", option_len) == 0)
1039 if (option_arg == NULL)
1040 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1042 options.sounds_directory = option_arg;
1043 if (option_arg == next_option)
1046 else if (strncmp(option, "-music", option_len) == 0)
1048 if (option_arg == NULL)
1049 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1051 options.music_directory = option_arg;
1052 if (option_arg == next_option)
1055 else if (strncmp(option, "-mytapes", option_len) == 0)
1057 options.mytapes = TRUE;
1059 else if (strncmp(option, "-network", option_len) == 0)
1061 options.network = TRUE;
1063 else if (strncmp(option, "-serveronly", option_len) == 0)
1065 options.serveronly = TRUE;
1067 else if (strncmp(option, "-debug", option_len) == 0)
1069 options.debug = TRUE;
1071 else if (strncmp(option, "-verbose", option_len) == 0)
1073 options.verbose = TRUE;
1075 else if (strncmp(option, "-version", option_len) == 0 ||
1076 strncmp(option, "-V", option_len) == 0)
1078 print_version_function();
1082 else if (strPrefix(option, "-D"))
1084 options.special_flags = getStringCopy(&option[2]);
1086 else if (strncmp(option, "-execute", option_len) == 0)
1088 if (option_arg == NULL)
1089 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1091 options.execute_command = option_arg;
1092 if (option_arg == next_option)
1095 /* when doing batch processing, always enable verbose mode (warnings) */
1096 options.verbose = TRUE;
1098 #if defined(PLATFORM_MACOSX)
1099 else if (strPrefix(option, "-psn"))
1101 /* ignore process serial number when launched via GUI on Mac OS X */
1104 else if (*option == '-')
1106 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1108 else if (options.server_host == NULL)
1110 options.server_host = *options_left;
1112 else if (options.server_port == 0)
1114 options.server_port = atoi(*options_left);
1115 if (options.server_port < 1024)
1116 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1119 Error(ERR_EXIT_HELP, "too many arguments");
1126 /* ------------------------------------------------------------------------- */
1127 /* error handling functions */
1128 /* ------------------------------------------------------------------------- */
1130 #define MAX_INTERNAL_ERROR_SIZE 1024
1132 /* used by SetError() and GetError() to store internal error messages */
1133 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1135 void SetError(char *format, ...)
1139 va_start(ap, format);
1140 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1146 return internal_error;
1149 void Error(int mode, char *format, ...)
1151 static boolean last_line_was_separator = FALSE;
1152 char *process_name = "";
1154 if (program.log_file[LOG_ERR_ID] == NULL)
1157 #if defined(PLATFORM_ANDROID)
1158 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1159 mode & ERR_INFO ? ANDROID_LOG_INFO :
1160 mode & ERR_WARN ? ANDROID_LOG_WARN :
1161 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1162 ANDROID_LOG_UNKNOWN);
1165 /* display debug messages only when running in debug mode */
1166 if (mode & ERR_DEBUG && !options.debug)
1169 /* display warnings only when running in verbose mode */
1170 if (mode & ERR_WARN && !options.verbose)
1173 if (mode == ERR_INFO_LINE)
1175 if (!last_line_was_separator)
1176 printf_log_line(format, 79);
1178 last_line_was_separator = TRUE;
1183 last_line_was_separator = FALSE;
1185 if (mode & ERR_SOUND_SERVER)
1186 process_name = " sound server";
1187 else if (mode & ERR_NETWORK_SERVER)
1188 process_name = " network server";
1189 else if (mode & ERR_NETWORK_CLIENT)
1190 process_name = " network client **";
1194 #if !defined(PLATFORM_ANDROID)
1195 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1198 if (mode & ERR_WARN)
1199 printf_log_nonewline("warning: ");
1201 if (mode & ERR_EXIT)
1202 printf_log_nonewline("fatal error: ");
1206 va_start(ap, format);
1207 vprintf_log(format, ap);
1210 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1212 va_start(ap, format);
1213 program.exit_message_function(format, ap);
1218 if (mode & ERR_HELP)
1219 printf_log("%s: Try option '--help' for more information.",
1220 program.command_basename);
1222 if (mode & ERR_EXIT)
1223 printf_log("%s%s: aborting", program.command_basename, process_name);
1225 if (mode & ERR_EXIT)
1227 if (mode & ERR_FROM_SERVER)
1228 exit(1); /* child process: normal exit */
1230 program.exit_function(1); /* main process: clean up stuff */
1235 /* ------------------------------------------------------------------------- */
1236 /* checked memory allocation and freeing functions */
1237 /* ------------------------------------------------------------------------- */
1239 void *checked_malloc(unsigned int size)
1246 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1251 void *checked_calloc(unsigned int size)
1255 ptr = calloc(1, size);
1258 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1263 void *checked_realloc(void *ptr, unsigned int size)
1265 ptr = realloc(ptr, size);
1268 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1273 void checked_free(void *ptr)
1275 if (ptr != NULL) /* this check should be done by free() anyway */
1279 void clear_mem(void *ptr, unsigned int size)
1281 #if defined(PLATFORM_WIN32)
1282 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1283 char *cptr = (char *)ptr;
1288 memset(ptr, 0, size);
1293 /* ------------------------------------------------------------------------- */
1294 /* various helper functions */
1295 /* ------------------------------------------------------------------------- */
1297 void swap_numbers(int *i1, int *i2)
1305 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1317 /* the "put" variants of the following file access functions check for the file
1318 pointer being != NULL and return the number of bytes they have or would have
1319 written; this allows for chunk writing functions to first determine the size
1320 of the (not yet written) chunk, write the correct chunk size and finally
1321 write the chunk itself */
1323 int getFile8BitInteger(File *file)
1325 return getByteFromFile(file);
1328 int putFile8BitInteger(FILE *file, int value)
1336 int getFile16BitInteger(File *file, int byte_order)
1338 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1339 return ((getByteFromFile(file) << 8) |
1340 (getByteFromFile(file) << 0));
1341 else /* BYTE_ORDER_LITTLE_ENDIAN */
1342 return ((getByteFromFile(file) << 0) |
1343 (getByteFromFile(file) << 8));
1346 int putFile16BitInteger(FILE *file, int value, int byte_order)
1350 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1352 fputc((value >> 8) & 0xff, file);
1353 fputc((value >> 0) & 0xff, file);
1355 else /* BYTE_ORDER_LITTLE_ENDIAN */
1357 fputc((value >> 0) & 0xff, file);
1358 fputc((value >> 8) & 0xff, file);
1365 int getFile32BitInteger(File *file, int byte_order)
1367 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1368 return ((getByteFromFile(file) << 24) |
1369 (getByteFromFile(file) << 16) |
1370 (getByteFromFile(file) << 8) |
1371 (getByteFromFile(file) << 0));
1372 else /* BYTE_ORDER_LITTLE_ENDIAN */
1373 return ((getByteFromFile(file) << 0) |
1374 (getByteFromFile(file) << 8) |
1375 (getByteFromFile(file) << 16) |
1376 (getByteFromFile(file) << 24));
1379 int putFile32BitInteger(FILE *file, int value, int byte_order)
1383 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1385 fputc((value >> 24) & 0xff, file);
1386 fputc((value >> 16) & 0xff, file);
1387 fputc((value >> 8) & 0xff, file);
1388 fputc((value >> 0) & 0xff, file);
1390 else /* BYTE_ORDER_LITTLE_ENDIAN */
1392 fputc((value >> 0) & 0xff, file);
1393 fputc((value >> 8) & 0xff, file);
1394 fputc((value >> 16) & 0xff, file);
1395 fputc((value >> 24) & 0xff, file);
1402 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1405 const int chunk_name_length = 4;
1407 /* read chunk name */
1408 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1411 if (chunk_size != NULL)
1413 /* read chunk size */
1414 *chunk_size = getFile32BitInteger(file, byte_order);
1417 return (checkEndOfFile(file) ? FALSE : TRUE);
1420 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1425 /* write chunk name */
1427 fputs(chunk_name, file);
1429 num_bytes += strlen(chunk_name);
1431 if (chunk_size >= 0)
1433 /* write chunk size */
1435 putFile32BitInteger(file, chunk_size, byte_order);
1443 int getFileVersion(File *file)
1445 int version_super = getByteFromFile(file);
1446 int version_major = getByteFromFile(file);
1447 int version_minor = getByteFromFile(file);
1448 int version_patch = getByteFromFile(file);
1450 return VERSION_IDENT(version_super, version_major, version_minor,
1454 int putFileVersion(FILE *file, int version)
1458 int version_super = VERSION_SUPER(version);
1459 int version_major = VERSION_MAJOR(version);
1460 int version_minor = VERSION_MINOR(version);
1461 int version_patch = VERSION_PATCH(version);
1463 fputc(version_super, file);
1464 fputc(version_major, file);
1465 fputc(version_minor, file);
1466 fputc(version_patch, file);
1472 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1476 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1477 buffer[i] = getByteFromFile(file);
1480 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1484 for(i = 0; i < bytes; i++)
1485 fputc(buffer[i], file);
1488 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1490 while (bytes-- && !checkEndOfFile(file))
1491 getByteFromFile(file);
1494 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1501 /* ------------------------------------------------------------------------- */
1502 /* functions to translate key identifiers between different format */
1503 /* ------------------------------------------------------------------------- */
1505 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1506 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1507 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1508 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1510 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1519 /* return and escape keys */
1520 { KSYM_Return, "XK_Return", "return" },
1521 { KSYM_Escape, "XK_Escape", "escape" },
1523 /* normal cursor keys */
1524 { KSYM_Left, "XK_Left", "cursor left" },
1525 { KSYM_Right, "XK_Right", "cursor right" },
1526 { KSYM_Up, "XK_Up", "cursor up" },
1527 { KSYM_Down, "XK_Down", "cursor down" },
1529 /* keypad cursor keys */
1531 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1532 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1533 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1534 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1537 /* other keypad keys */
1538 #ifdef KSYM_KP_Enter
1539 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1540 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1541 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1542 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1543 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1544 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1548 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1549 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1550 { KSYM_Control_L, "XK_Control_L", "left control" },
1551 { KSYM_Control_R, "XK_Control_R", "right control" },
1552 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1553 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1554 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1555 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1556 #if !defined(TARGET_SDL2)
1557 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1558 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1560 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1561 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1563 /* some special keys */
1564 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1565 { KSYM_Delete, "XK_Delete", "delete" },
1566 { KSYM_Insert, "XK_Insert", "insert" },
1567 { KSYM_Tab, "XK_Tab", "tab" },
1568 { KSYM_Home, "XK_Home", "home" },
1569 { KSYM_End, "XK_End", "end" },
1570 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1571 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1573 #if defined(TARGET_SDL2)
1574 { KSYM_Select, "XK_Select", "select" },
1575 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1576 { KSYM_Back, "XK_Back", "back" }, /* back key */
1577 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1578 #if defined(PLATFORM_ANDROID)
1579 { KSYM_Rewind, "XK_Rewind", "rewind" },
1580 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1584 /* ASCII 0x20 to 0x40 keys (except numbers) */
1585 { KSYM_space, "XK_space", "space" },
1586 { KSYM_exclam, "XK_exclam", "!" },
1587 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1588 { KSYM_numbersign, "XK_numbersign", "#" },
1589 { KSYM_dollar, "XK_dollar", "$" },
1590 { KSYM_percent, "XK_percent", "%" },
1591 { KSYM_ampersand, "XK_ampersand", "&" },
1592 { KSYM_apostrophe, "XK_apostrophe", "'" },
1593 { KSYM_parenleft, "XK_parenleft", "(" },
1594 { KSYM_parenright, "XK_parenright", ")" },
1595 { KSYM_asterisk, "XK_asterisk", "*" },
1596 { KSYM_plus, "XK_plus", "+" },
1597 { KSYM_comma, "XK_comma", "," },
1598 { KSYM_minus, "XK_minus", "-" },
1599 { KSYM_period, "XK_period", "." },
1600 { KSYM_slash, "XK_slash", "/" },
1601 { KSYM_colon, "XK_colon", ":" },
1602 { KSYM_semicolon, "XK_semicolon", ";" },
1603 { KSYM_less, "XK_less", "<" },
1604 { KSYM_equal, "XK_equal", "=" },
1605 { KSYM_greater, "XK_greater", ">" },
1606 { KSYM_question, "XK_question", "?" },
1607 { KSYM_at, "XK_at", "@" },
1609 /* more ASCII keys */
1610 { KSYM_bracketleft, "XK_bracketleft", "[" },
1611 { KSYM_backslash, "XK_backslash", "\\" },
1612 { KSYM_bracketright,"XK_bracketright", "]" },
1613 { KSYM_asciicircum, "XK_asciicircum", "^" },
1614 { KSYM_underscore, "XK_underscore", "_" },
1615 { KSYM_grave, "XK_grave", "grave" },
1616 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1617 { KSYM_braceleft, "XK_braceleft", "brace left" },
1618 { KSYM_bar, "XK_bar", "bar" },
1619 { KSYM_braceright, "XK_braceright", "brace right" },
1620 { KSYM_asciitilde, "XK_asciitilde", "~" },
1622 /* special (non-ASCII) keys */
1623 { KSYM_degree, "XK_degree", "degree" },
1624 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1625 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1626 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1627 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1628 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1629 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1630 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1632 #if defined(TARGET_SDL2)
1633 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1634 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1635 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1636 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1637 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1638 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1639 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1640 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1641 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1643 /* other keys (for reverse mapping only) */
1644 { KSYM_space, "XK_space", " " },
1647 #if defined(TARGET_SDL2)
1648 /* keypad keys are not in numerical order in SDL2 */
1649 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1650 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1651 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1652 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1653 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1654 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1655 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1656 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1657 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1658 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1661 /* end-of-array identifier */
1667 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1669 static char name_buffer[30];
1672 if (key >= KSYM_A && key <= KSYM_Z)
1673 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1674 else if (key >= KSYM_a && key <= KSYM_z)
1675 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1676 else if (key >= KSYM_0 && key <= KSYM_9)
1677 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1678 #if !defined(TARGET_SDL2)
1679 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1680 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1682 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1683 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1684 else if (key == KSYM_UNDEFINED)
1685 strcpy(name_buffer, "(undefined)");
1692 if (key == translate_key[i].key)
1694 strcpy(name_buffer, translate_key[i].name);
1698 while (translate_key[++i].name);
1700 if (!translate_key[i].name)
1701 strcpy(name_buffer, "(unknown)");
1704 *name = name_buffer;
1706 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1708 static char name_buffer[30];
1711 if (key >= KSYM_A && key <= KSYM_Z)
1712 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1713 else if (key >= KSYM_a && key <= KSYM_z)
1714 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1715 else if (key >= KSYM_0 && key <= KSYM_9)
1716 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1717 #if !defined(TARGET_SDL2)
1718 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1719 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1721 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1722 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1723 else if (key == KSYM_UNDEFINED)
1724 strcpy(name_buffer, "[undefined]");
1731 if (key == translate_key[i].key)
1733 strcpy(name_buffer, translate_key[i].x11name);
1737 while (translate_key[++i].x11name);
1739 if (!translate_key[i].x11name)
1740 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1743 *x11name = name_buffer;
1745 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1747 Key key = KSYM_UNDEFINED;
1748 char *name_ptr = *name;
1750 if (strlen(*name) == 1)
1752 char c = name_ptr[0];
1754 if (c >= 'A' && c <= 'Z')
1755 key = KSYM_A + (Key)(c - 'A');
1756 else if (c >= 'a' && c <= 'z')
1757 key = KSYM_a + (Key)(c - 'a');
1758 else if (c >= '0' && c <= '9')
1759 key = KSYM_0 + (Key)(c - '0');
1762 if (key == KSYM_UNDEFINED)
1768 if (strEqual(translate_key[i].name, *name))
1770 key = translate_key[i].key;
1774 while (translate_key[++i].x11name);
1777 if (key == KSYM_UNDEFINED)
1778 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1782 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1784 Key key = KSYM_UNDEFINED;
1785 char *name_ptr = *x11name;
1787 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1789 char c = name_ptr[3];
1791 if (c >= 'A' && c <= 'Z')
1792 key = KSYM_A + (Key)(c - 'A');
1793 else if (c >= 'a' && c <= 'z')
1794 key = KSYM_a + (Key)(c - 'a');
1795 else if (c >= '0' && c <= '9')
1796 key = KSYM_0 + (Key)(c - '0');
1798 #if !defined(TARGET_SDL2)
1799 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1801 char c = name_ptr[6];
1803 if (c >= '0' && c <= '9')
1804 key = KSYM_KP_0 + (Key)(c - '0');
1807 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1809 char c1 = name_ptr[4];
1810 char c2 = name_ptr[5];
1813 if ((c1 >= '0' && c1 <= '9') &&
1814 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1815 d = atoi(&name_ptr[4]);
1817 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1818 key = KSYM_F1 + (Key)(d - 1);
1820 else if (strPrefix(name_ptr, "XK_"))
1826 if (strEqual(name_ptr, translate_key[i].x11name))
1828 key = translate_key[i].key;
1832 while (translate_key[++i].x11name);
1834 else if (strPrefix(name_ptr, "0x"))
1836 unsigned int value = 0;
1842 char c = *name_ptr++;
1845 if (c >= '0' && c <= '9')
1847 else if (c >= 'a' && c <= 'f')
1848 d = (int)(c - 'a' + 10);
1849 else if (c >= 'A' && c <= 'F')
1850 d = (int)(c - 'A' + 10);
1858 value = value * 16 + d;
1869 char *getKeyNameFromKey(Key key)
1873 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1877 char *getX11KeyNameFromKey(Key key)
1881 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1885 Key getKeyFromKeyName(char *name)
1889 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1893 Key getKeyFromX11KeyName(char *x11name)
1897 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1901 char getCharFromKey(Key key)
1907 } translate_key_char[] =
1909 /* special (non-ASCII) keys (ISO-8859-1) */
1910 { KSYM_degree, CHAR_BYTE_DEGREE },
1911 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1912 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1913 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1914 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1915 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1916 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1917 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1919 /* end-of-array identifier */
1923 char *keyname = getKeyNameFromKey(key);
1926 if (strlen(keyname) == 1)
1928 else if (strEqual(keyname, "space"))
1936 if (key == translate_key_char[i].key)
1938 c = translate_key_char[i].key_char;
1943 while (translate_key_char[++i].key_char);
1949 char getValidConfigValueChar(char c)
1951 if (c == '#' || /* used to mark comments */
1952 c == '\\') /* used to mark continued lines */
1959 /* ------------------------------------------------------------------------- */
1960 /* functions to translate string identifiers to integer or boolean value */
1961 /* ------------------------------------------------------------------------- */
1963 int get_integer_from_string(char *s)
1965 static char *number_text[][3] =
1967 { "0", "zero", "null", },
1968 { "1", "one", "first" },
1969 { "2", "two", "second" },
1970 { "3", "three", "third" },
1971 { "4", "four", "fourth" },
1972 { "5", "five", "fifth" },
1973 { "6", "six", "sixth" },
1974 { "7", "seven", "seventh" },
1975 { "8", "eight", "eighth" },
1976 { "9", "nine", "ninth" },
1977 { "10", "ten", "tenth" },
1978 { "11", "eleven", "eleventh" },
1979 { "12", "twelve", "twelfth" },
1981 { NULL, NULL, NULL },
1985 char *s_lower = getStringToLower(s);
1988 for (i = 0; number_text[i][0] != NULL; i++)
1989 for (j = 0; j < 3; j++)
1990 if (strEqual(s_lower, number_text[i][j]))
1995 if (strEqual(s_lower, "false") ||
1996 strEqual(s_lower, "no") ||
1997 strEqual(s_lower, "off"))
1999 else if (strEqual(s_lower, "true") ||
2000 strEqual(s_lower, "yes") ||
2001 strEqual(s_lower, "on"))
2012 boolean get_boolean_from_string(char *s)
2014 char *s_lower = getStringToLower(s);
2015 boolean result = FALSE;
2017 if (strEqual(s_lower, "true") ||
2018 strEqual(s_lower, "yes") ||
2019 strEqual(s_lower, "on") ||
2020 get_integer_from_string(s) == 1)
2028 int get_switch3_from_string(char *s)
2030 char *s_lower = getStringToLower(s);
2033 if (strEqual(s_lower, "true") ||
2034 strEqual(s_lower, "yes") ||
2035 strEqual(s_lower, "on") ||
2036 get_integer_from_string(s) == 1)
2038 else if (strEqual(s_lower, "auto"))
2047 /* ------------------------------------------------------------------------- */
2048 /* functions for generic lists */
2049 /* ------------------------------------------------------------------------- */
2051 ListNode *newListNode()
2053 return checked_calloc(sizeof(ListNode));
2056 void addNodeToList(ListNode **node_first, char *key, void *content)
2058 ListNode *node_new = newListNode();
2060 node_new->key = getStringCopy(key);
2061 node_new->content = content;
2062 node_new->next = *node_first;
2065 (*node_first)->prev = node_new;
2067 *node_first = node_new;
2070 void deleteNodeFromList(ListNode **node_first, char *key,
2071 void (*destructor_function)(void *))
2073 if (node_first == NULL || *node_first == NULL)
2076 if (strEqual((*node_first)->key, key))
2078 // after first recursion, (*node_first)->prev->next == *node_first,
2079 // so *node_first would be overwritten with (*node_first)->next
2080 // => use a copy of *node_first (and later of (*node_first)->next)
2081 ListNode *node = *node_first;
2082 ListNode *node_next = node->next;
2084 checked_free(node->key);
2086 if (destructor_function)
2087 destructor_function(node->content);
2090 node->prev->next = node->next;
2093 node->next->prev = node->prev;
2097 // after removing node, set list pointer to next valid list node
2098 // (this is important if the first node of the list was deleted)
2099 *node_first = node_next;
2103 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2107 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2109 if (node_first == NULL)
2112 if (strEqual(node_first->key, key))
2115 return getNodeFromKey(node_first->next, key);
2118 int getNumNodes(ListNode *node_first)
2120 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2123 void dumpList(ListNode *node_first)
2125 ListNode *node = node_first;
2129 printf("['%s' (%d)]\n", node->key,
2130 ((struct ListNodeInfo *)node->content)->num_references);
2134 printf("[%d nodes]\n", getNumNodes(node_first));
2138 /* ------------------------------------------------------------------------- */
2139 /* functions for file handling */
2140 /* ------------------------------------------------------------------------- */
2142 #define MAX_BUFFER_SIZE 4096
2144 File *openFile(char *filename, char *mode)
2146 File *file = checked_calloc(sizeof(File));
2148 file->file = fopen(filename, mode);
2150 if (file->file != NULL)
2152 file->filename = getStringCopy(filename);
2157 #if defined(PLATFORM_ANDROID)
2158 file->asset_file = SDL_RWFromFile(filename, mode);
2160 if (file->asset_file != NULL)
2162 file->file_is_asset = TRUE;
2163 file->filename = getStringCopy(filename);
2174 int closeFile(File *file)
2181 #if defined(PLATFORM_ANDROID)
2182 if (file->asset_file)
2183 result = SDL_RWclose(file->asset_file);
2187 result = fclose(file->file);
2189 checked_free(file->filename);
2195 int checkEndOfFile(File *file)
2197 #if defined(PLATFORM_ANDROID)
2198 if (file->file_is_asset)
2199 return file->end_of_file;
2202 return feof(file->file);
2205 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2207 #if defined(PLATFORM_ANDROID)
2208 if (file->file_is_asset)
2210 if (file->end_of_file)
2213 size_t num_items_read =
2214 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2216 if (num_items_read < num_items)
2217 file->end_of_file = TRUE;
2219 return num_items_read;
2223 return fread(buffer, item_size, num_items, file->file);
2226 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2228 return fwrite(buffer, item_size, num_items, file->file);
2231 int seekFile(File *file, long offset, int whence)
2233 #if defined(PLATFORM_ANDROID)
2234 if (file->file_is_asset)
2236 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2237 whence == SEEK_CUR ? RW_SEEK_CUR :
2238 whence == SEEK_END ? RW_SEEK_END : 0);
2240 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2244 return fseek(file->file, offset, whence);
2247 int getByteFromFile(File *file)
2249 #if defined(PLATFORM_ANDROID)
2250 if (file->file_is_asset)
2252 if (file->end_of_file)
2256 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2258 if (num_bytes_read < 1)
2259 file->end_of_file = TRUE;
2261 return (file->end_of_file ? EOF : (int)c);
2265 return fgetc(file->file);
2268 char *getStringFromFile(File *file, char *line, int size)
2270 #if defined(PLATFORM_ANDROID)
2271 if (file->file_is_asset)
2273 if (file->end_of_file)
2276 char *line_ptr = line;
2277 int num_bytes_read = 0;
2279 while (num_bytes_read < size - 1 &&
2280 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2281 *line_ptr++ != '\n')
2286 if (strlen(line) == 0)
2288 file->end_of_file = TRUE;
2297 return fgets(line, size, file->file);
2300 int copyFile(char *filename_from, char *filename_to)
2302 File *file_from, *file_to;
2304 if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2309 if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2311 closeFile(file_from);
2316 while (!checkEndOfFile(file_from))
2318 byte buffer[MAX_BUFFER_SIZE];
2319 size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2321 writeFile(file_to, buffer, 1, bytes_read);
2324 closeFile(file_from);
2331 /* ------------------------------------------------------------------------- */
2332 /* functions for directory handling */
2333 /* ------------------------------------------------------------------------- */
2335 Directory *openDirectory(char *dir_name)
2337 Directory *dir = checked_calloc(sizeof(Directory));
2339 dir->dir = opendir(dir_name);
2341 if (dir->dir != NULL)
2343 dir->filename = getStringCopy(dir_name);
2348 #if defined(PLATFORM_ANDROID)
2349 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2351 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2353 checked_free(asset_toc_filename);
2355 if (dir->asset_toc_file != NULL)
2357 dir->directory_is_asset = TRUE;
2358 dir->filename = getStringCopy(dir_name);
2369 int closeDirectory(Directory *dir)
2376 #if defined(PLATFORM_ANDROID)
2377 if (dir->asset_toc_file)
2378 result = SDL_RWclose(dir->asset_toc_file);
2382 result = closedir(dir->dir);
2385 freeDirectoryEntry(dir->dir_entry);
2387 checked_free(dir->filename);
2393 DirectoryEntry *readDirectory(Directory *dir)
2396 freeDirectoryEntry(dir->dir_entry);
2398 dir->dir_entry = NULL;
2400 #if defined(PLATFORM_ANDROID)
2401 if (dir->directory_is_asset)
2403 char line[MAX_LINE_LEN];
2404 char *line_ptr = line;
2405 int num_bytes_read = 0;
2407 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2408 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2417 if (strlen(line) == 0)
2420 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2422 dir->dir_entry->is_directory = FALSE;
2423 if (line[strlen(line) - 1] == '/')
2425 dir->dir_entry->is_directory = TRUE;
2427 line[strlen(line) - 1] = '\0';
2430 dir->dir_entry->basename = getStringCopy(line);
2431 dir->dir_entry->filename = getPath2(dir->filename, line);
2433 return dir->dir_entry;
2437 struct dirent *dir_entry = readdir(dir->dir);
2439 if (dir_entry == NULL)
2442 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2444 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2445 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2447 struct stat file_status;
2449 dir->dir_entry->is_directory =
2450 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2451 S_ISDIR(file_status.st_mode));
2453 return dir->dir_entry;
2456 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2458 if (dir_entry == NULL)
2461 checked_free(dir_entry->basename);
2462 checked_free(dir_entry->filename);
2463 checked_free(dir_entry);
2467 /* ------------------------------------------------------------------------- */
2468 /* functions for checking files and filenames */
2469 /* ------------------------------------------------------------------------- */
2471 boolean directoryExists(char *dir_name)
2473 if (dir_name == NULL)
2476 struct stat file_status;
2477 boolean success = (stat(dir_name, &file_status) == 0 &&
2478 S_ISDIR(file_status.st_mode));
2480 #if defined(PLATFORM_ANDROID)
2483 // this might be an asset directory; check by trying to open toc file
2484 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2485 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2487 checked_free(asset_toc_filename);
2489 success = (file != NULL);
2499 boolean fileExists(char *filename)
2501 if (filename == NULL)
2504 boolean success = (access(filename, F_OK) == 0);
2506 #if defined(PLATFORM_ANDROID)
2509 // this might be an asset file; check by trying to open it
2510 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2512 success = (file != NULL);
2522 boolean fileHasPrefix(char *basename, char *prefix)
2524 static char *basename_lower = NULL;
2525 int basename_length, prefix_length;
2527 checked_free(basename_lower);
2529 if (basename == NULL || prefix == NULL)
2532 basename_lower = getStringToLower(basename);
2533 basename_length = strlen(basename_lower);
2534 prefix_length = strlen(prefix);
2536 if (basename_length > prefix_length + 1 &&
2537 basename_lower[prefix_length] == '.' &&
2538 strncmp(basename_lower, prefix, prefix_length) == 0)
2544 boolean fileHasSuffix(char *basename, char *suffix)
2546 static char *basename_lower = NULL;
2547 int basename_length, suffix_length;
2549 checked_free(basename_lower);
2551 if (basename == NULL || suffix == NULL)
2554 basename_lower = getStringToLower(basename);
2555 basename_length = strlen(basename_lower);
2556 suffix_length = strlen(suffix);
2558 if (basename_length > suffix_length + 1 &&
2559 basename_lower[basename_length - suffix_length - 1] == '.' &&
2560 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2566 static boolean FileCouldBeArtwork(char *filename)
2568 char *basename = getBaseNamePtr(filename);
2570 return (!strEqual(basename, ".") &&
2571 !strEqual(basename, "..") &&
2572 !fileHasSuffix(basename, "txt") &&
2573 !fileHasSuffix(basename, "conf") &&
2574 !directoryExists(filename));
2577 boolean FileIsGraphic(char *filename)
2579 return FileCouldBeArtwork(filename);
2582 boolean FileIsSound(char *filename)
2584 return FileCouldBeArtwork(filename);
2587 boolean FileIsMusic(char *filename)
2589 return FileCouldBeArtwork(filename);
2592 boolean FileIsArtworkType(char *filename, int type)
2594 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2595 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2596 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2602 /* ------------------------------------------------------------------------- */
2603 /* functions for loading artwork configuration information */
2604 /* ------------------------------------------------------------------------- */
2606 char *get_mapped_token(char *token)
2608 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2609 static char *map_token_prefix[][2] =
2611 { "char_procent", "char_percent" },
2616 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2618 int len_token_prefix = strlen(map_token_prefix[i][0]);
2620 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2621 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2624 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2625 char *gfx_substring = ".gfx";
2626 char *gfx_prefix = "gfx.";
2627 if (strstr(token, gfx_substring) != NULL)
2629 char *token_prefix = getStringCopy(token);
2630 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2631 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2634 // cut off token string at ".gfx" substring position
2635 *token_gfx_pos = '\0';
2637 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2638 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2642 return mapped_token;
2648 char *get_special_base_token(struct ArtworkListInfo *artwork_info, char *token)
2650 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2651 static struct ConfigTypeInfo prefix_list[] =
2653 { "global.anim_1" },
2654 { "global.anim_2" },
2655 { "global.anim_3" },
2656 { "global.anim_4" },
2657 { "global.anim_5" },
2658 { "global.anim_6" },
2659 { "global.anim_7" },
2660 { "global.anim_8" },
2661 { "global.anim_9" },
2662 { "global.anim_10" },
2663 { "global.anim_11" },
2664 { "global.anim_12" },
2665 { "global.anim_13" },
2666 { "global.anim_14" },
2667 { "global.anim_15" },
2668 { "global.anim_16" },
2669 { "global.anim_17" },
2670 { "global.anim_18" },
2671 { "global.anim_19" },
2672 { "global.anim_20" },
2673 { "global.anim_21" },
2674 { "global.anim_22" },
2675 { "global.anim_23" },
2676 { "global.anim_24" },
2677 { "global.anim_25" },
2678 { "global.anim_26" },
2679 { "global.anim_27" },
2680 { "global.anim_28" },
2681 { "global.anim_29" },
2682 { "global.anim_30" },
2683 { "global.anim_31" },
2684 { "global.anim_32" },
2688 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2689 boolean prefix_found = FALSE;
2693 /* search for prefix to check if base token has to be created */
2694 for (i = 0; prefix_list[i].token != NULL; i++)
2695 if (strPrefix(token, prefix_list[i].token))
2696 prefix_found = TRUE;
2701 /* search for suffix (parameter) to determine base token length */
2702 for (i = 0; suffix_list[i].token != NULL; i++)
2703 if (strSuffix(token, suffix_list[i].token))
2704 len_suffix = strlen(suffix_list[i].token);
2706 return getStringCopyN(token, strlen(token) - len_suffix);
2709 /* This function checks if a string <s> of the format "string1, string2, ..."
2710 exactly contains a string <s_contained>. */
2712 static boolean string_has_parameter(char *s, char *s_contained)
2716 if (s == NULL || s_contained == NULL)
2719 if (strlen(s_contained) > strlen(s))
2722 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2724 char next_char = s[strlen(s_contained)];
2726 /* check if next character is delimiter or whitespace */
2727 return (next_char == ',' || next_char == '\0' ||
2728 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2731 /* check if string contains another parameter string after a comma */
2732 substring = strchr(s, ',');
2733 if (substring == NULL) /* string does not contain a comma */
2736 /* advance string pointer to next character after the comma */
2739 /* skip potential whitespaces after the comma */
2740 while (*substring == ' ' || *substring == '\t')
2743 return string_has_parameter(substring, s_contained);
2746 int get_anim_parameter_value(char *s)
2748 char *pattern_1 = "click:anim_";
2749 char *pattern_2 = ".part_";
2750 char *matching_char = NULL;
2752 int result = ANIM_EVENT_NONE;
2754 matching_char = strstr(s_ptr, pattern_1);
2755 if (matching_char == NULL)
2756 return ANIM_EVENT_NONE;
2758 s_ptr = matching_char + strlen(pattern_1);
2760 // check for main animation number ("anim_X" or "anim_XX")
2761 if (*s_ptr >= '0' && *s_ptr <= '9')
2763 int gic_anim_nr = (*s_ptr++ - '0');
2765 if (*s_ptr >= '0' && *s_ptr <= '9')
2766 gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
2768 if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
2769 return ANIM_EVENT_NONE;
2771 result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
2775 // invalid main animation number specified
2777 return ANIM_EVENT_NONE;
2780 // check for animation part number ("part_X" or "part_XX") (optional)
2781 if (strPrefix(s_ptr, pattern_2))
2783 s_ptr += strlen(pattern_2);
2785 if (*s_ptr >= '0' && *s_ptr <= '9')
2787 int gic_part_nr = (*s_ptr++ - '0');
2789 if (*s_ptr >= '0' && *s_ptr <= '9')
2790 gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
2792 if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
2793 return ANIM_EVENT_NONE;
2795 result |= gic_part_nr << ANIM_EVENT_PART_BIT;
2799 // invalid animation part number specified
2801 return ANIM_EVENT_NONE;
2805 /* discard result if next character is neither delimiter nor whitespace */
2806 if (!(*s_ptr == ',' || *s_ptr == '\0' ||
2807 *s_ptr == ' ' || *s_ptr == '\t'))
2808 return ANIM_EVENT_NONE;
2813 int get_anim_action_parameter_value(char *token)
2815 int result = getImageIDFromToken(token);
2819 char *gfx_token = getStringCat2("gfx.", token);
2821 result = getImageIDFromToken(gfx_token);
2823 checked_free(gfx_token);
2828 Key key = getKeyFromX11KeyName(token);
2830 if (key != KSYM_UNDEFINED)
2835 result = ANIM_EVENT_ACTION_NONE;
2840 int get_parameter_value(char *value_raw, char *suffix, int type)
2842 char *value = getStringToLower(value_raw);
2843 int result = 0; /* probably a save default value */
2845 if (strEqual(suffix, ".direction"))
2847 result = (strEqual(value, "left") ? MV_LEFT :
2848 strEqual(value, "right") ? MV_RIGHT :
2849 strEqual(value, "up") ? MV_UP :
2850 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2852 else if (strEqual(suffix, ".position"))
2854 result = (strEqual(value, "left") ? POS_LEFT :
2855 strEqual(value, "right") ? POS_RIGHT :
2856 strEqual(value, "top") ? POS_TOP :
2857 strEqual(value, "upper") ? POS_UPPER :
2858 strEqual(value, "middle") ? POS_MIDDLE :
2859 strEqual(value, "lower") ? POS_LOWER :
2860 strEqual(value, "bottom") ? POS_BOTTOM :
2861 strEqual(value, "any") ? POS_ANY :
2862 strEqual(value, "last") ? POS_LAST : POS_UNDEFINED);
2864 else if (strEqual(suffix, ".align"))
2866 result = (strEqual(value, "left") ? ALIGN_LEFT :
2867 strEqual(value, "right") ? ALIGN_RIGHT :
2868 strEqual(value, "center") ? ALIGN_CENTER :
2869 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2871 else if (strEqual(suffix, ".valign"))
2873 result = (strEqual(value, "top") ? VALIGN_TOP :
2874 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2875 strEqual(value, "middle") ? VALIGN_MIDDLE :
2876 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2878 else if (strEqual(suffix, ".anim_mode"))
2880 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2881 string_has_parameter(value, "loop") ? ANIM_LOOP :
2882 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2883 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2884 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2885 string_has_parameter(value, "random") ? ANIM_RANDOM :
2886 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2887 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2888 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2889 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2890 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2891 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2892 string_has_parameter(value, "all") ? ANIM_ALL :
2895 if (string_has_parameter(value, "once"))
2896 result |= ANIM_ONCE;
2898 if (string_has_parameter(value, "reverse"))
2899 result |= ANIM_REVERSE;
2901 if (string_has_parameter(value, "opaque_player"))
2902 result |= ANIM_OPAQUE_PLAYER;
2904 if (string_has_parameter(value, "static_panel"))
2905 result |= ANIM_STATIC_PANEL;
2907 else if (strEqual(suffix, ".init_event") ||
2908 strEqual(suffix, ".anim_event"))
2910 result = ANIM_EVENT_DEFAULT;
2912 if (string_has_parameter(value, "any"))
2913 result |= ANIM_EVENT_ANY;
2915 if (string_has_parameter(value, "click"))
2916 result |= ANIM_EVENT_SELF;
2918 // add optional "click:anim_X" or "click:anim_X.part_X" parameter
2919 result |= get_anim_parameter_value(value);
2921 else if (strEqual(suffix, ".init_event_action") ||
2922 strEqual(suffix, ".anim_event_action"))
2924 result = get_anim_action_parameter_value(value_raw);
2926 else if (strEqual(suffix, ".class"))
2928 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2929 get_hash_from_key(value));
2931 else if (strEqual(suffix, ".style"))
2933 result = STYLE_DEFAULT;
2935 if (string_has_parameter(value, "accurate_borders"))
2936 result |= STYLE_ACCURATE_BORDERS;
2938 if (string_has_parameter(value, "inner_corners"))
2939 result |= STYLE_INNER_CORNERS;
2941 if (string_has_parameter(value, "reverse"))
2942 result |= STYLE_REVERSE;
2944 if (string_has_parameter(value, "passthrough_clicks"))
2945 result |= STYLE_PASSTHROUGH;
2947 if (string_has_parameter(value, "multiple_actions"))
2948 result |= STYLE_MULTIPLE_ACTIONS;
2950 else if (strEqual(suffix, ".fade_mode"))
2952 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2953 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2954 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2955 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2956 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
2959 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2961 result = gfx.get_font_from_token_function(value);
2963 else /* generic parameter of type integer or boolean */
2965 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2966 type == TYPE_INTEGER ? get_integer_from_string(value) :
2967 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2968 ARG_UNDEFINED_VALUE);
2976 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2977 struct ListNodeInfo ***, int *);
2979 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2980 struct ConfigTypeInfo *suffix_list,
2981 char **ignore_tokens,
2982 int num_file_list_entries)
2984 SetupFileHash *ignore_tokens_hash;
2985 struct FileInfo *file_list;
2986 int num_file_list_entries_found = 0;
2987 int num_suffix_list_entries = 0;
2991 /* create hash from list of tokens to be ignored (for quick access) */
2992 ignore_tokens_hash = newSetupFileHash();
2993 for (i = 0; ignore_tokens[i] != NULL; i++)
2994 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2996 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2998 for (i = 0; suffix_list[i].token != NULL; i++)
2999 num_suffix_list_entries++;
3001 /* always start with reliable default values */
3002 for (i = 0; i < num_file_list_entries; i++)
3004 file_list[i].token = NULL;
3006 file_list[i].default_filename = NULL;
3007 file_list[i].filename = NULL;
3009 if (num_suffix_list_entries > 0)
3011 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3013 file_list[i].default_parameter = checked_calloc(parameter_array_size);
3014 file_list[i].parameter = checked_calloc(parameter_array_size);
3016 for (j = 0; j < num_suffix_list_entries; j++)
3018 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3019 setString(&file_list[i].parameter[j], suffix_list[j].value);
3022 file_list[i].redefined = FALSE;
3023 file_list[i].fallback_to_default = FALSE;
3024 file_list[i].default_is_cloned = FALSE;
3030 for (i = 0; config_list[i].token != NULL; i++)
3032 int len_config_token = strlen(config_list[i].token);
3033 boolean is_file_entry = TRUE;
3035 for (j = 0; suffix_list[j].token != NULL; j++)
3037 int len_suffix = strlen(suffix_list[j].token);
3039 if (len_suffix < len_config_token &&
3040 strEqual(&config_list[i].token[len_config_token - len_suffix],
3041 suffix_list[j].token))
3043 setString(&file_list[list_pos].default_parameter[j],
3044 config_list[i].value);
3046 is_file_entry = FALSE;
3052 /* the following tokens are no file definitions, but other config tokens */
3053 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3054 is_file_entry = FALSE;
3061 if (list_pos >= num_file_list_entries)
3064 file_list[list_pos].token = config_list[i].token;
3065 file_list[list_pos].default_filename = config_list[i].value;
3068 if (strSuffix(config_list[i].token, ".clone_from"))
3069 file_list[list_pos].default_is_cloned = TRUE;
3072 num_file_list_entries_found = list_pos + 1;
3073 if (num_file_list_entries_found != num_file_list_entries)
3075 Error(ERR_INFO_LINE, "-");
3076 Error(ERR_INFO, "inconsistant config list information:");
3077 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
3078 num_file_list_entries);
3079 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
3080 num_file_list_entries_found);
3081 Error(ERR_EXIT, "please fix");
3084 freeSetupFileHash(ignore_tokens_hash);
3089 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3091 int len_token = strlen(token);
3092 int len_suffix = strlen(suffix);
3094 if (start_pos < 0) /* compare suffix from end of string */
3095 start_pos += len_token;
3097 if (start_pos < 0 || start_pos + len_suffix > len_token)
3100 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3103 if (token[start_pos + len_suffix] == '\0')
3106 if (token[start_pos + len_suffix] == '.')
3112 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3114 static void read_token_parameters(SetupFileHash *setup_file_hash,
3115 struct ConfigTypeInfo *suffix_list,
3116 struct FileInfo *file_list_entry)
3118 /* check for config token that is the base token without any suffixes */
3119 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3120 char *known_token_value = KNOWN_TOKEN_VALUE;
3123 if (filename != NULL)
3125 setString(&file_list_entry->filename, filename);
3127 /* when file definition found, set all parameters to default values */
3128 for (i = 0; suffix_list[i].token != NULL; i++)
3129 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3131 file_list_entry->redefined = TRUE;
3133 /* mark config file token as well known from default config */
3134 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3137 /* check for config tokens that can be build by base token and suffixes */
3138 for (i = 0; suffix_list[i].token != NULL; i++)
3140 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3141 char *value = getHashEntry(setup_file_hash, token);
3145 setString(&file_list_entry->parameter[i], value);
3147 /* mark config file token as well known from default config */
3148 setHashEntry(setup_file_hash, token, known_token_value);
3155 static void add_dynamic_file_list_entry(struct FileInfo **list,
3156 int *num_list_entries,
3157 SetupFileHash *extra_file_hash,
3158 struct ConfigTypeInfo *suffix_list,
3159 int num_suffix_list_entries,
3162 struct FileInfo *new_list_entry;
3163 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3165 (*num_list_entries)++;
3166 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3167 new_list_entry = &(*list)[*num_list_entries - 1];
3169 new_list_entry->token = getStringCopy(token);
3170 new_list_entry->default_filename = NULL;
3171 new_list_entry->filename = NULL;
3172 new_list_entry->parameter = checked_calloc(parameter_array_size);
3174 new_list_entry->redefined = FALSE;
3175 new_list_entry->fallback_to_default = FALSE;
3176 new_list_entry->default_is_cloned = FALSE;
3178 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3181 static void add_property_mapping(struct PropertyMapping **list,
3182 int *num_list_entries,
3183 int base_index, int ext1_index,
3184 int ext2_index, int ext3_index,
3187 struct PropertyMapping *new_list_entry;
3189 (*num_list_entries)++;
3190 *list = checked_realloc(*list,
3191 *num_list_entries * sizeof(struct PropertyMapping));
3192 new_list_entry = &(*list)[*num_list_entries - 1];
3194 new_list_entry->base_index = base_index;
3195 new_list_entry->ext1_index = ext1_index;
3196 new_list_entry->ext2_index = ext2_index;
3197 new_list_entry->ext3_index = ext3_index;
3199 new_list_entry->artwork_index = artwork_index;
3202 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3205 struct FileInfo *file_list = artwork_info->file_list;
3206 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3207 char **base_prefixes = artwork_info->base_prefixes;
3208 char **ext1_suffixes = artwork_info->ext1_suffixes;
3209 char **ext2_suffixes = artwork_info->ext2_suffixes;
3210 char **ext3_suffixes = artwork_info->ext3_suffixes;
3211 char **ignore_tokens = artwork_info->ignore_tokens;
3212 int num_file_list_entries = artwork_info->num_file_list_entries;
3213 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3214 int num_base_prefixes = artwork_info->num_base_prefixes;
3215 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3216 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3217 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3218 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3219 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3220 SetupFileHash *extra_file_hash, *empty_file_hash;
3221 char *known_token_value = KNOWN_TOKEN_VALUE;
3222 char *base_token_value = UNDEFINED_FILENAME;
3225 if (filename == NULL)
3228 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3231 /* separate valid (defined) from empty (undefined) config token values */
3232 valid_file_hash = newSetupFileHash();
3233 empty_file_hash = newSetupFileHash();
3234 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3236 char *value = HASH_ITERATION_VALUE(itr);
3238 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3239 HASH_ITERATION_TOKEN(itr), value);
3241 END_HASH_ITERATION(setup_file_hash, itr)
3243 /* at this point, we do not need the setup file hash anymore -- free it */
3244 freeSetupFileHash(setup_file_hash);
3246 /* prevent changing hash while iterating over it by using a temporary copy */
3247 valid_file_hash_tmp = newSetupFileHash();
3248 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3250 setHashEntry(valid_file_hash_tmp,
3251 HASH_ITERATION_TOKEN(itr),
3252 HASH_ITERATION_VALUE(itr));
3254 END_HASH_ITERATION(valid_file_hash, itr)
3256 /* (iterate over same temporary hash, as modifications are independent) */
3258 /* map deprecated to current tokens (using prefix match and replace) */
3259 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3261 char *token = HASH_ITERATION_TOKEN(itr);
3262 char *mapped_token = get_mapped_token(token);
3264 if (mapped_token != NULL)
3266 char *value = HASH_ITERATION_VALUE(itr);
3268 /* add mapped token */
3269 setHashEntry(valid_file_hash, mapped_token, value);
3271 /* ignore old token (by setting it to "known" keyword) */
3272 setHashEntry(valid_file_hash, token, known_token_value);
3277 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3279 /* add special base tokens (using prefix match and replace) */
3280 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3282 char *token = HASH_ITERATION_TOKEN(itr);
3283 char *base_token = get_special_base_token(artwork_info, token);
3285 if (base_token != NULL)
3287 /* add base token only if it does not already exist */
3288 if (getHashEntry(valid_file_hash, base_token) == NULL)
3289 setHashEntry(valid_file_hash, base_token, base_token_value);
3294 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3296 /* free temporary hash used for iteration */
3297 freeSetupFileHash(valid_file_hash_tmp);
3299 /* read parameters for all known config file tokens */
3300 for (i = 0; i < num_file_list_entries; i++)
3301 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3303 /* set all tokens that can be ignored here to "known" keyword */
3304 for (i = 0; i < num_ignore_tokens; i++)
3305 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3307 /* copy all unknown config file tokens to extra config hash */
3308 extra_file_hash = newSetupFileHash();
3309 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3311 char *value = HASH_ITERATION_VALUE(itr);
3313 if (!strEqual(value, known_token_value))
3314 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3316 END_HASH_ITERATION(valid_file_hash, itr)
3318 /* at this point, we do not need the valid file hash anymore -- free it */
3319 freeSetupFileHash(valid_file_hash);
3321 /* now try to determine valid, dynamically defined config tokens */
3323 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3325 struct FileInfo **dynamic_file_list =
3326 &artwork_info->dynamic_file_list;
3327 int *num_dynamic_file_list_entries =
3328 &artwork_info->num_dynamic_file_list_entries;
3329 struct PropertyMapping **property_mapping =
3330 &artwork_info->property_mapping;
3331 int *num_property_mapping_entries =
3332 &artwork_info->num_property_mapping_entries;
3333 int current_summarized_file_list_entry =
3334 artwork_info->num_file_list_entries +
3335 artwork_info->num_dynamic_file_list_entries;
3336 char *token = HASH_ITERATION_TOKEN(itr);
3337 int len_token = strlen(token);
3339 boolean base_prefix_found = FALSE;
3340 boolean parameter_suffix_found = FALSE;
3342 /* skip all parameter definitions (handled by read_token_parameters()) */
3343 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3345 int len_suffix = strlen(suffix_list[i].token);
3347 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3348 parameter_suffix_found = TRUE;
3351 if (parameter_suffix_found)
3354 /* ---------- step 0: search for matching base prefix ---------- */
3357 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3359 char *base_prefix = base_prefixes[i];
3360 int len_base_prefix = strlen(base_prefix);
3361 boolean ext1_suffix_found = FALSE;
3362 boolean ext2_suffix_found = FALSE;
3363 boolean ext3_suffix_found = FALSE;
3364 boolean exact_match = FALSE;
3365 int base_index = -1;
3366 int ext1_index = -1;
3367 int ext2_index = -1;
3368 int ext3_index = -1;
3370 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3372 if (!base_prefix_found)
3377 if (start_pos + len_base_prefix == len_token) /* exact match */
3381 add_dynamic_file_list_entry(dynamic_file_list,
3382 num_dynamic_file_list_entries,
3385 num_suffix_list_entries,
3387 add_property_mapping(property_mapping,
3388 num_property_mapping_entries,
3389 base_index, -1, -1, -1,
3390 current_summarized_file_list_entry);
3394 /* ---------- step 1: search for matching first suffix ---------- */
3396 start_pos += len_base_prefix;
3397 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3399 char *ext1_suffix = ext1_suffixes[j];
3400 int len_ext1_suffix = strlen(ext1_suffix);
3402 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3404 if (!ext1_suffix_found)
3409 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3413 add_dynamic_file_list_entry(dynamic_file_list,
3414 num_dynamic_file_list_entries,
3417 num_suffix_list_entries,
3419 add_property_mapping(property_mapping,
3420 num_property_mapping_entries,
3421 base_index, ext1_index, -1, -1,
3422 current_summarized_file_list_entry);
3426 start_pos += len_ext1_suffix;
3432 /* ---------- step 2: search for matching second suffix ---------- */
3434 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3436 char *ext2_suffix = ext2_suffixes[k];
3437 int len_ext2_suffix = strlen(ext2_suffix);
3439 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3441 if (!ext2_suffix_found)
3446 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3450 add_dynamic_file_list_entry(dynamic_file_list,
3451 num_dynamic_file_list_entries,
3454 num_suffix_list_entries,
3456 add_property_mapping(property_mapping,
3457 num_property_mapping_entries,
3458 base_index, ext1_index, ext2_index, -1,
3459 current_summarized_file_list_entry);
3463 start_pos += len_ext2_suffix;
3469 /* ---------- step 3: search for matching third suffix ---------- */
3471 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3473 char *ext3_suffix = ext3_suffixes[l];
3474 int len_ext3_suffix = strlen(ext3_suffix);
3476 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3478 if (!ext3_suffix_found)
3483 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3487 add_dynamic_file_list_entry(dynamic_file_list,
3488 num_dynamic_file_list_entries,
3491 num_suffix_list_entries,
3493 add_property_mapping(property_mapping,
3494 num_property_mapping_entries,
3495 base_index, ext1_index, ext2_index, ext3_index,
3496 current_summarized_file_list_entry);
3502 END_HASH_ITERATION(extra_file_hash, itr)
3504 if (artwork_info->num_dynamic_file_list_entries > 0)
3506 artwork_info->dynamic_artwork_list =
3507 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3508 artwork_info->sizeof_artwork_list_entry);
3511 if (options.verbose && IS_PARENT_PROCESS())
3513 SetupFileList *setup_file_list, *list;
3514 boolean dynamic_tokens_found = FALSE;
3515 boolean unknown_tokens_found = FALSE;
3516 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3518 /* list may be NULL for empty artwork config files */
3519 setup_file_list = loadSetupFileList(filename);
3521 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3523 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3524 dynamic_tokens_found = TRUE;
3526 unknown_tokens_found = TRUE;
3528 END_HASH_ITERATION(extra_file_hash, itr)
3530 if (options.debug && dynamic_tokens_found)
3532 Error(ERR_INFO_LINE, "-");
3533 Error(ERR_INFO, "dynamic token(s) found in config file:");
3534 Error(ERR_INFO, "- config file: '%s'", filename);
3536 for (list = setup_file_list; list != NULL; list = list->next)
3538 char *value = getHashEntry(extra_file_hash, list->token);
3540 if (value != NULL && strEqual(value, known_token_value))
3541 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3544 Error(ERR_INFO_LINE, "-");
3547 if (unknown_tokens_found)
3549 Error(ERR_INFO_LINE, "-");
3550 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3551 Error(ERR_INFO, "- config file: '%s'", filename);
3553 for (list = setup_file_list; list != NULL; list = list->next)
3555 char *value = getHashEntry(extra_file_hash, list->token);
3557 if (value != NULL && !strEqual(value, known_token_value))
3558 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3561 Error(ERR_INFO_LINE, "-");
3564 if (undefined_values_found)
3566 Error(ERR_INFO_LINE, "-");
3567 Error(ERR_INFO, "warning: undefined values found in config file:");
3568 Error(ERR_INFO, "- config file: '%s'", filename);
3570 for (list = setup_file_list; list != NULL; list = list->next)
3572 char *value = getHashEntry(empty_file_hash, list->token);
3575 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3578 Error(ERR_INFO_LINE, "-");
3581 freeSetupFileList(setup_file_list);
3584 freeSetupFileHash(extra_file_hash);
3585 freeSetupFileHash(empty_file_hash);
3588 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3590 struct FileInfo *file_list = artwork_info->file_list;
3591 int num_file_list_entries = artwork_info->num_file_list_entries;
3592 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3593 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3596 DrawInitText("Loading artwork config", 120, FC_GREEN);
3597 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3599 /* always start with reliable default values */
3600 for (i = 0; i < num_file_list_entries; i++)
3602 setString(&file_list[i].filename, file_list[i].default_filename);
3604 for (j = 0; j < num_suffix_list_entries; j++)
3605 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3607 file_list[i].redefined = FALSE;
3608 file_list[i].fallback_to_default = FALSE;
3611 /* free previous dynamic artwork file array */
3612 if (artwork_info->dynamic_file_list != NULL)
3614 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3616 free(artwork_info->dynamic_file_list[i].token);
3617 free(artwork_info->dynamic_file_list[i].filename);
3618 free(artwork_info->dynamic_file_list[i].parameter);
3621 free(artwork_info->dynamic_file_list);
3622 artwork_info->dynamic_file_list = NULL;
3624 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3625 &artwork_info->num_dynamic_file_list_entries);
3628 /* free previous property mapping */
3629 if (artwork_info->property_mapping != NULL)
3631 free(artwork_info->property_mapping);
3633 artwork_info->property_mapping = NULL;
3634 artwork_info->num_property_mapping_entries = 0;
3637 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3639 /* first look for special artwork configured in level series config */
3640 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3642 if (fileExists(filename_base))
3643 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3646 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3648 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3649 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3652 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3653 struct ListNodeInfo **listnode)
3657 char *filename = (*listnode)->source_filename;
3659 if (--(*listnode)->num_references <= 0)
3660 deleteNodeFromList(&artwork_info->content_list, filename,
3661 artwork_info->free_artwork);
3667 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3668 struct ListNodeInfo **listnode,
3669 struct FileInfo *file_list_entry)
3679 char *basename = file_list_entry->filename;
3680 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3682 if (filename == NULL)
3684 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3686 basename = file_list_entry->default_filename;
3688 /* fail for cloned default artwork that has no default filename defined */
3689 if (file_list_entry->default_is_cloned &&
3690 strEqual(basename, UNDEFINED_FILENAME))
3692 int error_mode = ERR_WARN;
3694 /* we can get away without sounds and music, but not without graphics */
3695 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3696 error_mode = ERR_EXIT;
3698 Error(error_mode, "token '%s' was cloned and has no default filename",
3699 file_list_entry->token);
3704 /* dynamic artwork has no default filename / skip empty default artwork */
3705 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3708 file_list_entry->fallback_to_default = TRUE;
3710 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3712 filename = getCustomArtworkFilename(basename, artwork_info->type);
3714 if (filename == NULL)
3716 int error_mode = ERR_WARN;
3718 /* we can get away without sounds and music, but not without graphics */
3719 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3720 error_mode = ERR_EXIT;
3722 Error(error_mode, "cannot find default artwork file '%s'", basename);
3728 /* check if the old and the new artwork file are the same */
3729 if (*listnode && strEqual((*listnode)->source_filename, filename))
3731 /* The old and new artwork are the same (have the same filename and path).
3732 This usually means that this artwork does not exist in this artwork set
3733 and a fallback to the existing artwork is done. */
3738 /* delete existing artwork file entry */
3739 deleteArtworkListEntry(artwork_info, listnode);
3741 /* check if the new artwork file already exists in the list of artwork */
3742 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3744 *listnode = (struct ListNodeInfo *)node->content;
3745 (*listnode)->num_references++;
3750 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3751 DrawInitText(basename, 150, FC_YELLOW);
3753 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3755 /* add new artwork file entry to the list of artwork files */
3756 (*listnode)->num_references = 1;
3757 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3762 int error_mode = ERR_WARN;
3764 /* we can get away without sounds and music, but not without graphics */
3765 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3766 error_mode = ERR_EXIT;
3768 Error(error_mode, "cannot load artwork file '%s'", basename);
3774 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3775 struct ListNodeInfo **listnode,
3776 struct FileInfo *file_list_entry)
3778 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3780 deleteArtworkListEntry(artwork_info, listnode);
3785 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3788 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3790 struct FileInfo *file_list = artwork_info->file_list;
3791 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3792 int num_file_list_entries = artwork_info->num_file_list_entries;
3793 int num_dynamic_file_list_entries =
3794 artwork_info->num_dynamic_file_list_entries;
3797 print_timestamp_init("ReloadCustomArtworkList");
3799 for (i = 0; i < num_file_list_entries; i++)
3800 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3803 for (i = 0; i < num_dynamic_file_list_entries; i++)
3804 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3805 &dynamic_file_list[i]);
3807 print_timestamp_done("ReloadCustomArtworkList");
3810 dumpList(artwork_info->content_list);
3814 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3815 struct ListNodeInfo ***list,
3816 int *num_list_entries)
3823 for (i = 0; i < *num_list_entries; i++)
3824 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3828 *num_list_entries = 0;
3831 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3833 if (artwork_info == NULL)
3836 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3837 &artwork_info->num_file_list_entries);
3839 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3840 &artwork_info->num_dynamic_file_list_entries);
3844 /* ------------------------------------------------------------------------- */
3845 /* functions only needed for non-Unix (non-command-line) systems */
3846 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3847 /* (now also added for Windows, to create files in user data directory) */
3848 /* ------------------------------------------------------------------------- */
3850 char *getLogFilename(char *basename)
3852 return getPath2(getUserGameDataDir(), basename);
3859 InitUserDataDirectory();
3861 for (i = 0; i < NUM_LOGS; i++)
3863 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3866 program.log_file[i] = program.log_file_default[i]; // reset to default
3868 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3869 program.log_filename[i], strerror(errno));
3872 /* output should be unbuffered so it is not truncated in a crash */
3873 setbuf(program.log_file[i], NULL);
3877 void CloseLogFiles()
3881 for (i = 0; i < NUM_LOGS; i++)
3882 if (program.log_file[i] != program.log_file_default[i])
3883 fclose(program.log_file[i]);
3886 void DumpLogFile(int nr)
3888 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3890 if (log_file == NULL)
3893 while (!feof(log_file))
3894 fputc(fgetc(log_file), stdout);
3899 void NotifyUserAboutErrorFile()
3901 #if defined(PLATFORM_WIN32)
3902 char *title_text = getStringCat2(program.program_title, " Error Message");
3903 char *error_text = getStringCat2("The program was aborted due to an error; "
3904 "for details, see the following error file:"
3906 program.log_filename[LOG_ERR_ID]);
3908 MessageBox(NULL, error_text, title_text, MB_OK);
3913 /* ------------------------------------------------------------------------- */
3914 /* the following is only for debugging purpose and normally not used */
3915 /* ------------------------------------------------------------------------- */
3919 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3920 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3922 #define DEBUG_NUM_TIMESTAMPS 10
3923 #define DEBUG_TIME_IN_MICROSECONDS 0
3925 #if DEBUG_TIME_IN_MICROSECONDS
3926 static double Counter_Microseconds()
3928 static struct timeval base_time = { 0, 0 };
3929 struct timeval current_time;
3932 gettimeofday(¤t_time, NULL);
3934 /* reset base time in case of wrap-around */
3935 if (current_time.tv_sec < base_time.tv_sec)
3936 base_time = current_time;
3939 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3940 ((double)(current_time.tv_usec - base_time.tv_usec));
3942 return counter; /* return microseconds since last init */
3946 char *debug_print_timestamp_get_padding(int padding_size)
3948 static char *padding = NULL;
3949 int max_padding_size = 100;
3951 if (padding == NULL)
3953 padding = checked_calloc(max_padding_size + 1);
3954 memset(padding, ' ', max_padding_size);
3957 return &padding[MAX(0, max_padding_size - padding_size)];
3960 void debug_print_timestamp(int counter_nr, char *message)
3962 int indent_size = 8;
3963 int padding_size = 40;
3964 float timestamp_interval;
3967 Error(ERR_EXIT, "debugging: invalid negative counter");
3968 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3969 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3971 #if DEBUG_TIME_IN_MICROSECONDS
3972 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3975 counter[counter_nr][0] = Counter_Microseconds();
3977 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3980 counter[counter_nr][0] = Counter();
3983 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3984 counter[counter_nr][1] = counter[counter_nr][0];
3987 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3988 debug_print_timestamp_get_padding(counter_nr * indent_size),
3990 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3991 timestamp_interval / 1000,
3995 void debug_print_parent_only(char *format, ...)
3997 if (!IS_PARENT_PROCESS())
4004 va_start(ap, format);
4005 vprintf(format, ap);
4014 void print_timestamp_ext(char *message, char *mode)
4016 #if DEBUG_PRINT_INIT_TIMESTAMPS
4017 static char *debug_message = NULL;
4018 static char *last_message = NULL;
4019 static int counter_nr = 0;
4020 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4022 checked_free(debug_message);
4023 debug_message = getStringCat3(mode, " ", message);
4025 if (strEqual(mode, "INIT"))
4027 debug_print_timestamp(counter_nr, NULL);
4029 if (counter_nr + 1 < max_depth)
4030 debug_print_timestamp(counter_nr, debug_message);
4034 debug_print_timestamp(counter_nr, NULL);
4036 else if (strEqual(mode, "DONE"))
4040 if (counter_nr + 1 < max_depth ||
4041 (counter_nr == 0 && max_depth == 1))
4043 last_message = message;
4045 if (counter_nr == 0 && max_depth == 1)
4047 checked_free(debug_message);
4048 debug_message = getStringCat3("TIME", " ", message);
4051 debug_print_timestamp(counter_nr, debug_message);
4054 else if (!strEqual(mode, "TIME") ||
4055 !strEqual(message, last_message))
4057 if (counter_nr < max_depth)
4058 debug_print_timestamp(counter_nr, debug_message);
4063 void print_timestamp_init(char *message)
4065 print_timestamp_ext(message, "INIT");
4068 void print_timestamp_time(char *message)
4070 print_timestamp_ext(message, "TIME");
4073 void print_timestamp_done(char *message)
4075 print_timestamp_ext(message, "DONE");