1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
16 #include <sys/types.h>
26 #if !defined(PLATFORM_WIN32)
28 #include <sys/param.h>
38 /* ========================================================================= */
39 /* some generic helper functions */
40 /* ========================================================================= */
42 /* ------------------------------------------------------------------------- */
43 /* platform independent wrappers for printf() et al. (newline aware) */
44 /* ------------------------------------------------------------------------- */
46 #if defined(PLATFORM_ANDROID)
47 static int android_log_prio = ANDROID_LOG_INFO;
51 static void vfPrintLog(FILE *stream, char *format, va_list ap)
55 static void vfPrintLog(FILE *stream, char *format, va_list ap)
59 static void fPrintLog(FILE *stream, char *format, va_list ap)
63 static void fPrintLog(FILE *stream, char *format, va_list ap)
68 static void vfprintf_nonewline(FILE *stream, char *format, va_list ap)
70 #if defined(PLATFORM_ANDROID)
71 // (prefix text of logging output is currently skipped on Android)
72 //__android_log_vprint(android_log_prio, program.program_title, format, ap);
77 vfprintf(stream, format, ap);
78 vfprintf(stderr, format, ap2);
84 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
86 #if defined(PLATFORM_ANDROID)
87 __android_log_vprint(android_log_prio, program.program_title, format, ap);
89 char *newline = STRING_NEWLINE;
94 vfprintf(stream, format, ap);
95 fprintf(stream, "%s", newline);
97 vfprintf(stderr, format, ap2);
98 fprintf(stderr, "%s", newline);
104 static void fprintf_nonewline(FILE *stream, char *format, ...)
108 va_start(ap, format);
109 vfprintf_nonewline(stream, format, ap);
113 static void fprintf_newline(FILE *stream, char *format, ...)
117 va_start(ap, format);
118 vfprintf_newline(stream, format, ap);
122 void fprintf_line(FILE *stream, char *line_chars, int line_length)
126 for (i = 0; i < line_length; i++)
127 fprintf_nonewline(stream, "%s", line_chars);
129 fprintf_newline(stream, "");
132 void printf_line(char *line_chars, int line_length)
134 fprintf_line(stdout, line_chars, line_length);
137 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
139 fprintf(stdout, "%s", prefix);
140 fprintf_line(stdout, line_chars, line_length);
144 /* ------------------------------------------------------------------------- */
145 /* string functions */
146 /* ------------------------------------------------------------------------- */
148 /* int2str() returns a number converted to a string;
149 the used memory is static, but will be overwritten by later calls,
150 so if you want to save the result, copy it to a private string buffer;
151 there can be 10 local calls of int2str() without buffering the result --
152 the 11th call will then destroy the result from the first call and so on.
155 char *int2str(int number, int size)
157 static char shift_array[10][40];
158 static int shift_counter = 0;
159 char *s = shift_array[shift_counter];
161 shift_counter = (shift_counter + 1) % 10;
168 sprintf(s, " %09d", number);
169 return &s[strlen(s) - size];
173 sprintf(s, "%d", number);
179 /* something similar to "int2str()" above, but allocates its own memory
180 and has a different interface; we cannot use "itoa()", because this
181 seems to be already defined when cross-compiling to the win32 target */
183 char *i_to_a(unsigned int i)
185 static char *a = NULL;
189 if (i > 2147483647) /* yes, this is a kludge */
192 a = checked_malloc(10 + 1);
200 /* calculate base-2 logarithm of argument (rounded down to integer;
201 this function returns the number of the highest bit set in argument) */
203 int log_2(unsigned int x)
209 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
216 boolean getTokenValueFromString(char *string, char **token, char **value)
218 return getTokenValueFromSetupLine(string, token, value);
222 /* ------------------------------------------------------------------------- */
223 /* counter functions */
224 /* ------------------------------------------------------------------------- */
226 /* maximal allowed length of a command line option */
227 #define MAX_OPTION_LEN 256
231 #if defined(TARGET_SDL)
232 static unsigned int getCurrentMS()
234 return SDL_GetTicks();
238 static unsigned int mainCounter(int mode)
240 static unsigned int base_ms = 0;
241 unsigned int current_ms;
243 /* get current system milliseconds */
244 current_ms = getCurrentMS();
246 /* reset base timestamp in case of counter reset or wrap-around */
247 if (mode == INIT_COUNTER || current_ms < base_ms)
248 base_ms = current_ms;
250 /* return milliseconds since last counter reset */
251 return current_ms - base_ms;
256 #if defined(TARGET_SDL)
257 static unsigned int mainCounter(int mode)
259 static unsigned int base_ms = 0;
260 unsigned int current_ms;
261 unsigned int counter_ms;
263 current_ms = SDL_GetTicks();
265 /* reset base time in case of counter initializing or wrap-around */
266 if (mode == INIT_COUNTER || current_ms < base_ms)
267 base_ms = current_ms;
269 counter_ms = current_ms - base_ms;
271 return counter_ms; /* return milliseconds since last init */
277 void InitCounter() /* set counter back to zero */
279 mainCounter(INIT_COUNTER);
282 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
284 return mainCounter(READ_COUNTER);
287 static void sleep_milliseconds(unsigned int milliseconds_delay)
289 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
293 /* we want to wait only a few ms -- if we assume that we have a
294 kernel timer resolution of 10 ms, we would wait far to long;
295 therefore it's better to do a short interval of busy waiting
296 to get our sleeping time more accurate */
298 unsigned int base_counter = Counter(), actual_counter = Counter();
300 while (actual_counter < base_counter + milliseconds_delay &&
301 actual_counter >= base_counter)
302 actual_counter = Counter();
306 #if defined(TARGET_SDL)
307 SDL_Delay(milliseconds_delay);
309 struct timeval delay;
311 delay.tv_sec = milliseconds_delay / 1000;
312 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
314 if (select(0, NULL, NULL, NULL, &delay) != 0)
315 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
320 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
322 sleep_milliseconds(delay);
325 boolean FrameReached(unsigned int *frame_counter_var,
326 unsigned int frame_delay)
328 unsigned int actual_frame_counter = FrameCounter;
330 if (actual_frame_counter >= *frame_counter_var &&
331 actual_frame_counter < *frame_counter_var + frame_delay)
334 *frame_counter_var = actual_frame_counter;
339 boolean DelayReached(unsigned int *counter_var,
342 unsigned int actual_counter = Counter();
344 if (actual_counter >= *counter_var &&
345 actual_counter < *counter_var + delay)
348 *counter_var = actual_counter;
353 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
355 unsigned int actual_counter;
359 actual_counter = Counter();
361 if (actual_counter >= *counter_var &&
362 actual_counter < *counter_var + delay)
363 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
368 *counter_var = actual_counter;
372 /* ------------------------------------------------------------------------- */
373 /* random generator functions */
374 /* ------------------------------------------------------------------------- */
376 unsigned int init_random_number(int nr, int seed)
378 if (seed == NEW_RANDOMIZE)
380 /* default random seed */
381 seed = (int)time(NULL); // seconds since the epoch
383 #if !defined(PLATFORM_WIN32)
384 /* add some more randomness */
385 struct timeval current_time;
387 gettimeofday(¤t_time, NULL);
389 seed += (int)current_time.tv_usec; // microseconds since the epoch
392 #if defined(TARGET_SDL)
393 /* add some more randomness */
394 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
398 /* add some more randomness */
399 seed += GetSimpleRandom(1000000);
403 srandom_linux_libc(nr, (unsigned int) seed);
405 return (unsigned int) seed;
408 unsigned int get_random_number(int nr, int max)
410 return (max > 0 ? random_linux_libc(nr) % max : 0);
414 /* ------------------------------------------------------------------------- */
415 /* system info functions */
416 /* ------------------------------------------------------------------------- */
418 #if !defined(PLATFORM_ANDROID)
419 static char *get_corrected_real_name(char *real_name)
421 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
422 char *from_ptr = real_name;
423 char *to_ptr = real_name_new;
425 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
426 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
428 /* the name field read from "passwd" file may also contain additional
429 user information, separated by commas, which will be removed here */
430 if (*from_ptr == ',')
433 /* the user's real name may contain 'ß' characters (german sharp s),
434 which have no equivalent in upper case letters (used by our fonts) */
435 if (*from_ptr == 'ß')
442 *to_ptr++ = *from_ptr++;
447 return real_name_new;
453 static char *login_name = NULL;
455 #if defined(PLATFORM_WIN32)
456 if (login_name == NULL)
458 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
459 login_name = checked_malloc(buffer_size);
461 if (GetUserName(login_name, &buffer_size) == 0)
462 strcpy(login_name, ANONYMOUS_NAME);
465 if (login_name == NULL)
469 if ((pwd = getpwuid(getuid())) == NULL)
470 login_name = ANONYMOUS_NAME;
472 login_name = getStringCopy(pwd->pw_name);
481 static char *real_name = NULL;
483 #if defined(PLATFORM_WIN32)
484 if (real_name == NULL)
486 static char buffer[MAX_USERNAME_LEN + 1];
487 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
489 if (GetUserName(buffer, &buffer_size) != 0)
490 real_name = get_corrected_real_name(buffer);
492 real_name = ANONYMOUS_NAME;
494 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
495 if (real_name == NULL)
499 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
500 real_name = get_corrected_real_name(pwd->pw_gecos);
502 real_name = ANONYMOUS_NAME;
505 real_name = ANONYMOUS_NAME;
511 time_t getFileTimestampEpochSeconds(char *filename)
513 struct stat file_status;
515 if (stat(filename, &file_status) != 0) /* cannot stat file */
518 return file_status.st_mtime;
522 /* ------------------------------------------------------------------------- */
523 /* path manipulation functions */
524 /* ------------------------------------------------------------------------- */
526 static char *getLastPathSeparatorPtr(char *filename)
528 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
530 if (last_separator == NULL) /* also try DOS/Windows variant */
531 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
533 return last_separator;
536 char *getBaseNamePtr(char *filename)
538 char *last_separator = getLastPathSeparatorPtr(filename);
540 if (last_separator != NULL)
541 return last_separator + 1; /* separator found: strip base path */
543 return filename; /* no separator found: filename has no path */
546 char *getBaseName(char *filename)
548 return getStringCopy(getBaseNamePtr(filename));
551 char *getBasePath(char *filename)
553 char *basepath = getStringCopy(filename);
554 char *last_separator = getLastPathSeparatorPtr(basepath);
556 if (last_separator != NULL)
557 *last_separator = '\0'; /* separator found: strip basename */
559 basepath = "."; /* no separator found: use current path */
564 static char *getProgramMainDataPath()
566 char *main_data_path = getStringCopy(program.command_basepath);
568 #if defined(PLATFORM_MACOSX)
569 static char *main_data_binary_subdir = NULL;
571 if (main_data_binary_subdir == NULL)
573 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
575 strlen(MAC_APP_BINARY_SUBDIR) + 1);
577 sprintf(main_data_binary_subdir, "%s.app/%s",
578 program.program_title, MAC_APP_BINARY_SUBDIR);
581 // cut relative path to Mac OS X application binary directory from path
582 if (strSuffix(main_data_path, main_data_binary_subdir))
583 main_data_path[strlen(main_data_path) -
584 strlen(main_data_binary_subdir)] = '\0';
586 // cut trailing path separator from path (but not if path is root directory)
587 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
588 main_data_path[strlen(main_data_path) - 1] = '\0';
591 return main_data_path;
595 /* ------------------------------------------------------------------------- */
596 /* various string functions */
597 /* ------------------------------------------------------------------------- */
599 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
601 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
604 sprintf(complete_string, "%s%s%s", s1, sep, s2);
606 return complete_string;
609 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
611 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
612 strlen(s2) + strlen(sep) +
615 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
617 return complete_string;
620 char *getStringCat2(char *s1, char *s2)
622 return getStringCat2WithSeparator(s1, s2, "");
625 char *getStringCat3(char *s1, char *s2, char *s3)
627 return getStringCat3WithSeparator(s1, s2, s3, "");
630 char *getPath2(char *path1, char *path2)
632 #if defined(PLATFORM_ANDROID)
633 // workaround for reading from APK assets directory -- skip leading "./"
634 if (strEqual(path1, "."))
635 return getStringCopy(path2);
638 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
641 char *getPath3(char *path1, char *path2, char *path3)
643 #if defined(PLATFORM_ANDROID)
644 // workaround for reading from APK assets directory -- skip leading "./"
645 if (strEqual(path1, "."))
646 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
649 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
652 char *getStringCopy(const char *s)
659 s_copy = checked_malloc(strlen(s) + 1);
665 char *getStringCopyN(const char *s, int n)
668 int s_len = MAX(0, n);
673 s_copy = checked_malloc(s_len + 1);
674 strncpy(s_copy, s, s_len);
675 s_copy[s_len] = '\0';
680 char *getStringCopyNStatic(const char *s, int n)
682 static char *s_copy = NULL;
684 checked_free(s_copy);
686 s_copy = getStringCopyN(s, n);
691 char *getStringToLower(const char *s)
693 char *s_copy = checked_malloc(strlen(s) + 1);
694 char *s_ptr = s_copy;
697 *s_ptr++ = tolower(*s++);
703 void setString(char **old_value, char *new_value)
705 checked_free(*old_value);
707 *old_value = getStringCopy(new_value);
710 boolean strEqual(char *s1, char *s2)
712 return (s1 == NULL && s2 == NULL ? TRUE :
713 s1 == NULL && s2 != NULL ? FALSE :
714 s1 != NULL && s2 == NULL ? FALSE :
715 strcmp(s1, s2) == 0);
718 boolean strEqualN(char *s1, char *s2, int n)
720 return (s1 == NULL && s2 == NULL ? TRUE :
721 s1 == NULL && s2 != NULL ? FALSE :
722 s1 != NULL && s2 == NULL ? FALSE :
723 strncmp(s1, s2, n) == 0);
726 boolean strPrefix(char *s, char *prefix)
728 return (s == NULL && prefix == NULL ? TRUE :
729 s == NULL && prefix != NULL ? FALSE :
730 s != NULL && prefix == NULL ? FALSE :
731 strncmp(s, prefix, strlen(prefix)) == 0);
734 boolean strSuffix(char *s, char *suffix)
736 return (s == NULL && suffix == NULL ? TRUE :
737 s == NULL && suffix != NULL ? FALSE :
738 s != NULL && suffix == NULL ? FALSE :
739 strlen(s) < strlen(suffix) ? FALSE :
740 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
743 boolean strPrefixLower(char *s, char *prefix)
745 char *s_lower = getStringToLower(s);
746 boolean match = strPrefix(s_lower, prefix);
753 boolean strSuffixLower(char *s, char *suffix)
755 char *s_lower = getStringToLower(s);
756 boolean match = strSuffix(s_lower, suffix);
764 /* ------------------------------------------------------------------------- */
765 /* command line option handling functions */
766 /* ------------------------------------------------------------------------- */
768 void GetOptions(char *argv[],
769 void (*print_usage_function)(void),
770 void (*print_version_function)(void))
772 char *ro_base_path = RO_BASE_PATH;
773 char *rw_base_path = RW_BASE_PATH;
774 char **options_left = &argv[1];
777 /* if the program is configured to start from current directory (default),
778 determine program package directory from program binary (some versions
779 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
780 set the current working directory to the program package directory) */
782 if (strEqual(ro_base_path, "."))
783 ro_base_path = getProgramMainDataPath();
784 if (strEqual(rw_base_path, "."))
785 rw_base_path = getProgramMainDataPath();
788 #if !defined(PLATFORM_MACOSX)
789 /* if the program is configured to start from current directory (default),
790 determine program package directory (KDE/Konqueror does not do this by
791 itself and fails otherwise); on Mac OS X, the program binary is stored
792 in an application package directory -- do not try to use this directory
793 as the program data directory (Mac OS X handles this correctly anyway) */
795 if (strEqual(ro_base_path, "."))
796 ro_base_path = program.command_basepath;
797 if (strEqual(rw_base_path, "."))
798 rw_base_path = program.command_basepath;
803 /* initialize global program options */
804 options.display_name = NULL;
805 options.server_host = NULL;
806 options.server_port = 0;
808 options.ro_base_directory = ro_base_path;
809 options.rw_base_directory = rw_base_path;
810 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
811 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
812 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
813 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
814 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
816 options.execute_command = NULL;
817 options.special_flags = NULL;
819 options.serveronly = FALSE;
820 options.network = FALSE;
821 options.verbose = FALSE;
822 options.debug = FALSE;
823 options.debug_x11_sync = FALSE;
826 options.verbose = TRUE;
828 #if !defined(PLATFORM_UNIX)
829 if (*options_left == NULL) /* no options given -- enable verbose mode */
830 options.verbose = TRUE;
834 while (*options_left)
836 char option_str[MAX_OPTION_LEN];
837 char *option = options_left[0];
838 char *next_option = options_left[1];
839 char *option_arg = NULL;
840 int option_len = strlen(option);
842 if (option_len >= MAX_OPTION_LEN)
843 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
845 strcpy(option_str, option); /* copy argument into buffer */
848 if (strEqual(option, "--")) /* stop scanning arguments */
851 if (strPrefix(option, "--")) /* treat '--' like '-' */
854 option_arg = strchr(option, '=');
855 if (option_arg == NULL) /* no '=' in option */
856 option_arg = next_option;
859 *option_arg++ = '\0'; /* cut argument from option */
860 if (*option_arg == '\0') /* no argument after '=' */
861 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
864 option_len = strlen(option);
866 if (strEqual(option, "-"))
868 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
870 else if (strncmp(option, "-help", option_len) == 0)
872 print_usage_function();
876 else if (strncmp(option, "-version", option_len) == 0 ||
877 strncmp(option, "-V", option_len) == 0)
879 print_version_function();
883 else if (strncmp(option, "-display", option_len) == 0)
885 if (option_arg == NULL)
886 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
888 options.display_name = option_arg;
889 if (option_arg == next_option)
892 else if (strncmp(option, "-basepath", option_len) == 0)
894 if (option_arg == NULL)
895 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
897 /* this should be extended to separate options for ro and rw data */
898 options.ro_base_directory = ro_base_path = option_arg;
899 options.rw_base_directory = rw_base_path = option_arg;
900 if (option_arg == next_option)
903 /* adjust paths for sub-directories in base directory accordingly */
904 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
905 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
906 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
907 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
908 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
910 else if (strncmp(option, "-levels", option_len) == 0)
912 if (option_arg == NULL)
913 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
915 options.level_directory = option_arg;
916 if (option_arg == next_option)
919 else if (strncmp(option, "-graphics", option_len) == 0)
921 if (option_arg == NULL)
922 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
924 options.graphics_directory = option_arg;
925 if (option_arg == next_option)
928 else if (strncmp(option, "-sounds", option_len) == 0)
930 if (option_arg == NULL)
931 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
933 options.sounds_directory = option_arg;
934 if (option_arg == next_option)
937 else if (strncmp(option, "-music", option_len) == 0)
939 if (option_arg == NULL)
940 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
942 options.music_directory = option_arg;
943 if (option_arg == next_option)
946 else if (strncmp(option, "-network", option_len) == 0)
948 options.network = TRUE;
950 else if (strncmp(option, "-serveronly", option_len) == 0)
952 options.serveronly = TRUE;
954 else if (strncmp(option, "-verbose", option_len) == 0)
956 options.verbose = TRUE;
958 else if (strncmp(option, "-debug", option_len) == 0)
960 options.debug = TRUE;
962 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
964 options.debug_x11_sync = TRUE;
966 else if (strPrefix(option, "-D"))
969 options.special_flags = getStringCopy(&option[2]);
971 char *flags_string = &option[2];
972 unsigned int flags_value;
974 if (*flags_string == '\0')
975 Error(ERR_EXIT_HELP, "empty flag ignored");
977 flags_value = get_special_flags_function(flags_string);
979 if (flags_value == 0)
980 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
982 options.special_flags |= flags_value;
985 else if (strncmp(option, "-execute", option_len) == 0)
987 if (option_arg == NULL)
988 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
990 options.execute_command = option_arg;
991 if (option_arg == next_option)
994 /* when doing batch processing, always enable verbose mode (warnings) */
995 options.verbose = TRUE;
997 else if (*option == '-')
999 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1001 else if (options.server_host == NULL)
1003 options.server_host = *options_left;
1005 else if (options.server_port == 0)
1007 options.server_port = atoi(*options_left);
1008 if (options.server_port < 1024)
1009 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1012 Error(ERR_EXIT_HELP, "too many arguments");
1019 /* ------------------------------------------------------------------------- */
1020 /* error handling functions */
1021 /* ------------------------------------------------------------------------- */
1023 #define MAX_INTERNAL_ERROR_SIZE 1024
1025 /* used by SetError() and GetError() to store internal error messages */
1026 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1028 void SetError(char *format, ...)
1032 va_start(ap, format);
1033 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1039 return internal_error;
1042 void Error(int mode, char *format, ...)
1044 static boolean last_line_was_separator = FALSE;
1045 char *process_name = "";
1047 #if defined(PLATFORM_ANDROID)
1048 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1049 mode & ERR_INFO ? ANDROID_LOG_INFO :
1050 mode & ERR_WARN ? ANDROID_LOG_WARN :
1051 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1052 ANDROID_LOG_UNKNOWN);
1056 /* display warnings only when running in verbose mode */
1057 if (mode & ERR_WARN && !options.verbose)
1061 if (mode == ERR_INFO_LINE)
1063 if (!last_line_was_separator)
1064 fprintf_line(program.error_file, format, 79);
1066 last_line_was_separator = TRUE;
1071 last_line_was_separator = FALSE;
1073 if (mode & ERR_SOUND_SERVER)
1074 process_name = " sound server";
1075 else if (mode & ERR_NETWORK_SERVER)
1076 process_name = " network server";
1077 else if (mode & ERR_NETWORK_CLIENT)
1078 process_name = " network client **";
1084 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1087 if (mode & ERR_WARN)
1088 fprintf_nonewline(program.error_file, "warning: ");
1090 va_start(ap, format);
1091 vfprintf_newline(program.error_file, format, ap);
1094 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1096 va_start(ap, format);
1097 program.exit_message_function(format, ap);
1102 if (mode & ERR_HELP)
1103 fprintf_newline(program.error_file,
1104 "%s: Try option '--help' for more information.",
1105 program.command_basename);
1107 if (mode & ERR_EXIT)
1108 fprintf_newline(program.error_file, "%s%s: aborting",
1109 program.command_basename, process_name);
1111 if (mode & ERR_EXIT)
1113 if (mode & ERR_FROM_SERVER)
1114 exit(1); /* child process: normal exit */
1116 program.exit_function(1); /* main process: clean up stuff */
1121 /* ------------------------------------------------------------------------- */
1122 /* checked memory allocation and freeing functions */
1123 /* ------------------------------------------------------------------------- */
1125 void *checked_malloc(unsigned int size)
1132 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1137 void *checked_calloc(unsigned int size)
1141 ptr = calloc(1, size);
1144 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1149 void *checked_realloc(void *ptr, unsigned int size)
1151 ptr = realloc(ptr, size);
1154 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1159 void checked_free(void *ptr)
1161 if (ptr != NULL) /* this check should be done by free() anyway */
1165 void clear_mem(void *ptr, unsigned int size)
1167 #if defined(PLATFORM_WIN32)
1168 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1169 char *cptr = (char *)ptr;
1174 memset(ptr, 0, size);
1179 /* ------------------------------------------------------------------------- */
1180 /* various helper functions */
1181 /* ------------------------------------------------------------------------- */
1183 inline void swap_numbers(int *i1, int *i2)
1191 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1203 /* the "put" variants of the following file access functions check for the file
1204 pointer being != NULL and return the number of bytes they have or would have
1205 written; this allows for chunk writing functions to first determine the size
1206 of the (not yet written) chunk, write the correct chunk size and finally
1207 write the chunk itself */
1211 int getFile8BitInteger(File *file)
1213 return getByteFromFile(file);
1218 int getFile8BitInteger(FILE *file)
1225 int putFile8BitInteger(FILE *file, int value)
1235 int getFile16BitInteger(File *file, int byte_order)
1237 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1238 return ((getByteFromFile(file) << 8) |
1239 (getByteFromFile(file) << 0));
1240 else /* BYTE_ORDER_LITTLE_ENDIAN */
1241 return ((getByteFromFile(file) << 0) |
1242 (getByteFromFile(file) << 8));
1247 int getFile16BitInteger(FILE *file, int byte_order)
1249 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1250 return ((fgetc(file) << 8) |
1251 (fgetc(file) << 0));
1252 else /* BYTE_ORDER_LITTLE_ENDIAN */
1253 return ((fgetc(file) << 0) |
1254 (fgetc(file) << 8));
1259 int putFile16BitInteger(FILE *file, int value, int byte_order)
1263 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1265 fputc((value >> 8) & 0xff, file);
1266 fputc((value >> 0) & 0xff, file);
1268 else /* BYTE_ORDER_LITTLE_ENDIAN */
1270 fputc((value >> 0) & 0xff, file);
1271 fputc((value >> 8) & 0xff, file);
1280 int getFile32BitInteger(File *file, int byte_order)
1282 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1283 return ((getByteFromFile(file) << 24) |
1284 (getByteFromFile(file) << 16) |
1285 (getByteFromFile(file) << 8) |
1286 (getByteFromFile(file) << 0));
1287 else /* BYTE_ORDER_LITTLE_ENDIAN */
1288 return ((getByteFromFile(file) << 0) |
1289 (getByteFromFile(file) << 8) |
1290 (getByteFromFile(file) << 16) |
1291 (getByteFromFile(file) << 24));
1296 int getFile32BitInteger(FILE *file, int byte_order)
1298 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1299 return ((fgetc(file) << 24) |
1300 (fgetc(file) << 16) |
1301 (fgetc(file) << 8) |
1302 (fgetc(file) << 0));
1303 else /* BYTE_ORDER_LITTLE_ENDIAN */
1304 return ((fgetc(file) << 0) |
1305 (fgetc(file) << 8) |
1306 (fgetc(file) << 16) |
1307 (fgetc(file) << 24));
1312 int putFile32BitInteger(FILE *file, int value, int byte_order)
1316 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1318 fputc((value >> 24) & 0xff, file);
1319 fputc((value >> 16) & 0xff, file);
1320 fputc((value >> 8) & 0xff, file);
1321 fputc((value >> 0) & 0xff, file);
1323 else /* BYTE_ORDER_LITTLE_ENDIAN */
1325 fputc((value >> 0) & 0xff, file);
1326 fputc((value >> 8) & 0xff, file);
1327 fputc((value >> 16) & 0xff, file);
1328 fputc((value >> 24) & 0xff, file);
1337 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1340 const int chunk_name_length = 4;
1342 /* read chunk name */
1343 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1346 if (chunk_size != NULL)
1348 /* read chunk size */
1349 *chunk_size = getFile32BitInteger(file, byte_order);
1352 return (checkEndOfFile(file) ? FALSE : TRUE);
1357 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1360 const int chunk_name_length = 4;
1362 /* read chunk name */
1363 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1366 if (chunk_size != NULL)
1368 /* read chunk size */
1369 *chunk_size = getFile32BitInteger(file, byte_order);
1372 return (feof(file) || ferror(file) ? FALSE : TRUE);
1377 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1382 /* write chunk name */
1384 fputs(chunk_name, file);
1386 num_bytes += strlen(chunk_name);
1388 if (chunk_size >= 0)
1390 /* write chunk size */
1392 putFile32BitInteger(file, chunk_size, byte_order);
1402 int getFileVersion(File *file)
1404 int version_major = getByteFromFile(file);
1405 int version_minor = getByteFromFile(file);
1406 int version_patch = getByteFromFile(file);
1407 int version_build = getByteFromFile(file);
1409 return VERSION_IDENT(version_major, version_minor, version_patch,
1415 int getFileVersion(FILE *file)
1417 int version_major = fgetc(file);
1418 int version_minor = fgetc(file);
1419 int version_patch = fgetc(file);
1420 int version_build = fgetc(file);
1422 return VERSION_IDENT(version_major, version_minor, version_patch,
1428 int putFileVersion(FILE *file, int version)
1432 int version_major = VERSION_MAJOR(version);
1433 int version_minor = VERSION_MINOR(version);
1434 int version_patch = VERSION_PATCH(version);
1435 int version_build = VERSION_BUILD(version);
1437 fputc(version_major, file);
1438 fputc(version_minor, file);
1439 fputc(version_patch, file);
1440 fputc(version_build, file);
1448 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1452 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1453 buffer[i] = getByteFromFile(file);
1458 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1462 for(i = 0; i < bytes && !feof(file); i++)
1463 buffer[i] = fgetc(file);
1468 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1472 for(i = 0; i < bytes; i++)
1473 fputc(buffer[i], file);
1478 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1480 while (bytes-- && !checkEndOfFile(file))
1481 getByteFromFile(file);
1486 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1488 while (bytes-- && !feof(file))
1494 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1501 /* ------------------------------------------------------------------------- */
1502 /* functions to translate key identifiers between different format */
1503 /* ------------------------------------------------------------------------- */
1505 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1506 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1507 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1508 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1510 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1519 /* normal cursor keys */
1520 { KSYM_Left, "XK_Left", "cursor left" },
1521 { KSYM_Right, "XK_Right", "cursor right" },
1522 { KSYM_Up, "XK_Up", "cursor up" },
1523 { KSYM_Down, "XK_Down", "cursor down" },
1525 /* keypad cursor keys */
1527 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1528 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1529 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1530 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1533 /* other keypad keys */
1534 #ifdef KSYM_KP_Enter
1535 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1536 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1537 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1538 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1539 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1540 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1544 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1545 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1546 { KSYM_Control_L, "XK_Control_L", "left control" },
1547 { KSYM_Control_R, "XK_Control_R", "right control" },
1548 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1549 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1550 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1551 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1552 #if !defined(TARGET_SDL2)
1553 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1554 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1556 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1557 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1559 /* some special keys */
1560 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1561 { KSYM_Delete, "XK_Delete", "delete" },
1562 { KSYM_Insert, "XK_Insert", "insert" },
1563 { KSYM_Tab, "XK_Tab", "tab" },
1564 { KSYM_Home, "XK_Home", "home" },
1565 { KSYM_End, "XK_End", "end" },
1566 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1567 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1569 #if defined(TARGET_SDL2)
1570 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1571 { KSYM_Back, "XK_Back", "back" }, /* back key */
1574 /* ASCII 0x20 to 0x40 keys (except numbers) */
1575 { KSYM_space, "XK_space", "space" },
1576 { KSYM_exclam, "XK_exclam", "!" },
1577 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1578 { KSYM_numbersign, "XK_numbersign", "#" },
1579 { KSYM_dollar, "XK_dollar", "$" },
1580 { KSYM_percent, "XK_percent", "%" },
1581 { KSYM_ampersand, "XK_ampersand", "&" },
1582 { KSYM_apostrophe, "XK_apostrophe", "'" },
1583 { KSYM_parenleft, "XK_parenleft", "(" },
1584 { KSYM_parenright, "XK_parenright", ")" },
1585 { KSYM_asterisk, "XK_asterisk", "*" },
1586 { KSYM_plus, "XK_plus", "+" },
1587 { KSYM_comma, "XK_comma", "," },
1588 { KSYM_minus, "XK_minus", "-" },
1589 { KSYM_period, "XK_period", "." },
1590 { KSYM_slash, "XK_slash", "/" },
1591 { KSYM_colon, "XK_colon", ":" },
1592 { KSYM_semicolon, "XK_semicolon", ";" },
1593 { KSYM_less, "XK_less", "<" },
1594 { KSYM_equal, "XK_equal", "=" },
1595 { KSYM_greater, "XK_greater", ">" },
1596 { KSYM_question, "XK_question", "?" },
1597 { KSYM_at, "XK_at", "@" },
1599 /* more ASCII keys */
1600 { KSYM_bracketleft, "XK_bracketleft", "[" },
1601 { KSYM_backslash, "XK_backslash", "\\" },
1602 { KSYM_bracketright,"XK_bracketright", "]" },
1603 { KSYM_asciicircum, "XK_asciicircum", "^" },
1604 { KSYM_underscore, "XK_underscore", "_" },
1605 { KSYM_grave, "XK_grave", "grave" },
1606 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1607 { KSYM_braceleft, "XK_braceleft", "brace left" },
1608 { KSYM_bar, "XK_bar", "bar" },
1609 { KSYM_braceright, "XK_braceright", "brace right" },
1610 { KSYM_asciitilde, "XK_asciitilde", "~" },
1612 /* special (non-ASCII) keys (ISO-Latin-1) */
1613 { KSYM_degree, "XK_degree", "°" },
1614 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1615 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1616 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1617 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1618 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1619 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1620 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1622 #if defined(TARGET_SDL2)
1623 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1624 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1625 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1626 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1627 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1628 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1629 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1630 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1631 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1633 /* other keys (for reverse mapping only) */
1634 { KSYM_space, "XK_space", " " },
1637 #if defined(TARGET_SDL2)
1638 /* keypad keys are not in numerical order in SDL2 */
1639 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1640 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1641 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1642 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1643 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1644 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1645 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1646 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1647 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1648 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1651 /* end-of-array identifier */
1657 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1659 static char name_buffer[30];
1662 if (key >= KSYM_A && key <= KSYM_Z)
1663 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1664 else if (key >= KSYM_a && key <= KSYM_z)
1665 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1666 else if (key >= KSYM_0 && key <= KSYM_9)
1667 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1668 #if !defined(TARGET_SDL2)
1669 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1670 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1672 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1673 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1674 else if (key == KSYM_UNDEFINED)
1675 strcpy(name_buffer, "(undefined)");
1682 if (key == translate_key[i].key)
1684 strcpy(name_buffer, translate_key[i].name);
1688 while (translate_key[++i].name);
1690 if (!translate_key[i].name)
1691 strcpy(name_buffer, "(unknown)");
1694 *name = name_buffer;
1696 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1698 static char name_buffer[30];
1701 if (key >= KSYM_A && key <= KSYM_Z)
1702 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1703 else if (key >= KSYM_a && key <= KSYM_z)
1704 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1705 else if (key >= KSYM_0 && key <= KSYM_9)
1706 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1707 #if !defined(TARGET_SDL2)
1708 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1709 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1711 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1712 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1713 else if (key == KSYM_UNDEFINED)
1714 strcpy(name_buffer, "[undefined]");
1721 if (key == translate_key[i].key)
1723 strcpy(name_buffer, translate_key[i].x11name);
1727 while (translate_key[++i].x11name);
1729 if (!translate_key[i].x11name)
1730 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1733 *x11name = name_buffer;
1735 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1737 Key key = KSYM_UNDEFINED;
1738 char *name_ptr = *name;
1740 if (strlen(*name) == 1)
1742 char c = name_ptr[0];
1744 if (c >= 'A' && c <= 'Z')
1745 key = KSYM_A + (Key)(c - 'A');
1746 else if (c >= 'a' && c <= 'z')
1747 key = KSYM_a + (Key)(c - 'a');
1748 else if (c >= '0' && c <= '9')
1749 key = KSYM_0 + (Key)(c - '0');
1752 if (key == KSYM_UNDEFINED)
1758 if (strEqual(translate_key[i].name, *name))
1760 key = translate_key[i].key;
1764 while (translate_key[++i].x11name);
1767 if (key == KSYM_UNDEFINED)
1768 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1772 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1774 Key key = KSYM_UNDEFINED;
1775 char *name_ptr = *x11name;
1777 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1779 char c = name_ptr[3];
1781 if (c >= 'A' && c <= 'Z')
1782 key = KSYM_A + (Key)(c - 'A');
1783 else if (c >= 'a' && c <= 'z')
1784 key = KSYM_a + (Key)(c - 'a');
1785 else if (c >= '0' && c <= '9')
1786 key = KSYM_0 + (Key)(c - '0');
1788 #if !defined(TARGET_SDL2)
1789 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1791 char c = name_ptr[6];
1793 if (c >= '0' && c <= '9')
1794 key = KSYM_KP_0 + (Key)(c - '0');
1797 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1799 char c1 = name_ptr[4];
1800 char c2 = name_ptr[5];
1803 if ((c1 >= '0' && c1 <= '9') &&
1804 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1805 d = atoi(&name_ptr[4]);
1807 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1808 key = KSYM_F1 + (Key)(d - 1);
1810 else if (strPrefix(name_ptr, "XK_"))
1816 if (strEqual(name_ptr, translate_key[i].x11name))
1818 key = translate_key[i].key;
1822 while (translate_key[++i].x11name);
1824 else if (strPrefix(name_ptr, "0x"))
1826 unsigned int value = 0;
1832 char c = *name_ptr++;
1835 if (c >= '0' && c <= '9')
1837 else if (c >= 'a' && c <= 'f')
1838 d = (int)(c - 'a' + 10);
1839 else if (c >= 'A' && c <= 'F')
1840 d = (int)(c - 'A' + 10);
1848 value = value * 16 + d;
1859 char *getKeyNameFromKey(Key key)
1863 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1867 char *getX11KeyNameFromKey(Key key)
1871 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1875 Key getKeyFromKeyName(char *name)
1879 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1883 Key getKeyFromX11KeyName(char *x11name)
1887 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1891 char getCharFromKey(Key key)
1893 char *keyname = getKeyNameFromKey(key);
1896 if (strlen(keyname) == 1)
1898 else if (strEqual(keyname, "space"))
1904 char getValidConfigValueChar(char c)
1906 if (c == '#' || /* used to mark comments */
1907 c == '\\') /* used to mark continued lines */
1914 /* ------------------------------------------------------------------------- */
1915 /* functions to translate string identifiers to integer or boolean value */
1916 /* ------------------------------------------------------------------------- */
1918 int get_integer_from_string(char *s)
1920 static char *number_text[][3] =
1922 { "0", "zero", "null", },
1923 { "1", "one", "first" },
1924 { "2", "two", "second" },
1925 { "3", "three", "third" },
1926 { "4", "four", "fourth" },
1927 { "5", "five", "fifth" },
1928 { "6", "six", "sixth" },
1929 { "7", "seven", "seventh" },
1930 { "8", "eight", "eighth" },
1931 { "9", "nine", "ninth" },
1932 { "10", "ten", "tenth" },
1933 { "11", "eleven", "eleventh" },
1934 { "12", "twelve", "twelfth" },
1936 { NULL, NULL, NULL },
1940 char *s_lower = getStringToLower(s);
1943 for (i = 0; number_text[i][0] != NULL; i++)
1944 for (j = 0; j < 3; j++)
1945 if (strEqual(s_lower, number_text[i][j]))
1950 if (strEqual(s_lower, "false") ||
1951 strEqual(s_lower, "no") ||
1952 strEqual(s_lower, "off"))
1954 else if (strEqual(s_lower, "true") ||
1955 strEqual(s_lower, "yes") ||
1956 strEqual(s_lower, "on"))
1967 boolean get_boolean_from_string(char *s)
1969 char *s_lower = getStringToLower(s);
1970 boolean result = FALSE;
1972 if (strEqual(s_lower, "true") ||
1973 strEqual(s_lower, "yes") ||
1974 strEqual(s_lower, "on") ||
1975 get_integer_from_string(s) == 1)
1983 int get_switch3_from_string(char *s)
1985 char *s_lower = getStringToLower(s);
1988 if (strEqual(s_lower, "true") ||
1989 strEqual(s_lower, "yes") ||
1990 strEqual(s_lower, "on") ||
1991 get_integer_from_string(s) == 1)
1993 else if (strEqual(s_lower, "auto"))
2002 /* ------------------------------------------------------------------------- */
2003 /* functions for generic lists */
2004 /* ------------------------------------------------------------------------- */
2006 ListNode *newListNode()
2008 return checked_calloc(sizeof(ListNode));
2011 void addNodeToList(ListNode **node_first, char *key, void *content)
2013 ListNode *node_new = newListNode();
2015 node_new->key = getStringCopy(key);
2016 node_new->content = content;
2017 node_new->next = *node_first;
2018 *node_first = node_new;
2021 void deleteNodeFromList(ListNode **node_first, char *key,
2022 void (*destructor_function)(void *))
2024 if (node_first == NULL || *node_first == NULL)
2027 if (strEqual((*node_first)->key, key))
2029 checked_free((*node_first)->key);
2030 if (destructor_function)
2031 destructor_function((*node_first)->content);
2032 *node_first = (*node_first)->next;
2035 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2038 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2040 if (node_first == NULL)
2043 if (strEqual(node_first->key, key))
2046 return getNodeFromKey(node_first->next, key);
2049 int getNumNodes(ListNode *node_first)
2051 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2054 void dumpList(ListNode *node_first)
2056 ListNode *node = node_first;
2060 printf("['%s' (%d)]\n", node->key,
2061 ((struct ListNodeInfo *)node->content)->num_references);
2065 printf("[%d nodes]\n", getNumNodes(node_first));
2069 /* ------------------------------------------------------------------------- */
2070 /* functions for file handling */
2071 /* ------------------------------------------------------------------------- */
2073 File *openFile(char *filename, char *mode)
2075 File *file = checked_calloc(sizeof(File));
2077 file->file = fopen(filename, mode);
2079 if (file->file != NULL)
2081 file->filename = getStringCopy(filename);
2086 #if defined(PLATFORM_ANDROID)
2087 file->asset_file = SDL_RWFromFile(filename, mode);
2089 if (file->asset_file != NULL)
2091 file->file_is_asset = TRUE;
2092 file->filename = getStringCopy(filename);
2103 int closeFile(File *file)
2110 #if defined(PLATFORM_ANDROID)
2111 if (file->asset_file)
2112 result = SDL_RWclose(file->asset_file);
2116 result = fclose(file->file);
2118 checked_free(file->filename);
2124 int checkEndOfFile(File *file)
2126 #if defined(PLATFORM_ANDROID)
2127 if (file->file_is_asset)
2128 return file->end_of_file;
2131 return feof(file->file);
2134 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2136 #if defined(PLATFORM_ANDROID)
2137 if (file->file_is_asset)
2139 if (file->end_of_file)
2142 size_t num_items_read =
2143 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2145 if (num_items_read < num_items)
2146 file->end_of_file = TRUE;
2148 return num_items_read;
2152 return fread(buffer, item_size, num_items, file->file);
2155 int seekFile(File *file, long offset, int whence)
2157 #if defined(PLATFORM_ANDROID)
2158 if (file->file_is_asset)
2160 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2161 whence == SEEK_CUR ? RW_SEEK_CUR :
2162 whence == SEEK_END ? RW_SEEK_END : 0);
2164 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2168 return fseek(file->file, offset, whence);
2171 int getByteFromFile(File *file)
2173 #if defined(PLATFORM_ANDROID)
2174 if (file->file_is_asset)
2176 if (file->end_of_file)
2180 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2182 if (num_bytes_read < 1)
2183 file->end_of_file = TRUE;
2185 return (file->end_of_file ? EOF : (int)c);
2189 return fgetc(file->file);
2192 char *getStringFromFile(File *file, char *line, int size)
2194 #if defined(PLATFORM_ANDROID)
2195 if (file->file_is_asset)
2197 if (file->end_of_file)
2200 char *line_ptr = line;
2201 int num_bytes_read = 0;
2203 while (num_bytes_read < size - 1 &&
2204 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2205 *line_ptr++ != '\n')
2210 if (strlen(line) == 0)
2212 file->end_of_file = TRUE;
2221 return fgets(line, size, file->file);
2225 /* ------------------------------------------------------------------------- */
2226 /* functions for directory handling */
2227 /* ------------------------------------------------------------------------- */
2229 Directory *openDirectory(char *dir_name)
2231 Directory *dir = checked_calloc(sizeof(Directory));
2233 dir->dir = opendir(dir_name);
2235 if (dir->dir != NULL)
2237 dir->filename = getStringCopy(dir_name);
2242 #if defined(PLATFORM_ANDROID)
2243 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2245 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2247 checked_free(asset_toc_filename);
2249 if (dir->asset_toc_file != NULL)
2251 dir->directory_is_asset = TRUE;
2252 dir->filename = getStringCopy(dir_name);
2263 int closeDirectory(Directory *dir)
2270 #if defined(PLATFORM_ANDROID)
2271 if (dir->asset_toc_file)
2272 result = SDL_RWclose(dir->asset_toc_file);
2276 result = closedir(dir->dir);
2279 freeDirectoryEntry(dir->dir_entry);
2281 checked_free(dir->filename);
2287 DirectoryEntry *readDirectory(Directory *dir)
2290 freeDirectoryEntry(dir->dir_entry);
2292 dir->dir_entry = NULL;
2294 #if defined(PLATFORM_ANDROID)
2295 if (dir->directory_is_asset)
2297 char line[MAX_LINE_LEN];
2298 char *line_ptr = line;
2299 int num_bytes_read = 0;
2301 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2302 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2311 if (strlen(line) == 0)
2314 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2316 dir->dir_entry->is_directory = FALSE;
2317 if (line[strlen(line) - 1] == '/')
2319 dir->dir_entry->is_directory = TRUE;
2321 line[strlen(line) - 1] = '\0';
2324 dir->dir_entry->basename = getStringCopy(line);
2325 dir->dir_entry->filename = getPath2(dir->filename, line);
2327 return dir->dir_entry;
2331 struct dirent *dir_entry = readdir(dir->dir);
2333 if (dir_entry == NULL)
2336 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2338 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2339 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2341 struct stat file_status;
2343 dir->dir_entry->is_directory =
2344 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2345 (file_status.st_mode & S_IFMT) == S_IFDIR);
2348 Error(ERR_INFO, "::: '%s' is directory: %d",
2349 dir->dir_entry->basename,
2350 dir->dir_entry->is_directory);
2353 return dir->dir_entry;
2356 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2358 if (dir_entry == NULL)
2361 checked_free(dir_entry->basename);
2362 checked_free(dir_entry->filename);
2363 checked_free(dir_entry);
2367 /* ------------------------------------------------------------------------- */
2368 /* functions for checking files and filenames */
2369 /* ------------------------------------------------------------------------- */
2371 boolean directoryExists(char *dir_name)
2373 if (dir_name == NULL)
2376 boolean success = (access(dir_name, F_OK) == 0);
2378 #if defined(PLATFORM_ANDROID)
2381 // this might be an asset directory; check by trying to open toc file
2382 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2383 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2385 checked_free(asset_toc_filename);
2387 success = (file != NULL);
2397 boolean fileExists(char *filename)
2399 if (filename == NULL)
2402 boolean success = (access(filename, F_OK) == 0);
2404 #if defined(PLATFORM_ANDROID)
2407 // this might be an asset file; check by trying to open it
2408 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2410 success = (file != NULL);
2420 boolean fileHasPrefix(char *basename, char *prefix)
2422 static char *basename_lower = NULL;
2423 int basename_length, prefix_length;
2425 checked_free(basename_lower);
2427 if (basename == NULL || prefix == NULL)
2430 basename_lower = getStringToLower(basename);
2431 basename_length = strlen(basename_lower);
2432 prefix_length = strlen(prefix);
2434 if (basename_length > prefix_length + 1 &&
2435 basename_lower[prefix_length] == '.' &&
2436 strncmp(basename_lower, prefix, prefix_length) == 0)
2442 boolean fileHasSuffix(char *basename, char *suffix)
2444 static char *basename_lower = NULL;
2445 int basename_length, suffix_length;
2447 checked_free(basename_lower);
2449 if (basename == NULL || suffix == NULL)
2452 basename_lower = getStringToLower(basename);
2453 basename_length = strlen(basename_lower);
2454 suffix_length = strlen(suffix);
2456 if (basename_length > suffix_length + 1 &&
2457 basename_lower[basename_length - suffix_length - 1] == '.' &&
2458 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2464 #if defined(TARGET_SDL)
2465 static boolean FileCouldBeArtwork(char *basename)
2467 return (!strEqual(basename, ".") &&
2468 !strEqual(basename, "..") &&
2469 !fileHasSuffix(basename, "txt") &&
2470 !fileHasSuffix(basename, "conf"));
2474 boolean FileIsGraphic(char *filename)
2476 char *basename = getBaseNamePtr(filename);
2478 #if defined(TARGET_SDL)
2479 return FileCouldBeArtwork(basename);
2481 return fileHasSuffix(basename, "pcx");
2485 boolean FileIsSound(char *filename)
2487 char *basename = getBaseNamePtr(filename);
2489 #if defined(TARGET_SDL)
2490 return FileCouldBeArtwork(basename);
2492 return fileHasSuffix(basename, "wav");
2496 boolean FileIsMusic(char *filename)
2498 char *basename = getBaseNamePtr(filename);
2500 #if defined(TARGET_SDL)
2501 return FileCouldBeArtwork(basename);
2503 if (FileIsSound(basename))
2507 #if defined(TARGET_SDL)
2508 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2509 fileHasSuffix(basename, "mod") ||
2510 fileHasSuffix(basename, "s3m") ||
2511 fileHasSuffix(basename, "it") ||
2512 fileHasSuffix(basename, "xm") ||
2513 fileHasSuffix(basename, "midi") ||
2514 fileHasSuffix(basename, "mid") ||
2515 fileHasSuffix(basename, "mp3") ||
2516 fileHasSuffix(basename, "ogg"))
2525 boolean FileIsArtworkType(char *basename, int type)
2527 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2528 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2529 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2535 /* ------------------------------------------------------------------------- */
2536 /* functions for loading artwork configuration information */
2537 /* ------------------------------------------------------------------------- */
2539 char *get_mapped_token(char *token)
2541 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2542 static char *map_token_prefix[][2] =
2544 { "char_procent", "char_percent" },
2549 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2551 int len_token_prefix = strlen(map_token_prefix[i][0]);
2553 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2554 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2560 /* This function checks if a string <s> of the format "string1, string2, ..."
2561 exactly contains a string <s_contained>. */
2563 static boolean string_has_parameter(char *s, char *s_contained)
2567 if (s == NULL || s_contained == NULL)
2570 if (strlen(s_contained) > strlen(s))
2573 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2575 char next_char = s[strlen(s_contained)];
2577 /* check if next character is delimiter or whitespace */
2578 return (next_char == ',' || next_char == '\0' ||
2579 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2582 /* check if string contains another parameter string after a comma */
2583 substring = strchr(s, ',');
2584 if (substring == NULL) /* string does not contain a comma */
2587 /* advance string pointer to next character after the comma */
2590 /* skip potential whitespaces after the comma */
2591 while (*substring == ' ' || *substring == '\t')
2594 return string_has_parameter(substring, s_contained);
2597 int get_parameter_value(char *value_raw, char *suffix, int type)
2599 char *value = getStringToLower(value_raw);
2600 int result = 0; /* probably a save default value */
2602 if (strEqual(suffix, ".direction"))
2604 result = (strEqual(value, "left") ? MV_LEFT :
2605 strEqual(value, "right") ? MV_RIGHT :
2606 strEqual(value, "up") ? MV_UP :
2607 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2609 else if (strEqual(suffix, ".align"))
2611 result = (strEqual(value, "left") ? ALIGN_LEFT :
2612 strEqual(value, "right") ? ALIGN_RIGHT :
2613 strEqual(value, "center") ? ALIGN_CENTER :
2614 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2616 else if (strEqual(suffix, ".valign"))
2618 result = (strEqual(value, "top") ? VALIGN_TOP :
2619 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2620 strEqual(value, "middle") ? VALIGN_MIDDLE :
2621 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2623 else if (strEqual(suffix, ".anim_mode"))
2625 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2626 string_has_parameter(value, "loop") ? ANIM_LOOP :
2627 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2628 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2629 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2630 string_has_parameter(value, "random") ? ANIM_RANDOM :
2631 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2632 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2633 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2634 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2635 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2636 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2639 if (string_has_parameter(value, "reverse"))
2640 result |= ANIM_REVERSE;
2642 if (string_has_parameter(value, "opaque_player"))
2643 result |= ANIM_OPAQUE_PLAYER;
2645 if (string_has_parameter(value, "static_panel"))
2646 result |= ANIM_STATIC_PANEL;
2648 else if (strEqual(suffix, ".class"))
2650 result = get_hash_from_key(value);
2652 else if (strEqual(suffix, ".style"))
2654 result = STYLE_DEFAULT;
2656 if (string_has_parameter(value, "accurate_borders"))
2657 result |= STYLE_ACCURATE_BORDERS;
2659 if (string_has_parameter(value, "inner_corners"))
2660 result |= STYLE_INNER_CORNERS;
2662 else if (strEqual(suffix, ".fade_mode"))
2664 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2665 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2666 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2667 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2671 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2673 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2676 result = gfx.get_font_from_token_function(value);
2678 else /* generic parameter of type integer or boolean */
2680 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2681 type == TYPE_INTEGER ? get_integer_from_string(value) :
2682 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2683 ARG_UNDEFINED_VALUE);
2691 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2693 static struct ScreenModeInfo screen_mode;
2694 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2695 char *screen_mode_string_copy;
2696 char *screen_mode_string_pos_w;
2697 char *screen_mode_string_pos_h;
2699 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2702 screen_mode_string_copy = getStringCopy(screen_mode_string);
2704 screen_mode_string_pos_w = screen_mode_string_copy;
2705 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2706 *screen_mode_string_pos_h++ = '\0';
2708 screen_mode.width = atoi(screen_mode_string_pos_w);
2709 screen_mode.height = atoi(screen_mode_string_pos_h);
2711 return &screen_mode;
2714 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2717 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2718 float aspect_ratio_new;
2723 *x = i * aspect_ratio + 0.000001;
2726 aspect_ratio_new = (float)*x / (float)*y;
2730 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2733 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2734 struct ListNodeInfo ***, int *);
2736 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2737 struct ConfigTypeInfo *suffix_list,
2738 char **ignore_tokens,
2739 int num_file_list_entries)
2741 struct FileInfo *file_list;
2742 int num_file_list_entries_found = 0;
2743 int num_suffix_list_entries = 0;
2747 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2749 for (i = 0; suffix_list[i].token != NULL; i++)
2750 num_suffix_list_entries++;
2752 /* always start with reliable default values */
2753 for (i = 0; i < num_file_list_entries; i++)
2755 file_list[i].token = NULL;
2757 file_list[i].default_filename = NULL;
2758 file_list[i].filename = NULL;
2760 if (num_suffix_list_entries > 0)
2762 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2764 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2765 file_list[i].parameter = checked_calloc(parameter_array_size);
2767 for (j = 0; j < num_suffix_list_entries; j++)
2769 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2770 setString(&file_list[i].parameter[j], suffix_list[j].value);
2773 file_list[i].redefined = FALSE;
2774 file_list[i].fallback_to_default = FALSE;
2775 file_list[i].default_is_cloned = FALSE;
2781 for (i = 0; config_list[i].token != NULL; i++)
2783 int len_config_token = strlen(config_list[i].token);
2785 int len_config_value = strlen(config_list[i].value);
2787 boolean is_file_entry = TRUE;
2789 for (j = 0; suffix_list[j].token != NULL; j++)
2791 int len_suffix = strlen(suffix_list[j].token);
2793 if (len_suffix < len_config_token &&
2794 strEqual(&config_list[i].token[len_config_token - len_suffix],
2795 suffix_list[j].token))
2797 setString(&file_list[list_pos].default_parameter[j],
2798 config_list[i].value);
2800 is_file_entry = FALSE;
2806 /* the following tokens are no file definitions, but other config tokens */
2807 for (j = 0; ignore_tokens[j] != NULL; j++)
2808 if (strEqual(config_list[i].token, ignore_tokens[j]))
2809 is_file_entry = FALSE;
2816 if (list_pos >= num_file_list_entries)
2820 /* simple sanity check if this is really a file definition */
2821 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2822 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2823 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2825 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2826 config_list[i].token, config_list[i].value);
2827 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2831 file_list[list_pos].token = config_list[i].token;
2832 file_list[list_pos].default_filename = config_list[i].value;
2835 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2839 if (strSuffix(config_list[i].token, ".clone_from"))
2840 file_list[list_pos].default_is_cloned = TRUE;
2843 num_file_list_entries_found = list_pos + 1;
2844 if (num_file_list_entries_found != num_file_list_entries)
2846 Error(ERR_INFO_LINE, "-");
2847 Error(ERR_INFO, "inconsistant config list information:");
2848 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2849 num_file_list_entries);
2850 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2851 num_file_list_entries_found);
2852 Error(ERR_EXIT, "please fix");
2856 printf("::: ---------- DONE ----------\n");
2862 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2864 int len_token = strlen(token);
2865 int len_suffix = strlen(suffix);
2867 if (start_pos < 0) /* compare suffix from end of string */
2868 start_pos += len_token;
2870 if (start_pos < 0 || start_pos + len_suffix > len_token)
2873 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2876 if (token[start_pos + len_suffix] == '\0')
2879 if (token[start_pos + len_suffix] == '.')
2885 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2887 static void read_token_parameters(SetupFileHash *setup_file_hash,
2888 struct ConfigTypeInfo *suffix_list,
2889 struct FileInfo *file_list_entry)
2891 /* check for config token that is the base token without any suffixes */
2892 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2893 char *known_token_value = KNOWN_TOKEN_VALUE;
2896 if (filename != NULL)
2898 setString(&file_list_entry->filename, filename);
2900 /* when file definition found, set all parameters to default values */
2901 for (i = 0; suffix_list[i].token != NULL; i++)
2902 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2904 file_list_entry->redefined = TRUE;
2906 /* mark config file token as well known from default config */
2907 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2910 /* check for config tokens that can be build by base token and suffixes */
2911 for (i = 0; suffix_list[i].token != NULL; i++)
2913 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2914 char *value = getHashEntry(setup_file_hash, token);
2918 setString(&file_list_entry->parameter[i], value);
2920 /* mark config file token as well known from default config */
2921 setHashEntry(setup_file_hash, token, known_token_value);
2928 static void add_dynamic_file_list_entry(struct FileInfo **list,
2929 int *num_list_entries,
2930 SetupFileHash *extra_file_hash,
2931 struct ConfigTypeInfo *suffix_list,
2932 int num_suffix_list_entries,
2935 struct FileInfo *new_list_entry;
2936 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2938 (*num_list_entries)++;
2939 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2940 new_list_entry = &(*list)[*num_list_entries - 1];
2942 new_list_entry->token = getStringCopy(token);
2943 new_list_entry->default_filename = NULL;
2944 new_list_entry->filename = NULL;
2945 new_list_entry->parameter = checked_calloc(parameter_array_size);
2947 new_list_entry->redefined = FALSE;
2948 new_list_entry->fallback_to_default = FALSE;
2949 new_list_entry->default_is_cloned = FALSE;
2951 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2954 static void add_property_mapping(struct PropertyMapping **list,
2955 int *num_list_entries,
2956 int base_index, int ext1_index,
2957 int ext2_index, int ext3_index,
2960 struct PropertyMapping *new_list_entry;
2962 (*num_list_entries)++;
2963 *list = checked_realloc(*list,
2964 *num_list_entries * sizeof(struct PropertyMapping));
2965 new_list_entry = &(*list)[*num_list_entries - 1];
2967 new_list_entry->base_index = base_index;
2968 new_list_entry->ext1_index = ext1_index;
2969 new_list_entry->ext2_index = ext2_index;
2970 new_list_entry->ext3_index = ext3_index;
2972 new_list_entry->artwork_index = artwork_index;
2975 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2978 struct FileInfo *file_list = artwork_info->file_list;
2979 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2980 char **base_prefixes = artwork_info->base_prefixes;
2981 char **ext1_suffixes = artwork_info->ext1_suffixes;
2982 char **ext2_suffixes = artwork_info->ext2_suffixes;
2983 char **ext3_suffixes = artwork_info->ext3_suffixes;
2984 char **ignore_tokens = artwork_info->ignore_tokens;
2985 int num_file_list_entries = artwork_info->num_file_list_entries;
2986 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2987 int num_base_prefixes = artwork_info->num_base_prefixes;
2988 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2989 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2990 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2991 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2992 SetupFileHash *setup_file_hash, *valid_file_hash;
2993 SetupFileHash *extra_file_hash, *empty_file_hash;
2994 char *known_token_value = KNOWN_TOKEN_VALUE;
2997 if (filename == NULL)
3001 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
3004 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3007 /* separate valid (defined) from empty (undefined) config token values */
3008 valid_file_hash = newSetupFileHash();
3009 empty_file_hash = newSetupFileHash();
3010 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3012 char *value = HASH_ITERATION_VALUE(itr);
3014 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3015 HASH_ITERATION_TOKEN(itr), value);
3017 END_HASH_ITERATION(setup_file_hash, itr)
3019 /* at this point, we do not need the setup file hash anymore -- free it */
3020 freeSetupFileHash(setup_file_hash);
3022 /* map deprecated to current tokens (using prefix match and replace) */
3023 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3025 char *token = HASH_ITERATION_TOKEN(itr);
3026 char *mapped_token = get_mapped_token(token);
3028 if (mapped_token != NULL)
3030 char *value = HASH_ITERATION_VALUE(itr);
3032 /* add mapped token */
3033 setHashEntry(valid_file_hash, mapped_token, value);
3035 /* ignore old token (by setting it to "known" keyword) */
3036 setHashEntry(valid_file_hash, token, known_token_value);
3041 END_HASH_ITERATION(valid_file_hash, itr)
3043 /* read parameters for all known config file tokens */
3044 for (i = 0; i < num_file_list_entries; i++)
3045 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3047 /* set all tokens that can be ignored here to "known" keyword */
3048 for (i = 0; i < num_ignore_tokens; i++)
3049 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3051 /* copy all unknown config file tokens to extra config hash */
3052 extra_file_hash = newSetupFileHash();
3053 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3055 char *value = HASH_ITERATION_VALUE(itr);
3057 if (!strEqual(value, known_token_value))
3058 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3060 END_HASH_ITERATION(valid_file_hash, itr)
3062 /* at this point, we do not need the valid file hash anymore -- free it */
3063 freeSetupFileHash(valid_file_hash);
3065 /* now try to determine valid, dynamically defined config tokens */
3067 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3069 struct FileInfo **dynamic_file_list =
3070 &artwork_info->dynamic_file_list;
3071 int *num_dynamic_file_list_entries =
3072 &artwork_info->num_dynamic_file_list_entries;
3073 struct PropertyMapping **property_mapping =
3074 &artwork_info->property_mapping;
3075 int *num_property_mapping_entries =
3076 &artwork_info->num_property_mapping_entries;
3077 int current_summarized_file_list_entry =
3078 artwork_info->num_file_list_entries +
3079 artwork_info->num_dynamic_file_list_entries;
3080 char *token = HASH_ITERATION_TOKEN(itr);
3081 int len_token = strlen(token);
3083 boolean base_prefix_found = FALSE;
3084 boolean parameter_suffix_found = FALSE;
3087 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3090 /* skip all parameter definitions (handled by read_token_parameters()) */
3091 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3093 int len_suffix = strlen(suffix_list[i].token);
3095 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3096 parameter_suffix_found = TRUE;
3099 if (parameter_suffix_found)
3102 /* ---------- step 0: search for matching base prefix ---------- */
3105 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3107 char *base_prefix = base_prefixes[i];
3108 int len_base_prefix = strlen(base_prefix);
3109 boolean ext1_suffix_found = FALSE;
3110 boolean ext2_suffix_found = FALSE;
3111 boolean ext3_suffix_found = FALSE;
3112 boolean exact_match = FALSE;
3113 int base_index = -1;
3114 int ext1_index = -1;
3115 int ext2_index = -1;
3116 int ext3_index = -1;
3118 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3120 if (!base_prefix_found)
3126 if (IS_PARENT_PROCESS())
3127 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3130 if (start_pos + len_base_prefix == len_token) /* exact match */
3135 if (IS_PARENT_PROCESS())
3136 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3139 add_dynamic_file_list_entry(dynamic_file_list,
3140 num_dynamic_file_list_entries,
3143 num_suffix_list_entries,
3145 add_property_mapping(property_mapping,
3146 num_property_mapping_entries,
3147 base_index, -1, -1, -1,
3148 current_summarized_file_list_entry);
3153 if (IS_PARENT_PROCESS())
3154 printf("---> examining token '%s': search 1st suffix ...\n", token);
3157 /* ---------- step 1: search for matching first suffix ---------- */
3159 start_pos += len_base_prefix;
3160 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3162 char *ext1_suffix = ext1_suffixes[j];
3163 int len_ext1_suffix = strlen(ext1_suffix);
3165 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3167 if (!ext1_suffix_found)
3173 if (IS_PARENT_PROCESS())
3174 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3177 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3182 if (IS_PARENT_PROCESS())
3183 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3186 add_dynamic_file_list_entry(dynamic_file_list,
3187 num_dynamic_file_list_entries,
3190 num_suffix_list_entries,
3192 add_property_mapping(property_mapping,
3193 num_property_mapping_entries,
3194 base_index, ext1_index, -1, -1,
3195 current_summarized_file_list_entry);
3199 start_pos += len_ext1_suffix;
3206 if (IS_PARENT_PROCESS())
3207 printf("---> examining token '%s': search 2nd suffix ...\n", token);
3210 /* ---------- step 2: search for matching second suffix ---------- */
3212 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3214 char *ext2_suffix = ext2_suffixes[k];
3215 int len_ext2_suffix = strlen(ext2_suffix);
3217 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3219 if (!ext2_suffix_found)
3225 if (IS_PARENT_PROCESS())
3226 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3229 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3234 if (IS_PARENT_PROCESS())
3235 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3238 add_dynamic_file_list_entry(dynamic_file_list,
3239 num_dynamic_file_list_entries,
3242 num_suffix_list_entries,
3244 add_property_mapping(property_mapping,
3245 num_property_mapping_entries,
3246 base_index, ext1_index, ext2_index, -1,
3247 current_summarized_file_list_entry);
3251 start_pos += len_ext2_suffix;
3258 if (IS_PARENT_PROCESS())
3259 printf("---> examining token '%s': search 3rd suffix ...\n",token);
3262 /* ---------- step 3: search for matching third suffix ---------- */
3264 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3266 char *ext3_suffix = ext3_suffixes[l];
3267 int len_ext3_suffix = strlen(ext3_suffix);
3269 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3271 if (!ext3_suffix_found)
3277 if (IS_PARENT_PROCESS())
3278 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3281 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3286 if (IS_PARENT_PROCESS())
3287 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3290 add_dynamic_file_list_entry(dynamic_file_list,
3291 num_dynamic_file_list_entries,
3294 num_suffix_list_entries,
3296 add_property_mapping(property_mapping,
3297 num_property_mapping_entries,
3298 base_index, ext1_index, ext2_index, ext3_index,
3299 current_summarized_file_list_entry);
3305 END_HASH_ITERATION(extra_file_hash, itr)
3307 if (artwork_info->num_dynamic_file_list_entries > 0)
3309 artwork_info->dynamic_artwork_list =
3310 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3311 artwork_info->sizeof_artwork_list_entry);
3314 if (options.verbose && IS_PARENT_PROCESS())
3316 SetupFileList *setup_file_list, *list;
3317 boolean dynamic_tokens_found = FALSE;
3318 boolean unknown_tokens_found = FALSE;
3319 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3321 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3322 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3324 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3326 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3327 dynamic_tokens_found = TRUE;
3329 unknown_tokens_found = TRUE;
3331 END_HASH_ITERATION(extra_file_hash, itr)
3333 if (options.debug && dynamic_tokens_found)
3335 Error(ERR_INFO_LINE, "-");
3336 Error(ERR_INFO, "dynamic token(s) found in config file:");
3337 Error(ERR_INFO, "- config file: '%s'", filename);
3339 for (list = setup_file_list; list != NULL; list = list->next)
3341 char *value = getHashEntry(extra_file_hash, list->token);
3343 if (value != NULL && strEqual(value, known_token_value))
3344 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3347 Error(ERR_INFO_LINE, "-");
3350 if (unknown_tokens_found)
3352 Error(ERR_INFO_LINE, "-");
3353 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3354 Error(ERR_INFO, "- config file: '%s'", filename);
3356 for (list = setup_file_list; list != NULL; list = list->next)
3358 char *value = getHashEntry(extra_file_hash, list->token);
3360 if (value != NULL && !strEqual(value, known_token_value))
3361 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3364 Error(ERR_INFO_LINE, "-");
3367 if (undefined_values_found)
3369 Error(ERR_INFO_LINE, "-");
3370 Error(ERR_INFO, "warning: undefined values found in config file:");
3371 Error(ERR_INFO, "- config file: '%s'", filename);
3373 for (list = setup_file_list; list != NULL; list = list->next)
3375 char *value = getHashEntry(empty_file_hash, list->token);
3378 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3381 Error(ERR_INFO_LINE, "-");
3384 freeSetupFileList(setup_file_list);
3387 freeSetupFileHash(extra_file_hash);
3388 freeSetupFileHash(empty_file_hash);
3391 for (i = 0; i < num_file_list_entries; i++)
3393 printf("'%s' ", file_list[i].token);
3394 if (file_list[i].filename)
3395 printf("-> '%s'\n", file_list[i].filename);
3397 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3402 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3404 struct FileInfo *file_list = artwork_info->file_list;
3405 int num_file_list_entries = artwork_info->num_file_list_entries;
3406 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3407 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3410 DrawInitText("Loading artwork config", 120, FC_GREEN);
3411 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3413 /* always start with reliable default values */
3414 for (i = 0; i < num_file_list_entries; i++)
3416 setString(&file_list[i].filename, file_list[i].default_filename);
3418 for (j = 0; j < num_suffix_list_entries; j++)
3419 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3421 file_list[i].redefined = FALSE;
3422 file_list[i].fallback_to_default = FALSE;
3425 /* free previous dynamic artwork file array */
3426 if (artwork_info->dynamic_file_list != NULL)
3428 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3430 free(artwork_info->dynamic_file_list[i].token);
3431 free(artwork_info->dynamic_file_list[i].filename);
3432 free(artwork_info->dynamic_file_list[i].parameter);
3435 free(artwork_info->dynamic_file_list);
3436 artwork_info->dynamic_file_list = NULL;
3438 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3439 &artwork_info->num_dynamic_file_list_entries);
3442 /* free previous property mapping */
3443 if (artwork_info->property_mapping != NULL)
3445 free(artwork_info->property_mapping);
3447 artwork_info->property_mapping = NULL;
3448 artwork_info->num_property_mapping_entries = 0;
3452 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3454 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3457 /* first look for special artwork configured in level series config */
3458 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3461 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3462 leveldir_current->graphics_set,
3463 leveldir_current->graphics_path);
3466 if (fileExists(filename_base))
3467 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3470 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3472 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3473 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3476 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3477 struct ListNodeInfo **listnode)
3481 char *filename = (*listnode)->source_filename;
3483 if (--(*listnode)->num_references <= 0)
3484 deleteNodeFromList(&artwork_info->content_list, filename,
3485 artwork_info->free_artwork);
3491 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3492 struct ListNodeInfo **listnode,
3493 struct FileInfo *file_list_entry)
3503 char *basename = file_list_entry->filename;
3504 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3506 if (filename == NULL)
3508 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3510 basename = file_list_entry->default_filename;
3512 /* fail for cloned default artwork that has no default filename defined */
3513 if (file_list_entry->default_is_cloned &&
3514 strEqual(basename, UNDEFINED_FILENAME))
3516 int error_mode = ERR_WARN;
3518 /* we can get away without sounds and music, but not without graphics */
3519 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3520 error_mode = ERR_EXIT;
3522 Error(error_mode, "token '%s' was cloned and has no default filename",
3523 file_list_entry->token);
3528 /* dynamic artwork has no default filename / skip empty default artwork */
3529 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3532 file_list_entry->fallback_to_default = TRUE;
3534 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3536 filename = getCustomArtworkFilename(basename, artwork_info->type);
3538 if (filename == NULL)
3540 int error_mode = ERR_WARN;
3542 /* we can get away without sounds and music, but not without graphics */
3543 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3544 error_mode = ERR_EXIT;
3546 Error(error_mode, "cannot find default artwork file '%s'", basename);
3552 /* check if the old and the new artwork file are the same */
3553 if (*listnode && strEqual((*listnode)->source_filename, filename))
3555 /* The old and new artwork are the same (have the same filename and path).
3556 This usually means that this artwork does not exist in this artwork set
3557 and a fallback to the existing artwork is done. */
3560 printf("[artwork '%s' already exists (same list entry)]\n", filename);
3566 /* delete existing artwork file entry */
3567 deleteArtworkListEntry(artwork_info, listnode);
3569 /* check if the new artwork file already exists in the list of artworks */
3570 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3573 printf("[artwork '%s' already exists (other list entry)]\n", filename);
3576 *listnode = (struct ListNodeInfo *)node->content;
3577 (*listnode)->num_references++;
3582 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3583 DrawInitText(basename, 150, FC_YELLOW);
3585 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3588 printf("[adding new artwork '%s']\n", filename);
3591 (*listnode)->num_references = 1;
3592 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3597 int error_mode = ERR_WARN;
3599 /* we can get away without sounds and music, but not without graphics */
3600 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3601 error_mode = ERR_EXIT;
3603 Error(error_mode, "cannot load artwork file '%s'", basename);
3609 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3610 struct ListNodeInfo **listnode,
3611 struct FileInfo *file_list_entry)
3614 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3617 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3619 deleteArtworkListEntry(artwork_info, listnode);
3624 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3627 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3629 struct FileInfo *file_list = artwork_info->file_list;
3630 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3631 int num_file_list_entries = artwork_info->num_file_list_entries;
3632 int num_dynamic_file_list_entries =
3633 artwork_info->num_dynamic_file_list_entries;
3636 print_timestamp_init("ReloadCustomArtworkList");
3638 for (i = 0; i < num_file_list_entries; i++)
3639 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3642 for (i = 0; i < num_dynamic_file_list_entries; i++)
3643 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3644 &dynamic_file_list[i]);
3646 print_timestamp_done("ReloadCustomArtworkList");
3649 dumpList(artwork_info->content_list);
3653 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3654 struct ListNodeInfo ***list,
3655 int *num_list_entries)
3662 for (i = 0; i < *num_list_entries; i++)
3663 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3667 *num_list_entries = 0;
3670 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3672 if (artwork_info == NULL)
3675 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3676 &artwork_info->num_file_list_entries);
3678 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3679 &artwork_info->num_dynamic_file_list_entries);
3683 /* ------------------------------------------------------------------------- */
3684 /* functions only needed for non-Unix (non-command-line) systems */
3685 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3686 /* (now also added for Windows, to create files in user data directory) */
3687 /* ------------------------------------------------------------------------- */
3689 char *getErrorFilename(char *basename)
3691 return getPath2(getUserGameDataDir(), basename);
3694 void openErrorFile()
3696 InitUserDataDirectory();
3698 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3700 program.error_file = stderr;
3702 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3703 program.error_filename, strerror(errno));
3706 /* error output should be unbuffered so it is not truncated in a crash */
3707 setbuf(program.error_file, NULL);
3710 void closeErrorFile()
3712 if (program.error_file != stderr) /* do not close stream 'stderr' */
3713 fclose(program.error_file);
3716 void dumpErrorFile()
3718 FILE *error_file = fopen(program.error_filename, MODE_READ);
3720 if (error_file != NULL)
3722 while (!feof(error_file))
3723 fputc(fgetc(error_file), stderr);
3729 void NotifyUserAboutErrorFile()
3731 #if defined(PLATFORM_WIN32)
3732 char *title_text = getStringCat2(program.program_title, " Error Message");
3733 char *error_text = getStringCat2("The program was aborted due to an error; "
3734 "for details, see the following error file:"
3735 STRING_NEWLINE, program.error_filename);
3737 MessageBox(NULL, error_text, title_text, MB_OK);
3742 /* ------------------------------------------------------------------------- */
3743 /* the following is only for debugging purpose and normally not used */
3744 /* ------------------------------------------------------------------------- */
3748 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3749 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3751 #define DEBUG_NUM_TIMESTAMPS 10
3752 #define DEBUG_TIME_IN_MICROSECONDS 0
3754 #if DEBUG_TIME_IN_MICROSECONDS
3755 static double Counter_Microseconds()
3757 static struct timeval base_time = { 0, 0 };
3758 struct timeval current_time;
3761 gettimeofday(¤t_time, NULL);
3763 /* reset base time in case of wrap-around */
3764 if (current_time.tv_sec < base_time.tv_sec)
3765 base_time = current_time;
3768 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3769 ((double)(current_time.tv_usec - base_time.tv_usec));
3771 return counter; /* return microseconds since last init */
3775 char *debug_print_timestamp_get_padding(int padding_size)
3777 static char *padding = NULL;
3778 int max_padding_size = 100;
3780 if (padding == NULL)
3782 padding = checked_calloc(max_padding_size + 1);
3783 memset(padding, ' ', max_padding_size);
3786 return &padding[MAX(0, max_padding_size - padding_size)];
3789 void debug_print_timestamp(int counter_nr, char *message)
3791 int indent_size = 8;
3792 int padding_size = 40;
3793 float timestamp_interval;
3796 Error(ERR_EXIT, "debugging: invalid negative counter");
3797 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3798 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3800 #if DEBUG_TIME_IN_MICROSECONDS
3801 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3804 counter[counter_nr][0] = Counter_Microseconds();
3806 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3809 counter[counter_nr][0] = Counter();
3812 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3813 counter[counter_nr][1] = counter[counter_nr][0];
3817 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3819 printf("%s%s%s %.3f %s\n",
3821 debug_print_timestamp_get_padding(counter_nr * indent_size),
3823 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3824 timestamp_interval / 1000,
3828 void debug_print_parent_only(char *format, ...)
3830 if (!IS_PARENT_PROCESS())
3837 va_start(ap, format);
3838 vprintf(format, ap);
3847 void print_timestamp_ext(char *message, char *mode)
3849 #if DEBUG_PRINT_INIT_TIMESTAMPS
3850 static char *debug_message = NULL;
3851 static char *last_message = NULL;
3852 static int counter_nr = 0;
3853 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3855 checked_free(debug_message);
3856 debug_message = getStringCat3(mode, " ", message);
3858 if (strEqual(mode, "INIT"))
3860 debug_print_timestamp(counter_nr, NULL);
3862 if (counter_nr + 1 < max_depth)
3863 debug_print_timestamp(counter_nr, debug_message);
3867 debug_print_timestamp(counter_nr, NULL);
3869 else if (strEqual(mode, "DONE"))
3873 if (counter_nr + 1 < max_depth ||
3874 (counter_nr == 0 && max_depth == 1))
3876 last_message = message;
3878 if (counter_nr == 0 && max_depth == 1)
3880 checked_free(debug_message);
3881 debug_message = getStringCat3("TIME", " ", message);
3884 debug_print_timestamp(counter_nr, debug_message);
3887 else if (!strEqual(mode, "TIME") ||
3888 !strEqual(message, last_message))
3890 if (counter_nr < max_depth)
3891 debug_print_timestamp(counter_nr, debug_message);
3896 void print_timestamp_init(char *message)
3898 print_timestamp_ext(message, "INIT");
3901 void print_timestamp_time(char *message)
3903 print_timestamp_ext(message, "TIME");
3906 void print_timestamp_done(char *message)
3908 print_timestamp_ext(message, "DONE");