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 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 #if defined(PLATFORM_ANDROID)
45 static int android_log_prio = ANDROID_LOG_INFO;
49 static void vfPrintLog(FILE *stream, char *format, va_list ap)
53 static void vfPrintLog(FILE *stream, char *format, va_list ap)
57 static void fPrintLog(FILE *stream, char *format, va_list ap)
61 static void fPrintLog(FILE *stream, char *format, va_list ap)
66 static void vfprintf_nonewline(FILE *stream, char *format, va_list ap)
68 #if defined(PLATFORM_ANDROID)
69 // (prefix text of logging output is currently skipped on Android)
70 //__android_log_vprint(android_log_prio, program.program_title, format, ap);
75 vfprintf(stream, format, ap);
76 vfprintf(stderr, format, ap2);
82 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
84 #if defined(PLATFORM_ANDROID)
85 __android_log_vprint(android_log_prio, program.program_title, format, ap);
87 char *newline = STRING_NEWLINE;
92 vfprintf(stream, format, ap);
93 fprintf(stream, "%s", newline);
95 vfprintf(stderr, format, ap2);
96 fprintf(stderr, "%s", newline);
102 static void fprintf_nonewline(FILE *stream, char *format, ...)
106 va_start(ap, format);
107 vfprintf_nonewline(stream, format, ap);
111 static void fprintf_newline(FILE *stream, char *format, ...)
115 va_start(ap, format);
116 vfprintf_newline(stream, format, ap);
120 void fprintf_line(FILE *stream, char *line_chars, int line_length)
124 for (i = 0; i < line_length; i++)
125 fprintf_nonewline(stream, "%s", line_chars);
127 fprintf_newline(stream, "");
130 void printf_line(char *line_chars, int line_length)
132 fprintf_line(stdout, line_chars, line_length);
135 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
137 fprintf(stdout, "%s", prefix);
138 fprintf_line(stdout, line_chars, line_length);
142 /* ------------------------------------------------------------------------- */
143 /* string functions */
144 /* ------------------------------------------------------------------------- */
146 /* int2str() returns a number converted to a string;
147 the used memory is static, but will be overwritten by later calls,
148 so if you want to save the result, copy it to a private string buffer;
149 there can be 10 local calls of int2str() without buffering the result --
150 the 11th call will then destroy the result from the first call and so on.
153 char *int2str(int number, int size)
155 static char shift_array[10][40];
156 static int shift_counter = 0;
157 char *s = shift_array[shift_counter];
159 shift_counter = (shift_counter + 1) % 10;
166 sprintf(s, " %09d", number);
167 return &s[strlen(s) - size];
171 sprintf(s, "%d", number);
177 /* something similar to "int2str()" above, but allocates its own memory
178 and has a different interface; we cannot use "itoa()", because this
179 seems to be already defined when cross-compiling to the win32 target */
181 char *i_to_a(unsigned int i)
183 static char *a = NULL;
187 if (i > 2147483647) /* yes, this is a kludge */
190 a = checked_malloc(10 + 1);
198 /* calculate base-2 logarithm of argument (rounded down to integer;
199 this function returns the number of the highest bit set in argument) */
201 int log_2(unsigned int x)
207 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
214 boolean getTokenValueFromString(char *string, char **token, char **value)
216 return getTokenValueFromSetupLine(string, token, value);
220 /* ------------------------------------------------------------------------- */
221 /* counter functions */
222 /* ------------------------------------------------------------------------- */
224 /* maximal allowed length of a command line option */
225 #define MAX_OPTION_LEN 256
229 #if defined(TARGET_SDL)
230 static unsigned int getCurrentMS()
232 return SDL_GetTicks();
236 static unsigned int mainCounter(int mode)
238 static unsigned int base_ms = 0;
239 unsigned int current_ms;
241 /* get current system milliseconds */
242 current_ms = getCurrentMS();
244 /* reset base timestamp in case of counter reset or wrap-around */
245 if (mode == INIT_COUNTER || current_ms < base_ms)
246 base_ms = current_ms;
248 /* return milliseconds since last counter reset */
249 return current_ms - base_ms;
254 #if defined(TARGET_SDL)
255 static unsigned int mainCounter(int mode)
257 static unsigned int base_ms = 0;
258 unsigned int current_ms;
259 unsigned int counter_ms;
261 current_ms = SDL_GetTicks();
263 /* reset base time in case of counter initializing or wrap-around */
264 if (mode == INIT_COUNTER || current_ms < base_ms)
265 base_ms = current_ms;
267 counter_ms = current_ms - base_ms;
269 return counter_ms; /* return milliseconds since last init */
275 void InitCounter() /* set counter back to zero */
277 mainCounter(INIT_COUNTER);
280 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
282 return mainCounter(READ_COUNTER);
285 static void sleep_milliseconds(unsigned int milliseconds_delay)
287 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
291 /* we want to wait only a few ms -- if we assume that we have a
292 kernel timer resolution of 10 ms, we would wait far to long;
293 therefore it's better to do a short interval of busy waiting
294 to get our sleeping time more accurate */
296 unsigned int base_counter = Counter(), actual_counter = Counter();
298 while (actual_counter < base_counter + milliseconds_delay &&
299 actual_counter >= base_counter)
300 actual_counter = Counter();
304 #if defined(TARGET_SDL)
305 SDL_Delay(milliseconds_delay);
307 struct timeval delay;
309 delay.tv_sec = milliseconds_delay / 1000;
310 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
312 if (select(0, NULL, NULL, NULL, &delay) != 0)
313 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
318 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
320 sleep_milliseconds(delay);
323 boolean FrameReached(unsigned int *frame_counter_var,
324 unsigned int frame_delay)
326 unsigned int actual_frame_counter = FrameCounter;
328 if (actual_frame_counter >= *frame_counter_var &&
329 actual_frame_counter < *frame_counter_var + frame_delay)
332 *frame_counter_var = actual_frame_counter;
337 boolean DelayReached(unsigned int *counter_var,
340 unsigned int actual_counter = Counter();
342 if (actual_counter >= *counter_var &&
343 actual_counter < *counter_var + delay)
346 *counter_var = actual_counter;
351 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
353 unsigned int actual_counter;
357 actual_counter = Counter();
359 if (actual_counter >= *counter_var &&
360 actual_counter < *counter_var + delay)
361 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
366 *counter_var = actual_counter;
370 /* ------------------------------------------------------------------------- */
371 /* random generator functions */
372 /* ------------------------------------------------------------------------- */
374 unsigned int init_random_number(int nr, int seed)
376 if (seed == NEW_RANDOMIZE)
378 /* default random seed */
379 seed = (int)time(NULL); // seconds since the epoch
381 #if !defined(PLATFORM_WIN32)
382 /* add some more randomness */
383 struct timeval current_time;
385 gettimeofday(¤t_time, NULL);
387 seed += (int)current_time.tv_usec; // microseconds since the epoch
390 #if defined(TARGET_SDL)
391 /* add some more randomness */
392 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
396 /* add some more randomness */
397 seed += GetSimpleRandom(1000000);
401 srandom_linux_libc(nr, (unsigned int) seed);
403 return (unsigned int) seed;
406 unsigned int get_random_number(int nr, int max)
408 return (max > 0 ? random_linux_libc(nr) % max : 0);
412 /* ------------------------------------------------------------------------- */
413 /* system info functions */
414 /* ------------------------------------------------------------------------- */
416 #if !defined(PLATFORM_ANDROID)
417 static char *get_corrected_real_name(char *real_name)
419 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
420 char *from_ptr = real_name;
421 char *to_ptr = real_name_new;
423 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
424 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
426 /* the name field read from "passwd" file may also contain additional
427 user information, separated by commas, which will be removed here */
428 if (*from_ptr == ',')
431 /* the user's real name may contain 'ß' characters (german sharp s),
432 which have no equivalent in upper case letters (used by our fonts) */
433 if (*from_ptr == 'ß')
440 *to_ptr++ = *from_ptr++;
445 return real_name_new;
451 static char *login_name = NULL;
453 #if defined(PLATFORM_WIN32)
454 if (login_name == NULL)
456 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
457 login_name = checked_malloc(buffer_size);
459 if (GetUserName(login_name, &buffer_size) == 0)
460 strcpy(login_name, ANONYMOUS_NAME);
463 if (login_name == NULL)
467 if ((pwd = getpwuid(getuid())) == NULL)
468 login_name = ANONYMOUS_NAME;
470 login_name = getStringCopy(pwd->pw_name);
479 static char *real_name = NULL;
481 #if defined(PLATFORM_WIN32)
482 if (real_name == NULL)
484 static char buffer[MAX_USERNAME_LEN + 1];
485 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
487 if (GetUserName(buffer, &buffer_size) != 0)
488 real_name = get_corrected_real_name(buffer);
490 real_name = ANONYMOUS_NAME;
492 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
493 if (real_name == NULL)
497 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
498 real_name = get_corrected_real_name(pwd->pw_gecos);
500 real_name = ANONYMOUS_NAME;
503 real_name = ANONYMOUS_NAME;
509 time_t getFileTimestampEpochSeconds(char *filename)
511 struct stat file_status;
513 if (stat(filename, &file_status) != 0) /* cannot stat file */
516 return file_status.st_mtime;
520 /* ------------------------------------------------------------------------- */
521 /* path manipulation functions */
522 /* ------------------------------------------------------------------------- */
524 static char *getLastPathSeparatorPtr(char *filename)
526 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
528 if (last_separator == NULL) /* also try DOS/Windows variant */
529 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
531 return last_separator;
534 char *getBaseNamePtr(char *filename)
536 char *last_separator = getLastPathSeparatorPtr(filename);
538 if (last_separator != NULL)
539 return last_separator + 1; /* separator found: strip base path */
541 return filename; /* no separator found: filename has no path */
544 char *getBaseName(char *filename)
546 return getStringCopy(getBaseNamePtr(filename));
549 char *getBasePath(char *filename)
551 char *basepath = getStringCopy(filename);
552 char *last_separator = getLastPathSeparatorPtr(basepath);
554 if (last_separator != NULL)
555 *last_separator = '\0'; /* separator found: strip basename */
557 basepath = "."; /* no separator found: use current path */
562 static char *getProgramMainDataPath()
564 char *main_data_path = getStringCopy(program.command_basepath);
566 #if defined(PLATFORM_MACOSX)
567 static char *main_data_binary_subdir = NULL;
569 if (main_data_binary_subdir == NULL)
571 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
573 strlen(MAC_APP_BINARY_SUBDIR) + 1);
575 sprintf(main_data_binary_subdir, "%s.app/%s",
576 program.program_title, MAC_APP_BINARY_SUBDIR);
579 // cut relative path to Mac OS X application binary directory from path
580 if (strSuffix(main_data_path, main_data_binary_subdir))
581 main_data_path[strlen(main_data_path) -
582 strlen(main_data_binary_subdir)] = '\0';
584 // cut trailing path separator from path (but not if path is root directory)
585 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
586 main_data_path[strlen(main_data_path) - 1] = '\0';
589 return main_data_path;
593 /* ------------------------------------------------------------------------- */
594 /* various string functions */
595 /* ------------------------------------------------------------------------- */
597 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
599 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
602 sprintf(complete_string, "%s%s%s", s1, sep, s2);
604 return complete_string;
607 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
609 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
610 strlen(s2) + strlen(sep) +
613 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
615 return complete_string;
618 char *getStringCat2(char *s1, char *s2)
620 return getStringCat2WithSeparator(s1, s2, "");
623 char *getStringCat3(char *s1, char *s2, char *s3)
625 return getStringCat3WithSeparator(s1, s2, s3, "");
628 char *getPath2(char *path1, char *path2)
630 #if defined(PLATFORM_ANDROID)
631 // workaround for reading from APK assets directory -- skip leading "./"
632 if (strEqual(path1, "."))
633 return getStringCopy(path2);
636 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
639 char *getPath3(char *path1, char *path2, char *path3)
641 #if defined(PLATFORM_ANDROID)
642 // workaround for reading from APK assets directory -- skip leading "./"
643 if (strEqual(path1, "."))
644 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
647 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
650 char *getStringCopy(const char *s)
657 s_copy = checked_malloc(strlen(s) + 1);
663 char *getStringCopyN(const char *s, int n)
666 int s_len = MAX(0, n);
671 s_copy = checked_malloc(s_len + 1);
672 strncpy(s_copy, s, s_len);
673 s_copy[s_len] = '\0';
678 char *getStringCopyNStatic(const char *s, int n)
680 static char *s_copy = NULL;
682 checked_free(s_copy);
684 s_copy = getStringCopyN(s, n);
689 char *getStringToLower(const char *s)
691 char *s_copy = checked_malloc(strlen(s) + 1);
692 char *s_ptr = s_copy;
695 *s_ptr++ = tolower(*s++);
701 void setString(char **old_value, char *new_value)
703 checked_free(*old_value);
705 *old_value = getStringCopy(new_value);
708 boolean strEqual(char *s1, char *s2)
710 return (s1 == NULL && s2 == NULL ? TRUE :
711 s1 == NULL && s2 != NULL ? FALSE :
712 s1 != NULL && s2 == NULL ? FALSE :
713 strcmp(s1, s2) == 0);
716 boolean strEqualN(char *s1, char *s2, int n)
718 return (s1 == NULL && s2 == NULL ? TRUE :
719 s1 == NULL && s2 != NULL ? FALSE :
720 s1 != NULL && s2 == NULL ? FALSE :
721 strncmp(s1, s2, n) == 0);
724 boolean strPrefix(char *s, char *prefix)
726 return (s == NULL && prefix == NULL ? TRUE :
727 s == NULL && prefix != NULL ? FALSE :
728 s != NULL && prefix == NULL ? FALSE :
729 strncmp(s, prefix, strlen(prefix)) == 0);
732 boolean strSuffix(char *s, char *suffix)
734 return (s == NULL && suffix == NULL ? TRUE :
735 s == NULL && suffix != NULL ? FALSE :
736 s != NULL && suffix == NULL ? FALSE :
737 strlen(s) < strlen(suffix) ? FALSE :
738 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
741 boolean strPrefixLower(char *s, char *prefix)
743 char *s_lower = getStringToLower(s);
744 boolean match = strPrefix(s_lower, prefix);
751 boolean strSuffixLower(char *s, char *suffix)
753 char *s_lower = getStringToLower(s);
754 boolean match = strSuffix(s_lower, suffix);
762 /* ------------------------------------------------------------------------- */
763 /* command line option handling functions */
764 /* ------------------------------------------------------------------------- */
766 void GetOptions(char *argv[],
767 void (*print_usage_function)(void),
768 void (*print_version_function)(void))
770 char *ro_base_path = RO_BASE_PATH;
771 char *rw_base_path = RW_BASE_PATH;
772 char **options_left = &argv[1];
775 /* if the program is configured to start from current directory (default),
776 determine program package directory from program binary (some versions
777 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
778 set the current working directory to the program package directory) */
780 if (strEqual(ro_base_path, "."))
781 ro_base_path = getProgramMainDataPath();
782 if (strEqual(rw_base_path, "."))
783 rw_base_path = getProgramMainDataPath();
786 #if !defined(PLATFORM_MACOSX)
787 /* if the program is configured to start from current directory (default),
788 determine program package directory (KDE/Konqueror does not do this by
789 itself and fails otherwise); on Mac OS X, the program binary is stored
790 in an application package directory -- do not try to use this directory
791 as the program data directory (Mac OS X handles this correctly anyway) */
793 if (strEqual(ro_base_path, "."))
794 ro_base_path = program.command_basepath;
795 if (strEqual(rw_base_path, "."))
796 rw_base_path = program.command_basepath;
801 /* initialize global program options */
802 options.display_name = NULL;
803 options.server_host = NULL;
804 options.server_port = 0;
806 options.ro_base_directory = ro_base_path;
807 options.rw_base_directory = rw_base_path;
808 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
809 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
810 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
811 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
812 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
814 options.execute_command = NULL;
815 options.special_flags = NULL;
817 options.serveronly = FALSE;
818 options.network = FALSE;
819 options.verbose = FALSE;
820 options.debug = FALSE;
821 options.debug_x11_sync = FALSE;
824 options.verbose = TRUE;
826 #if !defined(PLATFORM_UNIX)
827 if (*options_left == NULL) /* no options given -- enable verbose mode */
828 options.verbose = TRUE;
832 while (*options_left)
834 char option_str[MAX_OPTION_LEN];
835 char *option = options_left[0];
836 char *next_option = options_left[1];
837 char *option_arg = NULL;
838 int option_len = strlen(option);
840 if (option_len >= MAX_OPTION_LEN)
841 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
843 strcpy(option_str, option); /* copy argument into buffer */
846 if (strEqual(option, "--")) /* stop scanning arguments */
849 if (strPrefix(option, "--")) /* treat '--' like '-' */
852 option_arg = strchr(option, '=');
853 if (option_arg == NULL) /* no '=' in option */
854 option_arg = next_option;
857 *option_arg++ = '\0'; /* cut argument from option */
858 if (*option_arg == '\0') /* no argument after '=' */
859 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
862 option_len = strlen(option);
864 if (strEqual(option, "-"))
866 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
868 else if (strncmp(option, "-help", option_len) == 0)
870 print_usage_function();
874 else if (strncmp(option, "-display", option_len) == 0)
876 if (option_arg == NULL)
877 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
879 options.display_name = option_arg;
880 if (option_arg == next_option)
883 else if (strncmp(option, "-basepath", option_len) == 0)
885 if (option_arg == NULL)
886 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
888 /* this should be extended to separate options for ro and rw data */
889 options.ro_base_directory = ro_base_path = option_arg;
890 options.rw_base_directory = rw_base_path = option_arg;
891 if (option_arg == next_option)
894 /* adjust paths for sub-directories in base directory accordingly */
895 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
896 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
897 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
898 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
899 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
901 else if (strncmp(option, "-levels", option_len) == 0)
903 if (option_arg == NULL)
904 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
906 options.level_directory = option_arg;
907 if (option_arg == next_option)
910 else if (strncmp(option, "-graphics", option_len) == 0)
912 if (option_arg == NULL)
913 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
915 options.graphics_directory = option_arg;
916 if (option_arg == next_option)
919 else if (strncmp(option, "-sounds", option_len) == 0)
921 if (option_arg == NULL)
922 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
924 options.sounds_directory = option_arg;
925 if (option_arg == next_option)
928 else if (strncmp(option, "-music", option_len) == 0)
930 if (option_arg == NULL)
931 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
933 options.music_directory = option_arg;
934 if (option_arg == next_option)
937 else if (strncmp(option, "-network", option_len) == 0)
939 options.network = TRUE;
941 else if (strncmp(option, "-serveronly", option_len) == 0)
943 options.serveronly = TRUE;
945 else if (strncmp(option, "-debug", option_len) == 0)
947 options.debug = TRUE;
949 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
951 options.debug_x11_sync = TRUE;
953 else if (strncmp(option, "-verbose", option_len) == 0)
955 options.verbose = TRUE;
957 else if (strncmp(option, "-version", option_len) == 0 ||
958 strncmp(option, "-V", option_len) == 0)
960 print_version_function();
964 else if (strPrefix(option, "-D"))
967 options.special_flags = getStringCopy(&option[2]);
969 char *flags_string = &option[2];
970 unsigned int flags_value;
972 if (*flags_string == '\0')
973 Error(ERR_EXIT_HELP, "empty flag ignored");
975 flags_value = get_special_flags_function(flags_string);
977 if (flags_value == 0)
978 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
980 options.special_flags |= flags_value;
983 else if (strncmp(option, "-execute", option_len) == 0)
985 if (option_arg == NULL)
986 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
988 options.execute_command = option_arg;
989 if (option_arg == next_option)
992 /* when doing batch processing, always enable verbose mode (warnings) */
993 options.verbose = TRUE;
995 else if (*option == '-')
997 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
999 else if (options.server_host == NULL)
1001 options.server_host = *options_left;
1003 else if (options.server_port == 0)
1005 options.server_port = atoi(*options_left);
1006 if (options.server_port < 1024)
1007 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1010 Error(ERR_EXIT_HELP, "too many arguments");
1017 /* ------------------------------------------------------------------------- */
1018 /* error handling functions */
1019 /* ------------------------------------------------------------------------- */
1021 #define MAX_INTERNAL_ERROR_SIZE 1024
1023 /* used by SetError() and GetError() to store internal error messages */
1024 static char internal_error[MAX_INTERNAL_ERROR_SIZE];
1026 void SetError(char *format, ...)
1030 va_start(ap, format);
1031 vsnprintf(internal_error, MAX_INTERNAL_ERROR_SIZE, format, ap);
1037 return internal_error;
1040 void Error(int mode, char *format, ...)
1042 static boolean last_line_was_separator = FALSE;
1043 char *process_name = "";
1045 #if defined(PLATFORM_ANDROID)
1046 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1047 mode & ERR_INFO ? ANDROID_LOG_INFO :
1048 mode & ERR_WARN ? ANDROID_LOG_WARN :
1049 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1050 ANDROID_LOG_UNKNOWN);
1054 /* display warnings only when running in verbose mode */
1055 if (mode & ERR_WARN && !options.verbose)
1059 if (mode == ERR_INFO_LINE)
1061 if (!last_line_was_separator)
1062 fprintf_line(program.error_file, format, 79);
1064 last_line_was_separator = TRUE;
1069 last_line_was_separator = FALSE;
1071 if (mode & ERR_SOUND_SERVER)
1072 process_name = " sound server";
1073 else if (mode & ERR_NETWORK_SERVER)
1074 process_name = " network server";
1075 else if (mode & ERR_NETWORK_CLIENT)
1076 process_name = " network client **";
1082 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1085 if (mode & ERR_WARN)
1086 fprintf_nonewline(program.error_file, "warning: ");
1088 va_start(ap, format);
1089 vfprintf_newline(program.error_file, format, ap);
1092 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1094 va_start(ap, format);
1095 program.exit_message_function(format, ap);
1100 if (mode & ERR_HELP)
1101 fprintf_newline(program.error_file,
1102 "%s: Try option '--help' for more information.",
1103 program.command_basename);
1105 if (mode & ERR_EXIT)
1106 fprintf_newline(program.error_file, "%s%s: aborting",
1107 program.command_basename, process_name);
1109 if (mode & ERR_EXIT)
1111 if (mode & ERR_FROM_SERVER)
1112 exit(1); /* child process: normal exit */
1114 program.exit_function(1); /* main process: clean up stuff */
1119 /* ------------------------------------------------------------------------- */
1120 /* checked memory allocation and freeing functions */
1121 /* ------------------------------------------------------------------------- */
1123 void *checked_malloc(unsigned int size)
1130 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1135 void *checked_calloc(unsigned int size)
1139 ptr = calloc(1, size);
1142 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1147 void *checked_realloc(void *ptr, unsigned int size)
1149 ptr = realloc(ptr, size);
1152 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1157 void checked_free(void *ptr)
1159 if (ptr != NULL) /* this check should be done by free() anyway */
1163 void clear_mem(void *ptr, unsigned int size)
1165 #if defined(PLATFORM_WIN32)
1166 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1167 char *cptr = (char *)ptr;
1172 memset(ptr, 0, size);
1177 /* ------------------------------------------------------------------------- */
1178 /* various helper functions */
1179 /* ------------------------------------------------------------------------- */
1181 inline void swap_numbers(int *i1, int *i2)
1189 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1201 /* the "put" variants of the following file access functions check for the file
1202 pointer being != NULL and return the number of bytes they have or would have
1203 written; this allows for chunk writing functions to first determine the size
1204 of the (not yet written) chunk, write the correct chunk size and finally
1205 write the chunk itself */
1209 int getFile8BitInteger(File *file)
1211 return getByteFromFile(file);
1216 int getFile8BitInteger(FILE *file)
1223 int putFile8BitInteger(FILE *file, int value)
1233 int getFile16BitInteger(File *file, int byte_order)
1235 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1236 return ((getByteFromFile(file) << 8) |
1237 (getByteFromFile(file) << 0));
1238 else /* BYTE_ORDER_LITTLE_ENDIAN */
1239 return ((getByteFromFile(file) << 0) |
1240 (getByteFromFile(file) << 8));
1245 int getFile16BitInteger(FILE *file, int byte_order)
1247 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1248 return ((fgetc(file) << 8) |
1249 (fgetc(file) << 0));
1250 else /* BYTE_ORDER_LITTLE_ENDIAN */
1251 return ((fgetc(file) << 0) |
1252 (fgetc(file) << 8));
1257 int putFile16BitInteger(FILE *file, int value, int byte_order)
1261 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1263 fputc((value >> 8) & 0xff, file);
1264 fputc((value >> 0) & 0xff, file);
1266 else /* BYTE_ORDER_LITTLE_ENDIAN */
1268 fputc((value >> 0) & 0xff, file);
1269 fputc((value >> 8) & 0xff, file);
1278 int getFile32BitInteger(File *file, int byte_order)
1280 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1281 return ((getByteFromFile(file) << 24) |
1282 (getByteFromFile(file) << 16) |
1283 (getByteFromFile(file) << 8) |
1284 (getByteFromFile(file) << 0));
1285 else /* BYTE_ORDER_LITTLE_ENDIAN */
1286 return ((getByteFromFile(file) << 0) |
1287 (getByteFromFile(file) << 8) |
1288 (getByteFromFile(file) << 16) |
1289 (getByteFromFile(file) << 24));
1294 int getFile32BitInteger(FILE *file, int byte_order)
1296 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1297 return ((fgetc(file) << 24) |
1298 (fgetc(file) << 16) |
1299 (fgetc(file) << 8) |
1300 (fgetc(file) << 0));
1301 else /* BYTE_ORDER_LITTLE_ENDIAN */
1302 return ((fgetc(file) << 0) |
1303 (fgetc(file) << 8) |
1304 (fgetc(file) << 16) |
1305 (fgetc(file) << 24));
1310 int putFile32BitInteger(FILE *file, int value, int byte_order)
1314 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1316 fputc((value >> 24) & 0xff, file);
1317 fputc((value >> 16) & 0xff, file);
1318 fputc((value >> 8) & 0xff, file);
1319 fputc((value >> 0) & 0xff, file);
1321 else /* BYTE_ORDER_LITTLE_ENDIAN */
1323 fputc((value >> 0) & 0xff, file);
1324 fputc((value >> 8) & 0xff, file);
1325 fputc((value >> 16) & 0xff, file);
1326 fputc((value >> 24) & 0xff, file);
1335 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1338 const int chunk_name_length = 4;
1340 /* read chunk name */
1341 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1344 if (chunk_size != NULL)
1346 /* read chunk size */
1347 *chunk_size = getFile32BitInteger(file, byte_order);
1350 return (checkEndOfFile(file) ? FALSE : TRUE);
1355 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1358 const int chunk_name_length = 4;
1360 /* read chunk name */
1361 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1364 if (chunk_size != NULL)
1366 /* read chunk size */
1367 *chunk_size = getFile32BitInteger(file, byte_order);
1370 return (feof(file) || ferror(file) ? FALSE : TRUE);
1375 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1380 /* write chunk name */
1382 fputs(chunk_name, file);
1384 num_bytes += strlen(chunk_name);
1386 if (chunk_size >= 0)
1388 /* write chunk size */
1390 putFile32BitInteger(file, chunk_size, byte_order);
1400 int getFileVersion(File *file)
1402 int version_major = getByteFromFile(file);
1403 int version_minor = getByteFromFile(file);
1404 int version_patch = getByteFromFile(file);
1405 int version_build = getByteFromFile(file);
1407 return VERSION_IDENT(version_major, version_minor, version_patch,
1413 int getFileVersion(FILE *file)
1415 int version_major = fgetc(file);
1416 int version_minor = fgetc(file);
1417 int version_patch = fgetc(file);
1418 int version_build = fgetc(file);
1420 return VERSION_IDENT(version_major, version_minor, version_patch,
1426 int putFileVersion(FILE *file, int version)
1430 int version_major = VERSION_MAJOR(version);
1431 int version_minor = VERSION_MINOR(version);
1432 int version_patch = VERSION_PATCH(version);
1433 int version_build = VERSION_BUILD(version);
1435 fputc(version_major, file);
1436 fputc(version_minor, file);
1437 fputc(version_patch, file);
1438 fputc(version_build, file);
1446 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1450 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1451 buffer[i] = getByteFromFile(file);
1456 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1460 for(i = 0; i < bytes && !feof(file); i++)
1461 buffer[i] = fgetc(file);
1466 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1470 for(i = 0; i < bytes; i++)
1471 fputc(buffer[i], file);
1476 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1478 while (bytes-- && !checkEndOfFile(file))
1479 getByteFromFile(file);
1484 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1486 while (bytes-- && !feof(file))
1492 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1499 /* ------------------------------------------------------------------------- */
1500 /* functions to translate key identifiers between different format */
1501 /* ------------------------------------------------------------------------- */
1503 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1504 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1505 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1506 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1508 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1517 /* normal cursor keys */
1518 { KSYM_Left, "XK_Left", "cursor left" },
1519 { KSYM_Right, "XK_Right", "cursor right" },
1520 { KSYM_Up, "XK_Up", "cursor up" },
1521 { KSYM_Down, "XK_Down", "cursor down" },
1523 /* keypad cursor keys */
1525 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1526 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1527 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1528 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1531 /* other keypad keys */
1532 #ifdef KSYM_KP_Enter
1533 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1534 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1535 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1536 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1537 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1538 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1542 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1543 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1544 { KSYM_Control_L, "XK_Control_L", "left control" },
1545 { KSYM_Control_R, "XK_Control_R", "right control" },
1546 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1547 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1548 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1549 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1550 #if !defined(TARGET_SDL2)
1551 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1552 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1554 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1555 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1557 /* some special keys */
1558 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1559 { KSYM_Delete, "XK_Delete", "delete" },
1560 { KSYM_Insert, "XK_Insert", "insert" },
1561 { KSYM_Tab, "XK_Tab", "tab" },
1562 { KSYM_Home, "XK_Home", "home" },
1563 { KSYM_End, "XK_End", "end" },
1564 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1565 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1567 #if defined(TARGET_SDL2)
1568 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1569 { KSYM_Back, "XK_Back", "back" }, /* back key */
1572 /* ASCII 0x20 to 0x40 keys (except numbers) */
1573 { KSYM_space, "XK_space", "space" },
1574 { KSYM_exclam, "XK_exclam", "!" },
1575 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1576 { KSYM_numbersign, "XK_numbersign", "#" },
1577 { KSYM_dollar, "XK_dollar", "$" },
1578 { KSYM_percent, "XK_percent", "%" },
1579 { KSYM_ampersand, "XK_ampersand", "&" },
1580 { KSYM_apostrophe, "XK_apostrophe", "'" },
1581 { KSYM_parenleft, "XK_parenleft", "(" },
1582 { KSYM_parenright, "XK_parenright", ")" },
1583 { KSYM_asterisk, "XK_asterisk", "*" },
1584 { KSYM_plus, "XK_plus", "+" },
1585 { KSYM_comma, "XK_comma", "," },
1586 { KSYM_minus, "XK_minus", "-" },
1587 { KSYM_period, "XK_period", "." },
1588 { KSYM_slash, "XK_slash", "/" },
1589 { KSYM_colon, "XK_colon", ":" },
1590 { KSYM_semicolon, "XK_semicolon", ";" },
1591 { KSYM_less, "XK_less", "<" },
1592 { KSYM_equal, "XK_equal", "=" },
1593 { KSYM_greater, "XK_greater", ">" },
1594 { KSYM_question, "XK_question", "?" },
1595 { KSYM_at, "XK_at", "@" },
1597 /* more ASCII keys */
1598 { KSYM_bracketleft, "XK_bracketleft", "[" },
1599 { KSYM_backslash, "XK_backslash", "\\" },
1600 { KSYM_bracketright,"XK_bracketright", "]" },
1601 { KSYM_asciicircum, "XK_asciicircum", "^" },
1602 { KSYM_underscore, "XK_underscore", "_" },
1603 { KSYM_grave, "XK_grave", "grave" },
1604 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1605 { KSYM_braceleft, "XK_braceleft", "brace left" },
1606 { KSYM_bar, "XK_bar", "bar" },
1607 { KSYM_braceright, "XK_braceright", "brace right" },
1608 { KSYM_asciitilde, "XK_asciitilde", "~" },
1610 /* special (non-ASCII) keys (ISO-Latin-1) */
1611 { KSYM_degree, "XK_degree", "°" },
1612 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1613 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1614 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1615 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1616 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1617 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1618 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1620 #if defined(TARGET_SDL2)
1621 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1622 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1623 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1624 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1625 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1626 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1627 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1628 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1629 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1631 /* other keys (for reverse mapping only) */
1632 { KSYM_space, "XK_space", " " },
1635 #if defined(TARGET_SDL2)
1636 /* keypad keys are not in numerical order in SDL2 */
1637 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1638 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1639 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1640 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1641 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1642 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1643 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1644 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1645 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1646 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1649 /* end-of-array identifier */
1655 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1657 static char name_buffer[30];
1660 if (key >= KSYM_A && key <= KSYM_Z)
1661 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1662 else if (key >= KSYM_a && key <= KSYM_z)
1663 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1664 else if (key >= KSYM_0 && key <= KSYM_9)
1665 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1666 #if !defined(TARGET_SDL2)
1667 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1668 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1670 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1671 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1672 else if (key == KSYM_UNDEFINED)
1673 strcpy(name_buffer, "(undefined)");
1680 if (key == translate_key[i].key)
1682 strcpy(name_buffer, translate_key[i].name);
1686 while (translate_key[++i].name);
1688 if (!translate_key[i].name)
1689 strcpy(name_buffer, "(unknown)");
1692 *name = name_buffer;
1694 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1696 static char name_buffer[30];
1699 if (key >= KSYM_A && key <= KSYM_Z)
1700 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1701 else if (key >= KSYM_a && key <= KSYM_z)
1702 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1703 else if (key >= KSYM_0 && key <= KSYM_9)
1704 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1705 #if !defined(TARGET_SDL2)
1706 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1707 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1709 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1710 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1711 else if (key == KSYM_UNDEFINED)
1712 strcpy(name_buffer, "[undefined]");
1719 if (key == translate_key[i].key)
1721 strcpy(name_buffer, translate_key[i].x11name);
1725 while (translate_key[++i].x11name);
1727 if (!translate_key[i].x11name)
1728 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1731 *x11name = name_buffer;
1733 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1735 Key key = KSYM_UNDEFINED;
1736 char *name_ptr = *name;
1738 if (strlen(*name) == 1)
1740 char c = name_ptr[0];
1742 if (c >= 'A' && c <= 'Z')
1743 key = KSYM_A + (Key)(c - 'A');
1744 else if (c >= 'a' && c <= 'z')
1745 key = KSYM_a + (Key)(c - 'a');
1746 else if (c >= '0' && c <= '9')
1747 key = KSYM_0 + (Key)(c - '0');
1750 if (key == KSYM_UNDEFINED)
1756 if (strEqual(translate_key[i].name, *name))
1758 key = translate_key[i].key;
1762 while (translate_key[++i].x11name);
1765 if (key == KSYM_UNDEFINED)
1766 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1770 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1772 Key key = KSYM_UNDEFINED;
1773 char *name_ptr = *x11name;
1775 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1777 char c = name_ptr[3];
1779 if (c >= 'A' && c <= 'Z')
1780 key = KSYM_A + (Key)(c - 'A');
1781 else if (c >= 'a' && c <= 'z')
1782 key = KSYM_a + (Key)(c - 'a');
1783 else if (c >= '0' && c <= '9')
1784 key = KSYM_0 + (Key)(c - '0');
1786 #if !defined(TARGET_SDL2)
1787 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1789 char c = name_ptr[6];
1791 if (c >= '0' && c <= '9')
1792 key = KSYM_KP_0 + (Key)(c - '0');
1795 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1797 char c1 = name_ptr[4];
1798 char c2 = name_ptr[5];
1801 if ((c1 >= '0' && c1 <= '9') &&
1802 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1803 d = atoi(&name_ptr[4]);
1805 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1806 key = KSYM_F1 + (Key)(d - 1);
1808 else if (strPrefix(name_ptr, "XK_"))
1814 if (strEqual(name_ptr, translate_key[i].x11name))
1816 key = translate_key[i].key;
1820 while (translate_key[++i].x11name);
1822 else if (strPrefix(name_ptr, "0x"))
1824 unsigned int value = 0;
1830 char c = *name_ptr++;
1833 if (c >= '0' && c <= '9')
1835 else if (c >= 'a' && c <= 'f')
1836 d = (int)(c - 'a' + 10);
1837 else if (c >= 'A' && c <= 'F')
1838 d = (int)(c - 'A' + 10);
1846 value = value * 16 + d;
1857 char *getKeyNameFromKey(Key key)
1861 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1865 char *getX11KeyNameFromKey(Key key)
1869 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1873 Key getKeyFromKeyName(char *name)
1877 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1881 Key getKeyFromX11KeyName(char *x11name)
1885 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1889 char getCharFromKey(Key key)
1891 char *keyname = getKeyNameFromKey(key);
1894 if (strlen(keyname) == 1)
1896 else if (strEqual(keyname, "space"))
1902 char getValidConfigValueChar(char c)
1904 if (c == '#' || /* used to mark comments */
1905 c == '\\') /* used to mark continued lines */
1912 /* ------------------------------------------------------------------------- */
1913 /* functions to translate string identifiers to integer or boolean value */
1914 /* ------------------------------------------------------------------------- */
1916 int get_integer_from_string(char *s)
1918 static char *number_text[][3] =
1920 { "0", "zero", "null", },
1921 { "1", "one", "first" },
1922 { "2", "two", "second" },
1923 { "3", "three", "third" },
1924 { "4", "four", "fourth" },
1925 { "5", "five", "fifth" },
1926 { "6", "six", "sixth" },
1927 { "7", "seven", "seventh" },
1928 { "8", "eight", "eighth" },
1929 { "9", "nine", "ninth" },
1930 { "10", "ten", "tenth" },
1931 { "11", "eleven", "eleventh" },
1932 { "12", "twelve", "twelfth" },
1934 { NULL, NULL, NULL },
1938 char *s_lower = getStringToLower(s);
1941 for (i = 0; number_text[i][0] != NULL; i++)
1942 for (j = 0; j < 3; j++)
1943 if (strEqual(s_lower, number_text[i][j]))
1948 if (strEqual(s_lower, "false") ||
1949 strEqual(s_lower, "no") ||
1950 strEqual(s_lower, "off"))
1952 else if (strEqual(s_lower, "true") ||
1953 strEqual(s_lower, "yes") ||
1954 strEqual(s_lower, "on"))
1965 boolean get_boolean_from_string(char *s)
1967 char *s_lower = getStringToLower(s);
1968 boolean result = FALSE;
1970 if (strEqual(s_lower, "true") ||
1971 strEqual(s_lower, "yes") ||
1972 strEqual(s_lower, "on") ||
1973 get_integer_from_string(s) == 1)
1981 int get_switch3_from_string(char *s)
1983 char *s_lower = getStringToLower(s);
1986 if (strEqual(s_lower, "true") ||
1987 strEqual(s_lower, "yes") ||
1988 strEqual(s_lower, "on") ||
1989 get_integer_from_string(s) == 1)
1991 else if (strEqual(s_lower, "auto"))
2000 /* ------------------------------------------------------------------------- */
2001 /* functions for generic lists */
2002 /* ------------------------------------------------------------------------- */
2004 ListNode *newListNode()
2006 return checked_calloc(sizeof(ListNode));
2009 void addNodeToList(ListNode **node_first, char *key, void *content)
2011 ListNode *node_new = newListNode();
2013 node_new->key = getStringCopy(key);
2014 node_new->content = content;
2015 node_new->next = *node_first;
2016 *node_first = node_new;
2019 void deleteNodeFromList(ListNode **node_first, char *key,
2020 void (*destructor_function)(void *))
2022 if (node_first == NULL || *node_first == NULL)
2025 if (strEqual((*node_first)->key, key))
2027 checked_free((*node_first)->key);
2028 if (destructor_function)
2029 destructor_function((*node_first)->content);
2030 *node_first = (*node_first)->next;
2033 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2036 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2038 if (node_first == NULL)
2041 if (strEqual(node_first->key, key))
2044 return getNodeFromKey(node_first->next, key);
2047 int getNumNodes(ListNode *node_first)
2049 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2052 void dumpList(ListNode *node_first)
2054 ListNode *node = node_first;
2058 printf("['%s' (%d)]\n", node->key,
2059 ((struct ListNodeInfo *)node->content)->num_references);
2063 printf("[%d nodes]\n", getNumNodes(node_first));
2067 /* ------------------------------------------------------------------------- */
2068 /* functions for file handling */
2069 /* ------------------------------------------------------------------------- */
2071 File *openFile(char *filename, char *mode)
2073 File *file = checked_calloc(sizeof(File));
2075 file->file = fopen(filename, mode);
2077 if (file->file != NULL)
2079 file->filename = getStringCopy(filename);
2084 #if defined(PLATFORM_ANDROID)
2085 file->asset_file = SDL_RWFromFile(filename, mode);
2087 if (file->asset_file != NULL)
2089 file->file_is_asset = TRUE;
2090 file->filename = getStringCopy(filename);
2101 int closeFile(File *file)
2108 #if defined(PLATFORM_ANDROID)
2109 if (file->asset_file)
2110 result = SDL_RWclose(file->asset_file);
2114 result = fclose(file->file);
2116 checked_free(file->filename);
2122 int checkEndOfFile(File *file)
2124 #if defined(PLATFORM_ANDROID)
2125 if (file->file_is_asset)
2126 return file->end_of_file;
2129 return feof(file->file);
2132 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2134 #if defined(PLATFORM_ANDROID)
2135 if (file->file_is_asset)
2137 if (file->end_of_file)
2140 size_t num_items_read =
2141 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2143 if (num_items_read < num_items)
2144 file->end_of_file = TRUE;
2146 return num_items_read;
2150 return fread(buffer, item_size, num_items, file->file);
2153 int seekFile(File *file, long offset, int whence)
2155 #if defined(PLATFORM_ANDROID)
2156 if (file->file_is_asset)
2158 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2159 whence == SEEK_CUR ? RW_SEEK_CUR :
2160 whence == SEEK_END ? RW_SEEK_END : 0);
2162 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2166 return fseek(file->file, offset, whence);
2169 int getByteFromFile(File *file)
2171 #if defined(PLATFORM_ANDROID)
2172 if (file->file_is_asset)
2174 if (file->end_of_file)
2178 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2180 if (num_bytes_read < 1)
2181 file->end_of_file = TRUE;
2183 return (file->end_of_file ? EOF : (int)c);
2187 return fgetc(file->file);
2190 char *getStringFromFile(File *file, char *line, int size)
2192 #if defined(PLATFORM_ANDROID)
2193 if (file->file_is_asset)
2195 if (file->end_of_file)
2198 char *line_ptr = line;
2199 int num_bytes_read = 0;
2201 while (num_bytes_read < size - 1 &&
2202 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2203 *line_ptr++ != '\n')
2208 if (strlen(line) == 0)
2210 file->end_of_file = TRUE;
2219 return fgets(line, size, file->file);
2223 /* ------------------------------------------------------------------------- */
2224 /* functions for directory handling */
2225 /* ------------------------------------------------------------------------- */
2227 Directory *openDirectory(char *dir_name)
2229 Directory *dir = checked_calloc(sizeof(Directory));
2231 dir->dir = opendir(dir_name);
2233 if (dir->dir != NULL)
2235 dir->filename = getStringCopy(dir_name);
2240 #if defined(PLATFORM_ANDROID)
2241 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2243 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2245 checked_free(asset_toc_filename);
2247 if (dir->asset_toc_file != NULL)
2249 dir->directory_is_asset = TRUE;
2250 dir->filename = getStringCopy(dir_name);
2261 int closeDirectory(Directory *dir)
2268 #if defined(PLATFORM_ANDROID)
2269 if (dir->asset_toc_file)
2270 result = SDL_RWclose(dir->asset_toc_file);
2274 result = closedir(dir->dir);
2277 freeDirectoryEntry(dir->dir_entry);
2279 checked_free(dir->filename);
2285 DirectoryEntry *readDirectory(Directory *dir)
2288 freeDirectoryEntry(dir->dir_entry);
2290 dir->dir_entry = NULL;
2292 #if defined(PLATFORM_ANDROID)
2293 if (dir->directory_is_asset)
2295 char line[MAX_LINE_LEN];
2296 char *line_ptr = line;
2297 int num_bytes_read = 0;
2299 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2300 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2309 if (strlen(line) == 0)
2312 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2314 dir->dir_entry->is_directory = FALSE;
2315 if (line[strlen(line) - 1] == '/')
2317 dir->dir_entry->is_directory = TRUE;
2319 line[strlen(line) - 1] = '\0';
2322 dir->dir_entry->basename = getStringCopy(line);
2323 dir->dir_entry->filename = getPath2(dir->filename, line);
2325 return dir->dir_entry;
2329 struct dirent *dir_entry = readdir(dir->dir);
2331 if (dir_entry == NULL)
2334 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2336 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2337 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2339 struct stat file_status;
2341 dir->dir_entry->is_directory =
2342 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2343 (file_status.st_mode & S_IFMT) == S_IFDIR);
2346 Error(ERR_INFO, "::: '%s' is directory: %d",
2347 dir->dir_entry->basename,
2348 dir->dir_entry->is_directory);
2351 return dir->dir_entry;
2354 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2356 if (dir_entry == NULL)
2359 checked_free(dir_entry->basename);
2360 checked_free(dir_entry->filename);
2361 checked_free(dir_entry);
2365 /* ------------------------------------------------------------------------- */
2366 /* functions for checking files and filenames */
2367 /* ------------------------------------------------------------------------- */
2369 boolean directoryExists(char *dir_name)
2371 if (dir_name == NULL)
2374 boolean success = (access(dir_name, F_OK) == 0);
2376 #if defined(PLATFORM_ANDROID)
2379 // this might be an asset directory; check by trying to open toc file
2380 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2381 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2383 checked_free(asset_toc_filename);
2385 success = (file != NULL);
2395 boolean fileExists(char *filename)
2397 if (filename == NULL)
2400 boolean success = (access(filename, F_OK) == 0);
2402 #if defined(PLATFORM_ANDROID)
2405 // this might be an asset file; check by trying to open it
2406 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2408 success = (file != NULL);
2418 boolean fileHasPrefix(char *basename, char *prefix)
2420 static char *basename_lower = NULL;
2421 int basename_length, prefix_length;
2423 checked_free(basename_lower);
2425 if (basename == NULL || prefix == NULL)
2428 basename_lower = getStringToLower(basename);
2429 basename_length = strlen(basename_lower);
2430 prefix_length = strlen(prefix);
2432 if (basename_length > prefix_length + 1 &&
2433 basename_lower[prefix_length] == '.' &&
2434 strncmp(basename_lower, prefix, prefix_length) == 0)
2440 boolean fileHasSuffix(char *basename, char *suffix)
2442 static char *basename_lower = NULL;
2443 int basename_length, suffix_length;
2445 checked_free(basename_lower);
2447 if (basename == NULL || suffix == NULL)
2450 basename_lower = getStringToLower(basename);
2451 basename_length = strlen(basename_lower);
2452 suffix_length = strlen(suffix);
2454 if (basename_length > suffix_length + 1 &&
2455 basename_lower[basename_length - suffix_length - 1] == '.' &&
2456 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2462 #if defined(TARGET_SDL)
2463 static boolean FileCouldBeArtwork(char *basename)
2465 return (!strEqual(basename, ".") &&
2466 !strEqual(basename, "..") &&
2467 !fileHasSuffix(basename, "txt") &&
2468 !fileHasSuffix(basename, "conf"));
2472 boolean FileIsGraphic(char *filename)
2474 char *basename = getBaseNamePtr(filename);
2476 #if defined(TARGET_SDL)
2477 return FileCouldBeArtwork(basename);
2479 return fileHasSuffix(basename, "pcx");
2483 boolean FileIsSound(char *filename)
2485 char *basename = getBaseNamePtr(filename);
2487 #if defined(TARGET_SDL)
2488 return FileCouldBeArtwork(basename);
2490 return fileHasSuffix(basename, "wav");
2494 boolean FileIsMusic(char *filename)
2496 char *basename = getBaseNamePtr(filename);
2498 #if defined(TARGET_SDL)
2499 return FileCouldBeArtwork(basename);
2501 if (FileIsSound(basename))
2505 #if defined(TARGET_SDL)
2506 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2507 fileHasSuffix(basename, "mod") ||
2508 fileHasSuffix(basename, "s3m") ||
2509 fileHasSuffix(basename, "it") ||
2510 fileHasSuffix(basename, "xm") ||
2511 fileHasSuffix(basename, "midi") ||
2512 fileHasSuffix(basename, "mid") ||
2513 fileHasSuffix(basename, "mp3") ||
2514 fileHasSuffix(basename, "ogg"))
2523 boolean FileIsArtworkType(char *basename, int type)
2525 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2526 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2527 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2533 /* ------------------------------------------------------------------------- */
2534 /* functions for loading artwork configuration information */
2535 /* ------------------------------------------------------------------------- */
2537 char *get_mapped_token(char *token)
2539 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2540 static char *map_token_prefix[][2] =
2542 { "char_procent", "char_percent" },
2547 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2549 int len_token_prefix = strlen(map_token_prefix[i][0]);
2551 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2552 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2558 /* This function checks if a string <s> of the format "string1, string2, ..."
2559 exactly contains a string <s_contained>. */
2561 static boolean string_has_parameter(char *s, char *s_contained)
2565 if (s == NULL || s_contained == NULL)
2568 if (strlen(s_contained) > strlen(s))
2571 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2573 char next_char = s[strlen(s_contained)];
2575 /* check if next character is delimiter or whitespace */
2576 return (next_char == ',' || next_char == '\0' ||
2577 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2580 /* check if string contains another parameter string after a comma */
2581 substring = strchr(s, ',');
2582 if (substring == NULL) /* string does not contain a comma */
2585 /* advance string pointer to next character after the comma */
2588 /* skip potential whitespaces after the comma */
2589 while (*substring == ' ' || *substring == '\t')
2592 return string_has_parameter(substring, s_contained);
2595 int get_parameter_value(char *value_raw, char *suffix, int type)
2597 char *value = getStringToLower(value_raw);
2598 int result = 0; /* probably a save default value */
2600 if (strEqual(suffix, ".direction"))
2602 result = (strEqual(value, "left") ? MV_LEFT :
2603 strEqual(value, "right") ? MV_RIGHT :
2604 strEqual(value, "up") ? MV_UP :
2605 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2607 else if (strEqual(suffix, ".align"))
2609 result = (strEqual(value, "left") ? ALIGN_LEFT :
2610 strEqual(value, "right") ? ALIGN_RIGHT :
2611 strEqual(value, "center") ? ALIGN_CENTER :
2612 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2614 else if (strEqual(suffix, ".valign"))
2616 result = (strEqual(value, "top") ? VALIGN_TOP :
2617 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2618 strEqual(value, "middle") ? VALIGN_MIDDLE :
2619 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2621 else if (strEqual(suffix, ".anim_mode"))
2623 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2624 string_has_parameter(value, "loop") ? ANIM_LOOP :
2625 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2626 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2627 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2628 string_has_parameter(value, "random") ? ANIM_RANDOM :
2629 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2630 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2631 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2632 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2633 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2634 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2637 if (string_has_parameter(value, "reverse"))
2638 result |= ANIM_REVERSE;
2640 if (string_has_parameter(value, "opaque_player"))
2641 result |= ANIM_OPAQUE_PLAYER;
2643 if (string_has_parameter(value, "static_panel"))
2644 result |= ANIM_STATIC_PANEL;
2646 else if (strEqual(suffix, ".class"))
2648 result = get_hash_from_key(value);
2650 else if (strEqual(suffix, ".style"))
2652 result = STYLE_DEFAULT;
2654 if (string_has_parameter(value, "accurate_borders"))
2655 result |= STYLE_ACCURATE_BORDERS;
2657 if (string_has_parameter(value, "inner_corners"))
2658 result |= STYLE_INNER_CORNERS;
2660 else if (strEqual(suffix, ".fade_mode"))
2662 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2663 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2664 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2665 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2669 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2671 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2674 result = gfx.get_font_from_token_function(value);
2676 else /* generic parameter of type integer or boolean */
2678 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2679 type == TYPE_INTEGER ? get_integer_from_string(value) :
2680 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2681 ARG_UNDEFINED_VALUE);
2689 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2691 static struct ScreenModeInfo screen_mode;
2692 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2693 char *screen_mode_string_copy;
2694 char *screen_mode_string_pos_w;
2695 char *screen_mode_string_pos_h;
2697 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2700 screen_mode_string_copy = getStringCopy(screen_mode_string);
2702 screen_mode_string_pos_w = screen_mode_string_copy;
2703 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2704 *screen_mode_string_pos_h++ = '\0';
2706 screen_mode.width = atoi(screen_mode_string_pos_w);
2707 screen_mode.height = atoi(screen_mode_string_pos_h);
2709 return &screen_mode;
2712 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2715 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2716 float aspect_ratio_new;
2721 *x = i * aspect_ratio + 0.000001;
2724 aspect_ratio_new = (float)*x / (float)*y;
2728 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2731 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2732 struct ListNodeInfo ***, int *);
2734 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2735 struct ConfigTypeInfo *suffix_list,
2736 char **ignore_tokens,
2737 int num_file_list_entries)
2739 struct FileInfo *file_list;
2740 int num_file_list_entries_found = 0;
2741 int num_suffix_list_entries = 0;
2745 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2747 for (i = 0; suffix_list[i].token != NULL; i++)
2748 num_suffix_list_entries++;
2750 /* always start with reliable default values */
2751 for (i = 0; i < num_file_list_entries; i++)
2753 file_list[i].token = NULL;
2755 file_list[i].default_filename = NULL;
2756 file_list[i].filename = NULL;
2758 if (num_suffix_list_entries > 0)
2760 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2762 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2763 file_list[i].parameter = checked_calloc(parameter_array_size);
2765 for (j = 0; j < num_suffix_list_entries; j++)
2767 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2768 setString(&file_list[i].parameter[j], suffix_list[j].value);
2771 file_list[i].redefined = FALSE;
2772 file_list[i].fallback_to_default = FALSE;
2773 file_list[i].default_is_cloned = FALSE;
2779 for (i = 0; config_list[i].token != NULL; i++)
2781 int len_config_token = strlen(config_list[i].token);
2783 int len_config_value = strlen(config_list[i].value);
2785 boolean is_file_entry = TRUE;
2787 for (j = 0; suffix_list[j].token != NULL; j++)
2789 int len_suffix = strlen(suffix_list[j].token);
2791 if (len_suffix < len_config_token &&
2792 strEqual(&config_list[i].token[len_config_token - len_suffix],
2793 suffix_list[j].token))
2795 setString(&file_list[list_pos].default_parameter[j],
2796 config_list[i].value);
2798 is_file_entry = FALSE;
2804 /* the following tokens are no file definitions, but other config tokens */
2805 for (j = 0; ignore_tokens[j] != NULL; j++)
2806 if (strEqual(config_list[i].token, ignore_tokens[j]))
2807 is_file_entry = FALSE;
2814 if (list_pos >= num_file_list_entries)
2818 /* simple sanity check if this is really a file definition */
2819 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2820 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2821 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2823 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2824 config_list[i].token, config_list[i].value);
2825 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2829 file_list[list_pos].token = config_list[i].token;
2830 file_list[list_pos].default_filename = config_list[i].value;
2833 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2837 if (strSuffix(config_list[i].token, ".clone_from"))
2838 file_list[list_pos].default_is_cloned = TRUE;
2841 num_file_list_entries_found = list_pos + 1;
2842 if (num_file_list_entries_found != num_file_list_entries)
2844 Error(ERR_INFO_LINE, "-");
2845 Error(ERR_INFO, "inconsistant config list information:");
2846 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2847 num_file_list_entries);
2848 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2849 num_file_list_entries_found);
2850 Error(ERR_EXIT, "please fix");
2854 printf("::: ---------- DONE ----------\n");
2860 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2862 int len_token = strlen(token);
2863 int len_suffix = strlen(suffix);
2865 if (start_pos < 0) /* compare suffix from end of string */
2866 start_pos += len_token;
2868 if (start_pos < 0 || start_pos + len_suffix > len_token)
2871 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2874 if (token[start_pos + len_suffix] == '\0')
2877 if (token[start_pos + len_suffix] == '.')
2883 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2885 static void read_token_parameters(SetupFileHash *setup_file_hash,
2886 struct ConfigTypeInfo *suffix_list,
2887 struct FileInfo *file_list_entry)
2889 /* check for config token that is the base token without any suffixes */
2890 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2891 char *known_token_value = KNOWN_TOKEN_VALUE;
2894 if (filename != NULL)
2896 setString(&file_list_entry->filename, filename);
2898 /* when file definition found, set all parameters to default values */
2899 for (i = 0; suffix_list[i].token != NULL; i++)
2900 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2902 file_list_entry->redefined = TRUE;
2904 /* mark config file token as well known from default config */
2905 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2908 /* check for config tokens that can be build by base token and suffixes */
2909 for (i = 0; suffix_list[i].token != NULL; i++)
2911 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2912 char *value = getHashEntry(setup_file_hash, token);
2916 setString(&file_list_entry->parameter[i], value);
2918 /* mark config file token as well known from default config */
2919 setHashEntry(setup_file_hash, token, known_token_value);
2926 static void add_dynamic_file_list_entry(struct FileInfo **list,
2927 int *num_list_entries,
2928 SetupFileHash *extra_file_hash,
2929 struct ConfigTypeInfo *suffix_list,
2930 int num_suffix_list_entries,
2933 struct FileInfo *new_list_entry;
2934 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2936 (*num_list_entries)++;
2937 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2938 new_list_entry = &(*list)[*num_list_entries - 1];
2940 new_list_entry->token = getStringCopy(token);
2941 new_list_entry->default_filename = NULL;
2942 new_list_entry->filename = NULL;
2943 new_list_entry->parameter = checked_calloc(parameter_array_size);
2945 new_list_entry->redefined = FALSE;
2946 new_list_entry->fallback_to_default = FALSE;
2947 new_list_entry->default_is_cloned = FALSE;
2949 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2952 static void add_property_mapping(struct PropertyMapping **list,
2953 int *num_list_entries,
2954 int base_index, int ext1_index,
2955 int ext2_index, int ext3_index,
2958 struct PropertyMapping *new_list_entry;
2960 (*num_list_entries)++;
2961 *list = checked_realloc(*list,
2962 *num_list_entries * sizeof(struct PropertyMapping));
2963 new_list_entry = &(*list)[*num_list_entries - 1];
2965 new_list_entry->base_index = base_index;
2966 new_list_entry->ext1_index = ext1_index;
2967 new_list_entry->ext2_index = ext2_index;
2968 new_list_entry->ext3_index = ext3_index;
2970 new_list_entry->artwork_index = artwork_index;
2973 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2976 struct FileInfo *file_list = artwork_info->file_list;
2977 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2978 char **base_prefixes = artwork_info->base_prefixes;
2979 char **ext1_suffixes = artwork_info->ext1_suffixes;
2980 char **ext2_suffixes = artwork_info->ext2_suffixes;
2981 char **ext3_suffixes = artwork_info->ext3_suffixes;
2982 char **ignore_tokens = artwork_info->ignore_tokens;
2983 int num_file_list_entries = artwork_info->num_file_list_entries;
2984 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2985 int num_base_prefixes = artwork_info->num_base_prefixes;
2986 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2987 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2988 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2989 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2990 SetupFileHash *setup_file_hash, *valid_file_hash;
2991 SetupFileHash *extra_file_hash, *empty_file_hash;
2992 char *known_token_value = KNOWN_TOKEN_VALUE;
2995 if (filename == NULL)
2999 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
3002 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3005 /* separate valid (defined) from empty (undefined) config token values */
3006 valid_file_hash = newSetupFileHash();
3007 empty_file_hash = newSetupFileHash();
3008 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3010 char *value = HASH_ITERATION_VALUE(itr);
3012 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3013 HASH_ITERATION_TOKEN(itr), value);
3015 END_HASH_ITERATION(setup_file_hash, itr)
3017 /* at this point, we do not need the setup file hash anymore -- free it */
3018 freeSetupFileHash(setup_file_hash);
3020 /* map deprecated to current tokens (using prefix match and replace) */
3021 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3023 char *token = HASH_ITERATION_TOKEN(itr);
3024 char *mapped_token = get_mapped_token(token);
3026 if (mapped_token != NULL)
3028 char *value = HASH_ITERATION_VALUE(itr);
3030 /* add mapped token */
3031 setHashEntry(valid_file_hash, mapped_token, value);
3033 /* ignore old token (by setting it to "known" keyword) */
3034 setHashEntry(valid_file_hash, token, known_token_value);
3039 END_HASH_ITERATION(valid_file_hash, itr)
3041 /* read parameters for all known config file tokens */
3042 for (i = 0; i < num_file_list_entries; i++)
3043 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3045 /* set all tokens that can be ignored here to "known" keyword */
3046 for (i = 0; i < num_ignore_tokens; i++)
3047 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3049 /* copy all unknown config file tokens to extra config hash */
3050 extra_file_hash = newSetupFileHash();
3051 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3053 char *value = HASH_ITERATION_VALUE(itr);
3055 if (!strEqual(value, known_token_value))
3056 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3058 END_HASH_ITERATION(valid_file_hash, itr)
3060 /* at this point, we do not need the valid file hash anymore -- free it */
3061 freeSetupFileHash(valid_file_hash);
3063 /* now try to determine valid, dynamically defined config tokens */
3065 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3067 struct FileInfo **dynamic_file_list =
3068 &artwork_info->dynamic_file_list;
3069 int *num_dynamic_file_list_entries =
3070 &artwork_info->num_dynamic_file_list_entries;
3071 struct PropertyMapping **property_mapping =
3072 &artwork_info->property_mapping;
3073 int *num_property_mapping_entries =
3074 &artwork_info->num_property_mapping_entries;
3075 int current_summarized_file_list_entry =
3076 artwork_info->num_file_list_entries +
3077 artwork_info->num_dynamic_file_list_entries;
3078 char *token = HASH_ITERATION_TOKEN(itr);
3079 int len_token = strlen(token);
3081 boolean base_prefix_found = FALSE;
3082 boolean parameter_suffix_found = FALSE;
3085 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3088 /* skip all parameter definitions (handled by read_token_parameters()) */
3089 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3091 int len_suffix = strlen(suffix_list[i].token);
3093 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3094 parameter_suffix_found = TRUE;
3097 if (parameter_suffix_found)
3100 /* ---------- step 0: search for matching base prefix ---------- */
3103 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3105 char *base_prefix = base_prefixes[i];
3106 int len_base_prefix = strlen(base_prefix);
3107 boolean ext1_suffix_found = FALSE;
3108 boolean ext2_suffix_found = FALSE;
3109 boolean ext3_suffix_found = FALSE;
3110 boolean exact_match = FALSE;
3111 int base_index = -1;
3112 int ext1_index = -1;
3113 int ext2_index = -1;
3114 int ext3_index = -1;
3116 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3118 if (!base_prefix_found)
3124 if (IS_PARENT_PROCESS())
3125 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3128 if (start_pos + len_base_prefix == len_token) /* exact match */
3133 if (IS_PARENT_PROCESS())
3134 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3137 add_dynamic_file_list_entry(dynamic_file_list,
3138 num_dynamic_file_list_entries,
3141 num_suffix_list_entries,
3143 add_property_mapping(property_mapping,
3144 num_property_mapping_entries,
3145 base_index, -1, -1, -1,
3146 current_summarized_file_list_entry);
3151 if (IS_PARENT_PROCESS())
3152 printf("---> examining token '%s': search 1st suffix ...\n", token);
3155 /* ---------- step 1: search for matching first suffix ---------- */
3157 start_pos += len_base_prefix;
3158 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3160 char *ext1_suffix = ext1_suffixes[j];
3161 int len_ext1_suffix = strlen(ext1_suffix);
3163 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3165 if (!ext1_suffix_found)
3171 if (IS_PARENT_PROCESS())
3172 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3175 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3180 if (IS_PARENT_PROCESS())
3181 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3184 add_dynamic_file_list_entry(dynamic_file_list,
3185 num_dynamic_file_list_entries,
3188 num_suffix_list_entries,
3190 add_property_mapping(property_mapping,
3191 num_property_mapping_entries,
3192 base_index, ext1_index, -1, -1,
3193 current_summarized_file_list_entry);
3197 start_pos += len_ext1_suffix;
3204 if (IS_PARENT_PROCESS())
3205 printf("---> examining token '%s': search 2nd suffix ...\n", token);
3208 /* ---------- step 2: search for matching second suffix ---------- */
3210 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3212 char *ext2_suffix = ext2_suffixes[k];
3213 int len_ext2_suffix = strlen(ext2_suffix);
3215 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3217 if (!ext2_suffix_found)
3223 if (IS_PARENT_PROCESS())
3224 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3227 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3232 if (IS_PARENT_PROCESS())
3233 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3236 add_dynamic_file_list_entry(dynamic_file_list,
3237 num_dynamic_file_list_entries,
3240 num_suffix_list_entries,
3242 add_property_mapping(property_mapping,
3243 num_property_mapping_entries,
3244 base_index, ext1_index, ext2_index, -1,
3245 current_summarized_file_list_entry);
3249 start_pos += len_ext2_suffix;
3256 if (IS_PARENT_PROCESS())
3257 printf("---> examining token '%s': search 3rd suffix ...\n",token);
3260 /* ---------- step 3: search for matching third suffix ---------- */
3262 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3264 char *ext3_suffix = ext3_suffixes[l];
3265 int len_ext3_suffix = strlen(ext3_suffix);
3267 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3269 if (!ext3_suffix_found)
3275 if (IS_PARENT_PROCESS())
3276 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3279 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3284 if (IS_PARENT_PROCESS())
3285 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3288 add_dynamic_file_list_entry(dynamic_file_list,
3289 num_dynamic_file_list_entries,
3292 num_suffix_list_entries,
3294 add_property_mapping(property_mapping,
3295 num_property_mapping_entries,
3296 base_index, ext1_index, ext2_index, ext3_index,
3297 current_summarized_file_list_entry);
3303 END_HASH_ITERATION(extra_file_hash, itr)
3305 if (artwork_info->num_dynamic_file_list_entries > 0)
3307 artwork_info->dynamic_artwork_list =
3308 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3309 artwork_info->sizeof_artwork_list_entry);
3312 if (options.verbose && IS_PARENT_PROCESS())
3314 SetupFileList *setup_file_list, *list;
3315 boolean dynamic_tokens_found = FALSE;
3316 boolean unknown_tokens_found = FALSE;
3317 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3319 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3320 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3322 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3324 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3325 dynamic_tokens_found = TRUE;
3327 unknown_tokens_found = TRUE;
3329 END_HASH_ITERATION(extra_file_hash, itr)
3331 if (options.debug && dynamic_tokens_found)
3333 Error(ERR_INFO_LINE, "-");
3334 Error(ERR_INFO, "dynamic token(s) found in config file:");
3335 Error(ERR_INFO, "- config file: '%s'", filename);
3337 for (list = setup_file_list; list != NULL; list = list->next)
3339 char *value = getHashEntry(extra_file_hash, list->token);
3341 if (value != NULL && strEqual(value, known_token_value))
3342 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3345 Error(ERR_INFO_LINE, "-");
3348 if (unknown_tokens_found)
3350 Error(ERR_INFO_LINE, "-");
3351 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3352 Error(ERR_INFO, "- config file: '%s'", filename);
3354 for (list = setup_file_list; list != NULL; list = list->next)
3356 char *value = getHashEntry(extra_file_hash, list->token);
3358 if (value != NULL && !strEqual(value, known_token_value))
3359 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3362 Error(ERR_INFO_LINE, "-");
3365 if (undefined_values_found)
3367 Error(ERR_INFO_LINE, "-");
3368 Error(ERR_INFO, "warning: undefined values found in config file:");
3369 Error(ERR_INFO, "- config file: '%s'", filename);
3371 for (list = setup_file_list; list != NULL; list = list->next)
3373 char *value = getHashEntry(empty_file_hash, list->token);
3376 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3379 Error(ERR_INFO_LINE, "-");
3382 freeSetupFileList(setup_file_list);
3385 freeSetupFileHash(extra_file_hash);
3386 freeSetupFileHash(empty_file_hash);
3389 for (i = 0; i < num_file_list_entries; i++)
3391 printf("'%s' ", file_list[i].token);
3392 if (file_list[i].filename)
3393 printf("-> '%s'\n", file_list[i].filename);
3395 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3400 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3402 struct FileInfo *file_list = artwork_info->file_list;
3403 int num_file_list_entries = artwork_info->num_file_list_entries;
3404 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3405 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3408 DrawInitText("Loading artwork config", 120, FC_GREEN);
3409 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3411 /* always start with reliable default values */
3412 for (i = 0; i < num_file_list_entries; i++)
3414 setString(&file_list[i].filename, file_list[i].default_filename);
3416 for (j = 0; j < num_suffix_list_entries; j++)
3417 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3419 file_list[i].redefined = FALSE;
3420 file_list[i].fallback_to_default = FALSE;
3423 /* free previous dynamic artwork file array */
3424 if (artwork_info->dynamic_file_list != NULL)
3426 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3428 free(artwork_info->dynamic_file_list[i].token);
3429 free(artwork_info->dynamic_file_list[i].filename);
3430 free(artwork_info->dynamic_file_list[i].parameter);
3433 free(artwork_info->dynamic_file_list);
3434 artwork_info->dynamic_file_list = NULL;
3436 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3437 &artwork_info->num_dynamic_file_list_entries);
3440 /* free previous property mapping */
3441 if (artwork_info->property_mapping != NULL)
3443 free(artwork_info->property_mapping);
3445 artwork_info->property_mapping = NULL;
3446 artwork_info->num_property_mapping_entries = 0;
3450 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3452 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3455 /* first look for special artwork configured in level series config */
3456 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3459 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3460 leveldir_current->graphics_set,
3461 leveldir_current->graphics_path);
3464 if (fileExists(filename_base))
3465 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3468 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3470 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3471 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3474 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3475 struct ListNodeInfo **listnode)
3479 char *filename = (*listnode)->source_filename;
3481 if (--(*listnode)->num_references <= 0)
3482 deleteNodeFromList(&artwork_info->content_list, filename,
3483 artwork_info->free_artwork);
3489 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3490 struct ListNodeInfo **listnode,
3491 struct FileInfo *file_list_entry)
3501 char *basename = file_list_entry->filename;
3502 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3504 if (filename == NULL)
3506 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3508 basename = file_list_entry->default_filename;
3510 /* fail for cloned default artwork that has no default filename defined */
3511 if (file_list_entry->default_is_cloned &&
3512 strEqual(basename, UNDEFINED_FILENAME))
3514 int error_mode = ERR_WARN;
3516 /* we can get away without sounds and music, but not without graphics */
3517 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3518 error_mode = ERR_EXIT;
3520 Error(error_mode, "token '%s' was cloned and has no default filename",
3521 file_list_entry->token);
3526 /* dynamic artwork has no default filename / skip empty default artwork */
3527 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3530 file_list_entry->fallback_to_default = TRUE;
3532 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3534 filename = getCustomArtworkFilename(basename, artwork_info->type);
3536 if (filename == NULL)
3538 int error_mode = ERR_WARN;
3540 /* we can get away without sounds and music, but not without graphics */
3541 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3542 error_mode = ERR_EXIT;
3544 Error(error_mode, "cannot find default artwork file '%s'", basename);
3550 /* check if the old and the new artwork file are the same */
3551 if (*listnode && strEqual((*listnode)->source_filename, filename))
3553 /* The old and new artwork are the same (have the same filename and path).
3554 This usually means that this artwork does not exist in this artwork set
3555 and a fallback to the existing artwork is done. */
3558 printf("[artwork '%s' already exists (same list entry)]\n", filename);
3564 /* delete existing artwork file entry */
3565 deleteArtworkListEntry(artwork_info, listnode);
3567 /* check if the new artwork file already exists in the list of artworks */
3568 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3571 printf("[artwork '%s' already exists (other list entry)]\n", filename);
3574 *listnode = (struct ListNodeInfo *)node->content;
3575 (*listnode)->num_references++;
3580 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3581 DrawInitText(basename, 150, FC_YELLOW);
3583 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3586 printf("[adding new artwork '%s']\n", filename);
3589 (*listnode)->num_references = 1;
3590 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3595 int error_mode = ERR_WARN;
3597 /* we can get away without sounds and music, but not without graphics */
3598 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3599 error_mode = ERR_EXIT;
3601 Error(error_mode, "cannot load artwork file '%s'", basename);
3607 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3608 struct ListNodeInfo **listnode,
3609 struct FileInfo *file_list_entry)
3612 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3615 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3617 deleteArtworkListEntry(artwork_info, listnode);
3622 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3625 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3627 struct FileInfo *file_list = artwork_info->file_list;
3628 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3629 int num_file_list_entries = artwork_info->num_file_list_entries;
3630 int num_dynamic_file_list_entries =
3631 artwork_info->num_dynamic_file_list_entries;
3634 print_timestamp_init("ReloadCustomArtworkList");
3636 for (i = 0; i < num_file_list_entries; i++)
3637 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3640 for (i = 0; i < num_dynamic_file_list_entries; i++)
3641 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3642 &dynamic_file_list[i]);
3644 print_timestamp_done("ReloadCustomArtworkList");
3647 dumpList(artwork_info->content_list);
3651 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3652 struct ListNodeInfo ***list,
3653 int *num_list_entries)
3660 for (i = 0; i < *num_list_entries; i++)
3661 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3665 *num_list_entries = 0;
3668 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3670 if (artwork_info == NULL)
3673 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3674 &artwork_info->num_file_list_entries);
3676 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3677 &artwork_info->num_dynamic_file_list_entries);
3681 /* ------------------------------------------------------------------------- */
3682 /* functions only needed for non-Unix (non-command-line) systems */
3683 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3684 /* (now also added for Windows, to create files in user data directory) */
3685 /* ------------------------------------------------------------------------- */
3687 char *getErrorFilename(char *basename)
3689 return getPath2(getUserGameDataDir(), basename);
3692 void openErrorFile()
3694 InitUserDataDirectory();
3696 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3698 program.error_file = stderr;
3700 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3701 program.error_filename, strerror(errno));
3704 /* error output should be unbuffered so it is not truncated in a crash */
3705 setbuf(program.error_file, NULL);
3708 void closeErrorFile()
3710 if (program.error_file != stderr) /* do not close stream 'stderr' */
3711 fclose(program.error_file);
3714 void dumpErrorFile()
3716 FILE *error_file = fopen(program.error_filename, MODE_READ);
3718 if (error_file != NULL)
3720 while (!feof(error_file))
3721 fputc(fgetc(error_file), stderr);
3727 void NotifyUserAboutErrorFile()
3729 #if defined(PLATFORM_WIN32)
3730 char *title_text = getStringCat2(program.program_title, " Error Message");
3731 char *error_text = getStringCat2("The program was aborted due to an error; "
3732 "for details, see the following error file:"
3733 STRING_NEWLINE, program.error_filename);
3735 MessageBox(NULL, error_text, title_text, MB_OK);
3740 /* ------------------------------------------------------------------------- */
3741 /* the following is only for debugging purpose and normally not used */
3742 /* ------------------------------------------------------------------------- */
3746 #define DEBUG_PRINT_INIT_TIMESTAMPS FALSE
3747 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3749 #define DEBUG_NUM_TIMESTAMPS 10
3750 #define DEBUG_TIME_IN_MICROSECONDS 0
3752 #if DEBUG_TIME_IN_MICROSECONDS
3753 static double Counter_Microseconds()
3755 static struct timeval base_time = { 0, 0 };
3756 struct timeval current_time;
3759 gettimeofday(¤t_time, NULL);
3761 /* reset base time in case of wrap-around */
3762 if (current_time.tv_sec < base_time.tv_sec)
3763 base_time = current_time;
3766 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3767 ((double)(current_time.tv_usec - base_time.tv_usec));
3769 return counter; /* return microseconds since last init */
3773 char *debug_print_timestamp_get_padding(int padding_size)
3775 static char *padding = NULL;
3776 int max_padding_size = 100;
3778 if (padding == NULL)
3780 padding = checked_calloc(max_padding_size + 1);
3781 memset(padding, ' ', max_padding_size);
3784 return &padding[MAX(0, max_padding_size - padding_size)];
3787 void debug_print_timestamp(int counter_nr, char *message)
3789 int indent_size = 8;
3790 int padding_size = 40;
3791 float timestamp_interval;
3794 Error(ERR_EXIT, "debugging: invalid negative counter");
3795 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3796 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3798 #if DEBUG_TIME_IN_MICROSECONDS
3799 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3802 counter[counter_nr][0] = Counter_Microseconds();
3804 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3807 counter[counter_nr][0] = Counter();
3810 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3811 counter[counter_nr][1] = counter[counter_nr][0];
3815 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3817 printf("%s%s%s %.3f %s\n",
3819 debug_print_timestamp_get_padding(counter_nr * indent_size),
3821 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3822 timestamp_interval / 1000,
3826 void debug_print_parent_only(char *format, ...)
3828 if (!IS_PARENT_PROCESS())
3835 va_start(ap, format);
3836 vprintf(format, ap);
3845 void print_timestamp_ext(char *message, char *mode)
3847 #if DEBUG_PRINT_INIT_TIMESTAMPS
3848 static char *debug_message = NULL;
3849 static char *last_message = NULL;
3850 static int counter_nr = 0;
3851 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3853 checked_free(debug_message);
3854 debug_message = getStringCat3(mode, " ", message);
3856 if (strEqual(mode, "INIT"))
3858 debug_print_timestamp(counter_nr, NULL);
3860 if (counter_nr + 1 < max_depth)
3861 debug_print_timestamp(counter_nr, debug_message);
3865 debug_print_timestamp(counter_nr, NULL);
3867 else if (strEqual(mode, "DONE"))
3871 if (counter_nr + 1 < max_depth ||
3872 (counter_nr == 0 && max_depth == 1))
3874 last_message = message;
3876 if (counter_nr == 0 && max_depth == 1)
3878 checked_free(debug_message);
3879 debug_message = getStringCat3("TIME", " ", message);
3882 debug_print_timestamp(counter_nr, debug_message);
3885 else if (!strEqual(mode, "TIME") ||
3886 !strEqual(message, last_message))
3888 if (counter_nr < max_depth)
3889 debug_print_timestamp(counter_nr, debug_message);
3894 void print_timestamp_init(char *message)
3896 print_timestamp_ext(message, "INIT");
3899 void print_timestamp_time(char *message)
3901 print_timestamp_ext(message, "TIME");
3904 void print_timestamp_done(char *message)
3906 print_timestamp_ext(message, "DONE");