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 #if defined(PLATFORM_MSDOS)
227 volatile unsigned int counter = 0;
229 void increment_counter()
234 END_OF_FUNCTION(increment_counter);
238 /* maximal allowed length of a command line option */
239 #define MAX_OPTION_LEN 256
243 #if defined(TARGET_SDL)
244 static unsigned int getCurrentMS()
246 return SDL_GetTicks();
249 #else /* !TARGET_SDL */
251 #if defined(PLATFORM_UNIX)
252 static unsigned int getCurrentMS()
254 struct timeval current_time;
256 gettimeofday(¤t_time, NULL);
258 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
260 #endif /* PLATFORM_UNIX */
261 #endif /* !TARGET_SDL */
263 static unsigned int mainCounter(int mode)
265 static unsigned int base_ms = 0;
266 unsigned int current_ms;
268 /* get current system milliseconds */
269 current_ms = getCurrentMS();
271 /* reset base timestamp in case of counter reset or wrap-around */
272 if (mode == INIT_COUNTER || current_ms < base_ms)
273 base_ms = current_ms;
275 /* return milliseconds since last counter reset */
276 return current_ms - base_ms;
281 #if defined(TARGET_SDL)
282 static unsigned int mainCounter(int mode)
284 static unsigned int base_ms = 0;
285 unsigned int current_ms;
286 unsigned int counter_ms;
288 current_ms = SDL_GetTicks();
290 /* reset base time in case of counter initializing or wrap-around */
291 if (mode == INIT_COUNTER || current_ms < base_ms)
292 base_ms = current_ms;
294 counter_ms = current_ms - base_ms;
296 return counter_ms; /* return milliseconds since last init */
299 #else /* !TARGET_SDL */
301 #if defined(PLATFORM_UNIX)
302 static unsigned int mainCounter(int mode)
304 static struct timeval base_time = { 0, 0 };
305 struct timeval current_time;
306 unsigned int counter_ms;
308 gettimeofday(¤t_time, NULL);
310 /* reset base time in case of counter initializing or wrap-around */
311 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
312 base_time = current_time;
314 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
315 + (current_time.tv_usec - base_time.tv_usec) / 1000;
317 return counter_ms; /* return milliseconds since last init */
319 #endif /* PLATFORM_UNIX */
320 #endif /* !TARGET_SDL */
324 void InitCounter() /* set counter back to zero */
326 #if !defined(PLATFORM_MSDOS)
327 mainCounter(INIT_COUNTER);
329 LOCK_VARIABLE(counter);
330 LOCK_FUNCTION(increment_counter);
331 install_int_ex(increment_counter, BPS_TO_TIMER(100));
335 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
337 #if !defined(PLATFORM_MSDOS)
338 return mainCounter(READ_COUNTER);
340 return (counter * 10);
344 static void sleep_milliseconds(unsigned int milliseconds_delay)
346 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
350 /* we want to wait only a few ms -- if we assume that we have a
351 kernel timer resolution of 10 ms, we would wait far to long;
352 therefore it's better to do a short interval of busy waiting
353 to get our sleeping time more accurate */
355 unsigned int base_counter = Counter(), actual_counter = Counter();
357 while (actual_counter < base_counter + milliseconds_delay &&
358 actual_counter >= base_counter)
359 actual_counter = Counter();
363 #if defined(TARGET_SDL)
364 SDL_Delay(milliseconds_delay);
365 #elif defined(TARGET_ALLEGRO)
366 rest(milliseconds_delay);
368 struct timeval delay;
370 delay.tv_sec = milliseconds_delay / 1000;
371 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
373 if (select(0, NULL, NULL, NULL, &delay) != 0)
374 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
379 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
381 sleep_milliseconds(delay);
384 boolean FrameReached(unsigned int *frame_counter_var,
385 unsigned int frame_delay)
387 unsigned int actual_frame_counter = FrameCounter;
389 if (actual_frame_counter >= *frame_counter_var &&
390 actual_frame_counter < *frame_counter_var + frame_delay)
393 *frame_counter_var = actual_frame_counter;
398 boolean DelayReached(unsigned int *counter_var,
401 unsigned int actual_counter = Counter();
403 if (actual_counter >= *counter_var &&
404 actual_counter < *counter_var + delay)
407 *counter_var = actual_counter;
412 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
414 unsigned int actual_counter;
418 actual_counter = Counter();
420 if (actual_counter >= *counter_var &&
421 actual_counter < *counter_var + delay)
422 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
427 *counter_var = actual_counter;
431 /* ------------------------------------------------------------------------- */
432 /* random generator functions */
433 /* ------------------------------------------------------------------------- */
435 unsigned int init_random_number(int nr, int seed)
437 if (seed == NEW_RANDOMIZE)
439 /* default random seed */
440 seed = (int)time(NULL); // seconds since the epoch
442 #if !defined(PLATFORM_WIN32)
443 /* add some more randomness */
444 struct timeval current_time;
446 gettimeofday(¤t_time, NULL);
448 seed += (int)current_time.tv_usec; // microseconds since the epoch
451 #if defined(TARGET_SDL)
452 /* add some more randomness */
453 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
457 /* add some more randomness */
458 seed += GetSimpleRandom(1000000);
462 srandom_linux_libc(nr, (unsigned int) seed);
464 return (unsigned int) seed;
467 unsigned int get_random_number(int nr, int max)
469 return (max > 0 ? random_linux_libc(nr) % max : 0);
473 /* ------------------------------------------------------------------------- */
474 /* system info functions */
475 /* ------------------------------------------------------------------------- */
477 #if !defined(PLATFORM_MSDOS) && !defined(PLATFORM_ANDROID)
478 static char *get_corrected_real_name(char *real_name)
480 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
481 char *from_ptr = real_name;
482 char *to_ptr = real_name_new;
484 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
485 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
487 /* the name field read from "passwd" file may also contain additional
488 user information, separated by commas, which will be removed here */
489 if (*from_ptr == ',')
492 /* the user's real name may contain 'ß' characters (german sharp s),
493 which have no equivalent in upper case letters (used by our fonts) */
494 if (*from_ptr == 'ß')
501 *to_ptr++ = *from_ptr++;
506 return real_name_new;
512 static char *login_name = NULL;
514 #if defined(PLATFORM_WIN32)
515 if (login_name == NULL)
517 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
518 login_name = checked_malloc(buffer_size);
520 if (GetUserName(login_name, &buffer_size) == 0)
521 strcpy(login_name, ANONYMOUS_NAME);
524 if (login_name == NULL)
528 if ((pwd = getpwuid(getuid())) == NULL)
529 login_name = ANONYMOUS_NAME;
531 login_name = getStringCopy(pwd->pw_name);
540 static char *real_name = NULL;
542 #if defined(PLATFORM_WIN32)
543 if (real_name == NULL)
545 static char buffer[MAX_USERNAME_LEN + 1];
546 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
548 if (GetUserName(buffer, &buffer_size) != 0)
549 real_name = get_corrected_real_name(buffer);
551 real_name = ANONYMOUS_NAME;
553 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
554 if (real_name == NULL)
558 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
559 real_name = get_corrected_real_name(pwd->pw_gecos);
561 real_name = ANONYMOUS_NAME;
564 real_name = ANONYMOUS_NAME;
570 time_t getFileTimestampEpochSeconds(char *filename)
572 struct stat file_status;
574 if (stat(filename, &file_status) != 0) /* cannot stat file */
577 return file_status.st_mtime;
581 /* ------------------------------------------------------------------------- */
582 /* path manipulation functions */
583 /* ------------------------------------------------------------------------- */
585 static char *getLastPathSeparatorPtr(char *filename)
587 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
589 if (last_separator == NULL) /* also try DOS/Windows variant */
590 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
592 return last_separator;
595 char *getBaseNamePtr(char *filename)
597 char *last_separator = getLastPathSeparatorPtr(filename);
599 if (last_separator != NULL)
600 return last_separator + 1; /* separator found: strip base path */
602 return filename; /* no separator found: filename has no path */
605 char *getBaseName(char *filename)
607 return getStringCopy(getBaseNamePtr(filename));
610 char *getBasePath(char *filename)
612 char *basepath = getStringCopy(filename);
613 char *last_separator = getLastPathSeparatorPtr(basepath);
615 if (last_separator != NULL)
616 *last_separator = '\0'; /* separator found: strip basename */
618 basepath = "."; /* no separator found: use current path */
623 static char *getProgramMainDataPath()
625 char *main_data_path = getStringCopy(program.command_basepath);
627 #if defined(PLATFORM_MACOSX)
628 static char *main_data_binary_subdir = NULL;
630 if (main_data_binary_subdir == NULL)
632 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
634 strlen(MAC_APP_BINARY_SUBDIR) + 1);
636 sprintf(main_data_binary_subdir, "%s.app/%s",
637 program.program_title, MAC_APP_BINARY_SUBDIR);
640 // cut relative path to Mac OS X application binary directory from path
641 if (strSuffix(main_data_path, main_data_binary_subdir))
642 main_data_path[strlen(main_data_path) -
643 strlen(main_data_binary_subdir)] = '\0';
645 // cut trailing path separator from path (but not if path is root directory)
646 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
647 main_data_path[strlen(main_data_path) - 1] = '\0';
650 return main_data_path;
654 /* ------------------------------------------------------------------------- */
655 /* various string functions */
656 /* ------------------------------------------------------------------------- */
658 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
660 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
663 sprintf(complete_string, "%s%s%s", s1, sep, s2);
665 return complete_string;
668 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
670 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
671 strlen(s2) + strlen(sep) +
674 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
676 return complete_string;
679 char *getStringCat2(char *s1, char *s2)
681 return getStringCat2WithSeparator(s1, s2, "");
684 char *getStringCat3(char *s1, char *s2, char *s3)
686 return getStringCat3WithSeparator(s1, s2, s3, "");
689 char *getPath2(char *path1, char *path2)
691 #if defined(PLATFORM_ANDROID)
692 // workaround for reading from APK assets directory -- skip leading "./"
693 if (strEqual(path1, "."))
694 return getStringCopy(path2);
697 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
700 char *getPath3(char *path1, char *path2, char *path3)
702 #if defined(PLATFORM_ANDROID)
703 // workaround for reading from APK assets directory -- skip leading "./"
704 if (strEqual(path1, "."))
705 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
708 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
711 char *getStringCopy(char *s)
718 s_copy = checked_malloc(strlen(s) + 1);
724 char *getStringCopyN(char *s, int n)
727 int s_len = MAX(0, n);
732 s_copy = checked_malloc(s_len + 1);
733 strncpy(s_copy, s, s_len);
734 s_copy[s_len] = '\0';
739 char *getStringToLower(char *s)
741 char *s_copy = checked_malloc(strlen(s) + 1);
742 char *s_ptr = s_copy;
745 *s_ptr++ = tolower(*s++);
751 void setString(char **old_value, char *new_value)
753 checked_free(*old_value);
755 *old_value = getStringCopy(new_value);
758 boolean strEqual(char *s1, char *s2)
760 return (s1 == NULL && s2 == NULL ? TRUE :
761 s1 == NULL && s2 != NULL ? FALSE :
762 s1 != NULL && s2 == NULL ? FALSE :
763 strcmp(s1, s2) == 0);
766 boolean strEqualN(char *s1, char *s2, int n)
768 return (s1 == NULL && s2 == NULL ? TRUE :
769 s1 == NULL && s2 != NULL ? FALSE :
770 s1 != NULL && s2 == NULL ? FALSE :
771 strncmp(s1, s2, n) == 0);
774 boolean strPrefix(char *s, char *prefix)
776 return (s == NULL && prefix == NULL ? TRUE :
777 s == NULL && prefix != NULL ? FALSE :
778 s != NULL && prefix == NULL ? FALSE :
779 strncmp(s, prefix, strlen(prefix)) == 0);
782 boolean strSuffix(char *s, char *suffix)
784 return (s == NULL && suffix == NULL ? TRUE :
785 s == NULL && suffix != NULL ? FALSE :
786 s != NULL && suffix == NULL ? FALSE :
787 strlen(s) < strlen(suffix) ? FALSE :
788 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
791 boolean strPrefixLower(char *s, char *prefix)
793 char *s_lower = getStringToLower(s);
794 boolean match = strPrefix(s_lower, prefix);
801 boolean strSuffixLower(char *s, char *suffix)
803 char *s_lower = getStringToLower(s);
804 boolean match = strSuffix(s_lower, suffix);
812 /* ------------------------------------------------------------------------- */
813 /* command line option handling functions */
814 /* ------------------------------------------------------------------------- */
816 void GetOptions(char *argv[], void (*print_usage_function)(void))
818 char *ro_base_path = RO_BASE_PATH;
819 char *rw_base_path = RW_BASE_PATH;
820 char **options_left = &argv[1];
823 /* if the program is configured to start from current directory (default),
824 determine program package directory from program binary (some versions
825 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
826 set the current working directory to the program package directory) */
828 if (strEqual(ro_base_path, "."))
829 ro_base_path = getProgramMainDataPath();
830 if (strEqual(rw_base_path, "."))
831 rw_base_path = getProgramMainDataPath();
834 #if !defined(PLATFORM_MACOSX)
835 /* if the program is configured to start from current directory (default),
836 determine program package directory (KDE/Konqueror does not do this by
837 itself and fails otherwise); on Mac OS X, the program binary is stored
838 in an application package directory -- do not try to use this directory
839 as the program data directory (Mac OS X handles this correctly anyway) */
841 if (strEqual(ro_base_path, "."))
842 ro_base_path = program.command_basepath;
843 if (strEqual(rw_base_path, "."))
844 rw_base_path = program.command_basepath;
849 /* initialize global program options */
850 options.display_name = NULL;
851 options.server_host = NULL;
852 options.server_port = 0;
854 options.ro_base_directory = ro_base_path;
855 options.rw_base_directory = rw_base_path;
856 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
857 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
858 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
859 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
860 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
862 options.execute_command = NULL;
863 options.special_flags = NULL;
865 options.serveronly = FALSE;
866 options.network = FALSE;
867 options.verbose = FALSE;
868 options.debug = FALSE;
869 options.debug_x11_sync = FALSE;
872 options.verbose = TRUE;
874 #if !defined(PLATFORM_UNIX)
875 if (*options_left == NULL) /* no options given -- enable verbose mode */
876 options.verbose = TRUE;
880 while (*options_left)
882 char option_str[MAX_OPTION_LEN];
883 char *option = options_left[0];
884 char *next_option = options_left[1];
885 char *option_arg = NULL;
886 int option_len = strlen(option);
888 if (option_len >= MAX_OPTION_LEN)
889 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
891 strcpy(option_str, option); /* copy argument into buffer */
894 if (strEqual(option, "--")) /* stop scanning arguments */
897 if (strPrefix(option, "--")) /* treat '--' like '-' */
900 option_arg = strchr(option, '=');
901 if (option_arg == NULL) /* no '=' in option */
902 option_arg = next_option;
905 *option_arg++ = '\0'; /* cut argument from option */
906 if (*option_arg == '\0') /* no argument after '=' */
907 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
910 option_len = strlen(option);
912 if (strEqual(option, "-"))
913 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
914 else if (strncmp(option, "-help", option_len) == 0)
916 print_usage_function();
920 else if (strncmp(option, "-display", option_len) == 0)
922 if (option_arg == NULL)
923 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
925 options.display_name = option_arg;
926 if (option_arg == next_option)
929 else if (strncmp(option, "-basepath", option_len) == 0)
931 if (option_arg == NULL)
932 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
934 /* this should be extended to separate options for ro and rw data */
935 options.ro_base_directory = ro_base_path = option_arg;
936 options.rw_base_directory = rw_base_path = option_arg;
937 if (option_arg == next_option)
940 /* adjust paths for sub-directories in base directory accordingly */
941 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
942 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
943 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
944 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
945 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
947 else if (strncmp(option, "-levels", option_len) == 0)
949 if (option_arg == NULL)
950 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
952 options.level_directory = option_arg;
953 if (option_arg == next_option)
956 else if (strncmp(option, "-graphics", option_len) == 0)
958 if (option_arg == NULL)
959 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
961 options.graphics_directory = option_arg;
962 if (option_arg == next_option)
965 else if (strncmp(option, "-sounds", option_len) == 0)
967 if (option_arg == NULL)
968 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
970 options.sounds_directory = option_arg;
971 if (option_arg == next_option)
974 else if (strncmp(option, "-music", option_len) == 0)
976 if (option_arg == NULL)
977 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
979 options.music_directory = option_arg;
980 if (option_arg == next_option)
983 else if (strncmp(option, "-network", option_len) == 0)
985 options.network = TRUE;
987 else if (strncmp(option, "-serveronly", option_len) == 0)
989 options.serveronly = TRUE;
991 else if (strncmp(option, "-verbose", option_len) == 0)
993 options.verbose = TRUE;
995 else if (strncmp(option, "-debug", option_len) == 0)
997 options.debug = TRUE;
999 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
1001 options.debug_x11_sync = TRUE;
1003 else if (strPrefix(option, "-D"))
1006 options.special_flags = getStringCopy(&option[2]);
1008 char *flags_string = &option[2];
1009 unsigned int flags_value;
1011 if (*flags_string == '\0')
1012 Error(ERR_EXIT_HELP, "empty flag ignored");
1014 flags_value = get_special_flags_function(flags_string);
1016 if (flags_value == 0)
1017 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
1019 options.special_flags |= flags_value;
1022 else if (strncmp(option, "-execute", option_len) == 0)
1024 if (option_arg == NULL)
1025 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
1027 options.execute_command = option_arg;
1028 if (option_arg == next_option)
1031 /* when doing batch processing, always enable verbose mode (warnings) */
1032 options.verbose = TRUE;
1034 else if (*option == '-')
1036 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1038 else if (options.server_host == NULL)
1040 options.server_host = *options_left;
1042 else if (options.server_port == 0)
1044 options.server_port = atoi(*options_left);
1045 if (options.server_port < 1024)
1046 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1049 Error(ERR_EXIT_HELP, "too many arguments");
1056 /* ------------------------------------------------------------------------- */
1057 /* error handling functions */
1058 /* ------------------------------------------------------------------------- */
1060 /* used by SetError() and GetError() to store internal error messages */
1061 static char internal_error[1024]; /* this is bad */
1063 void SetError(char *format, ...)
1067 va_start(ap, format);
1068 vsprintf(internal_error, format, ap);
1074 return internal_error;
1077 void Error(int mode, char *format, ...)
1079 static boolean last_line_was_separator = FALSE;
1080 char *process_name = "";
1082 #if defined(PLATFORM_ANDROID)
1083 android_log_prio = (mode & ERR_DEBUG ? ANDROID_LOG_DEBUG :
1084 mode & ERR_INFO ? ANDROID_LOG_INFO :
1085 mode & ERR_WARN ? ANDROID_LOG_WARN :
1086 mode & ERR_EXIT ? ANDROID_LOG_FATAL :
1087 ANDROID_LOG_UNKNOWN);
1091 /* display warnings only when running in verbose mode */
1092 if (mode & ERR_WARN && !options.verbose)
1096 if (mode == ERR_INFO_LINE)
1098 if (!last_line_was_separator)
1099 fprintf_line(program.error_file, format, 79);
1101 last_line_was_separator = TRUE;
1106 last_line_was_separator = FALSE;
1108 if (mode & ERR_SOUND_SERVER)
1109 process_name = " sound server";
1110 else if (mode & ERR_NETWORK_SERVER)
1111 process_name = " network server";
1112 else if (mode & ERR_NETWORK_CLIENT)
1113 process_name = " network client **";
1119 fprintf_nonewline(program.error_file, "%s%s: ", program.command_basename,
1122 if (mode & ERR_WARN)
1123 fprintf_nonewline(program.error_file, "warning: ");
1125 va_start(ap, format);
1126 vfprintf_newline(program.error_file, format, ap);
1129 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1131 va_start(ap, format);
1132 program.exit_message_function(format, ap);
1137 if (mode & ERR_HELP)
1138 fprintf_newline(program.error_file,
1139 "%s: Try option '--help' for more information.",
1140 program.command_basename);
1142 if (mode & ERR_EXIT)
1143 fprintf_newline(program.error_file, "%s%s: aborting",
1144 program.command_basename, process_name);
1146 if (mode & ERR_EXIT)
1148 if (mode & ERR_FROM_SERVER)
1149 exit(1); /* child process: normal exit */
1151 program.exit_function(1); /* main process: clean up stuff */
1156 /* ------------------------------------------------------------------------- */
1157 /* checked memory allocation and freeing functions */
1158 /* ------------------------------------------------------------------------- */
1160 void *checked_malloc(unsigned int size)
1167 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1172 void *checked_calloc(unsigned int size)
1176 ptr = calloc(1, size);
1179 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1184 void *checked_realloc(void *ptr, unsigned int size)
1186 ptr = realloc(ptr, size);
1189 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1194 void checked_free(void *ptr)
1196 if (ptr != NULL) /* this check should be done by free() anyway */
1200 void clear_mem(void *ptr, unsigned int size)
1202 #if defined(PLATFORM_WIN32)
1203 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1204 char *cptr = (char *)ptr;
1209 memset(ptr, 0, size);
1214 /* ------------------------------------------------------------------------- */
1215 /* various helper functions */
1216 /* ------------------------------------------------------------------------- */
1218 inline void swap_numbers(int *i1, int *i2)
1226 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1238 /* the "put" variants of the following file access functions check for the file
1239 pointer being != NULL and return the number of bytes they have or would have
1240 written; this allows for chunk writing functions to first determine the size
1241 of the (not yet written) chunk, write the correct chunk size and finally
1242 write the chunk itself */
1246 int getFile8BitInteger(File *file)
1248 return getByteFromFile(file);
1253 int getFile8BitInteger(FILE *file)
1260 int putFile8BitInteger(FILE *file, int value)
1270 int getFile16BitInteger(File *file, int byte_order)
1272 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1273 return ((getByteFromFile(file) << 8) |
1274 (getByteFromFile(file) << 0));
1275 else /* BYTE_ORDER_LITTLE_ENDIAN */
1276 return ((getByteFromFile(file) << 0) |
1277 (getByteFromFile(file) << 8));
1282 int getFile16BitInteger(FILE *file, int byte_order)
1284 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1285 return ((fgetc(file) << 8) |
1286 (fgetc(file) << 0));
1287 else /* BYTE_ORDER_LITTLE_ENDIAN */
1288 return ((fgetc(file) << 0) |
1289 (fgetc(file) << 8));
1294 int putFile16BitInteger(FILE *file, int value, int byte_order)
1298 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1300 fputc((value >> 8) & 0xff, file);
1301 fputc((value >> 0) & 0xff, file);
1303 else /* BYTE_ORDER_LITTLE_ENDIAN */
1305 fputc((value >> 0) & 0xff, file);
1306 fputc((value >> 8) & 0xff, file);
1315 int getFile32BitInteger(File *file, int byte_order)
1317 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1318 return ((getByteFromFile(file) << 24) |
1319 (getByteFromFile(file) << 16) |
1320 (getByteFromFile(file) << 8) |
1321 (getByteFromFile(file) << 0));
1322 else /* BYTE_ORDER_LITTLE_ENDIAN */
1323 return ((getByteFromFile(file) << 0) |
1324 (getByteFromFile(file) << 8) |
1325 (getByteFromFile(file) << 16) |
1326 (getByteFromFile(file) << 24));
1331 int getFile32BitInteger(FILE *file, int byte_order)
1333 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1334 return ((fgetc(file) << 24) |
1335 (fgetc(file) << 16) |
1336 (fgetc(file) << 8) |
1337 (fgetc(file) << 0));
1338 else /* BYTE_ORDER_LITTLE_ENDIAN */
1339 return ((fgetc(file) << 0) |
1340 (fgetc(file) << 8) |
1341 (fgetc(file) << 16) |
1342 (fgetc(file) << 24));
1347 int putFile32BitInteger(FILE *file, int value, int byte_order)
1351 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1353 fputc((value >> 24) & 0xff, file);
1354 fputc((value >> 16) & 0xff, file);
1355 fputc((value >> 8) & 0xff, file);
1356 fputc((value >> 0) & 0xff, file);
1358 else /* BYTE_ORDER_LITTLE_ENDIAN */
1360 fputc((value >> 0) & 0xff, file);
1361 fputc((value >> 8) & 0xff, file);
1362 fputc((value >> 16) & 0xff, file);
1363 fputc((value >> 24) & 0xff, file);
1372 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1375 const int chunk_name_length = 4;
1377 /* read chunk name */
1378 if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1381 if (chunk_size != NULL)
1383 /* read chunk size */
1384 *chunk_size = getFile32BitInteger(file, byte_order);
1387 return (checkEndOfFile(file) ? FALSE : TRUE);
1392 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1395 const int chunk_name_length = 4;
1397 /* read chunk name */
1398 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1401 if (chunk_size != NULL)
1403 /* read chunk size */
1404 *chunk_size = getFile32BitInteger(file, byte_order);
1407 return (feof(file) || ferror(file) ? FALSE : TRUE);
1412 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1417 /* write chunk name */
1419 fputs(chunk_name, file);
1421 num_bytes += strlen(chunk_name);
1423 if (chunk_size >= 0)
1425 /* write chunk size */
1427 putFile32BitInteger(file, chunk_size, byte_order);
1437 int getFileVersion(File *file)
1439 int version_major = getByteFromFile(file);
1440 int version_minor = getByteFromFile(file);
1441 int version_patch = getByteFromFile(file);
1442 int version_build = getByteFromFile(file);
1444 return VERSION_IDENT(version_major, version_minor, version_patch,
1450 int getFileVersion(FILE *file)
1452 int version_major = fgetc(file);
1453 int version_minor = fgetc(file);
1454 int version_patch = fgetc(file);
1455 int version_build = fgetc(file);
1457 return VERSION_IDENT(version_major, version_minor, version_patch,
1463 int putFileVersion(FILE *file, int version)
1467 int version_major = VERSION_MAJOR(version);
1468 int version_minor = VERSION_MINOR(version);
1469 int version_patch = VERSION_PATCH(version);
1470 int version_build = VERSION_BUILD(version);
1472 fputc(version_major, file);
1473 fputc(version_minor, file);
1474 fputc(version_patch, file);
1475 fputc(version_build, file);
1483 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1487 for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1488 buffer[i] = getByteFromFile(file);
1493 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1497 for(i = 0; i < bytes && !feof(file); i++)
1498 buffer[i] = fgetc(file);
1503 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1507 for(i = 0; i < bytes; i++)
1508 fputc(buffer[i], file);
1513 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1515 while (bytes-- && !checkEndOfFile(file))
1516 getByteFromFile(file);
1521 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1523 while (bytes-- && !feof(file))
1529 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1536 /* ------------------------------------------------------------------------- */
1537 /* functions to translate key identifiers between different format */
1538 /* ------------------------------------------------------------------------- */
1540 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1541 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1542 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1543 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1545 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1554 /* normal cursor keys */
1555 { KSYM_Left, "XK_Left", "cursor left" },
1556 { KSYM_Right, "XK_Right", "cursor right" },
1557 { KSYM_Up, "XK_Up", "cursor up" },
1558 { KSYM_Down, "XK_Down", "cursor down" },
1560 /* keypad cursor keys */
1562 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1563 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1564 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1565 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1568 /* other keypad keys */
1569 #ifdef KSYM_KP_Enter
1570 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1571 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1572 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1573 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1574 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1575 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1579 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1580 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1581 { KSYM_Control_L, "XK_Control_L", "left control" },
1582 { KSYM_Control_R, "XK_Control_R", "right control" },
1583 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1584 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1585 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1586 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1587 #if !defined(TARGET_SDL2)
1588 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1589 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1591 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1592 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1594 /* some special keys */
1595 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1596 { KSYM_Delete, "XK_Delete", "delete" },
1597 { KSYM_Insert, "XK_Insert", "insert" },
1598 { KSYM_Tab, "XK_Tab", "tab" },
1599 { KSYM_Home, "XK_Home", "home" },
1600 { KSYM_End, "XK_End", "end" },
1601 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1602 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1604 #if defined(TARGET_SDL2)
1605 { KSYM_Menu, "XK_Menu", "menu" }, /* menu key */
1606 { KSYM_Back, "XK_Back", "back" }, /* back key */
1609 /* ASCII 0x20 to 0x40 keys (except numbers) */
1610 { KSYM_space, "XK_space", "space" },
1611 { KSYM_exclam, "XK_exclam", "!" },
1612 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1613 { KSYM_numbersign, "XK_numbersign", "#" },
1614 { KSYM_dollar, "XK_dollar", "$" },
1615 { KSYM_percent, "XK_percent", "%" },
1616 { KSYM_ampersand, "XK_ampersand", "&" },
1617 { KSYM_apostrophe, "XK_apostrophe", "'" },
1618 { KSYM_parenleft, "XK_parenleft", "(" },
1619 { KSYM_parenright, "XK_parenright", ")" },
1620 { KSYM_asterisk, "XK_asterisk", "*" },
1621 { KSYM_plus, "XK_plus", "+" },
1622 { KSYM_comma, "XK_comma", "," },
1623 { KSYM_minus, "XK_minus", "-" },
1624 { KSYM_period, "XK_period", "." },
1625 { KSYM_slash, "XK_slash", "/" },
1626 { KSYM_colon, "XK_colon", ":" },
1627 { KSYM_semicolon, "XK_semicolon", ";" },
1628 { KSYM_less, "XK_less", "<" },
1629 { KSYM_equal, "XK_equal", "=" },
1630 { KSYM_greater, "XK_greater", ">" },
1631 { KSYM_question, "XK_question", "?" },
1632 { KSYM_at, "XK_at", "@" },
1634 /* more ASCII keys */
1635 { KSYM_bracketleft, "XK_bracketleft", "[" },
1636 { KSYM_backslash, "XK_backslash", "\\" },
1637 { KSYM_bracketright,"XK_bracketright", "]" },
1638 { KSYM_asciicircum, "XK_asciicircum", "^" },
1639 { KSYM_underscore, "XK_underscore", "_" },
1640 { KSYM_grave, "XK_grave", "grave" },
1641 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1642 { KSYM_braceleft, "XK_braceleft", "brace left" },
1643 { KSYM_bar, "XK_bar", "bar" },
1644 { KSYM_braceright, "XK_braceright", "brace right" },
1645 { KSYM_asciitilde, "XK_asciitilde", "~" },
1647 /* special (non-ASCII) keys (ISO-Latin-1) */
1648 { KSYM_degree, "XK_degree", "°" },
1649 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1650 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1651 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1652 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1653 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1654 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1655 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1657 #if defined(TARGET_SDL2)
1658 /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1659 { KSYM_degree, "XK_degree", "\xc2\xb0" },
1660 { KSYM_Adiaeresis, "XK_Adiaeresis", "\xc3\x84" },
1661 { KSYM_Odiaeresis, "XK_Odiaeresis", "\xc3\x96" },
1662 { KSYM_Udiaeresis, "XK_Udiaeresis", "\xc3\x9c" },
1663 { KSYM_adiaeresis, "XK_adiaeresis", "\xc3\xa4" },
1664 { KSYM_odiaeresis, "XK_odiaeresis", "\xc3\xb6" },
1665 { KSYM_udiaeresis, "XK_udiaeresis", "\xc3\xbc" },
1666 { KSYM_ssharp, "XK_ssharp", "\xc3\x9f" },
1669 #if defined(TARGET_SDL2)
1670 /* keypad keys are not in numerical order in SDL2 */
1671 { KSYM_KP_0, "XK_KP_0", "keypad 0" },
1672 { KSYM_KP_1, "XK_KP_1", "keypad 1" },
1673 { KSYM_KP_2, "XK_KP_2", "keypad 2" },
1674 { KSYM_KP_3, "XK_KP_3", "keypad 3" },
1675 { KSYM_KP_4, "XK_KP_4", "keypad 4" },
1676 { KSYM_KP_5, "XK_KP_5", "keypad 5" },
1677 { KSYM_KP_6, "XK_KP_6", "keypad 6" },
1678 { KSYM_KP_7, "XK_KP_7", "keypad 7" },
1679 { KSYM_KP_8, "XK_KP_8", "keypad 8" },
1680 { KSYM_KP_9, "XK_KP_9", "keypad 9" },
1683 /* end-of-array identifier */
1689 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1691 static char name_buffer[30];
1694 if (key >= KSYM_A && key <= KSYM_Z)
1695 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1696 else if (key >= KSYM_a && key <= KSYM_z)
1697 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1698 else if (key >= KSYM_0 && key <= KSYM_9)
1699 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1700 #if !defined(TARGET_SDL2)
1701 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1702 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1704 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1705 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1706 else if (key == KSYM_UNDEFINED)
1707 strcpy(name_buffer, "(undefined)");
1714 if (key == translate_key[i].key)
1716 strcpy(name_buffer, translate_key[i].name);
1720 while (translate_key[++i].name);
1722 if (!translate_key[i].name)
1723 strcpy(name_buffer, "(unknown)");
1726 *name = name_buffer;
1728 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1730 static char name_buffer[30];
1733 if (key >= KSYM_A && key <= KSYM_Z)
1734 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1735 else if (key >= KSYM_a && key <= KSYM_z)
1736 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1737 else if (key >= KSYM_0 && key <= KSYM_9)
1738 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1739 #if !defined(TARGET_SDL2)
1740 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1741 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1743 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1744 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1745 else if (key == KSYM_UNDEFINED)
1746 strcpy(name_buffer, "[undefined]");
1753 if (key == translate_key[i].key)
1755 strcpy(name_buffer, translate_key[i].x11name);
1759 while (translate_key[++i].x11name);
1761 if (!translate_key[i].x11name)
1762 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1765 *x11name = name_buffer;
1767 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1769 Key key = KSYM_UNDEFINED;
1770 char *name_ptr = *name;
1772 if (strlen(*name) == 1)
1774 char c = name_ptr[0];
1776 if (c >= 'A' && c <= 'Z')
1777 key = KSYM_A + (Key)(c - 'A');
1778 else if (c >= 'a' && c <= 'z')
1779 key = KSYM_a + (Key)(c - 'a');
1780 else if (c >= '0' && c <= '9')
1781 key = KSYM_0 + (Key)(c - '0');
1784 if (key == KSYM_UNDEFINED)
1790 if (strEqual(translate_key[i].name, *name))
1792 key = translate_key[i].key;
1796 while (translate_key[++i].x11name);
1799 if (key == KSYM_UNDEFINED)
1800 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1804 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1806 Key key = KSYM_UNDEFINED;
1807 char *name_ptr = *x11name;
1809 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1811 char c = name_ptr[3];
1813 if (c >= 'A' && c <= 'Z')
1814 key = KSYM_A + (Key)(c - 'A');
1815 else if (c >= 'a' && c <= 'z')
1816 key = KSYM_a + (Key)(c - 'a');
1817 else if (c >= '0' && c <= '9')
1818 key = KSYM_0 + (Key)(c - '0');
1820 #if !defined(TARGET_SDL2)
1821 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1823 char c = name_ptr[6];
1825 if (c >= '0' && c <= '9')
1826 key = KSYM_KP_0 + (Key)(c - '0');
1829 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1831 char c1 = name_ptr[4];
1832 char c2 = name_ptr[5];
1835 if ((c1 >= '0' && c1 <= '9') &&
1836 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1837 d = atoi(&name_ptr[4]);
1839 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1840 key = KSYM_F1 + (Key)(d - 1);
1842 else if (strPrefix(name_ptr, "XK_"))
1848 if (strEqual(name_ptr, translate_key[i].x11name))
1850 key = translate_key[i].key;
1854 while (translate_key[++i].x11name);
1856 else if (strPrefix(name_ptr, "0x"))
1858 unsigned int value = 0;
1864 char c = *name_ptr++;
1867 if (c >= '0' && c <= '9')
1869 else if (c >= 'a' && c <= 'f')
1870 d = (int)(c - 'a' + 10);
1871 else if (c >= 'A' && c <= 'F')
1872 d = (int)(c - 'A' + 10);
1880 value = value * 16 + d;
1891 char *getKeyNameFromKey(Key key)
1895 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1899 char *getX11KeyNameFromKey(Key key)
1903 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1907 Key getKeyFromKeyName(char *name)
1911 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1915 Key getKeyFromX11KeyName(char *x11name)
1919 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1923 char getCharFromKey(Key key)
1925 char *keyname = getKeyNameFromKey(key);
1928 if (strlen(keyname) == 1)
1930 else if (strEqual(keyname, "space"))
1936 char getValidConfigValueChar(char c)
1938 if (c == '#' || /* used to mark comments */
1939 c == '\\') /* used to mark continued lines */
1946 /* ------------------------------------------------------------------------- */
1947 /* functions to translate string identifiers to integer or boolean value */
1948 /* ------------------------------------------------------------------------- */
1950 int get_integer_from_string(char *s)
1952 static char *number_text[][3] =
1954 { "0", "zero", "null", },
1955 { "1", "one", "first" },
1956 { "2", "two", "second" },
1957 { "3", "three", "third" },
1958 { "4", "four", "fourth" },
1959 { "5", "five", "fifth" },
1960 { "6", "six", "sixth" },
1961 { "7", "seven", "seventh" },
1962 { "8", "eight", "eighth" },
1963 { "9", "nine", "ninth" },
1964 { "10", "ten", "tenth" },
1965 { "11", "eleven", "eleventh" },
1966 { "12", "twelve", "twelfth" },
1968 { NULL, NULL, NULL },
1972 char *s_lower = getStringToLower(s);
1975 for (i = 0; number_text[i][0] != NULL; i++)
1976 for (j = 0; j < 3; j++)
1977 if (strEqual(s_lower, number_text[i][j]))
1982 if (strEqual(s_lower, "false") ||
1983 strEqual(s_lower, "no") ||
1984 strEqual(s_lower, "off"))
1986 else if (strEqual(s_lower, "true") ||
1987 strEqual(s_lower, "yes") ||
1988 strEqual(s_lower, "on"))
1999 boolean get_boolean_from_string(char *s)
2001 char *s_lower = getStringToLower(s);
2002 boolean result = FALSE;
2004 if (strEqual(s_lower, "true") ||
2005 strEqual(s_lower, "yes") ||
2006 strEqual(s_lower, "on") ||
2007 get_integer_from_string(s) == 1)
2015 int get_switch3_from_string(char *s)
2017 char *s_lower = getStringToLower(s);
2020 if (strEqual(s_lower, "true") ||
2021 strEqual(s_lower, "yes") ||
2022 strEqual(s_lower, "on") ||
2023 get_integer_from_string(s) == 1)
2025 else if (strEqual(s_lower, "auto"))
2034 /* ------------------------------------------------------------------------- */
2035 /* functions for generic lists */
2036 /* ------------------------------------------------------------------------- */
2038 ListNode *newListNode()
2040 return checked_calloc(sizeof(ListNode));
2043 void addNodeToList(ListNode **node_first, char *key, void *content)
2045 ListNode *node_new = newListNode();
2047 node_new->key = getStringCopy(key);
2048 node_new->content = content;
2049 node_new->next = *node_first;
2050 *node_first = node_new;
2053 void deleteNodeFromList(ListNode **node_first, char *key,
2054 void (*destructor_function)(void *))
2056 if (node_first == NULL || *node_first == NULL)
2059 if (strEqual((*node_first)->key, key))
2061 checked_free((*node_first)->key);
2062 if (destructor_function)
2063 destructor_function((*node_first)->content);
2064 *node_first = (*node_first)->next;
2067 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2070 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2072 if (node_first == NULL)
2075 if (strEqual(node_first->key, key))
2078 return getNodeFromKey(node_first->next, key);
2081 int getNumNodes(ListNode *node_first)
2083 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2086 void dumpList(ListNode *node_first)
2088 ListNode *node = node_first;
2092 printf("['%s' (%d)]\n", node->key,
2093 ((struct ListNodeInfo *)node->content)->num_references);
2097 printf("[%d nodes]\n", getNumNodes(node_first));
2101 /* ------------------------------------------------------------------------- */
2102 /* functions for file handling */
2103 /* ------------------------------------------------------------------------- */
2105 File *openFile(char *filename, char *mode)
2107 File *file = checked_calloc(sizeof(File));
2109 file->file = fopen(filename, mode);
2111 if (file->file != NULL)
2113 file->filename = getStringCopy(filename);
2118 #if defined(PLATFORM_ANDROID)
2119 file->asset_file = SDL_RWFromFile(filename, mode);
2121 if (file->asset_file != NULL)
2123 file->file_is_asset = TRUE;
2124 file->filename = getStringCopy(filename);
2135 int closeFile(File *file)
2142 #if defined(PLATFORM_ANDROID)
2143 if (file->asset_file)
2144 result = SDL_RWclose(file->asset_file);
2148 result = fclose(file->file);
2150 checked_free(file->filename);
2156 int checkEndOfFile(File *file)
2158 #if defined(PLATFORM_ANDROID)
2159 if (file->file_is_asset)
2160 return file->end_of_file;
2163 return feof(file->file);
2166 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2168 #if defined(PLATFORM_ANDROID)
2169 if (file->file_is_asset)
2171 if (file->end_of_file)
2174 size_t num_items_read =
2175 SDL_RWread(file->asset_file, buffer, item_size, num_items);
2177 if (num_items_read < num_items)
2178 file->end_of_file = TRUE;
2180 return num_items_read;
2184 return fread(buffer, item_size, num_items, file->file);
2187 int seekFile(File *file, long offset, int whence)
2189 #if defined(PLATFORM_ANDROID)
2190 if (file->file_is_asset)
2192 int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2193 whence == SEEK_CUR ? RW_SEEK_CUR :
2194 whence == SEEK_END ? RW_SEEK_END : 0);
2196 return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2200 return fseek(file->file, offset, whence);
2203 int getByteFromFile(File *file)
2205 #if defined(PLATFORM_ANDROID)
2206 if (file->file_is_asset)
2208 if (file->end_of_file)
2212 size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2214 if (num_bytes_read < 1)
2215 file->end_of_file = TRUE;
2217 return (file->end_of_file ? EOF : (int)c);
2221 return fgetc(file->file);
2224 char *getStringFromFile(File *file, char *line, int size)
2226 #if defined(PLATFORM_ANDROID)
2227 if (file->file_is_asset)
2229 if (file->end_of_file)
2232 char *line_ptr = line;
2233 int num_bytes_read = 0;
2235 while (num_bytes_read < size - 1 &&
2236 SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2237 *line_ptr++ != '\n')
2242 if (strlen(line) == 0)
2244 file->end_of_file = TRUE;
2253 return fgets(line, size, file->file);
2257 /* ------------------------------------------------------------------------- */
2258 /* functions for directory handling */
2259 /* ------------------------------------------------------------------------- */
2261 Directory *openDirectory(char *dir_name)
2263 Directory *dir = checked_calloc(sizeof(Directory));
2265 dir->dir = opendir(dir_name);
2267 if (dir->dir != NULL)
2269 dir->filename = getStringCopy(dir_name);
2274 #if defined(PLATFORM_ANDROID)
2275 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2277 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2279 checked_free(asset_toc_filename);
2281 if (dir->asset_toc_file != NULL)
2283 dir->directory_is_asset = TRUE;
2284 dir->filename = getStringCopy(dir_name);
2295 int closeDirectory(Directory *dir)
2302 #if defined(PLATFORM_ANDROID)
2303 if (dir->asset_toc_file)
2304 result = SDL_RWclose(dir->asset_toc_file);
2308 result = closedir(dir->dir);
2311 freeDirectoryEntry(dir->dir_entry);
2313 checked_free(dir->filename);
2319 DirectoryEntry *readDirectory(Directory *dir)
2322 freeDirectoryEntry(dir->dir_entry);
2324 dir->dir_entry = NULL;
2326 #if defined(PLATFORM_ANDROID)
2327 if (dir->directory_is_asset)
2329 char line[MAX_LINE_LEN];
2330 char *line_ptr = line;
2331 int num_bytes_read = 0;
2333 while (num_bytes_read < MAX_LINE_LEN - 1 &&
2334 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2343 if (strlen(line) == 0)
2346 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2348 dir->dir_entry->is_directory = FALSE;
2349 if (line[strlen(line) - 1] == '/')
2351 dir->dir_entry->is_directory = TRUE;
2353 line[strlen(line) - 1] = '\0';
2356 dir->dir_entry->basename = getStringCopy(line);
2357 dir->dir_entry->filename = getPath2(dir->filename, line);
2359 return dir->dir_entry;
2363 struct dirent *dir_entry = readdir(dir->dir);
2365 if (dir_entry == NULL)
2368 dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2370 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2371 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2373 struct stat file_status;
2375 dir->dir_entry->is_directory =
2376 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2377 (file_status.st_mode & S_IFMT) == S_IFDIR);
2380 Error(ERR_INFO, "::: '%s' is directory: %d",
2381 dir->dir_entry->basename,
2382 dir->dir_entry->is_directory);
2385 return dir->dir_entry;
2388 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2390 if (dir_entry == NULL)
2393 checked_free(dir_entry->basename);
2394 checked_free(dir_entry->filename);
2395 checked_free(dir_entry);
2399 /* ------------------------------------------------------------------------- */
2400 /* functions for checking files and filenames */
2401 /* ------------------------------------------------------------------------- */
2403 boolean directoryExists(char *dir_name)
2405 if (dir_name == NULL)
2408 boolean success = (access(dir_name, F_OK) == 0);
2410 #if defined(PLATFORM_ANDROID)
2413 // this might be an asset directory; check by trying to open toc file
2414 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2415 SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2417 checked_free(asset_toc_filename);
2419 success = (file != NULL);
2429 boolean fileExists(char *filename)
2431 if (filename == NULL)
2434 boolean success = (access(filename, F_OK) == 0);
2436 #if defined(PLATFORM_ANDROID)
2439 // this might be an asset file; check by trying to open it
2440 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2442 success = (file != NULL);
2452 boolean fileHasPrefix(char *basename, char *prefix)
2454 static char *basename_lower = NULL;
2455 int basename_length, prefix_length;
2457 checked_free(basename_lower);
2459 if (basename == NULL || prefix == NULL)
2462 basename_lower = getStringToLower(basename);
2463 basename_length = strlen(basename_lower);
2464 prefix_length = strlen(prefix);
2466 if (basename_length > prefix_length + 1 &&
2467 basename_lower[prefix_length] == '.' &&
2468 strncmp(basename_lower, prefix, prefix_length) == 0)
2474 boolean fileHasSuffix(char *basename, char *suffix)
2476 static char *basename_lower = NULL;
2477 int basename_length, suffix_length;
2479 checked_free(basename_lower);
2481 if (basename == NULL || suffix == NULL)
2484 basename_lower = getStringToLower(basename);
2485 basename_length = strlen(basename_lower);
2486 suffix_length = strlen(suffix);
2488 if (basename_length > suffix_length + 1 &&
2489 basename_lower[basename_length - suffix_length - 1] == '.' &&
2490 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2496 boolean FileIsGraphic(char *filename)
2498 char *basename = getBaseNamePtr(filename);
2500 #if defined(TARGET_SDL)
2501 return (!fileHasSuffix(basename, "txt") &&
2502 !fileHasSuffix(basename, "conf"));
2504 return fileHasSuffix(basename, "pcx");
2508 boolean FileIsSound(char *filename)
2510 char *basename = getBaseNamePtr(filename);
2512 #if defined(TARGET_SDL)
2513 return (!fileHasSuffix(basename, "txt") &&
2514 !fileHasSuffix(basename, "conf"));
2516 return fileHasSuffix(basename, "wav");
2520 boolean FileIsMusic(char *filename)
2522 char *basename = getBaseNamePtr(filename);
2524 #if defined(TARGET_SDL)
2525 return (!fileHasSuffix(basename, "txt") &&
2526 !fileHasSuffix(basename, "conf"));
2528 if (FileIsSound(basename))
2532 #if defined(TARGET_SDL)
2533 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2534 fileHasSuffix(basename, "mod") ||
2535 fileHasSuffix(basename, "s3m") ||
2536 fileHasSuffix(basename, "it") ||
2537 fileHasSuffix(basename, "xm") ||
2538 fileHasSuffix(basename, "midi") ||
2539 fileHasSuffix(basename, "mid") ||
2540 fileHasSuffix(basename, "mp3") ||
2541 fileHasSuffix(basename, "ogg"))
2550 boolean FileIsArtworkType(char *basename, int type)
2552 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2553 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2554 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2560 /* ------------------------------------------------------------------------- */
2561 /* functions for loading artwork configuration information */
2562 /* ------------------------------------------------------------------------- */
2564 char *get_mapped_token(char *token)
2566 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2567 static char *map_token_prefix[][2] =
2569 { "char_procent", "char_percent" },
2574 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2576 int len_token_prefix = strlen(map_token_prefix[i][0]);
2578 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2579 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2585 /* This function checks if a string <s> of the format "string1, string2, ..."
2586 exactly contains a string <s_contained>. */
2588 static boolean string_has_parameter(char *s, char *s_contained)
2592 if (s == NULL || s_contained == NULL)
2595 if (strlen(s_contained) > strlen(s))
2598 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2600 char next_char = s[strlen(s_contained)];
2602 /* check if next character is delimiter or whitespace */
2603 return (next_char == ',' || next_char == '\0' ||
2604 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2607 /* check if string contains another parameter string after a comma */
2608 substring = strchr(s, ',');
2609 if (substring == NULL) /* string does not contain a comma */
2612 /* advance string pointer to next character after the comma */
2615 /* skip potential whitespaces after the comma */
2616 while (*substring == ' ' || *substring == '\t')
2619 return string_has_parameter(substring, s_contained);
2622 int get_parameter_value(char *value_raw, char *suffix, int type)
2624 char *value = getStringToLower(value_raw);
2625 int result = 0; /* probably a save default value */
2627 if (strEqual(suffix, ".direction"))
2629 result = (strEqual(value, "left") ? MV_LEFT :
2630 strEqual(value, "right") ? MV_RIGHT :
2631 strEqual(value, "up") ? MV_UP :
2632 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2634 else if (strEqual(suffix, ".align"))
2636 result = (strEqual(value, "left") ? ALIGN_LEFT :
2637 strEqual(value, "right") ? ALIGN_RIGHT :
2638 strEqual(value, "center") ? ALIGN_CENTER :
2639 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2641 else if (strEqual(suffix, ".valign"))
2643 result = (strEqual(value, "top") ? VALIGN_TOP :
2644 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2645 strEqual(value, "middle") ? VALIGN_MIDDLE :
2646 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2648 else if (strEqual(suffix, ".anim_mode"))
2650 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2651 string_has_parameter(value, "loop") ? ANIM_LOOP :
2652 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2653 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2654 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2655 string_has_parameter(value, "random") ? ANIM_RANDOM :
2656 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2657 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2658 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2659 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2660 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2661 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2664 if (string_has_parameter(value, "reverse"))
2665 result |= ANIM_REVERSE;
2667 if (string_has_parameter(value, "opaque_player"))
2668 result |= ANIM_OPAQUE_PLAYER;
2670 if (string_has_parameter(value, "static_panel"))
2671 result |= ANIM_STATIC_PANEL;
2673 else if (strEqual(suffix, ".class"))
2675 result = get_hash_from_key(value);
2677 else if (strEqual(suffix, ".style"))
2679 result = STYLE_DEFAULT;
2681 if (string_has_parameter(value, "accurate_borders"))
2682 result |= STYLE_ACCURATE_BORDERS;
2684 if (string_has_parameter(value, "inner_corners"))
2685 result |= STYLE_INNER_CORNERS;
2687 else if (strEqual(suffix, ".fade_mode"))
2689 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2690 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2691 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2692 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2696 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2698 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2701 result = gfx.get_font_from_token_function(value);
2703 else /* generic parameter of type integer or boolean */
2705 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2706 type == TYPE_INTEGER ? get_integer_from_string(value) :
2707 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2708 ARG_UNDEFINED_VALUE);
2716 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2718 static struct ScreenModeInfo screen_mode;
2719 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2720 char *screen_mode_string_copy;
2721 char *screen_mode_string_pos_w;
2722 char *screen_mode_string_pos_h;
2724 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2727 screen_mode_string_copy = getStringCopy(screen_mode_string);
2729 screen_mode_string_pos_w = screen_mode_string_copy;
2730 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2731 *screen_mode_string_pos_h++ = '\0';
2733 screen_mode.width = atoi(screen_mode_string_pos_w);
2734 screen_mode.height = atoi(screen_mode_string_pos_h);
2736 return &screen_mode;
2739 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2742 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2743 float aspect_ratio_new;
2748 *x = i * aspect_ratio + 0.000001;
2751 aspect_ratio_new = (float)*x / (float)*y;
2755 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2758 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2759 struct ListNodeInfo ***, int *);
2761 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2762 struct ConfigTypeInfo *suffix_list,
2763 char **ignore_tokens,
2764 int num_file_list_entries)
2766 struct FileInfo *file_list;
2767 int num_file_list_entries_found = 0;
2768 int num_suffix_list_entries = 0;
2772 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2774 for (i = 0; suffix_list[i].token != NULL; i++)
2775 num_suffix_list_entries++;
2777 /* always start with reliable default values */
2778 for (i = 0; i < num_file_list_entries; i++)
2780 file_list[i].token = NULL;
2782 file_list[i].default_filename = NULL;
2783 file_list[i].filename = NULL;
2785 if (num_suffix_list_entries > 0)
2787 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2789 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2790 file_list[i].parameter = checked_calloc(parameter_array_size);
2792 for (j = 0; j < num_suffix_list_entries; j++)
2794 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2795 setString(&file_list[i].parameter[j], suffix_list[j].value);
2798 file_list[i].redefined = FALSE;
2799 file_list[i].fallback_to_default = FALSE;
2800 file_list[i].default_is_cloned = FALSE;
2806 for (i = 0; config_list[i].token != NULL; i++)
2808 int len_config_token = strlen(config_list[i].token);
2810 int len_config_value = strlen(config_list[i].value);
2812 boolean is_file_entry = TRUE;
2814 for (j = 0; suffix_list[j].token != NULL; j++)
2816 int len_suffix = strlen(suffix_list[j].token);
2818 if (len_suffix < len_config_token &&
2819 strEqual(&config_list[i].token[len_config_token - len_suffix],
2820 suffix_list[j].token))
2822 setString(&file_list[list_pos].default_parameter[j],
2823 config_list[i].value);
2825 is_file_entry = FALSE;
2831 /* the following tokens are no file definitions, but other config tokens */
2832 for (j = 0; ignore_tokens[j] != NULL; j++)
2833 if (strEqual(config_list[i].token, ignore_tokens[j]))
2834 is_file_entry = FALSE;
2841 if (list_pos >= num_file_list_entries)
2845 /* simple sanity check if this is really a file definition */
2846 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2847 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2848 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2850 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2851 config_list[i].token, config_list[i].value);
2852 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2856 file_list[list_pos].token = config_list[i].token;
2857 file_list[list_pos].default_filename = config_list[i].value;
2860 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2864 if (strSuffix(config_list[i].token, ".clone_from"))
2865 file_list[list_pos].default_is_cloned = TRUE;
2868 num_file_list_entries_found = list_pos + 1;
2869 if (num_file_list_entries_found != num_file_list_entries)
2871 Error(ERR_INFO_LINE, "-");
2872 Error(ERR_INFO, "inconsistant config list information:");
2873 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2874 num_file_list_entries);
2875 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2876 num_file_list_entries_found);
2877 Error(ERR_EXIT, "please fix");
2881 printf("::: ---------- DONE ----------\n");
2887 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2889 int len_token = strlen(token);
2890 int len_suffix = strlen(suffix);
2892 if (start_pos < 0) /* compare suffix from end of string */
2893 start_pos += len_token;
2895 if (start_pos < 0 || start_pos + len_suffix > len_token)
2898 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2901 if (token[start_pos + len_suffix] == '\0')
2904 if (token[start_pos + len_suffix] == '.')
2910 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2912 static void read_token_parameters(SetupFileHash *setup_file_hash,
2913 struct ConfigTypeInfo *suffix_list,
2914 struct FileInfo *file_list_entry)
2916 /* check for config token that is the base token without any suffixes */
2917 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2918 char *known_token_value = KNOWN_TOKEN_VALUE;
2921 if (filename != NULL)
2923 setString(&file_list_entry->filename, filename);
2925 /* when file definition found, set all parameters to default values */
2926 for (i = 0; suffix_list[i].token != NULL; i++)
2927 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2929 file_list_entry->redefined = TRUE;
2931 /* mark config file token as well known from default config */
2932 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2935 /* check for config tokens that can be build by base token and suffixes */
2936 for (i = 0; suffix_list[i].token != NULL; i++)
2938 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2939 char *value = getHashEntry(setup_file_hash, token);
2943 setString(&file_list_entry->parameter[i], value);
2945 /* mark config file token as well known from default config */
2946 setHashEntry(setup_file_hash, token, known_token_value);
2953 static void add_dynamic_file_list_entry(struct FileInfo **list,
2954 int *num_list_entries,
2955 SetupFileHash *extra_file_hash,
2956 struct ConfigTypeInfo *suffix_list,
2957 int num_suffix_list_entries,
2960 struct FileInfo *new_list_entry;
2961 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2963 (*num_list_entries)++;
2964 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2965 new_list_entry = &(*list)[*num_list_entries - 1];
2967 new_list_entry->token = getStringCopy(token);
2968 new_list_entry->default_filename = NULL;
2969 new_list_entry->filename = NULL;
2970 new_list_entry->parameter = checked_calloc(parameter_array_size);
2972 new_list_entry->redefined = FALSE;
2973 new_list_entry->fallback_to_default = FALSE;
2974 new_list_entry->default_is_cloned = FALSE;
2976 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2979 static void add_property_mapping(struct PropertyMapping **list,
2980 int *num_list_entries,
2981 int base_index, int ext1_index,
2982 int ext2_index, int ext3_index,
2985 struct PropertyMapping *new_list_entry;
2987 (*num_list_entries)++;
2988 *list = checked_realloc(*list,
2989 *num_list_entries * sizeof(struct PropertyMapping));
2990 new_list_entry = &(*list)[*num_list_entries - 1];
2992 new_list_entry->base_index = base_index;
2993 new_list_entry->ext1_index = ext1_index;
2994 new_list_entry->ext2_index = ext2_index;
2995 new_list_entry->ext3_index = ext3_index;
2997 new_list_entry->artwork_index = artwork_index;
3000 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3003 struct FileInfo *file_list = artwork_info->file_list;
3004 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3005 char **base_prefixes = artwork_info->base_prefixes;
3006 char **ext1_suffixes = artwork_info->ext1_suffixes;
3007 char **ext2_suffixes = artwork_info->ext2_suffixes;
3008 char **ext3_suffixes = artwork_info->ext3_suffixes;
3009 char **ignore_tokens = artwork_info->ignore_tokens;
3010 int num_file_list_entries = artwork_info->num_file_list_entries;
3011 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3012 int num_base_prefixes = artwork_info->num_base_prefixes;
3013 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3014 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3015 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3016 int num_ignore_tokens = artwork_info->num_ignore_tokens;
3017 SetupFileHash *setup_file_hash, *valid_file_hash;
3018 SetupFileHash *extra_file_hash, *empty_file_hash;
3019 char *known_token_value = KNOWN_TOKEN_VALUE;
3022 if (filename == NULL)
3026 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
3029 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3032 /* separate valid (defined) from empty (undefined) config token values */
3033 valid_file_hash = newSetupFileHash();
3034 empty_file_hash = newSetupFileHash();
3035 BEGIN_HASH_ITERATION(setup_file_hash, itr)
3037 char *value = HASH_ITERATION_VALUE(itr);
3039 setHashEntry(*value ? valid_file_hash : empty_file_hash,
3040 HASH_ITERATION_TOKEN(itr), value);
3042 END_HASH_ITERATION(setup_file_hash, itr)
3044 /* at this point, we do not need the setup file hash anymore -- free it */
3045 freeSetupFileHash(setup_file_hash);
3047 /* map deprecated to current tokens (using prefix match and replace) */
3048 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3050 char *token = HASH_ITERATION_TOKEN(itr);
3051 char *mapped_token = get_mapped_token(token);
3053 if (mapped_token != NULL)
3055 char *value = HASH_ITERATION_VALUE(itr);
3057 /* add mapped token */
3058 setHashEntry(valid_file_hash, mapped_token, value);
3060 /* ignore old token (by setting it to "known" keyword) */
3061 setHashEntry(valid_file_hash, token, known_token_value);
3066 END_HASH_ITERATION(valid_file_hash, itr)
3068 /* read parameters for all known config file tokens */
3069 for (i = 0; i < num_file_list_entries; i++)
3070 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3072 /* set all tokens that can be ignored here to "known" keyword */
3073 for (i = 0; i < num_ignore_tokens; i++)
3074 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3076 /* copy all unknown config file tokens to extra config hash */
3077 extra_file_hash = newSetupFileHash();
3078 BEGIN_HASH_ITERATION(valid_file_hash, itr)
3080 char *value = HASH_ITERATION_VALUE(itr);
3082 if (!strEqual(value, known_token_value))
3083 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3085 END_HASH_ITERATION(valid_file_hash, itr)
3087 /* at this point, we do not need the valid file hash anymore -- free it */
3088 freeSetupFileHash(valid_file_hash);
3090 /* now try to determine valid, dynamically defined config tokens */
3092 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3094 struct FileInfo **dynamic_file_list =
3095 &artwork_info->dynamic_file_list;
3096 int *num_dynamic_file_list_entries =
3097 &artwork_info->num_dynamic_file_list_entries;
3098 struct PropertyMapping **property_mapping =
3099 &artwork_info->property_mapping;
3100 int *num_property_mapping_entries =
3101 &artwork_info->num_property_mapping_entries;
3102 int current_summarized_file_list_entry =
3103 artwork_info->num_file_list_entries +
3104 artwork_info->num_dynamic_file_list_entries;
3105 char *token = HASH_ITERATION_TOKEN(itr);
3106 int len_token = strlen(token);
3108 boolean base_prefix_found = FALSE;
3109 boolean parameter_suffix_found = FALSE;
3112 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3115 /* skip all parameter definitions (handled by read_token_parameters()) */
3116 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3118 int len_suffix = strlen(suffix_list[i].token);
3120 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3121 parameter_suffix_found = TRUE;
3124 if (parameter_suffix_found)
3127 /* ---------- step 0: search for matching base prefix ---------- */
3130 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3132 char *base_prefix = base_prefixes[i];
3133 int len_base_prefix = strlen(base_prefix);
3134 boolean ext1_suffix_found = FALSE;
3135 boolean ext2_suffix_found = FALSE;
3136 boolean ext3_suffix_found = FALSE;
3137 boolean exact_match = FALSE;
3138 int base_index = -1;
3139 int ext1_index = -1;
3140 int ext2_index = -1;
3141 int ext3_index = -1;
3143 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3145 if (!base_prefix_found)
3151 if (IS_PARENT_PROCESS())
3152 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3155 if (start_pos + len_base_prefix == len_token) /* exact match */
3160 if (IS_PARENT_PROCESS())
3161 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3164 add_dynamic_file_list_entry(dynamic_file_list,
3165 num_dynamic_file_list_entries,
3168 num_suffix_list_entries,
3170 add_property_mapping(property_mapping,
3171 num_property_mapping_entries,
3172 base_index, -1, -1, -1,
3173 current_summarized_file_list_entry);
3178 if (IS_PARENT_PROCESS())
3179 printf("---> examining token '%s': search 1st suffix ...\n", token);
3182 /* ---------- step 1: search for matching first suffix ---------- */
3184 start_pos += len_base_prefix;
3185 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3187 char *ext1_suffix = ext1_suffixes[j];
3188 int len_ext1_suffix = strlen(ext1_suffix);
3190 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3192 if (!ext1_suffix_found)
3198 if (IS_PARENT_PROCESS())
3199 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3202 if (start_pos + len_ext1_suffix == len_token) /* exact match */
3207 if (IS_PARENT_PROCESS())
3208 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3211 add_dynamic_file_list_entry(dynamic_file_list,
3212 num_dynamic_file_list_entries,
3215 num_suffix_list_entries,
3217 add_property_mapping(property_mapping,
3218 num_property_mapping_entries,
3219 base_index, ext1_index, -1, -1,
3220 current_summarized_file_list_entry);
3224 start_pos += len_ext1_suffix;
3231 if (IS_PARENT_PROCESS())
3232 printf("---> examining token '%s': search 2nd suffix ...\n", token);
3235 /* ---------- step 2: search for matching second suffix ---------- */
3237 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3239 char *ext2_suffix = ext2_suffixes[k];
3240 int len_ext2_suffix = strlen(ext2_suffix);
3242 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3244 if (!ext2_suffix_found)
3250 if (IS_PARENT_PROCESS())
3251 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3254 if (start_pos + len_ext2_suffix == len_token) /* exact match */
3259 if (IS_PARENT_PROCESS())
3260 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3263 add_dynamic_file_list_entry(dynamic_file_list,
3264 num_dynamic_file_list_entries,
3267 num_suffix_list_entries,
3269 add_property_mapping(property_mapping,
3270 num_property_mapping_entries,
3271 base_index, ext1_index, ext2_index, -1,
3272 current_summarized_file_list_entry);
3276 start_pos += len_ext2_suffix;
3283 if (IS_PARENT_PROCESS())
3284 printf("---> examining token '%s': search 3rd suffix ...\n",token);
3287 /* ---------- step 3: search for matching third suffix ---------- */
3289 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3291 char *ext3_suffix = ext3_suffixes[l];
3292 int len_ext3_suffix = strlen(ext3_suffix);
3294 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3296 if (!ext3_suffix_found)
3302 if (IS_PARENT_PROCESS())
3303 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3306 if (start_pos + len_ext3_suffix == len_token) /* exact match */
3311 if (IS_PARENT_PROCESS())
3312 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3315 add_dynamic_file_list_entry(dynamic_file_list,
3316 num_dynamic_file_list_entries,
3319 num_suffix_list_entries,
3321 add_property_mapping(property_mapping,
3322 num_property_mapping_entries,
3323 base_index, ext1_index, ext2_index, ext3_index,
3324 current_summarized_file_list_entry);
3330 END_HASH_ITERATION(extra_file_hash, itr)
3332 if (artwork_info->num_dynamic_file_list_entries > 0)
3334 artwork_info->dynamic_artwork_list =
3335 checked_calloc(artwork_info->num_dynamic_file_list_entries *
3336 artwork_info->sizeof_artwork_list_entry);
3339 if (options.verbose && IS_PARENT_PROCESS())
3341 SetupFileList *setup_file_list, *list;
3342 boolean dynamic_tokens_found = FALSE;
3343 boolean unknown_tokens_found = FALSE;
3344 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3346 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3347 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3349 BEGIN_HASH_ITERATION(extra_file_hash, itr)
3351 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3352 dynamic_tokens_found = TRUE;
3354 unknown_tokens_found = TRUE;
3356 END_HASH_ITERATION(extra_file_hash, itr)
3358 if (options.debug && dynamic_tokens_found)
3360 Error(ERR_INFO_LINE, "-");
3361 Error(ERR_INFO, "dynamic token(s) found in config file:");
3362 Error(ERR_INFO, "- config file: '%s'", filename);
3364 for (list = setup_file_list; list != NULL; list = list->next)
3366 char *value = getHashEntry(extra_file_hash, list->token);
3368 if (value != NULL && strEqual(value, known_token_value))
3369 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3372 Error(ERR_INFO_LINE, "-");
3375 if (unknown_tokens_found)
3377 Error(ERR_INFO_LINE, "-");
3378 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3379 Error(ERR_INFO, "- config file: '%s'", filename);
3381 for (list = setup_file_list; list != NULL; list = list->next)
3383 char *value = getHashEntry(extra_file_hash, list->token);
3385 if (value != NULL && !strEqual(value, known_token_value))
3386 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3389 Error(ERR_INFO_LINE, "-");
3392 if (undefined_values_found)
3394 Error(ERR_INFO_LINE, "-");
3395 Error(ERR_INFO, "warning: undefined values found in config file:");
3396 Error(ERR_INFO, "- config file: '%s'", filename);
3398 for (list = setup_file_list; list != NULL; list = list->next)
3400 char *value = getHashEntry(empty_file_hash, list->token);
3403 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3406 Error(ERR_INFO_LINE, "-");
3409 freeSetupFileList(setup_file_list);
3412 freeSetupFileHash(extra_file_hash);
3413 freeSetupFileHash(empty_file_hash);
3416 for (i = 0; i < num_file_list_entries; i++)
3418 printf("'%s' ", file_list[i].token);
3419 if (file_list[i].filename)
3420 printf("-> '%s'\n", file_list[i].filename);
3422 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3427 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3429 struct FileInfo *file_list = artwork_info->file_list;
3430 int num_file_list_entries = artwork_info->num_file_list_entries;
3431 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3432 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3435 DrawInitText("Loading artwork config", 120, FC_GREEN);
3436 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3438 /* always start with reliable default values */
3439 for (i = 0; i < num_file_list_entries; i++)
3441 setString(&file_list[i].filename, file_list[i].default_filename);
3443 for (j = 0; j < num_suffix_list_entries; j++)
3444 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3446 file_list[i].redefined = FALSE;
3447 file_list[i].fallback_to_default = FALSE;
3450 /* free previous dynamic artwork file array */
3451 if (artwork_info->dynamic_file_list != NULL)
3453 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3455 free(artwork_info->dynamic_file_list[i].token);
3456 free(artwork_info->dynamic_file_list[i].filename);
3457 free(artwork_info->dynamic_file_list[i].parameter);
3460 free(artwork_info->dynamic_file_list);
3461 artwork_info->dynamic_file_list = NULL;
3463 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3464 &artwork_info->num_dynamic_file_list_entries);
3467 /* free previous property mapping */
3468 if (artwork_info->property_mapping != NULL)
3470 free(artwork_info->property_mapping);
3472 artwork_info->property_mapping = NULL;
3473 artwork_info->num_property_mapping_entries = 0;
3477 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3479 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3482 /* first look for special artwork configured in level series config */
3483 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3486 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3487 leveldir_current->graphics_set,
3488 leveldir_current->graphics_path);
3491 if (fileExists(filename_base))
3492 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3495 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3497 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3498 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3501 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3502 struct ListNodeInfo **listnode)
3506 char *filename = (*listnode)->source_filename;
3508 if (--(*listnode)->num_references <= 0)
3509 deleteNodeFromList(&artwork_info->content_list, filename,
3510 artwork_info->free_artwork);
3516 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3517 struct ListNodeInfo **listnode,
3518 struct FileInfo *file_list_entry)
3528 char *basename = file_list_entry->filename;
3529 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3531 if (filename == NULL)
3533 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3535 basename = file_list_entry->default_filename;
3537 /* fail for cloned default artwork that has no default filename defined */
3538 if (file_list_entry->default_is_cloned &&
3539 strEqual(basename, UNDEFINED_FILENAME))
3541 int error_mode = ERR_WARN;
3543 /* we can get away without sounds and music, but not without graphics */
3544 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3545 error_mode = ERR_EXIT;
3547 Error(error_mode, "token '%s' was cloned and has no default filename",
3548 file_list_entry->token);
3553 /* dynamic artwork has no default filename / skip empty default artwork */
3554 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3557 file_list_entry->fallback_to_default = TRUE;
3559 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3561 filename = getCustomArtworkFilename(basename, artwork_info->type);
3563 if (filename == NULL)
3565 int error_mode = ERR_WARN;
3567 /* we can get away without sounds and music, but not without graphics */
3568 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3569 error_mode = ERR_EXIT;
3571 Error(error_mode, "cannot find default artwork file '%s'", basename);
3577 /* check if the old and the new artwork file are the same */
3578 if (*listnode && strEqual((*listnode)->source_filename, filename))
3580 /* The old and new artwork are the same (have the same filename and path).
3581 This usually means that this artwork does not exist in this artwork set
3582 and a fallback to the existing artwork is done. */
3585 printf("[artwork '%s' already exists (same list entry)]\n", filename);
3591 /* delete existing artwork file entry */
3592 deleteArtworkListEntry(artwork_info, listnode);
3594 /* check if the new artwork file already exists in the list of artworks */
3595 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3598 printf("[artwork '%s' already exists (other list entry)]\n", filename);
3601 *listnode = (struct ListNodeInfo *)node->content;
3602 (*listnode)->num_references++;
3607 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3608 DrawInitText(basename, 150, FC_YELLOW);
3610 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3613 printf("[adding new artwork '%s']\n", filename);
3616 (*listnode)->num_references = 1;
3617 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3622 int error_mode = ERR_WARN;
3624 /* we can get away without sounds and music, but not without graphics */
3625 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3626 error_mode = ERR_EXIT;
3628 Error(error_mode, "cannot load artwork file '%s'", basename);
3634 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3635 struct ListNodeInfo **listnode,
3636 struct FileInfo *file_list_entry)
3639 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3642 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3644 deleteArtworkListEntry(artwork_info, listnode);
3649 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3652 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3654 struct FileInfo *file_list = artwork_info->file_list;
3655 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3656 int num_file_list_entries = artwork_info->num_file_list_entries;
3657 int num_dynamic_file_list_entries =
3658 artwork_info->num_dynamic_file_list_entries;
3661 print_timestamp_init("ReloadCustomArtworkList");
3663 for (i = 0; i < num_file_list_entries; i++)
3664 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3667 for (i = 0; i < num_dynamic_file_list_entries; i++)
3668 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3669 &dynamic_file_list[i]);
3671 print_timestamp_done("ReloadCustomArtworkList");
3674 dumpList(artwork_info->content_list);
3678 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3679 struct ListNodeInfo ***list,
3680 int *num_list_entries)
3687 for (i = 0; i < *num_list_entries; i++)
3688 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3692 *num_list_entries = 0;
3695 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3697 if (artwork_info == NULL)
3700 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3701 &artwork_info->num_file_list_entries);
3703 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3704 &artwork_info->num_dynamic_file_list_entries);
3708 /* ------------------------------------------------------------------------- */
3709 /* functions only needed for non-Unix (non-command-line) systems */
3710 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3711 /* (now also added for Windows, to create files in user data directory) */
3712 /* ------------------------------------------------------------------------- */
3714 char *getErrorFilename(char *basename)
3716 return getPath2(getUserGameDataDir(), basename);
3719 void openErrorFile()
3721 InitUserDataDirectory();
3723 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3725 program.error_file = stderr;
3727 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3728 program.error_filename, strerror(errno));
3732 void closeErrorFile()
3734 if (program.error_file != stderr) /* do not close stream 'stderr' */
3735 fclose(program.error_file);
3738 void dumpErrorFile()
3740 FILE *error_file = fopen(program.error_filename, MODE_READ);
3742 if (error_file != NULL)
3744 while (!feof(error_file))
3745 fputc(fgetc(error_file), stderr);
3751 void NotifyUserAboutErrorFile()
3753 #if defined(PLATFORM_WIN32)
3754 char *title_text = getStringCat2(program.program_title, " Error Message");
3755 char *error_text = getStringCat2("The program was aborted due to an error; "
3756 "for details, see the following error file:"
3757 STRING_NEWLINE, program.error_filename);
3759 MessageBox(NULL, error_text, title_text, MB_OK);
3764 /* ------------------------------------------------------------------------- */
3765 /* the following is only for debugging purpose and normally not used */
3766 /* ------------------------------------------------------------------------- */
3770 #define DEBUG_PRINT_INIT_TIMESTAMPS TRUE
3771 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH 10
3773 #define DEBUG_NUM_TIMESTAMPS 10
3774 #define DEBUG_TIME_IN_MICROSECONDS 0
3776 #if DEBUG_TIME_IN_MICROSECONDS
3777 static double Counter_Microseconds()
3779 static struct timeval base_time = { 0, 0 };
3780 struct timeval current_time;
3783 gettimeofday(¤t_time, NULL);
3785 /* reset base time in case of wrap-around */
3786 if (current_time.tv_sec < base_time.tv_sec)
3787 base_time = current_time;
3790 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3791 ((double)(current_time.tv_usec - base_time.tv_usec));
3793 return counter; /* return microseconds since last init */
3797 char *debug_print_timestamp_get_padding(int padding_size)
3799 static char *padding = NULL;
3800 int max_padding_size = 100;
3802 if (padding == NULL)
3804 padding = checked_calloc(max_padding_size + 1);
3805 memset(padding, ' ', max_padding_size);
3808 return &padding[MAX(0, max_padding_size - padding_size)];
3811 void debug_print_timestamp(int counter_nr, char *message)
3813 int indent_size = 8;
3814 int padding_size = 40;
3815 float timestamp_interval;
3818 Error(ERR_EXIT, "debugging: invalid negative counter");
3819 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3820 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3822 #if DEBUG_TIME_IN_MICROSECONDS
3823 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3826 counter[counter_nr][0] = Counter_Microseconds();
3828 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3831 counter[counter_nr][0] = Counter();
3834 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3835 counter[counter_nr][1] = counter[counter_nr][0];
3839 Error(ERR_DEBUG, "%s%s%s %.3f %s",
3841 printf("%s%s%s %.3f %s\n",
3843 debug_print_timestamp_get_padding(counter_nr * indent_size),
3845 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3846 timestamp_interval / 1000,
3850 void debug_print_parent_only(char *format, ...)
3852 if (!IS_PARENT_PROCESS())
3859 va_start(ap, format);
3860 vprintf(format, ap);
3869 void print_timestamp_ext(char *message, char *mode)
3871 #if DEBUG_PRINT_INIT_TIMESTAMPS
3872 static char *debug_message = NULL;
3873 static char *last_message = NULL;
3874 static int counter_nr = 0;
3875 int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3877 checked_free(debug_message);
3878 debug_message = getStringCat3(mode, " ", message);
3880 if (strEqual(mode, "INIT"))
3882 debug_print_timestamp(counter_nr, NULL);
3884 if (counter_nr + 1 < max_depth)
3885 debug_print_timestamp(counter_nr, debug_message);
3889 debug_print_timestamp(counter_nr, NULL);
3891 else if (strEqual(mode, "DONE"))
3895 if (counter_nr + 1 < max_depth ||
3896 (counter_nr == 0 && max_depth == 1))
3898 last_message = message;
3900 if (counter_nr == 0 && max_depth == 1)
3902 checked_free(debug_message);
3903 debug_message = getStringCat3("TIME", " ", message);
3906 debug_print_timestamp(counter_nr, debug_message);
3909 else if (!strEqual(mode, "TIME") ||
3910 !strEqual(message, last_message))
3912 if (counter_nr < max_depth)
3913 debug_print_timestamp(counter_nr, debug_message);
3918 void print_timestamp_init(char *message)
3920 print_timestamp_ext(message, "INIT");
3923 void print_timestamp_time(char *message)
3925 print_timestamp_ext(message, "TIME");
3928 void print_timestamp_done(char *message)
3930 print_timestamp_ext(message, "DONE");