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';
699 static char *getProgramMainDataPath()
701 char *main_data_path = getStringCopy(program.command_basepath);
703 #if defined(PLATFORM_MACOSX)
704 static char *main_data_binary_subdir = NULL;
705 static char *main_data_files_subdir = NULL;
707 if (main_data_binary_subdir == NULL)
709 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
711 strlen(MAC_APP_BINARY_SUBDIR) + 1);
713 sprintf(main_data_binary_subdir, "%s.app/%s",
714 program.program_title, MAC_APP_BINARY_SUBDIR);
717 if (main_data_files_subdir == NULL)
719 main_data_files_subdir = checked_malloc(strlen(program.program_title) + 1 +
721 strlen(MAC_APP_FILES_SUBDIR) + 1);
723 sprintf(main_data_files_subdir, "%s.app/%s",
724 program.program_title, MAC_APP_FILES_SUBDIR);
727 if (strSuffix(main_data_path, main_data_binary_subdir))
729 char *main_data_path_old = main_data_path;
731 // cut relative path to Mac OS X application binary directory from path
732 main_data_path[strlen(main_data_path) -
733 strlen(main_data_binary_subdir)] = '\0';
735 // cut trailing path separator from path (but not if path is root directory)
736 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
737 main_data_path[strlen(main_data_path) - 1] = '\0';
739 // replace empty path with current directory
740 if (strEqual(main_data_path, ""))
741 main_data_path = ".";
743 // add relative path to Mac OS X application resources directory to path
744 main_data_path = getPath2(main_data_path, main_data_files_subdir);
746 free(main_data_path_old);
750 return main_data_path;
754 /* ------------------------------------------------------------------------- */
755 /* various string functions */
756 /* ------------------------------------------------------------------------- */
758 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
760 if (s1 == NULL || s2 == NULL || sep == NULL)
763 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
766 sprintf(complete_string, "%s%s%s", s1, sep, s2);
768 return complete_string;
771 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
773 if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
776 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
777 strlen(s2) + strlen(sep) +
780 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
782 return complete_string;
785 char *getStringCat2(char *s1, char *s2)
787 return getStringCat2WithSeparator(s1, s2, "");
790 char *getStringCat3(char *s1, char *s2, char *s3)
792 return getStringCat3WithSeparator(s1, s2, s3, "");
795 char *getPath2(char *path1, char *path2)
797 #if defined(PLATFORM_ANDROID)
798 // workaround for reading from assets directory -- skip "." subdirs in path
799 if (strEqual(path1, "."))
800 return getStringCopy(path2);
801 else if (strEqual(path2, "."))
802 return getStringCopy(path1);
805 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
808 char *getPath3(char *path1, char *path2, char *path3)
810 #if defined(PLATFORM_ANDROID)
811 // workaround for reading from assets directory -- skip "." subdirs in path
812 if (strEqual(path1, "."))
813 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
814 else if (strEqual(path2, "."))
815 return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
816 else if (strEqual(path3, "."))
817 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
820 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
823 static char *getPngOrPcxIfNotExists(char *filename)
825 // switch from PNG to PCX file and vice versa, if file does not exist
826 // (backwards compatibility with PCX files used in previous versions)
828 if (!fileExists(filename) && strSuffix(filename, ".png"))
829 strcpy(&filename[strlen(filename) - 3], "pcx");
830 else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
831 strcpy(&filename[strlen(filename) - 3], "png");
836 char *getImg2(char *path1, char *path2)
838 return getPngOrPcxIfNotExists(getPath2(path1, path2));
841 char *getImg3(char *path1, char *path2, char *path3)
843 return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
846 char *getStringCopy(const char *s)
853 s_copy = checked_malloc(strlen(s) + 1);
859 char *getStringCopyN(const char *s, int n)
862 int s_len = MAX(0, n);
867 s_copy = checked_malloc(s_len + 1);
868 strncpy(s_copy, s, s_len);
869 s_copy[s_len] = '\0';
874 char *getStringCopyNStatic(const char *s, int n)
876 static char *s_copy = NULL;
878 checked_free(s_copy);
880 s_copy = getStringCopyN(s, n);
885 char *getStringToLower(const char *s)
887 char *s_copy = checked_malloc(strlen(s) + 1);
888 char *s_ptr = s_copy;
891 *s_ptr++ = tolower(*s++);
897 void setString(char **old_value, char *new_value)
899 checked_free(*old_value);
901 *old_value = getStringCopy(new_value);
904 boolean strEqual(char *s1, char *s2)
906 return (s1 == NULL && s2 == NULL ? TRUE :
907 s1 == NULL && s2 != NULL ? FALSE :
908 s1 != NULL && s2 == NULL ? FALSE :
909 strcmp(s1, s2) == 0);
912 boolean strEqualN(char *s1, char *s2, int n)
914 return (s1 == NULL && s2 == NULL ? TRUE :
915 s1 == NULL && s2 != NULL ? FALSE :
916 s1 != NULL && s2 == NULL ? FALSE :
917 strncmp(s1, s2, n) == 0);
920 boolean strPrefix(char *s, char *prefix)
922 return (s == NULL && prefix == NULL ? TRUE :
923 s == NULL && prefix != NULL ? FALSE :
924 s != NULL && prefix == NULL ? FALSE :
925 strncmp(s, prefix, strlen(prefix)) == 0);
928 boolean strSuffix(char *s, char *suffix)
930 return (s == NULL && suffix == NULL ? TRUE :
931 s == NULL && suffix != NULL ? FALSE :
932 s != NULL && suffix == NULL ? FALSE :
933 strlen(s) < strlen(suffix) ? FALSE :
934 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
937 boolean strPrefixLower(char *s, char *prefix)
939 char *s_lower = getStringToLower(s);
940 boolean match = strPrefix(s_lower, prefix);
947 boolean strSuffixLower(char *s, char *suffix)
949 char *s_lower = getStringToLower(s);
950 boolean match = strSuffix(s_lower, suffix);
958 /* ------------------------------------------------------------------------- */
959 /* command line option handling functions */
960 /* ------------------------------------------------------------------------- */
962 void GetOptions(int argc, char *argv[],
963 void (*print_usage_function)(void),
964 void (*print_version_function)(void))
966 char *ro_base_path = RO_BASE_PATH;
967 char *rw_base_path = RW_BASE_PATH;
968 char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
969 char **options_left = &argvplus[1];
971 /* replace original "argv" with null-terminated array of string pointers */
973 argvplus[argc] = argv[argc];
975 /* if the program is configured to start from current directory (default),
976 determine program package directory from program binary (some versions
977 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
978 set the current working directory to the program package directory) */
980 if (strEqual(ro_base_path, "."))
981 ro_base_path = getProgramMainDataPath();
982 if (strEqual(rw_base_path, "."))
983 rw_base_path = getProgramMainDataPath();
985 /* initialize global program options */
986 options.server_host = NULL;
987 options.server_port = 0;
989 options.ro_base_directory = ro_base_path;
990 options.rw_base_directory = rw_base_path;
991 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
992 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
993 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
994 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
995 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
996 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
998 options.execute_command = NULL;
999 options.special_flags = NULL;
1001 options.mytapes = FALSE;
1002 options.serveronly = FALSE;
1003 options.network = FALSE;
1004 options.verbose = FALSE;
1005 options.debug = FALSE;
1008 options.verbose = TRUE;
1010 #if !defined(PLATFORM_UNIX)
1011 if (*options_left == NULL) /* no options given -- enable verbose mode */
1012 options.verbose = TRUE;
1017 #if defined(PLATFORM_ANDROID)
1018 options.debug = TRUE;
1022 while (*options_left)
1024 char option_str[MAX_OPTION_LEN];
1025 char *option = options_left[0];
1026 char *next_option = options_left[1];
1027 char *option_arg = NULL;
1028 int option_len = strlen(option);
1030 if (option_len >= MAX_OPTION_LEN)
1031 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1033 strcpy(option_str, option); /* copy argument into buffer */
1034 option = option_str;
1036 if (strEqual(option, "--")) /* stop scanning arguments */
1039 if (strPrefix(option, "--")) /* treat '--' like '-' */
1042 option_arg = strchr(option, '=');
1043 if (option_arg == NULL) /* no '=' in option */
1044 option_arg = next_option;
1047 *option_arg++ = '\0'; /* cut argument from option */
1048 if (*option_arg == '\0') /* no argument after '=' */
1049 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
1052 option_len = strlen(option);
1054 if (strEqual(option, "-"))
1056 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
1058 else if (strncmp(option, "-help", option_len) == 0)
1060 print_usage_function();
1064 else if (strncmp(option, "-basepath", option_len) == 0)
1066 if (option_arg == NULL)
1067 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1069 /* this should be extended to separate options for ro and rw data */
1070 options.ro_base_directory = ro_base_path = option_arg;
1071 options.rw_base_directory = rw_base_path = option_arg;
1072 if (option_arg == next_option)
1075 /* adjust paths for sub-directories in base directory accordingly */
1076 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
1077 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1078 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1079 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
1080 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
1081 options.conf_directory = getPath2(ro_base_path, CONF_DIRECTORY);
1083 else if (strncmp(option, "-levels", option_len) == 0)
1085 if (option_arg == NULL)
1086 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1088 options.level_directory = option_arg;
1089 if (option_arg == next_option)
1092 else if (strncmp(option, "-graphics", option_len) == 0)
1094 if (option_arg == NULL)
1095 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1097 options.graphics_directory = option_arg;
1098 if (option_arg == next_option)
1101 else if (strncmp(option, "-sounds", option_len) == 0)
1103 if (option_arg == NULL)
1104 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1106 options.sounds_directory = option_arg;
1107 if (option_arg == next_option)
1110 else if (strncmp(option, "-music", option_len) == 0)
1112 if (option_arg == NULL)
1113 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1115 options.music_directory = option_arg;
1116 if (option_arg == next_option)
1119 else if (strncmp(option, "-mytapes", option_len) == 0)
1121 options.mytapes = TRUE;
1123 else if (strncmp(option, "-network", option_len) == 0)
1125 options.network = TRUE;
1127 else if (strncmp(option, "-serveronly", option_len) == 0)
1129 options.serveronly = TRUE;
1131 else if (strncmp(option, "-debug", option_len) == 0)
1133 options.debug = TRUE;
1135 else if (strncmp(option, "-verbose", option_len) == 0)
1137 options.verbose = TRUE;
1139 else if (strncmp(option, "-version", option_len) == 0 ||
1140 strncmp(option, "-V", option_len) == 0)
1142 print_version_function();
1146 else if (strPrefix(option, "-D"))
1148 options.special_flags = getStringCopy(&option[2]);
1150 else if (strncmp(option, "-execute", option_len) == 0)
1152 if (option_arg == NULL)
1153 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1155 options.execute_command = option_arg;
1156 if (option_arg == next_option)
1159 /* when doing batch processing, always enable verbose mode (warnings) */
1160 options.verbose = TRUE;
1162 #if defined(PLATFORM_MACOSX)
1163 else if (strPrefix(option, "-psn"))
1165 /* ignore process serial number when launched via GUI on Mac OS X */
1168 else if (*option == '-')
1170 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1172 else if (options.server_host == NULL)
1174 options.server_host = *options_left;
1176 else if (options.server_port == 0)
1178 options.server_port = atoi(*options_left);
1179 if (options.server_port < 1024)
1180 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1183 Error(ERR_EXIT_HELP, "too many arguments");
1190 /* ------------------------------------------------------------------------- */
1191 /* error handling functions */
1192 /* ------------------------------------------------------------------------- */
1194 #define MAX_INTERNAL_ERROR_SIZE 1024
1196 /* used by SetError() and GetError() to store internal error messages */
1197 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1199 void SetError(char *format, ...)
1203 va_start(ap, format);
1204 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1210 return internal_error;
1213 void Error(int mode, char *format, ...)
1215 static boolean last_line_was_separator = FALSE;
1216 char *process_name = "";
1218 if (program.log_file[LOG_ERR_ID] == NULL)
1221 #if defined(PLATFORM_ANDROID)
1222 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1223 mode & ERR_INFO ? ANDROID_LOG_INFO :
1224 mode & ERR_WARN ? ANDROID_LOG_WARN :
1225 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1226 ANDROID_LOG_UNKNOWN);
1229 /* display debug messages only when running in debug mode */
1230 if (mode & ERR_DEBUG && !options.debug)
1233 /* display warnings only when running in verbose mode */
1234 if (mode & ERR_WARN && !options.verbose)
1237 if (mode == ERR_INFO_LINE)
1239 if (!last_line_was_separator)
1240 printf_log_line(format, 79);
1242 last_line_was_separator = TRUE;
1247 last_line_was_separator = FALSE;
1249 if (mode & ERR_SOUND_SERVER)
1250 process_name = " sound server";
1251 else if (mode & ERR_NETWORK_SERVER)
1252 process_name = " network server";
1253 else if (mode & ERR_NETWORK_CLIENT)
1254 process_name = " network client **";
1258 #if !defined(PLATFORM_ANDROID)
1259 printf_log_nonewline("%s%s: ", program.command_basename, process_name);
1262 if (mode & ERR_WARN)
1263 printf_log_nonewline("warning: ");
1265 if (mode & ERR_EXIT)
1266 printf_log_nonewline("fatal error: ");
1270 va_start(ap, format);
1271 vprintf_log(format, ap);
1274 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1276 va_start(ap, format);
1277 program.exit_message_function(format, ap);
1282 if (mode & ERR_HELP)
1283 printf_log("%s: Try option '--help' for more information.",
1284 program.command_basename);
1286 if (mode & ERR_EXIT)
1287 printf_log("%s%s: aborting", program.command_basename, process_name);
1289 if (mode & ERR_EXIT)
1291 if (mode & ERR_FROM_SERVER)
1292 exit(1); /* child process: normal exit */
1294 program.exit_function(1); /* main process: clean up stuff */
1299 /* ------------------------------------------------------------------------- */
1300 /* checked memory allocation and freeing functions */
1301 /* ------------------------------------------------------------------------- */
1303 void *checked_malloc(unsigned int size)
1310 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1315 void *checked_calloc(unsigned int size)
1319 ptr = calloc(1, size);
1322 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1327 void *checked_realloc(void *ptr, unsigned int size)
1329 ptr = realloc(ptr, size);
1332 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1337 void checked_free(void *ptr)
1339 if (ptr != NULL) /* this check should be done by free() anyway */
1343 void clear_mem(void *ptr, unsigned int size)
1345 #if defined(PLATFORM_WIN32)
1346 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1347 char *cptr = (char *)ptr;
1352 memset(ptr, 0, size);
1357 /* ------------------------------------------------------------------------- */
1358 /* various helper functions */
1359 /* ------------------------------------------------------------------------- */
1361 void swap_numbers(int *i1, int *i2)
1369 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1381 /* the "put" variants of the following file access functions check for the file
1382 pointer being != NULL and return the number of bytes they have or would have
1383 written; this allows for chunk writing functions to first determine the size
1384 of the (not yet written) chunk, write the correct chunk size and finally
1385 write the chunk itself */
1387 int getFile8BitInteger(File *file)
1389 return getByteFromFile(file);
1392 int putFile8BitInteger(FILE *file, int value)
1400 int getFile16BitInteger(File *file, int byte_order)
1402 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1403 return ((getByteFromFile(file) << 8) |
1404 (getByteFromFile(file) << 0));
1405 else /* BYTE_ORDER_LITTLE_ENDIAN */
1406 return ((getByteFromFile(file) << 0) |
1407 (getByteFromFile(file) << 8));
1410 int putFile16BitInteger(FILE *file, int value, int byte_order)
1414 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1416 fputc((value >> 8) & 0xff, file);
1417 fputc((value >> 0) & 0xff, file);
1419 else /* BYTE_ORDER_LITTLE_ENDIAN */
1421 fputc((value >> 0) & 0xff, file);
1422 fputc((value >> 8) & 0xff, file);
1429 int getFile32BitInteger(File *file, int byte_order)
1431 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1432 return ((getByteFromFile(file) << 24) |
1433 (getByteFromFile(file) << 16) |
1434 (getByteFromFile(file) << 8) |
1435 (getByteFromFile(file) << 0));
1436 else /* BYTE_ORDER_LITTLE_ENDIAN */
1437 return ((getByteFromFile(file) << 0) |
1438 (getByteFromFile(file) << 8) |
1439 (getByteFromFile(file) << 16) |
1440 (getByteFromFile(file) << 24));
1443 int putFile32BitInteger(FILE *file, int value, int byte_order)
1447 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1449 fputc((value >> 24) & 0xff, file);
1450 fputc((value >> 16) & 0xff, file);
1451 fputc((value >> 8) & 0xff, file);
1452 fputc((value >> 0) & 0xff, file);
1454 else /* BYTE_ORDER_LITTLE_ENDIAN */
1456 fputc((value >> 0) & 0xff, file);
1457 fputc((value >> 8) & 0xff, file);
1458 fputc((value >> 16) & 0xff, file);
1459 fputc((value >> 24) & 0xff, file);
1466 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1469 const int chunk_name_length = 4;
1471 /* read chunk name */
1472 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1475 if (chunk_size != NULL)
1477 /* read chunk size */
1478 *chunk_size = getFile32BitInteger(file, byte_order);
1481 return (checkEndOfFile(file) ? FALSE : TRUE);
1484 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1489 /* write chunk name */
1491 fputs(chunk_name, file);
1493 num_bytes += strlen(chunk_name);
1495 if (chunk_size >= 0)
1497 /* write chunk size */
1499 putFile32BitInteger(file, chunk_size, byte_order);
1507 int getFileVersion(File *file)
1509 int version_major = getByteFromFile(file);
1510 int version_minor = getByteFromFile(file);
1511 int version_patch = getByteFromFile(file);
1512 int version_build = getByteFromFile(file);
1514 return VERSION_IDENT(version_major, version_minor, version_patch,
1518 int putFileVersion(FILE *file, int version)
1522 int version_major = VERSION_MAJOR(version);
1523 int version_minor = VERSION_MINOR(version);
1524 int version_patch = VERSION_PATCH(version);
1525 int version_build = VERSION_BUILD(version);
1527 fputc(version_major, file);
1528 fputc(version_minor, file);
1529 fputc(version_patch, file);
1530 fputc(version_build, file);
1536 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1540 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1541 buffer[i] = getByteFromFile(file);
1544 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1548 for(i = 0; i < bytes; i++)
1549 fputc(buffer[i], file);
1552 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1554 while (bytes-- && !checkEndOfFile(file))
1555 getByteFromFile(file);
1558 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1565 /* ------------------------------------------------------------------------- */
1566 /* functions to translate key identifiers between different format */
1567 /* ------------------------------------------------------------------------- */
1569 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1570 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1571 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1572 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1574 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1583 /* normal cursor keys */
1584 { KSYM_Left, "XK_Left", "cursor left" },
1585 { KSYM_Right, "XK_Right", "cursor right" },
1586 { KSYM_Up, "XK_Up", "cursor up" },
1587 { KSYM_Down, "XK_Down", "cursor down" },
1589 /* keypad cursor keys */
1591 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1592 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1593 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1594 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1597 /* other keypad keys */
1598 #ifdef KSYM_KP_Enter
1599 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1600 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1601 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1602 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1603 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1604 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1608 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1609 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1610 { KSYM_Control_L, "XK_Control_L", "left control" },
1611 { KSYM_Control_R, "XK_Control_R", "right control" },
1612 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1613 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1614 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1615 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1616 #if !defined(TARGET_SDL2)
1617 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1618 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1620 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1621 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1623 /* some special keys */
1624 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1625 { KSYM_Delete, "XK_Delete", "delete" },
1626 { KSYM_Insert, "XK_Insert", "insert" },
1627 { KSYM_Tab, "XK_Tab", "tab" },
1628 { KSYM_Home, "XK_Home", "home" },
1629 { KSYM_End, "XK_End", "end" },
1630 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1631 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1633 #if defined(TARGET_SDL2)
1634 { KSYM_Select, "XK_Select", "select" },
1635 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1636 { KSYM_Back, "XK_Back", "back" }, /* back key */
1637 { KSYM_PlayPause, "XK_PlayPause", "play/pause" },
1638 #if defined(PLATFORM_ANDROID)
1639 { KSYM_Rewind, "XK_Rewind", "rewind" },
1640 { KSYM_FastForward, "XK_FastForward", "fast forward" },
1644 /* ASCII 0x20 to 0x40 keys (except numbers) */
1645 { KSYM_space, "XK_space", "space" },
1646 { KSYM_exclam, "XK_exclam", "!" },
1647 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1648 { KSYM_numbersign, "XK_numbersign", "#" },
1649 { KSYM_dollar, "XK_dollar", "$" },
1650 { KSYM_percent, "XK_percent", "%" },
1651 { KSYM_ampersand, "XK_ampersand", "&" },
1652 { KSYM_apostrophe, "XK_apostrophe", "'" },
1653 { KSYM_parenleft, "XK_parenleft", "(" },
1654 { KSYM_parenright, "XK_parenright", ")" },
1655 { KSYM_asterisk, "XK_asterisk", "*" },
1656 { KSYM_plus, "XK_plus", "+" },
1657 { KSYM_comma, "XK_comma", "," },
1658 { KSYM_minus, "XK_minus", "-" },
1659 { KSYM_period, "XK_period", "." },
1660 { KSYM_slash, "XK_slash", "/" },
1661 { KSYM_colon, "XK_colon", ":" },
1662 { KSYM_semicolon, "XK_semicolon", ";" },
1663 { KSYM_less, "XK_less", "<" },
1664 { KSYM_equal, "XK_equal", "=" },
1665 { KSYM_greater, "XK_greater", ">" },
1666 { KSYM_question, "XK_question", "?" },
1667 { KSYM_at, "XK_at", "@" },
1669 /* more ASCII keys */
1670 { KSYM_bracketleft, "XK_bracketleft", "[" },
1671 { KSYM_backslash, "XK_backslash", "\\" },
1672 { KSYM_bracketright,"XK_bracketright", "]" },
1673 { KSYM_asciicircum, "XK_asciicircum", "^" },
1674 { KSYM_underscore, "XK_underscore", "_" },
1675 { KSYM_grave, "XK_grave", "grave" },
1676 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1677 { KSYM_braceleft, "XK_braceleft", "brace left" },
1678 { KSYM_bar, "XK_bar", "bar" },
1679 { KSYM_braceright, "XK_braceright", "brace right" },
1680 { KSYM_asciitilde, "XK_asciitilde", "~" },
1682 /* special (non-ASCII) keys */
1683 { KSYM_degree, "XK_degree", "degree" },
1684 { KSYM_Adiaeresis, "XK_Adiaeresis", "A umlaut" },
1685 { KSYM_Odiaeresis, "XK_Odiaeresis", "O umlaut" },
1686 { KSYM_Udiaeresis, "XK_Udiaeresis", "U umlaut" },
1687 { KSYM_adiaeresis, "XK_adiaeresis", "a umlaut" },
1688 { KSYM_odiaeresis, "XK_odiaeresis", "o umlaut" },
1689 { KSYM_udiaeresis, "XK_udiaeresis", "u umlaut" },
1690 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1692 #if defined(TARGET_SDL2)
1693 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1694 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1695 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1696 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1697 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1698 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1699 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1700 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1701 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1703 /* other keys (for reverse mapping only) */
1704 { KSYM_space, "XK_space", " " },
1707 #if defined(TARGET_SDL2)
1708 /* keypad keys are not in numerical order in SDL2 */
1709 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1710 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1711 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1712 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1713 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1714 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1715 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1716 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1717 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1718 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1721 /* end-of-array identifier */
1727 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1729 static char name_buffer[30];
1732 if (key >= KSYM_A && key <= KSYM_Z)
1733 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1734 else if (key >= KSYM_a && key <= KSYM_z)
1735 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1736 else if (key >= KSYM_0 && key <= KSYM_9)
1737 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1738 #if !defined(TARGET_SDL2)
1739 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1740 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1742 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1743 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1744 else if (key == KSYM_UNDEFINED)
1745 strcpy(name_buffer, "(undefined)");
1752 if (key == translate_key[i].key)
1754 strcpy(name_buffer, translate_key[i].name);
1758 while (translate_key[++i].name);
1760 if (!translate_key[i].name)
1761 strcpy(name_buffer, "(unknown)");
1764 *name = name_buffer;
1766 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1768 static char name_buffer[30];
1771 if (key >= KSYM_A && key <= KSYM_Z)
1772 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1773 else if (key >= KSYM_a && key <= KSYM_z)
1774 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1775 else if (key >= KSYM_0 && key <= KSYM_9)
1776 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1777 #if !defined(TARGET_SDL2)
1778 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1779 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1781 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1782 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1783 else if (key == KSYM_UNDEFINED)
1784 strcpy(name_buffer, "[undefined]");
1791 if (key == translate_key[i].key)
1793 strcpy(name_buffer, translate_key[i].x11name);
1797 while (translate_key[++i].x11name);
1799 if (!translate_key[i].x11name)
1800 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1803 *x11name = name_buffer;
1805 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1807 Key key = KSYM_UNDEFINED;
1808 char *name_ptr = *name;
1810 if (strlen(*name) == 1)
1812 char c = name_ptr[0];
1814 if (c >= 'A' && c <= 'Z')
1815 key = KSYM_A + (Key)(c - 'A');
1816 else if (c >= 'a' && c <= 'z')
1817 key = KSYM_a + (Key)(c - 'a');
1818 else if (c >= '0' && c <= '9')
1819 key = KSYM_0 + (Key)(c - '0');
1822 if (key == KSYM_UNDEFINED)
1828 if (strEqual(translate_key[i].name, *name))
1830 key = translate_key[i].key;
1834 while (translate_key[++i].x11name);
1837 if (key == KSYM_UNDEFINED)
1838 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1842 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1844 Key key = KSYM_UNDEFINED;
1845 char *name_ptr = *x11name;
1847 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1849 char c = name_ptr[3];
1851 if (c >= 'A' && c <= 'Z')
1852 key = KSYM_A + (Key)(c - 'A');
1853 else if (c >= 'a' && c <= 'z')
1854 key = KSYM_a + (Key)(c - 'a');
1855 else if (c >= '0' && c <= '9')
1856 key = KSYM_0 + (Key)(c - '0');
1858 #if !defined(TARGET_SDL2)
1859 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1861 char c = name_ptr[6];
1863 if (c >= '0' && c <= '9')
1864 key = KSYM_KP_0 + (Key)(c - '0');
1867 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1869 char c1 = name_ptr[4];
1870 char c2 = name_ptr[5];
1873 if ((c1 >= '0' && c1 <= '9') &&
1874 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1875 d = atoi(&name_ptr[4]);
1877 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1878 key = KSYM_F1 + (Key)(d - 1);
1880 else if (strPrefix(name_ptr, "XK_"))
1886 if (strEqual(name_ptr, translate_key[i].x11name))
1888 key = translate_key[i].key;
1892 while (translate_key[++i].x11name);
1894 else if (strPrefix(name_ptr, "0x"))
1896 unsigned int value = 0;
1902 char c = *name_ptr++;
1905 if (c >= '0' && c <= '9')
1907 else if (c >= 'a' && c <= 'f')
1908 d = (int)(c - 'a' + 10);
1909 else if (c >= 'A' && c <= 'F')
1910 d = (int)(c - 'A' + 10);
1918 value = value * 16 + d;
1929 char *getKeyNameFromKey(Key key)
1933 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1937 char *getX11KeyNameFromKey(Key key)
1941 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1945 Key getKeyFromKeyName(char *name)
1949 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1953 Key getKeyFromX11KeyName(char *x11name)
1957 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1961 char getCharFromKey(Key key)
1967 } translate_key_char[] =
1969 /* special (non-ASCII) keys (ISO-8859-1) */
1970 { KSYM_degree, CHAR_BYTE_DEGREE },
1971 { KSYM_Adiaeresis, CHAR_BYTE_UMLAUT_A },
1972 { KSYM_Odiaeresis, CHAR_BYTE_UMLAUT_O },
1973 { KSYM_Udiaeresis, CHAR_BYTE_UMLAUT_U },
1974 { KSYM_adiaeresis, CHAR_BYTE_UMLAUT_a },
1975 { KSYM_odiaeresis, CHAR_BYTE_UMLAUT_o },
1976 { KSYM_udiaeresis, CHAR_BYTE_UMLAUT_u },
1977 { KSYM_ssharp, CHAR_BYTE_SHARP_S },
1979 /* end-of-array identifier */
1983 char *keyname = getKeyNameFromKey(key);
1986 if (strlen(keyname) == 1)
1988 else if (strEqual(keyname, "space"))
1996 if (key == translate_key_char[i].key)
1998 c = translate_key_char[i].key_char;
2003 while (translate_key_char[++i].key_char);
2009 char getValidConfigValueChar(char c)
2011 if (c == '#' || /* used to mark comments */
2012 c == '\\') /* used to mark continued lines */
2019 /* ------------------------------------------------------------------------- */
2020 /* functions to translate string identifiers to integer or boolean value */
2021 /* ------------------------------------------------------------------------- */
2023 int get_integer_from_string(char *s)
2025 static char *number_text[][3] =
2027 { "0", "zero", "null", },
2028 { "1", "one", "first" },
2029 { "2", "two", "second" },
2030 { "3", "three", "third" },
2031 { "4", "four", "fourth" },
2032 { "5", "five", "fifth" },
2033 { "6", "six", "sixth" },
2034 { "7", "seven", "seventh" },
2035 { "8", "eight", "eighth" },
2036 { "9", "nine", "ninth" },
2037 { "10", "ten", "tenth" },
2038 { "11", "eleven", "eleventh" },
2039 { "12", "twelve", "twelfth" },
2041 { NULL, NULL, NULL },
2045 char *s_lower = getStringToLower(s);
2048 for (i = 0; number_text[i][0] != NULL; i++)
2049 for (j = 0; j < 3; j++)
2050 if (strEqual(s_lower, number_text[i][j]))
2055 if (strEqual(s_lower, "false") ||
2056 strEqual(s_lower, "no") ||
2057 strEqual(s_lower, "off"))
2059 else if (strEqual(s_lower, "true") ||
2060 strEqual(s_lower, "yes") ||
2061 strEqual(s_lower, "on"))
2072 boolean get_boolean_from_string(char *s)
2074 char *s_lower = getStringToLower(s);
2075 boolean result = FALSE;
2077 if (strEqual(s_lower, "true") ||
2078 strEqual(s_lower, "yes") ||
2079 strEqual(s_lower, "on") ||
2080 get_integer_from_string(s) == 1)
2088 int get_switch3_from_string(char *s)
2090 char *s_lower = getStringToLower(s);
2093 if (strEqual(s_lower, "true") ||
2094 strEqual(s_lower, "yes") ||
2095 strEqual(s_lower, "on") ||
2096 get_integer_from_string(s) == 1)
2098 else if (strEqual(s_lower, "auto"))
2107 /* ------------------------------------------------------------------------- */
2108 /* functions for generic lists */
2109 /* ------------------------------------------------------------------------- */
2111 ListNode *newListNode()
2113 return checked_calloc(sizeof(ListNode));
2116 void addNodeToList(ListNode **node_first, char *key, void *content)
2118 ListNode *node_new = newListNode();
2120 node_new->key = getStringCopy(key);
2121 node_new->content = content;
2122 node_new->next = *node_first;
2125 (*node_first)->prev = node_new;
2127 *node_first = node_new;
2130 void deleteNodeFromList(ListNode **node_first, char *key,
2131 void (*destructor_function)(void *))
2133 if (node_first == NULL || *node_first == NULL)
2136 if (strEqual((*node_first)->key, key))
2138 // after first recursion, (*node_first)->prev->next == *node_first,
2139 // so *node_first would be overwritten with (*node_first)->next
2140 // => use a copy of *node_first (and later of (*node_first)->next)
2141 ListNode *node = *node_first;
2142 ListNode *node_next = node->next;
2144 checked_free(node->key);
2146 if (destructor_function)
2147 destructor_function(node->content);
2150 node->prev->next = node->next;
2153 node->next->prev = node->prev;
2157 // after removing node, set list pointer to next valid list node
2158 // (this is important if the first node of the list was deleted)
2159 *node_first = node_next;
2163 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2167 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2169 if (node_first == NULL)
2172 if (strEqual(node_first->key, key))
2175 return getNodeFromKey(node_first->next, key);
2178 int getNumNodes(ListNode *node_first)
2180 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2183 void dumpList(ListNode *node_first)
2185 ListNode *node = node_first;
2189 printf("['%s' (%d)]\n", node->key,
2190 ((struct ListNodeInfo *)node->content)->num_references);
2194 printf("[%d nodes]\n", getNumNodes(node_first));
2198 /* ------------------------------------------------------------------------- */
2199 /* functions for file handling */
2200 /* ------------------------------------------------------------------------- */
2202 File *openFile(char *filename, char *mode)
2204 File *file = checked_calloc(sizeof(File));
2206 file->file = fopen(filename, mode);
2208 if (file->file != NULL)
2210 file->filename = getStringCopy(filename);
2215 #if defined(PLATFORM_ANDROID)
2216 file->asset_file = SDL_RWFromFile(filename, mode);
2218 if (file->asset_file != NULL)
2220 file->file_is_asset = TRUE;
2221 file->filename = getStringCopy(filename);
2232 int closeFile(File *file)
2239 #if defined(PLATFORM_ANDROID)
2240 if (file->asset_file)
2241 result = SDL_RWclose(file->asset_file);
2245 result = fclose(file->file);
2247 checked_free(file->filename);
2253 int checkEndOfFile(File *file)
2255 #if defined(PLATFORM_ANDROID)
2256 if (file->file_is_asset)
2257 return file->end_of_file;
2260 return feof(file->file);
2263 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2265 #if defined(PLATFORM_ANDROID)
2266 if (file->file_is_asset)
2268 if (file->end_of_file)
2271 size_t num_items_read =
2272 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2274 if (num_items_read < num_items)
2275 file->end_of_file = TRUE;
2277 return num_items_read;
2281 return fread(buffer, item_size, num_items, file->file);
2284 int seekFile(File *file, long offset, int whence)
2286 #if defined(PLATFORM_ANDROID)
2287 if (file->file_is_asset)
2289 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2290 whence == SEEK_CUR ? RW_SEEK_CUR :
2291 whence == SEEK_END ? RW_SEEK_END : 0);
2293 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2297 return fseek(file->file, offset, whence);
2300 int getByteFromFile(File *file)
2302 #if defined(PLATFORM_ANDROID)
2303 if (file->file_is_asset)
2305 if (file->end_of_file)
2309 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2311 if (num_bytes_read < 1)
2312 file->end_of_file = TRUE;
2314 return (file->end_of_file ? EOF : (int)c);
2318 return fgetc(file->file);
2321 char *getStringFromFile(File *file, char *line, int size)
2323 #if defined(PLATFORM_ANDROID)
2324 if (file->file_is_asset)
2326 if (file->end_of_file)
2329 char *line_ptr = line;
2330 int num_bytes_read = 0;
2332 while (num_bytes_read < size - 1 &&
2333 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2334 *line_ptr++ != '\n')
2339 if (strlen(line) == 0)
2341 file->end_of_file = TRUE;
2350 return fgets(line, size, file->file);
2354 /* ------------------------------------------------------------------------- */
2355 /* functions for directory handling */
2356 /* ------------------------------------------------------------------------- */
2358 Directory *openDirectory(char *dir_name)
2360 Directory *dir = checked_calloc(sizeof(Directory));
2362 dir->dir = opendir(dir_name);
2364 if (dir->dir != NULL)
2366 dir->filename = getStringCopy(dir_name);
2371 #if defined(PLATFORM_ANDROID)
2372 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2374 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2376 checked_free(asset_toc_filename);
2378 if (dir->asset_toc_file != NULL)
2380 dir->directory_is_asset = TRUE;
2381 dir->filename = getStringCopy(dir_name);
2392 int closeDirectory(Directory *dir)
2399 #if defined(PLATFORM_ANDROID)
2400 if (dir->asset_toc_file)
2401 result = SDL_RWclose(dir->asset_toc_file);
2405 result = closedir(dir->dir);
2408 freeDirectoryEntry(dir->dir_entry);
2410 checked_free(dir->filename);
2416 DirectoryEntry *readDirectory(Directory *dir)
2419 freeDirectoryEntry(dir->dir_entry);
2421 dir->dir_entry = NULL;
2423 #if defined(PLATFORM_ANDROID)
2424 if (dir->directory_is_asset)
2426 char line[MAX_LINE_LEN];
2427 char *line_ptr = line;
2428 int num_bytes_read = 0;
2430 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2431 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2440 if (strlen(line) == 0)
2443 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2445 dir->dir_entry->is_directory = FALSE;
2446 if (line[strlen(line) - 1] == '/')
2448 dir->dir_entry->is_directory = TRUE;
2450 line[strlen(line) - 1] = '\0';
2453 dir->dir_entry->basename = getStringCopy(line);
2454 dir->dir_entry->filename = getPath2(dir->filename, line);
2456 return dir->dir_entry;
2460 struct dirent *dir_entry = readdir(dir->dir);
2462 if (dir_entry == NULL)
2465 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2467 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2468 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2470 struct stat file_status;
2472 dir->dir_entry->is_directory =
2473 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2474 S_ISDIR(file_status.st_mode));
2476 return dir->dir_entry;
2479 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2481 if (dir_entry == NULL)
2484 checked_free(dir_entry->basename);
2485 checked_free(dir_entry->filename);
2486 checked_free(dir_entry);
2490 /* ------------------------------------------------------------------------- */
2491 /* functions for checking files and filenames */
2492 /* ------------------------------------------------------------------------- */
2494 boolean directoryExists(char *dir_name)
2496 if (dir_name == NULL)
2499 struct stat file_status;
2500 boolean success = (stat(dir_name, &file_status) == 0 &&
2501 S_ISDIR(file_status.st_mode));
2503 #if defined(PLATFORM_ANDROID)
2506 // this might be an asset directory; check by trying to open toc file
2507 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2508 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2510 checked_free(asset_toc_filename);
2512 success = (file != NULL);
2522 boolean fileExists(char *filename)
2524 if (filename == NULL)
2527 boolean success = (access(filename, F_OK) == 0);
2529 #if defined(PLATFORM_ANDROID)
2532 // this might be an asset file; check by trying to open it
2533 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2535 success = (file != NULL);
2545 boolean fileHasPrefix(char *basename, char *prefix)
2547 static char *basename_lower = NULL;
2548 int basename_length, prefix_length;
2550 checked_free(basename_lower);
2552 if (basename == NULL || prefix == NULL)
2555 basename_lower = getStringToLower(basename);
2556 basename_length = strlen(basename_lower);
2557 prefix_length = strlen(prefix);
2559 if (basename_length > prefix_length + 1 &&
2560 basename_lower[prefix_length] == '.' &&
2561 strncmp(basename_lower, prefix, prefix_length) == 0)
2567 boolean fileHasSuffix(char *basename, char *suffix)
2569 static char *basename_lower = NULL;
2570 int basename_length, suffix_length;
2572 checked_free(basename_lower);
2574 if (basename == NULL || suffix == NULL)
2577 basename_lower = getStringToLower(basename);
2578 basename_length = strlen(basename_lower);
2579 suffix_length = strlen(suffix);
2581 if (basename_length > suffix_length + 1 &&
2582 basename_lower[basename_length - suffix_length - 1] == '.' &&
2583 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2589 static boolean FileCouldBeArtwork(char *filename)
2591 char *basename = getBaseNamePtr(filename);
2593 return (!strEqual(basename, ".") &&
2594 !strEqual(basename, "..") &&
2595 !fileHasSuffix(basename, "txt") &&
2596 !fileHasSuffix(basename, "conf") &&
2597 !directoryExists(filename));
2600 boolean FileIsGraphic(char *filename)
2602 return FileCouldBeArtwork(filename);
2605 boolean FileIsSound(char *filename)
2607 return FileCouldBeArtwork(filename);
2610 boolean FileIsMusic(char *filename)
2612 return FileCouldBeArtwork(filename);
2615 boolean FileIsArtworkType(char *filename, int type)
2617 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2618 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2619 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2625 /* ------------------------------------------------------------------------- */
2626 /* functions for loading artwork configuration information */
2627 /* ------------------------------------------------------------------------- */
2629 char *get_mapped_token(char *token)
2631 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2632 static char *map_token_prefix[][2] =
2634 { "char_procent", "char_percent" },
2639 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2641 int len_token_prefix = strlen(map_token_prefix[i][0]);
2643 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2644 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2647 // change tokens containing ".gfx" by moving the "gfx" part to the very left
2648 char *gfx_substring = ".gfx";
2649 char *gfx_prefix = "gfx.";
2650 if (strstr(token, gfx_substring) != NULL)
2652 char *token_prefix = getStringCopy(token);
2653 char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2654 char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2657 // cut off token string at ".gfx" substring position
2658 *token_gfx_pos = '\0';
2660 // put together prefix "gfx." and token prefix and suffix without ".gfx"
2661 mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2665 return mapped_token;
2671 char *get_special_base_token(struct ArtworkListInfo *artwork_info, char *token)
2673 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2674 static struct ConfigTypeInfo prefix_list[] =
2676 { "global.anim_1" },
2677 { "global.anim_2" },
2678 { "global.anim_3" },
2679 { "global.anim_4" },
2680 { "global.anim_5" },
2681 { "global.anim_6" },
2682 { "global.anim_7" },
2683 { "global.anim_8" },
2684 { "global.anim_9" },
2685 { "global.anim_10" },
2686 { "global.anim_11" },
2687 { "global.anim_12" },
2688 { "global.anim_13" },
2689 { "global.anim_14" },
2690 { "global.anim_15" },
2691 { "global.anim_16" },
2692 { "global.anim_17" },
2693 { "global.anim_18" },
2694 { "global.anim_19" },
2695 { "global.anim_20" },
2696 { "global.anim_21" },
2697 { "global.anim_22" },
2698 { "global.anim_23" },
2699 { "global.anim_24" },
2700 { "global.anim_25" },
2701 { "global.anim_26" },
2702 { "global.anim_27" },
2703 { "global.anim_28" },
2704 { "global.anim_29" },
2705 { "global.anim_30" },
2706 { "global.anim_31" },
2707 { "global.anim_32" },
2711 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2712 boolean prefix_found = FALSE;
2716 /* search for prefix to check if base token has to be created */
2717 for (i = 0; prefix_list[i].token != NULL; i++)
2718 if (strPrefix(token, prefix_list[i].token))
2719 prefix_found = TRUE;
2724 /* search for suffix (parameter) to determine base token length */
2725 for (i = 0; suffix_list[i].token != NULL; i++)
2726 if (strSuffix(token, suffix_list[i].token))
2727 len_suffix = strlen(suffix_list[i].token);
2729 return getStringCopyN(token, strlen(token) - len_suffix);
2732 /* This function checks if a string <s> of the format "string1, string2, ..."
2733 exactly contains a string <s_contained>. */
2735 static boolean string_has_parameter(char *s, char *s_contained)
2739 if (s == NULL || s_contained == NULL)
2742 if (strlen(s_contained) > strlen(s))
2745 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2747 char next_char = s[strlen(s_contained)];
2749 /* check if next character is delimiter or whitespace */
2750 return (next_char == ',' || next_char == '\0' ||
2751 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2754 /* check if string contains another parameter string after a comma */
2755 substring = strchr(s, ',');
2756 if (substring == NULL) /* string does not contain a comma */
2759 /* advance string pointer to next character after the comma */
2762 /* skip potential whitespaces after the comma */
2763 while (*substring == ' ' || *substring == '\t')
2766 return string_has_parameter(substring, s_contained);
2769 int get_anim_parameter_value(char *s)
2771 char *pattern_1 = "click:anim_";
2772 char *pattern_2 = ".part_";
2773 char *matching_char = NULL;
2775 int result = ANIM_EVENT_NONE;
2777 matching_char = strstr(s_ptr, pattern_1);
2778 if (matching_char == NULL)
2779 return ANIM_EVENT_NONE;
2781 s_ptr = matching_char + strlen(pattern_1);
2783 // check for main animation number ("anim_X" or "anim_XX")
2784 if (*s_ptr >= '0' && *s_ptr <= '9')
2786 int gic_anim_nr = (*s_ptr++ - '0');
2788 if (*s_ptr >= '0' && *s_ptr <= '9')
2789 gic_anim_nr = 10 * gic_anim_nr + (*s_ptr++ - '0');
2791 if (gic_anim_nr < 1 || gic_anim_nr > MAX_GLOBAL_ANIMS)
2792 return ANIM_EVENT_NONE;
2794 result |= gic_anim_nr << ANIM_EVENT_ANIM_BIT;
2798 // invalid main animation number specified
2800 return ANIM_EVENT_NONE;
2803 // check for animation part number ("part_X" or "part_XX") (optional)
2804 if (strPrefix(s_ptr, pattern_2))
2806 s_ptr += strlen(pattern_2);
2808 if (*s_ptr >= '0' && *s_ptr <= '9')
2810 int gic_part_nr = (*s_ptr++ - '0');
2812 if (*s_ptr >= '0' && *s_ptr <= '9')
2813 gic_part_nr = 10 * gic_part_nr + (*s_ptr++ - '0');
2815 if (gic_part_nr < 1 || gic_part_nr > MAX_GLOBAL_ANIM_PARTS)
2816 return ANIM_EVENT_NONE;
2818 result |= gic_part_nr << ANIM_EVENT_PART_BIT;
2822 // invalid animation part number specified
2824 return ANIM_EVENT_NONE;
2828 /* discard result if next character is neither delimiter nor whitespace */
2829 if (!(*s_ptr == ',' || *s_ptr == '\0' ||
2830 *s_ptr == ' ' || *s_ptr == '\t'))
2831 return ANIM_EVENT_NONE;
2836 int get_parameter_value(char *value_raw, char *suffix, int type)
2838 char *value = getStringToLower(value_raw);
2839 int result = 0; /* probably a save default value */
2841 if (strEqual(suffix, ".direction"))
2843 result = (strEqual(value, "left") ? MV_LEFT :
2844 strEqual(value, "right") ? MV_RIGHT :
2845 strEqual(value, "up") ? MV_UP :
2846 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2848 else if (strEqual(suffix, ".position"))
2850 result = (strEqual(value, "left") ? POS_LEFT :
2851 strEqual(value, "right") ? POS_RIGHT :
2852 strEqual(value, "top") ? POS_TOP :
2853 strEqual(value, "upper") ? POS_UPPER :
2854 strEqual(value, "middle") ? POS_MIDDLE :
2855 strEqual(value, "lower") ? POS_LOWER :
2856 strEqual(value, "bottom") ? POS_BOTTOM :
2857 strEqual(value, "any") ? POS_ANY :
2858 strEqual(value, "last") ? POS_LAST : POS_UNDEFINED);
2860 else if (strEqual(suffix, ".align"))
2862 result = (strEqual(value, "left") ? ALIGN_LEFT :
2863 strEqual(value, "right") ? ALIGN_RIGHT :
2864 strEqual(value, "center") ? ALIGN_CENTER :
2865 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2867 else if (strEqual(suffix, ".valign"))
2869 result = (strEqual(value, "top") ? VALIGN_TOP :
2870 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2871 strEqual(value, "middle") ? VALIGN_MIDDLE :
2872 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2874 else if (strEqual(suffix, ".anim_mode"))
2876 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2877 string_has_parameter(value, "loop") ? ANIM_LOOP :
2878 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2879 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2880 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2881 string_has_parameter(value, "random") ? ANIM_RANDOM :
2882 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2883 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2884 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2885 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2886 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2887 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2888 string_has_parameter(value, "all") ? ANIM_ALL :
2891 if (string_has_parameter(value, "once"))
2892 result |= ANIM_ONCE;
2894 if (string_has_parameter(value, "reverse"))
2895 result |= ANIM_REVERSE;
2897 if (string_has_parameter(value, "opaque_player"))
2898 result |= ANIM_OPAQUE_PLAYER;
2900 if (string_has_parameter(value, "static_panel"))
2901 result |= ANIM_STATIC_PANEL;
2903 else if (strEqual(suffix, ".init_event") ||
2904 strEqual(suffix, ".anim_event"))
2906 result = ANIM_EVENT_DEFAULT;
2908 if (string_has_parameter(value, "any"))
2909 result |= ANIM_EVENT_ANY;
2911 if (string_has_parameter(value, "click"))
2912 result |= ANIM_EVENT_SELF;
2914 // add optional "click:anim_X" or "click:anim_X.part_X" parameter
2915 result |= get_anim_parameter_value(value);
2917 else if (strEqual(suffix, ".class"))
2919 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2920 get_hash_from_key(value));
2922 else if (strEqual(suffix, ".style"))
2924 result = STYLE_DEFAULT;
2926 if (string_has_parameter(value, "accurate_borders"))
2927 result |= STYLE_ACCURATE_BORDERS;
2929 if (string_has_parameter(value, "inner_corners"))
2930 result |= STYLE_INNER_CORNERS;
2932 if (string_has_parameter(value, "reverse"))
2933 result |= STYLE_REVERSE;
2935 else if (strEqual(suffix, ".fade_mode"))
2937 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2938 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2939 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2940 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2941 string_has_parameter(value, "curtain") ? FADE_MODE_CURTAIN :
2944 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2946 result = gfx.get_font_from_token_function(value);
2948 else /* generic parameter of type integer or boolean */
2950 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2951 type == TYPE_INTEGER ? get_integer_from_string(value) :
2952 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2953 ARG_UNDEFINED_VALUE);
2961 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2962 struct ListNodeInfo ***, int *);
2964 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2965 struct ConfigTypeInfo *suffix_list,
2966 char **ignore_tokens,
2967 int num_file_list_entries)
2969 SetupFileHash *ignore_tokens_hash;
2970 struct FileInfo *file_list;
2971 int num_file_list_entries_found = 0;
2972 int num_suffix_list_entries = 0;
2976 /* create hash from list of tokens to be ignored (for quick access) */
2977 ignore_tokens_hash = newSetupFileHash();
2978 for (i = 0; ignore_tokens[i] != NULL; i++)
2979 setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2981 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2983 for (i = 0; suffix_list[i].token != NULL; i++)
2984 num_suffix_list_entries++;
2986 /* always start with reliable default values */
2987 for (i = 0; i < num_file_list_entries; i++)
2989 file_list[i].token = NULL;
2991 file_list[i].default_filename = NULL;
2992 file_list[i].filename = NULL;
2994 if (num_suffix_list_entries > 0)
2996 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2998 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2999 file_list[i].parameter = checked_calloc(parameter_array_size);
3001 for (j = 0; j < num_suffix_list_entries; j++)
3003 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3004 setString(&file_list[i].parameter[j], suffix_list[j].value);
3007 file_list[i].redefined = FALSE;
3008 file_list[i].fallback_to_default = FALSE;
3009 file_list[i].default_is_cloned = FALSE;
3015 for (i = 0; config_list[i].token != NULL; i++)
3017 int len_config_token = strlen(config_list[i].token);
3018 boolean is_file_entry = TRUE;
3020 for (j = 0; suffix_list[j].token != NULL; j++)
3022 int len_suffix = strlen(suffix_list[j].token);
3024 if (len_suffix < len_config_token &&
3025 strEqual(&config_list[i].token[len_config_token - len_suffix],
3026 suffix_list[j].token))
3028 setString(&file_list[list_pos].default_parameter[j],
3029 config_list[i].value);
3031 is_file_entry = FALSE;
3037 /* the following tokens are no file definitions, but other config tokens */
3038 if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3039 is_file_entry = FALSE;
3046 if (list_pos >= num_file_list_entries)
3049 file_list[list_pos].token = config_list[i].token;
3050 file_list[list_pos].default_filename = config_list[i].value;
3053 if (strSuffix(config_list[i].token, ".clone_from"))
3054 file_list[list_pos].default_is_cloned = TRUE;
3057 num_file_list_entries_found = list_pos + 1;
3058 if (num_file_list_entries_found != num_file_list_entries)
3060 Error(ERR_INFO_LINE, "-");
3061 Error(ERR_INFO, "inconsistant config list information:");
3062 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
3063 num_file_list_entries);
3064 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
3065 num_file_list_entries_found);
3066 Error(ERR_EXIT, "please fix");
3069 freeSetupFileHash(ignore_tokens_hash);
3074 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3076 int len_token = strlen(token);
3077 int len_suffix = strlen(suffix);
3079 if (start_pos < 0) /* compare suffix from end of string */
3080 start_pos += len_token;
3082 if (start_pos < 0 || start_pos + len_suffix > len_token)
3085 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3088 if (token[start_pos + len_suffix] == '\0')
3091 if (token[start_pos + len_suffix] == '.')
3097 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
3099 static void read_token_parameters(SetupFileHash *setup_file_hash,
3100 struct ConfigTypeInfo *suffix_list,
3101 struct FileInfo *file_list_entry)
3103 /* check for config token that is the base token without any suffixes */
3104 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3105 char *known_token_value = KNOWN_TOKEN_VALUE;
3108 if (filename != NULL)
3110 setString(&file_list_entry->filename, filename);
3112 /* when file definition found, set all parameters to default values */
3113 for (i = 0; suffix_list[i].token != NULL; i++)
3114 setString(&file_list_entry->parameter[i], suffix_list[i].value);
3116 file_list_entry->redefined = TRUE;
3118 /* mark config file token as well known from default config */
3119 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3122 /* check for config tokens that can be build by base token and suffixes */
3123 for (i = 0; suffix_list[i].token != NULL; i++)
3125 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3126 char *value = getHashEntry(setup_file_hash, token);
3130 setString(&file_list_entry->parameter[i], value);
3132 /* mark config file token as well known from default config */
3133 setHashEntry(setup_file_hash, token, known_token_value);
3140 static void add_dynamic_file_list_entry(struct FileInfo **list,
3141 int *num_list_entries,
3142 SetupFileHash *extra_file_hash,
3143 struct ConfigTypeInfo *suffix_list,
3144 int num_suffix_list_entries,
3147 struct FileInfo *new_list_entry;
3148 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3150 (*num_list_entries)++;
3151 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3152 new_list_entry = &(*list)[*num_list_entries - 1];
3154 new_list_entry->token = getStringCopy(token);
3155 new_list_entry->default_filename = NULL;
3156 new_list_entry->filename = NULL;
3157 new_list_entry->parameter = checked_calloc(parameter_array_size);
3159 new_list_entry->redefined = FALSE;
3160 new_list_entry->fallback_to_default = FALSE;
3161 new_list_entry->default_is_cloned = FALSE;
3163 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3166 static void add_property_mapping(struct PropertyMapping **list,
3167 int *num_list_entries,
3168 int base_index, int ext1_index,
3169 int ext2_index, int ext3_index,
3172 struct PropertyMapping *new_list_entry;
3174 (*num_list_entries)++;
3175 *list = checked_realloc(*list,
3176 *num_list_entries * sizeof(struct PropertyMapping));
3177 new_list_entry = &(*list)[*num_list_entries - 1];
3179 new_list_entry->base_index = base_index;
3180 new_list_entry->ext1_index = ext1_index;
3181 new_list_entry->ext2_index = ext2_index;
3182 new_list_entry->ext3_index = ext3_index;
3184 new_list_entry->artwork_index = artwork_index;
3187 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3190 struct FileInfo *file_list = artwork_info->file_list;
3191 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3192 char **base_prefixes = artwork_info->base_prefixes;
3193 char **ext1_suffixes = artwork_info->ext1_suffixes;
3194 char **ext2_suffixes = artwork_info->ext2_suffixes;
3195 char **ext3_suffixes = artwork_info->ext3_suffixes;
3196 char **ignore_tokens = artwork_info->ignore_tokens;
3197 int num_file_list_entries = artwork_info->num_file_list_entries;
3198 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3199 int num_base_prefixes = artwork_info->num_base_prefixes;
3200 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3201 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3202 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3203 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3204 SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3205 SetupFileHash *extra_file_hash, *empty_file_hash;
3206 char *known_token_value = KNOWN_TOKEN_VALUE;
3207 char *base_token_value = UNDEFINED_FILENAME;
3210 if (filename == NULL)
3213 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3216 /* separate valid (defined) from empty (undefined) config token values */
3217 valid_file_hash = newSetupFileHash();
3218 empty_file_hash = newSetupFileHash();
3219 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3221 char *value = HASH_ITERATION_VALUE(itr);
3223 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3224 HASH_ITERATION_TOKEN(itr), value);
3226 END_HASH_ITERATION(setup_file_hash, itr)
3228 /* at this point, we do not need the setup file hash anymore -- free it */
3229 freeSetupFileHash(setup_file_hash);
3231 /* prevent changing hash while iterating over it by using a temporary copy */
3232 valid_file_hash_tmp = newSetupFileHash();
3233 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3235 setHashEntry(valid_file_hash_tmp,
3236 HASH_ITERATION_TOKEN(itr),
3237 HASH_ITERATION_VALUE(itr));
3239 END_HASH_ITERATION(valid_file_hash, itr)
3241 /* (iterate over same temporary hash, as modifications are independent) */
3243 /* map deprecated to current tokens (using prefix match and replace) */
3244 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3246 char *token = HASH_ITERATION_TOKEN(itr);
3247 char *mapped_token = get_mapped_token(token);
3249 if (mapped_token != NULL)
3251 char *value = HASH_ITERATION_VALUE(itr);
3253 /* add mapped token */
3254 setHashEntry(valid_file_hash, mapped_token, value);
3256 /* ignore old token (by setting it to "known" keyword) */
3257 setHashEntry(valid_file_hash, token, known_token_value);
3262 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3264 /* add special base tokens (using prefix match and replace) */
3265 BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3267 char *token = HASH_ITERATION_TOKEN(itr);
3268 char *base_token = get_special_base_token(artwork_info, token);
3270 if (base_token != NULL)
3272 /* add base token only if it does not already exist */
3273 if (getHashEntry(valid_file_hash, base_token) == NULL)
3274 setHashEntry(valid_file_hash, base_token, base_token_value);
3279 END_HASH_ITERATION(valid_file_hash_tmp, itr)
3281 /* free temporary hash used for iteration */
3282 freeSetupFileHash(valid_file_hash_tmp);
3284 /* read parameters for all known config file tokens */
3285 for (i = 0; i < num_file_list_entries; i++)
3286 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3288 /* set all tokens that can be ignored here to "known" keyword */
3289 for (i = 0; i < num_ignore_tokens; i++)
3290 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3292 /* copy all unknown config file tokens to extra config hash */
3293 extra_file_hash = newSetupFileHash();
3294 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3296 char *value = HASH_ITERATION_VALUE(itr);
3298 if (!strEqual(value, known_token_value))
3299 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3301 END_HASH_ITERATION(valid_file_hash, itr)
3303 /* at this point, we do not need the valid file hash anymore -- free it */
3304 freeSetupFileHash(valid_file_hash);
3306 /* now try to determine valid, dynamically defined config tokens */
3308 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3310 struct FileInfo **dynamic_file_list =
3311 &artwork_info->dynamic_file_list;
3312 int *num_dynamic_file_list_entries =
3313 &artwork_info->num_dynamic_file_list_entries;
3314 struct PropertyMapping **property_mapping =
3315 &artwork_info->property_mapping;
3316 int *num_property_mapping_entries =
3317 &artwork_info->num_property_mapping_entries;
3318 int current_summarized_file_list_entry =
3319 artwork_info->num_file_list_entries +
3320 artwork_info->num_dynamic_file_list_entries;
3321 char *token = HASH_ITERATION_TOKEN(itr);
3322 int len_token = strlen(token);
3324 boolean base_prefix_found = FALSE;
3325 boolean parameter_suffix_found = FALSE;
3327 /* skip all parameter definitions (handled by read_token_parameters()) */
3328 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3330 int len_suffix = strlen(suffix_list[i].token);
3332 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3333 parameter_suffix_found = TRUE;
3336 if (parameter_suffix_found)
3339 /* ---------- step 0: search for matching base prefix ---------- */
3342 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3344 char *base_prefix = base_prefixes[i];
3345 int len_base_prefix = strlen(base_prefix);
3346 boolean ext1_suffix_found = FALSE;
3347 boolean ext2_suffix_found = FALSE;
3348 boolean ext3_suffix_found = FALSE;
3349 boolean exact_match = FALSE;
3350 int base_index = -1;
3351 int ext1_index = -1;
3352 int ext2_index = -1;
3353 int ext3_index = -1;
3355 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3357 if (!base_prefix_found)
3362 if (start_pos + len_base_prefix == len_token) /* exact match */
3366 add_dynamic_file_list_entry(dynamic_file_list,
3367 num_dynamic_file_list_entries,
3370 num_suffix_list_entries,
3372 add_property_mapping(property_mapping,
3373 num_property_mapping_entries,
3374 base_index, -1, -1, -1,
3375 current_summarized_file_list_entry);
3379 /* ---------- step 1: search for matching first suffix ---------- */
3381 start_pos += len_base_prefix;
3382 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3384 char *ext1_suffix = ext1_suffixes[j];
3385 int len_ext1_suffix = strlen(ext1_suffix);
3387 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3389 if (!ext1_suffix_found)
3394 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3398 add_dynamic_file_list_entry(dynamic_file_list,
3399 num_dynamic_file_list_entries,
3402 num_suffix_list_entries,
3404 add_property_mapping(property_mapping,
3405 num_property_mapping_entries,
3406 base_index, ext1_index, -1, -1,
3407 current_summarized_file_list_entry);
3411 start_pos += len_ext1_suffix;
3417 /* ---------- step 2: search for matching second suffix ---------- */
3419 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3421 char *ext2_suffix = ext2_suffixes[k];
3422 int len_ext2_suffix = strlen(ext2_suffix);
3424 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3426 if (!ext2_suffix_found)
3431 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3435 add_dynamic_file_list_entry(dynamic_file_list,
3436 num_dynamic_file_list_entries,
3439 num_suffix_list_entries,
3441 add_property_mapping(property_mapping,
3442 num_property_mapping_entries,
3443 base_index, ext1_index, ext2_index, -1,
3444 current_summarized_file_list_entry);
3448 start_pos += len_ext2_suffix;
3454 /* ---------- step 3: search for matching third suffix ---------- */
3456 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3458 char *ext3_suffix = ext3_suffixes[l];
3459 int len_ext3_suffix = strlen(ext3_suffix);
3461 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3463 if (!ext3_suffix_found)
3468 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3472 add_dynamic_file_list_entry(dynamic_file_list,
3473 num_dynamic_file_list_entries,
3476 num_suffix_list_entries,
3478 add_property_mapping(property_mapping,
3479 num_property_mapping_entries,
3480 base_index, ext1_index, ext2_index, ext3_index,
3481 current_summarized_file_list_entry);
3487 END_HASH_ITERATION(extra_file_hash, itr)
3489 if (artwork_info->num_dynamic_file_list_entries > 0)
3491 artwork_info->dynamic_artwork_list =
3492 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3493 artwork_info->sizeof_artwork_list_entry);
3496 if (options.verbose && IS_PARENT_PROCESS())
3498 SetupFileList *setup_file_list, *list;
3499 boolean dynamic_tokens_found = FALSE;
3500 boolean unknown_tokens_found = FALSE;
3501 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3503 /* list may be NULL for empty artwork config files */
3504 setup_file_list = loadSetupFileList(filename);
3506 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3508 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3509 dynamic_tokens_found = TRUE;
3511 unknown_tokens_found = TRUE;
3513 END_HASH_ITERATION(extra_file_hash, itr)
3515 if (options.debug && dynamic_tokens_found)
3517 Error(ERR_INFO_LINE, "-");
3518 Error(ERR_INFO, "dynamic token(s) found in config file:");
3519 Error(ERR_INFO, "- config file: '%s'", filename);
3521 for (list = setup_file_list; list != NULL; list = list->next)
3523 char *value = getHashEntry(extra_file_hash, list->token);
3525 if (value != NULL && strEqual(value, known_token_value))
3526 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3529 Error(ERR_INFO_LINE, "-");
3532 if (unknown_tokens_found)
3534 Error(ERR_INFO_LINE, "-");
3535 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3536 Error(ERR_INFO, "- config file: '%s'", filename);
3538 for (list = setup_file_list; list != NULL; list = list->next)
3540 char *value = getHashEntry(extra_file_hash, list->token);
3542 if (value != NULL && !strEqual(value, known_token_value))
3543 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3546 Error(ERR_INFO_LINE, "-");
3549 if (undefined_values_found)
3551 Error(ERR_INFO_LINE, "-");
3552 Error(ERR_INFO, "warning: undefined values found in config file:");
3553 Error(ERR_INFO, "- config file: '%s'", filename);
3555 for (list = setup_file_list; list != NULL; list = list->next)
3557 char *value = getHashEntry(empty_file_hash, list->token);
3560 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3563 Error(ERR_INFO_LINE, "-");
3566 freeSetupFileList(setup_file_list);
3569 freeSetupFileHash(extra_file_hash);
3570 freeSetupFileHash(empty_file_hash);
3573 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3575 struct FileInfo *file_list = artwork_info->file_list;
3576 int num_file_list_entries = artwork_info->num_file_list_entries;
3577 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3578 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3581 DrawInitText("Loading artwork config", 120, FC_GREEN);
3582 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3584 /* always start with reliable default values */
3585 for (i = 0; i < num_file_list_entries; i++)
3587 setString(&file_list[i].filename, file_list[i].default_filename);
3589 for (j = 0; j < num_suffix_list_entries; j++)
3590 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3592 file_list[i].redefined = FALSE;
3593 file_list[i].fallback_to_default = FALSE;
3596 /* free previous dynamic artwork file array */
3597 if (artwork_info->dynamic_file_list != NULL)
3599 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3601 free(artwork_info->dynamic_file_list[i].token);
3602 free(artwork_info->dynamic_file_list[i].filename);
3603 free(artwork_info->dynamic_file_list[i].parameter);
3606 free(artwork_info->dynamic_file_list);
3607 artwork_info->dynamic_file_list = NULL;
3609 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3610 &artwork_info->num_dynamic_file_list_entries);
3613 /* free previous property mapping */
3614 if (artwork_info->property_mapping != NULL)
3616 free(artwork_info->property_mapping);
3618 artwork_info->property_mapping = NULL;
3619 artwork_info->num_property_mapping_entries = 0;
3622 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3624 /* first look for special artwork configured in level series config */
3625 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3627 if (fileExists(filename_base))
3628 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3631 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3633 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3634 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3637 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3638 struct ListNodeInfo **listnode)
3642 char *filename = (*listnode)->source_filename;
3644 if (--(*listnode)->num_references <= 0)
3645 deleteNodeFromList(&artwork_info->content_list, filename,
3646 artwork_info->free_artwork);
3652 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3653 struct ListNodeInfo **listnode,
3654 struct FileInfo *file_list_entry)
3664 char *basename = file_list_entry->filename;
3665 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3667 if (filename == NULL)
3669 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3671 basename = file_list_entry->default_filename;
3673 /* fail for cloned default artwork that has no default filename defined */
3674 if (file_list_entry->default_is_cloned &&
3675 strEqual(basename, UNDEFINED_FILENAME))
3677 int error_mode = ERR_WARN;
3679 /* we can get away without sounds and music, but not without graphics */
3680 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3681 error_mode = ERR_EXIT;
3683 Error(error_mode, "token '%s' was cloned and has no default filename",
3684 file_list_entry->token);
3689 /* dynamic artwork has no default filename / skip empty default artwork */
3690 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3693 file_list_entry->fallback_to_default = TRUE;
3695 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3697 filename = getCustomArtworkFilename(basename, artwork_info->type);
3699 if (filename == NULL)
3701 int error_mode = ERR_WARN;
3703 /* we can get away without sounds and music, but not without graphics */
3704 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3705 error_mode = ERR_EXIT;
3707 Error(error_mode, "cannot find default artwork file '%s'", basename);
3713 /* check if the old and the new artwork file are the same */
3714 if (*listnode && strEqual((*listnode)->source_filename, filename))
3716 /* The old and new artwork are the same (have the same filename and path).
3717 This usually means that this artwork does not exist in this artwork set
3718 and a fallback to the existing artwork is done. */
3723 /* delete existing artwork file entry */
3724 deleteArtworkListEntry(artwork_info, listnode);
3726 /* check if the new artwork file already exists in the list of artwork */
3727 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3729 *listnode = (struct ListNodeInfo *)node->content;
3730 (*listnode)->num_references++;
3735 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3736 DrawInitText(basename, 150, FC_YELLOW);
3738 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3740 /* add new artwork file entry to the list of artwork files */
3741 (*listnode)->num_references = 1;
3742 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3747 int error_mode = ERR_WARN;
3749 /* we can get away without sounds and music, but not without graphics */
3750 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3751 error_mode = ERR_EXIT;
3753 Error(error_mode, "cannot load artwork file '%s'", basename);
3759 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3760 struct ListNodeInfo **listnode,
3761 struct FileInfo *file_list_entry)
3763 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3765 deleteArtworkListEntry(artwork_info, listnode);
3770 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3773 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3775 struct FileInfo *file_list = artwork_info->file_list;
3776 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3777 int num_file_list_entries = artwork_info->num_file_list_entries;
3778 int num_dynamic_file_list_entries =
3779 artwork_info->num_dynamic_file_list_entries;
3782 print_timestamp_init("ReloadCustomArtworkList");
3784 for (i = 0; i < num_file_list_entries; i++)
3785 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3788 for (i = 0; i < num_dynamic_file_list_entries; i++)
3789 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3790 &dynamic_file_list[i]);
3792 print_timestamp_done("ReloadCustomArtworkList");
3795 dumpList(artwork_info->content_list);
3799 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3800 struct ListNodeInfo ***list,
3801 int *num_list_entries)
3808 for (i = 0; i < *num_list_entries; i++)
3809 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3813 *num_list_entries = 0;
3816 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3818 if (artwork_info == NULL)
3821 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3822 &artwork_info->num_file_list_entries);
3824 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3825 &artwork_info->num_dynamic_file_list_entries);
3829 /* ------------------------------------------------------------------------- */
3830 /* functions only needed for non-Unix (non-command-line) systems */
3831 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3832 /* (now also added for Windows, to create files in user data directory) */
3833 /* ------------------------------------------------------------------------- */
3835 char *getLogFilename(char *basename)
3837 return getPath2(getUserGameDataDir(), basename);
3844 InitUserDataDirectory();
3846 for (i = 0; i < NUM_LOGS; i++)
3848 if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3851 program.log_file[i] = program.log_file_default[i]; // reset to default
3853 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3854 program.log_filename[i], strerror(errno));
3857 /* output should be unbuffered so it is not truncated in a crash */
3858 setbuf(program.log_file[i], NULL);
3862 void CloseLogFiles()
3866 for (i = 0; i < NUM_LOGS; i++)
3867 if (program.log_file[i] != program.log_file_default[i])
3868 fclose(program.log_file[i]);
3871 void DumpLogFile(int nr)
3873 FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3875 if (log_file == NULL)
3878 while (!feof(log_file))
3879 fputc(fgetc(log_file), stdout);
3884 void NotifyUserAboutErrorFile()
3886 #if defined(PLATFORM_WIN32)
3887 char *title_text = getStringCat2(program.program_title, " Error Message");
3888 char *error_text = getStringCat2("The program was aborted due to an error; "
3889 "for details, see the following error file:"
3891 program.log_filename[LOG_ERR_ID]);
3893 MessageBox(NULL, error_text, title_text, MB_OK);
3898 /* ------------------------------------------------------------------------- */
3899 /* the following is only for debugging purpose and normally not used */
3900 /* ------------------------------------------------------------------------- */
3904 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3905 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3907 #define DEBUG_NUM_TIMESTAMPS 10
3908 #define DEBUG_TIME_IN_MICROSECONDS 0
3910 #if DEBUG_TIME_IN_MICROSECONDS
3911 static double Counter_Microseconds()
3913 static struct timeval base_time = { 0, 0 };
3914 struct timeval current_time;
3917 gettimeofday(¤t_time, NULL);
3919 /* reset base time in case of wrap-around */
3920 if (current_time.tv_sec < base_time.tv_sec)
3921 base_time = current_time;
3924 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3925 ((double)(current_time.tv_usec - base_time.tv_usec));
3927 return counter; /* return microseconds since last init */
3931 char *debug_print_timestamp_get_padding(int padding_size)
3933 static char *padding = NULL;
3934 int max_padding_size = 100;
3936 if (padding == NULL)
3938 padding = checked_calloc(max_padding_size + 1);
3939 memset(padding, ' ', max_padding_size);
3942 return &padding[MAX(0, max_padding_size - padding_size)];
3945 void debug_print_timestamp(int counter_nr, char *message)
3947 int indent_size = 8;
3948 int padding_size = 40;
3949 float timestamp_interval;
3952 Error(ERR_EXIT, "debugging: invalid negative counter");
3953 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3954 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3956 #if DEBUG_TIME_IN_MICROSECONDS
3957 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3960 counter[counter_nr][0] = Counter_Microseconds();
3962 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3965 counter[counter_nr][0] = Counter();
3968 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3969 counter[counter_nr][1] = counter[counter_nr][0];
3972 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3973 debug_print_timestamp_get_padding(counter_nr * indent_size),
3975 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3976 timestamp_interval / 1000,
3980 void debug_print_parent_only(char *format, ...)
3982 if (!IS_PARENT_PROCESS())
3989 va_start(ap, format);
3990 vprintf(format, ap);
3999 void print_timestamp_ext(char *message, char *mode)
4001 #if DEBUG_PRINT_INIT_TIMESTAMPS
4002 static char *debug_message = NULL;
4003 static char *last_message = NULL;
4004 static int counter_nr = 0;
4005 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4007 checked_free(debug_message);
4008 debug_message = getStringCat3(mode, " ", message);
4010 if (strEqual(mode, "INIT"))
4012 debug_print_timestamp(counter_nr, NULL);
4014 if (counter_nr + 1 < max_depth)
4015 debug_print_timestamp(counter_nr, debug_message);
4019 debug_print_timestamp(counter_nr, NULL);
4021 else if (strEqual(mode, "DONE"))
4025 if (counter_nr + 1 < max_depth ||
4026 (counter_nr == 0 && max_depth == 1))
4028 last_message = message;
4030 if (counter_nr == 0 && max_depth == 1)
4032 checked_free(debug_message);
4033 debug_message = getStringCat3("TIME", " ", message);
4036 debug_print_timestamp(counter_nr, debug_message);
4039 else if (!strEqual(mode, "TIME") ||
4040 !strEqual(message, last_message))
4042 if (counter_nr < max_depth)
4043 debug_print_timestamp(counter_nr, debug_message);
4048 void print_timestamp_init(char *message)
4050 print_timestamp_ext(message, "INIT");
4053 void print_timestamp_time(char *message)
4055 print_timestamp_ext(message, "TIME");
4058 void print_timestamp_done(char *message)
4060 print_timestamp_ext(message, "DONE");