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_newline(FILE *stream, char *format, va_list ap)
70 #if defined(PLATFORM_ANDROID)
71 __android_log_vprint(android_log_prio, program.program_title, format, ap);
73 char *newline = STRING_NEWLINE;
75 vfprintf(stream, format, ap);
76 fprintf(stream, "%s", newline);
80 static void fprintf_newline(FILE *stream, char *format, ...)
85 vfprintf_newline(stream, format, ap);
89 void fprintf_line(FILE *stream, char *line_chars, int line_length)
93 for (i = 0; i < line_length; i++)
94 fprintf(stream, "%s", line_chars);
96 fprintf_newline(stream, "");
99 void printf_line(char *line_chars, int line_length)
101 fprintf_line(stdout, line_chars, line_length);
104 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
106 fprintf(stdout, "%s", prefix);
107 fprintf_line(stdout, line_chars, line_length);
111 /* ------------------------------------------------------------------------- */
112 /* string functions */
113 /* ------------------------------------------------------------------------- */
115 /* int2str() returns a number converted to a string;
116 the used memory is static, but will be overwritten by later calls,
117 so if you want to save the result, copy it to a private string buffer;
118 there can be 10 local calls of int2str() without buffering the result --
119 the 11th call will then destroy the result from the first call and so on.
122 char *int2str(int number, int size)
124 static char shift_array[10][40];
125 static int shift_counter = 0;
126 char *s = shift_array[shift_counter];
128 shift_counter = (shift_counter + 1) % 10;
135 sprintf(s, " %09d", number);
136 return &s[strlen(s) - size];
140 sprintf(s, "%d", number);
146 /* something similar to "int2str()" above, but allocates its own memory
147 and has a different interface; we cannot use "itoa()", because this
148 seems to be already defined when cross-compiling to the win32 target */
150 char *i_to_a(unsigned int i)
152 static char *a = NULL;
156 if (i > 2147483647) /* yes, this is a kludge */
159 a = checked_malloc(10 + 1);
167 /* calculate base-2 logarithm of argument (rounded down to integer;
168 this function returns the number of the highest bit set in argument) */
170 int log_2(unsigned int x)
176 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
183 boolean getTokenValueFromString(char *string, char **token, char **value)
185 return getTokenValueFromSetupLine(string, token, value);
189 /* ------------------------------------------------------------------------- */
190 /* counter functions */
191 /* ------------------------------------------------------------------------- */
193 #if defined(PLATFORM_MSDOS)
194 volatile unsigned int counter = 0;
196 void increment_counter()
201 END_OF_FUNCTION(increment_counter);
205 /* maximal allowed length of a command line option */
206 #define MAX_OPTION_LEN 256
210 #if defined(TARGET_SDL)
211 static unsigned int getCurrentMS()
213 return SDL_GetTicks();
216 #else /* !TARGET_SDL */
218 #if defined(PLATFORM_UNIX)
219 static unsigned int getCurrentMS()
221 struct timeval current_time;
223 gettimeofday(¤t_time, NULL);
225 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
227 #endif /* PLATFORM_UNIX */
228 #endif /* !TARGET_SDL */
230 static unsigned int mainCounter(int mode)
232 static unsigned int base_ms = 0;
233 unsigned int current_ms;
235 /* get current system milliseconds */
236 current_ms = getCurrentMS();
238 /* reset base timestamp in case of counter reset or wrap-around */
239 if (mode == INIT_COUNTER || current_ms < base_ms)
240 base_ms = current_ms;
242 /* return milliseconds since last counter reset */
243 return current_ms - base_ms;
248 #if defined(TARGET_SDL)
249 static unsigned int mainCounter(int mode)
251 static unsigned int base_ms = 0;
252 unsigned int current_ms;
253 unsigned int counter_ms;
255 current_ms = SDL_GetTicks();
257 /* reset base time in case of counter initializing or wrap-around */
258 if (mode == INIT_COUNTER || current_ms < base_ms)
259 base_ms = current_ms;
261 counter_ms = current_ms - base_ms;
263 return counter_ms; /* return milliseconds since last init */
266 #else /* !TARGET_SDL */
268 #if defined(PLATFORM_UNIX)
269 static unsigned int mainCounter(int mode)
271 static struct timeval base_time = { 0, 0 };
272 struct timeval current_time;
273 unsigned int counter_ms;
275 gettimeofday(¤t_time, NULL);
277 /* reset base time in case of counter initializing or wrap-around */
278 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
279 base_time = current_time;
281 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
282 + (current_time.tv_usec - base_time.tv_usec) / 1000;
284 return counter_ms; /* return milliseconds since last init */
286 #endif /* PLATFORM_UNIX */
287 #endif /* !TARGET_SDL */
291 void InitCounter() /* set counter back to zero */
293 #if !defined(PLATFORM_MSDOS)
294 mainCounter(INIT_COUNTER);
296 LOCK_VARIABLE(counter);
297 LOCK_FUNCTION(increment_counter);
298 install_int_ex(increment_counter, BPS_TO_TIMER(100));
302 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
304 #if !defined(PLATFORM_MSDOS)
305 return mainCounter(READ_COUNTER);
307 return (counter * 10);
311 static void sleep_milliseconds(unsigned int milliseconds_delay)
313 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
317 /* we want to wait only a few ms -- if we assume that we have a
318 kernel timer resolution of 10 ms, we would wait far to long;
319 therefore it's better to do a short interval of busy waiting
320 to get our sleeping time more accurate */
322 unsigned int base_counter = Counter(), actual_counter = Counter();
324 while (actual_counter < base_counter + milliseconds_delay &&
325 actual_counter >= base_counter)
326 actual_counter = Counter();
330 #if defined(TARGET_SDL)
331 SDL_Delay(milliseconds_delay);
332 #elif defined(TARGET_ALLEGRO)
333 rest(milliseconds_delay);
335 struct timeval delay;
337 delay.tv_sec = milliseconds_delay / 1000;
338 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
340 if (select(0, NULL, NULL, NULL, &delay) != 0)
341 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
346 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
348 sleep_milliseconds(delay);
351 boolean FrameReached(unsigned int *frame_counter_var,
352 unsigned int frame_delay)
354 unsigned int actual_frame_counter = FrameCounter;
356 if (actual_frame_counter >= *frame_counter_var &&
357 actual_frame_counter < *frame_counter_var + frame_delay)
360 *frame_counter_var = actual_frame_counter;
365 boolean DelayReached(unsigned int *counter_var,
368 unsigned int actual_counter = Counter();
370 if (actual_counter >= *counter_var &&
371 actual_counter < *counter_var + delay)
374 *counter_var = actual_counter;
379 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
381 unsigned int actual_counter;
385 actual_counter = Counter();
387 if (actual_counter >= *counter_var &&
388 actual_counter < *counter_var + delay)
389 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
394 *counter_var = actual_counter;
398 /* ------------------------------------------------------------------------- */
399 /* random generator functions */
400 /* ------------------------------------------------------------------------- */
402 unsigned int init_random_number(int nr, int seed)
404 if (seed == NEW_RANDOMIZE)
406 /* default random seed */
407 seed = (int)time(NULL); // seconds since the epoch
409 #if !defined(PLATFORM_WIN32)
410 /* add some more randomness */
411 struct timeval current_time;
413 gettimeofday(¤t_time, NULL);
415 seed += (int)current_time.tv_usec; // microseconds since the epoch
418 #if defined(TARGET_SDL)
419 /* add some more randomness */
420 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
424 /* add some more randomness */
425 seed += GetSimpleRandom(1000000);
429 srandom_linux_libc(nr, (unsigned int) seed);
431 return (unsigned int) seed;
434 unsigned int get_random_number(int nr, int max)
436 return (max > 0 ? random_linux_libc(nr) % max : 0);
440 /* ------------------------------------------------------------------------- */
441 /* system info functions */
442 /* ------------------------------------------------------------------------- */
444 #if !defined(PLATFORM_MSDOS)
445 static char *get_corrected_real_name(char *real_name)
447 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
448 char *from_ptr = real_name;
449 char *to_ptr = real_name_new;
451 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
452 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
454 /* the name field read from "passwd" file may also contain additional
455 user information, separated by commas, which will be removed here */
456 if (*from_ptr == ',')
459 /* the user's real name may contain 'ß' characters (german sharp s),
460 which have no equivalent in upper case letters (used by our fonts) */
461 if (*from_ptr == 'ß')
468 *to_ptr++ = *from_ptr++;
473 return real_name_new;
479 static char *login_name = NULL;
481 #if defined(PLATFORM_WIN32)
482 if (login_name == NULL)
484 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
485 login_name = checked_malloc(buffer_size);
487 if (GetUserName(login_name, &buffer_size) == 0)
488 strcpy(login_name, ANONYMOUS_NAME);
491 if (login_name == NULL)
495 if ((pwd = getpwuid(getuid())) == NULL)
496 login_name = ANONYMOUS_NAME;
498 login_name = getStringCopy(pwd->pw_name);
507 static char *real_name = NULL;
509 #if defined(PLATFORM_WIN32)
510 if (real_name == NULL)
512 static char buffer[MAX_USERNAME_LEN + 1];
513 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
515 if (GetUserName(buffer, &buffer_size) != 0)
516 real_name = get_corrected_real_name(buffer);
518 real_name = ANONYMOUS_NAME;
520 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
521 if (real_name == NULL)
525 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
526 real_name = get_corrected_real_name(pwd->pw_gecos);
528 real_name = ANONYMOUS_NAME;
531 real_name = ANONYMOUS_NAME;
537 time_t getFileTimestampEpochSeconds(char *filename)
539 struct stat file_status;
541 if (stat(filename, &file_status) != 0) /* cannot stat file */
544 return file_status.st_mtime;
548 /* ------------------------------------------------------------------------- */
549 /* path manipulation functions */
550 /* ------------------------------------------------------------------------- */
552 static char *getLastPathSeparatorPtr(char *filename)
554 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
556 if (last_separator == NULL) /* also try DOS/Windows variant */
557 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
559 return last_separator;
562 char *getBaseNamePtr(char *filename)
564 char *last_separator = getLastPathSeparatorPtr(filename);
566 if (last_separator != NULL)
567 return last_separator + 1; /* separator found: strip base path */
569 return filename; /* no separator found: filename has no path */
572 char *getBaseName(char *filename)
574 return getStringCopy(getBaseNamePtr(filename));
577 char *getBasePath(char *filename)
579 char *basepath = getStringCopy(filename);
580 char *last_separator = getLastPathSeparatorPtr(basepath);
582 if (last_separator != NULL)
583 *last_separator = '\0'; /* separator found: strip basename */
585 basepath = "."; /* no separator found: use current path */
590 static char *getProgramMainDataPath()
592 char *main_data_path = getStringCopy(program.command_basepath);
594 #if defined(PLATFORM_MACOSX)
595 static char *main_data_binary_subdir = NULL;
597 if (main_data_binary_subdir == NULL)
599 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
601 strlen(MAC_APP_BINARY_SUBDIR) + 1);
603 sprintf(main_data_binary_subdir, "%s.app/%s",
604 program.program_title, MAC_APP_BINARY_SUBDIR);
607 // cut relative path to Mac OS X application binary directory from path
608 if (strSuffix(main_data_path, main_data_binary_subdir))
609 main_data_path[strlen(main_data_path) -
610 strlen(main_data_binary_subdir)] = '\0';
612 // cut trailing path separator from path (but not if path is root directory)
613 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
614 main_data_path[strlen(main_data_path) - 1] = '\0';
617 return main_data_path;
621 /* ------------------------------------------------------------------------- */
622 /* various string functions */
623 /* ------------------------------------------------------------------------- */
625 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
627 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
630 sprintf(complete_string, "%s%s%s", s1, sep, s2);
632 return complete_string;
635 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
637 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
638 strlen(s2) + strlen(sep) +
641 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
643 return complete_string;
646 char *getStringCat2(char *s1, char *s2)
648 return getStringCat2WithSeparator(s1, s2, "");
651 char *getStringCat3(char *s1, char *s2, char *s3)
653 return getStringCat3WithSeparator(s1, s2, s3, "");
656 char *getPath2(char *path1, char *path2)
658 #if defined(PLATFORM_ANDROID)
659 // workaround for reading from APK assets directory -- skip leading "./"
660 if (strEqual(path1, "."))
661 return getStringCopy(path2);
664 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
667 char *getPath3(char *path1, char *path2, char *path3)
669 #if defined(PLATFORM_ANDROID)
670 // workaround for reading from APK assets directory -- skip leading "./"
671 if (strEqual(path1, "."))
672 return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
675 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
678 char *getStringCopy(char *s)
685 s_copy = checked_malloc(strlen(s) + 1);
691 char *getStringCopyN(char *s, int n)
694 int s_len = MAX(0, n);
699 s_copy = checked_malloc(s_len + 1);
700 strncpy(s_copy, s, s_len);
701 s_copy[s_len] = '\0';
706 char *getStringToLower(char *s)
708 char *s_copy = checked_malloc(strlen(s) + 1);
709 char *s_ptr = s_copy;
712 *s_ptr++ = tolower(*s++);
718 void setString(char **old_value, char *new_value)
720 checked_free(*old_value);
722 *old_value = getStringCopy(new_value);
725 boolean strEqual(char *s1, char *s2)
727 return (s1 == NULL && s2 == NULL ? TRUE :
728 s1 == NULL && s2 != NULL ? FALSE :
729 s1 != NULL && s2 == NULL ? FALSE :
730 strcmp(s1, s2) == 0);
733 boolean strEqualN(char *s1, char *s2, int n)
735 return (s1 == NULL && s2 == NULL ? TRUE :
736 s1 == NULL && s2 != NULL ? FALSE :
737 s1 != NULL && s2 == NULL ? FALSE :
738 strncmp(s1, s2, n) == 0);
741 boolean strPrefix(char *s, char *prefix)
743 return (s == NULL && prefix == NULL ? TRUE :
744 s == NULL && prefix != NULL ? FALSE :
745 s != NULL && prefix == NULL ? FALSE :
746 strncmp(s, prefix, strlen(prefix)) == 0);
749 boolean strSuffix(char *s, char *suffix)
751 return (s == NULL && suffix == NULL ? TRUE :
752 s == NULL && suffix != NULL ? FALSE :
753 s != NULL && suffix == NULL ? FALSE :
754 strlen(s) < strlen(suffix) ? FALSE :
755 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
758 boolean strPrefixLower(char *s, char *prefix)
760 char *s_lower = getStringToLower(s);
761 boolean match = strPrefix(s_lower, prefix);
768 boolean strSuffixLower(char *s, char *suffix)
770 char *s_lower = getStringToLower(s);
771 boolean match = strSuffix(s_lower, suffix);
779 /* ------------------------------------------------------------------------- */
780 /* command line option handling functions */
781 /* ------------------------------------------------------------------------- */
783 void GetOptions(char *argv[], void (*print_usage_function)(void))
785 char *ro_base_path = RO_BASE_PATH;
786 char *rw_base_path = RW_BASE_PATH;
787 char **options_left = &argv[1];
790 /* if the program is configured to start from current directory (default),
791 determine program package directory from program binary (some versions
792 of KDE/Konqueror and Mac OS X (especially "Mavericks") apparently do not
793 set the current working directory to the program package directory) */
795 if (strEqual(ro_base_path, "."))
796 ro_base_path = getProgramMainDataPath();
797 if (strEqual(rw_base_path, "."))
798 rw_base_path = getProgramMainDataPath();
801 #if !defined(PLATFORM_MACOSX)
802 /* if the program is configured to start from current directory (default),
803 determine program package directory (KDE/Konqueror does not do this by
804 itself and fails otherwise); on Mac OS X, the program binary is stored
805 in an application package directory -- do not try to use this directory
806 as the program data directory (Mac OS X handles this correctly anyway) */
808 if (strEqual(ro_base_path, "."))
809 ro_base_path = program.command_basepath;
810 if (strEqual(rw_base_path, "."))
811 rw_base_path = program.command_basepath;
816 /* initialize global program options */
817 options.display_name = NULL;
818 options.server_host = NULL;
819 options.server_port = 0;
821 options.ro_base_directory = ro_base_path;
822 options.rw_base_directory = rw_base_path;
823 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
824 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
825 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
826 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
827 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
829 options.execute_command = NULL;
830 options.special_flags = NULL;
832 options.serveronly = FALSE;
833 options.network = FALSE;
834 options.verbose = FALSE;
835 options.debug = FALSE;
836 options.debug_x11_sync = FALSE;
838 #if !defined(PLATFORM_UNIX)
839 if (*options_left == NULL) /* no options given -- enable verbose mode */
840 options.verbose = TRUE;
843 while (*options_left)
845 char option_str[MAX_OPTION_LEN];
846 char *option = options_left[0];
847 char *next_option = options_left[1];
848 char *option_arg = NULL;
849 int option_len = strlen(option);
851 if (option_len >= MAX_OPTION_LEN)
852 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
854 strcpy(option_str, option); /* copy argument into buffer */
857 if (strEqual(option, "--")) /* stop scanning arguments */
860 if (strPrefix(option, "--")) /* treat '--' like '-' */
863 option_arg = strchr(option, '=');
864 if (option_arg == NULL) /* no '=' in option */
865 option_arg = next_option;
868 *option_arg++ = '\0'; /* cut argument from option */
869 if (*option_arg == '\0') /* no argument after '=' */
870 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
873 option_len = strlen(option);
875 if (strEqual(option, "-"))
876 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
877 else if (strncmp(option, "-help", option_len) == 0)
879 print_usage_function();
883 else if (strncmp(option, "-display", option_len) == 0)
885 if (option_arg == NULL)
886 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
888 options.display_name = option_arg;
889 if (option_arg == next_option)
892 else if (strncmp(option, "-basepath", option_len) == 0)
894 if (option_arg == NULL)
895 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
897 /* this should be extended to separate options for ro and rw data */
898 options.ro_base_directory = ro_base_path = option_arg;
899 options.rw_base_directory = rw_base_path = option_arg;
900 if (option_arg == next_option)
903 /* adjust paths for sub-directories in base directory accordingly */
904 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
905 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
906 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
907 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
908 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
910 else if (strncmp(option, "-levels", option_len) == 0)
912 if (option_arg == NULL)
913 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
915 options.level_directory = option_arg;
916 if (option_arg == next_option)
919 else if (strncmp(option, "-graphics", option_len) == 0)
921 if (option_arg == NULL)
922 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
924 options.graphics_directory = option_arg;
925 if (option_arg == next_option)
928 else if (strncmp(option, "-sounds", option_len) == 0)
930 if (option_arg == NULL)
931 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
933 options.sounds_directory = option_arg;
934 if (option_arg == next_option)
937 else if (strncmp(option, "-music", option_len) == 0)
939 if (option_arg == NULL)
940 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
942 options.music_directory = option_arg;
943 if (option_arg == next_option)
946 else if (strncmp(option, "-network", option_len) == 0)
948 options.network = TRUE;
950 else if (strncmp(option, "-serveronly", option_len) == 0)
952 options.serveronly = TRUE;
954 else if (strncmp(option, "-verbose", option_len) == 0)
956 options.verbose = TRUE;
958 else if (strncmp(option, "-debug", option_len) == 0)
960 options.debug = TRUE;
962 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
964 options.debug_x11_sync = TRUE;
966 else if (strPrefix(option, "-D"))
969 options.special_flags = getStringCopy(&option[2]);
971 char *flags_string = &option[2];
972 unsigned int flags_value;
974 if (*flags_string == '\0')
975 Error(ERR_EXIT_HELP, "empty flag ignored");
977 flags_value = get_special_flags_function(flags_string);
979 if (flags_value == 0)
980 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
982 options.special_flags |= flags_value;
985 else if (strncmp(option, "-execute", option_len) == 0)
987 if (option_arg == NULL)
988 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
990 options.execute_command = option_arg;
991 if (option_arg == next_option)
994 /* when doing batch processing, always enable verbose mode (warnings) */
995 options.verbose = TRUE;
997 else if (*option == '-')
999 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
1001 else if (options.server_host == NULL)
1003 options.server_host = *options_left;
1005 else if (options.server_port == 0)
1007 options.server_port = atoi(*options_left);
1008 if (options.server_port < 1024)
1009 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
1012 Error(ERR_EXIT_HELP, "too many arguments");
1019 /* ------------------------------------------------------------------------- */
1020 /* error handling functions */
1021 /* ------------------------------------------------------------------------- */
1023 /* used by SetError() and GetError() to store internal error messages */
1024 static char internal_error[1024]; /* this is bad */
1026 void SetError(char *format, ...)
1030 va_start(ap, format);
1031 vsprintf(internal_error, format, ap);
1037 return internal_error;
1040 void Error(int mode, char *format, ...)
1042 static boolean last_line_was_separator = FALSE;
1043 char *process_name = "";
1045 #if defined(PLATFORM_ANDROID)
1046 android_log_prio = (mode & ERR_WARN ? ANDROID_LOG_WARN :
1047 mode & ERR_EXIT ? ANDROID_LOG_FATAL : ANDROID_LOG_INFO);
1051 /* display warnings only when running in verbose mode */
1052 if (mode & ERR_WARN && !options.verbose)
1056 if (mode == ERR_INFO_LINE)
1058 if (!last_line_was_separator)
1059 fprintf_line(program.error_file, format, 79);
1061 last_line_was_separator = TRUE;
1066 last_line_was_separator = FALSE;
1068 if (mode & ERR_SOUND_SERVER)
1069 process_name = " sound server";
1070 else if (mode & ERR_NETWORK_SERVER)
1071 process_name = " network server";
1072 else if (mode & ERR_NETWORK_CLIENT)
1073 process_name = " network client **";
1079 fprintf(program.error_file, "%s%s: ", program.command_basename,
1082 if (mode & ERR_WARN)
1083 fprintf(program.error_file, "warning: ");
1085 va_start(ap, format);
1086 vfprintf_newline(program.error_file, format, ap);
1089 if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1091 va_start(ap, format);
1092 program.exit_message_function(format, ap);
1097 if (mode & ERR_HELP)
1098 fprintf_newline(program.error_file,
1099 "%s: Try option '--help' for more information.",
1100 program.command_basename);
1102 if (mode & ERR_EXIT)
1103 fprintf_newline(program.error_file, "%s%s: aborting",
1104 program.command_basename, process_name);
1106 if (mode & ERR_EXIT)
1108 if (mode & ERR_FROM_SERVER)
1109 exit(1); /* child process: normal exit */
1111 program.exit_function(1); /* main process: clean up stuff */
1116 /* ------------------------------------------------------------------------- */
1117 /* checked memory allocation and freeing functions */
1118 /* ------------------------------------------------------------------------- */
1120 void *checked_malloc(unsigned int size)
1127 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1132 void *checked_calloc(unsigned int size)
1136 ptr = calloc(1, size);
1139 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1144 void *checked_realloc(void *ptr, unsigned int size)
1146 ptr = realloc(ptr, size);
1149 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1154 void checked_free(void *ptr)
1156 if (ptr != NULL) /* this check should be done by free() anyway */
1160 void clear_mem(void *ptr, unsigned int size)
1162 #if defined(PLATFORM_WIN32)
1163 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1164 char *cptr = (char *)ptr;
1169 memset(ptr, 0, size);
1174 /* ------------------------------------------------------------------------- */
1175 /* various helper functions */
1176 /* ------------------------------------------------------------------------- */
1178 inline void swap_numbers(int *i1, int *i2)
1186 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1198 /* the "put" variants of the following file access functions check for the file
1199 pointer being != NULL and return the number of bytes they have or would have
1200 written; this allows for chunk writing functions to first determine the size
1201 of the (not yet written) chunk, write the correct chunk size and finally
1202 write the chunk itself */
1204 int getFile8BitInteger(FILE *file)
1209 int putFile8BitInteger(FILE *file, int value)
1217 int getFile16BitInteger(FILE *file, int byte_order)
1219 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1220 return ((fgetc(file) << 8) |
1221 (fgetc(file) << 0));
1222 else /* BYTE_ORDER_LITTLE_ENDIAN */
1223 return ((fgetc(file) << 0) |
1224 (fgetc(file) << 8));
1227 int putFile16BitInteger(FILE *file, int value, int byte_order)
1231 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1233 fputc((value >> 8) & 0xff, file);
1234 fputc((value >> 0) & 0xff, file);
1236 else /* BYTE_ORDER_LITTLE_ENDIAN */
1238 fputc((value >> 0) & 0xff, file);
1239 fputc((value >> 8) & 0xff, file);
1246 int getFile32BitInteger(FILE *file, int byte_order)
1248 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1249 return ((fgetc(file) << 24) |
1250 (fgetc(file) << 16) |
1251 (fgetc(file) << 8) |
1252 (fgetc(file) << 0));
1253 else /* BYTE_ORDER_LITTLE_ENDIAN */
1254 return ((fgetc(file) << 0) |
1255 (fgetc(file) << 8) |
1256 (fgetc(file) << 16) |
1257 (fgetc(file) << 24));
1260 int putFile32BitInteger(FILE *file, int value, int byte_order)
1264 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1266 fputc((value >> 24) & 0xff, file);
1267 fputc((value >> 16) & 0xff, file);
1268 fputc((value >> 8) & 0xff, file);
1269 fputc((value >> 0) & 0xff, file);
1271 else /* BYTE_ORDER_LITTLE_ENDIAN */
1273 fputc((value >> 0) & 0xff, file);
1274 fputc((value >> 8) & 0xff, file);
1275 fputc((value >> 16) & 0xff, file);
1276 fputc((value >> 24) & 0xff, file);
1283 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1286 const int chunk_name_length = 4;
1288 /* read chunk name */
1289 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1292 if (chunk_size != NULL)
1294 /* read chunk size */
1295 *chunk_size = getFile32BitInteger(file, byte_order);
1298 return (feof(file) || ferror(file) ? FALSE : TRUE);
1301 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1306 /* write chunk name */
1308 fputs(chunk_name, file);
1310 num_bytes += strlen(chunk_name);
1312 if (chunk_size >= 0)
1314 /* write chunk size */
1316 putFile32BitInteger(file, chunk_size, byte_order);
1324 int getFileVersion(FILE *file)
1326 int version_major = fgetc(file);
1327 int version_minor = fgetc(file);
1328 int version_patch = fgetc(file);
1329 int version_build = fgetc(file);
1331 return VERSION_IDENT(version_major, version_minor, version_patch,
1335 int putFileVersion(FILE *file, int version)
1339 int version_major = VERSION_MAJOR(version);
1340 int version_minor = VERSION_MINOR(version);
1341 int version_patch = VERSION_PATCH(version);
1342 int version_build = VERSION_BUILD(version);
1344 fputc(version_major, file);
1345 fputc(version_minor, file);
1346 fputc(version_patch, file);
1347 fputc(version_build, file);
1353 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1357 for(i = 0; i < bytes && !feof(file); i++)
1358 buffer[i] = fgetc(file);
1361 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1365 for(i = 0; i < bytes; i++)
1366 fputc(buffer[i], file);
1369 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1371 while (bytes-- && !feof(file))
1375 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1382 /* ------------------------------------------------------------------------- */
1383 /* functions to translate key identifiers between different format */
1384 /* ------------------------------------------------------------------------- */
1386 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1387 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1388 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1389 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1391 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1400 /* normal cursor keys */
1401 { KSYM_Left, "XK_Left", "cursor left" },
1402 { KSYM_Right, "XK_Right", "cursor right" },
1403 { KSYM_Up, "XK_Up", "cursor up" },
1404 { KSYM_Down, "XK_Down", "cursor down" },
1406 /* keypad cursor keys */
1408 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1409 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1410 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1411 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1414 /* other keypad keys */
1415 #ifdef KSYM_KP_Enter
1416 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1417 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1418 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1419 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1420 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1421 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1425 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1426 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1427 { KSYM_Control_L, "XK_Control_L", "left control" },
1428 { KSYM_Control_R, "XK_Control_R", "right control" },
1429 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1430 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1431 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1432 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1433 #if !defined(TARGET_SDL2)
1434 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1435 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1437 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1438 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1440 /* some special keys */
1441 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1442 { KSYM_Delete, "XK_Delete", "delete" },
1443 { KSYM_Insert, "XK_Insert", "insert" },
1444 { KSYM_Tab, "XK_Tab", "tab" },
1445 { KSYM_Home, "XK_Home", "home" },
1446 { KSYM_End, "XK_End", "end" },
1447 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1448 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1449 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1451 /* ASCII 0x20 to 0x40 keys (except numbers) */
1452 { KSYM_space, "XK_space", "space" },
1453 { KSYM_exclam, "XK_exclam", "!" },
1454 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1455 { KSYM_numbersign, "XK_numbersign", "#" },
1456 { KSYM_dollar, "XK_dollar", "$" },
1457 { KSYM_percent, "XK_percent", "%" },
1458 { KSYM_ampersand, "XK_ampersand", "&" },
1459 { KSYM_apostrophe, "XK_apostrophe", "'" },
1460 { KSYM_parenleft, "XK_parenleft", "(" },
1461 { KSYM_parenright, "XK_parenright", ")" },
1462 { KSYM_asterisk, "XK_asterisk", "*" },
1463 { KSYM_plus, "XK_plus", "+" },
1464 { KSYM_comma, "XK_comma", "," },
1465 { KSYM_minus, "XK_minus", "-" },
1466 { KSYM_period, "XK_period", "." },
1467 { KSYM_slash, "XK_slash", "/" },
1468 { KSYM_colon, "XK_colon", ":" },
1469 { KSYM_semicolon, "XK_semicolon", ";" },
1470 { KSYM_less, "XK_less", "<" },
1471 { KSYM_equal, "XK_equal", "=" },
1472 { KSYM_greater, "XK_greater", ">" },
1473 { KSYM_question, "XK_question", "?" },
1474 { KSYM_at, "XK_at", "@" },
1476 /* more ASCII keys */
1477 { KSYM_bracketleft, "XK_bracketleft", "[" },
1478 { KSYM_backslash, "XK_backslash", "\\" },
1479 { KSYM_bracketright,"XK_bracketright", "]" },
1480 { KSYM_asciicircum, "XK_asciicircum", "^" },
1481 { KSYM_underscore, "XK_underscore", "_" },
1482 { KSYM_grave, "XK_grave", "grave" },
1483 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1484 { KSYM_braceleft, "XK_braceleft", "brace left" },
1485 { KSYM_bar, "XK_bar", "bar" },
1486 { KSYM_braceright, "XK_braceright", "brace right" },
1487 { KSYM_asciitilde, "XK_asciitilde", "~" },
1489 #if !defined(TARGET_SDL2)
1490 /* special (non-ASCII) keys */
1491 { KSYM_degree, "XK_degree", "°" },
1492 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1493 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1494 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1495 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1496 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1497 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1498 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1501 /* end-of-array identifier */
1507 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1509 static char name_buffer[30];
1512 if (key >= KSYM_A && key <= KSYM_Z)
1513 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1514 else if (key >= KSYM_a && key <= KSYM_z)
1515 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1516 else if (key >= KSYM_0 && key <= KSYM_9)
1517 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1518 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1519 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1520 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1521 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1522 else if (key == KSYM_UNDEFINED)
1523 strcpy(name_buffer, "(undefined)");
1530 if (key == translate_key[i].key)
1532 strcpy(name_buffer, translate_key[i].name);
1536 while (translate_key[++i].name);
1538 if (!translate_key[i].name)
1539 strcpy(name_buffer, "(unknown)");
1542 *name = name_buffer;
1544 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1546 static char name_buffer[30];
1549 if (key >= KSYM_A && key <= KSYM_Z)
1550 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1551 else if (key >= KSYM_a && key <= KSYM_z)
1552 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1553 else if (key >= KSYM_0 && key <= KSYM_9)
1554 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1555 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1556 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1557 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1558 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1559 else if (key == KSYM_UNDEFINED)
1560 strcpy(name_buffer, "[undefined]");
1567 if (key == translate_key[i].key)
1569 strcpy(name_buffer, translate_key[i].x11name);
1573 while (translate_key[++i].x11name);
1575 if (!translate_key[i].x11name)
1576 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1579 *x11name = name_buffer;
1581 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1583 Key key = KSYM_UNDEFINED;
1588 if (strEqual(translate_key[i].name, *name))
1590 key = translate_key[i].key;
1594 while (translate_key[++i].x11name);
1596 if (key == KSYM_UNDEFINED)
1597 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1601 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1603 Key key = KSYM_UNDEFINED;
1604 char *name_ptr = *x11name;
1606 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1608 char c = name_ptr[3];
1610 if (c >= 'A' && c <= 'Z')
1611 key = KSYM_A + (Key)(c - 'A');
1612 else if (c >= 'a' && c <= 'z')
1613 key = KSYM_a + (Key)(c - 'a');
1614 else if (c >= '0' && c <= '9')
1615 key = KSYM_0 + (Key)(c - '0');
1617 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1619 char c = name_ptr[6];
1621 if (c >= '0' && c <= '9')
1622 key = KSYM_KP_0 + (Key)(c - '0');
1624 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1626 char c1 = name_ptr[4];
1627 char c2 = name_ptr[5];
1630 if ((c1 >= '0' && c1 <= '9') &&
1631 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1632 d = atoi(&name_ptr[4]);
1634 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1635 key = KSYM_F1 + (Key)(d - 1);
1637 else if (strPrefix(name_ptr, "XK_"))
1643 if (strEqual(name_ptr, translate_key[i].x11name))
1645 key = translate_key[i].key;
1649 while (translate_key[++i].x11name);
1651 else if (strPrefix(name_ptr, "0x"))
1653 unsigned int value = 0;
1659 char c = *name_ptr++;
1662 if (c >= '0' && c <= '9')
1664 else if (c >= 'a' && c <= 'f')
1665 d = (int)(c - 'a' + 10);
1666 else if (c >= 'A' && c <= 'F')
1667 d = (int)(c - 'A' + 10);
1675 value = value * 16 + d;
1686 char *getKeyNameFromKey(Key key)
1690 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1694 char *getX11KeyNameFromKey(Key key)
1698 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1702 Key getKeyFromKeyName(char *name)
1706 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1710 Key getKeyFromX11KeyName(char *x11name)
1714 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1718 char getCharFromKey(Key key)
1720 char *keyname = getKeyNameFromKey(key);
1723 if (strlen(keyname) == 1)
1725 else if (strEqual(keyname, "space"))
1731 char getValidConfigValueChar(char c)
1733 if (c == '#' || /* used to mark comments */
1734 c == '\\') /* used to mark continued lines */
1741 /* ------------------------------------------------------------------------- */
1742 /* functions to translate string identifiers to integer or boolean value */
1743 /* ------------------------------------------------------------------------- */
1745 int get_integer_from_string(char *s)
1747 static char *number_text[][3] =
1749 { "0", "zero", "null", },
1750 { "1", "one", "first" },
1751 { "2", "two", "second" },
1752 { "3", "three", "third" },
1753 { "4", "four", "fourth" },
1754 { "5", "five", "fifth" },
1755 { "6", "six", "sixth" },
1756 { "7", "seven", "seventh" },
1757 { "8", "eight", "eighth" },
1758 { "9", "nine", "ninth" },
1759 { "10", "ten", "tenth" },
1760 { "11", "eleven", "eleventh" },
1761 { "12", "twelve", "twelfth" },
1763 { NULL, NULL, NULL },
1767 char *s_lower = getStringToLower(s);
1770 for (i = 0; number_text[i][0] != NULL; i++)
1771 for (j = 0; j < 3; j++)
1772 if (strEqual(s_lower, number_text[i][j]))
1777 if (strEqual(s_lower, "false") ||
1778 strEqual(s_lower, "no") ||
1779 strEqual(s_lower, "off"))
1781 else if (strEqual(s_lower, "true") ||
1782 strEqual(s_lower, "yes") ||
1783 strEqual(s_lower, "on"))
1794 boolean get_boolean_from_string(char *s)
1796 char *s_lower = getStringToLower(s);
1797 boolean result = FALSE;
1799 if (strEqual(s_lower, "true") ||
1800 strEqual(s_lower, "yes") ||
1801 strEqual(s_lower, "on") ||
1802 get_integer_from_string(s) == 1)
1810 int get_switch3_from_string(char *s)
1812 char *s_lower = getStringToLower(s);
1815 if (strEqual(s_lower, "true") ||
1816 strEqual(s_lower, "yes") ||
1817 strEqual(s_lower, "on") ||
1818 get_integer_from_string(s) == 1)
1820 else if (strEqual(s_lower, "auto"))
1829 /* ------------------------------------------------------------------------- */
1830 /* functions for generic lists */
1831 /* ------------------------------------------------------------------------- */
1833 ListNode *newListNode()
1835 return checked_calloc(sizeof(ListNode));
1838 void addNodeToList(ListNode **node_first, char *key, void *content)
1840 ListNode *node_new = newListNode();
1842 node_new->key = getStringCopy(key);
1843 node_new->content = content;
1844 node_new->next = *node_first;
1845 *node_first = node_new;
1848 void deleteNodeFromList(ListNode **node_first, char *key,
1849 void (*destructor_function)(void *))
1851 if (node_first == NULL || *node_first == NULL)
1854 if (strEqual((*node_first)->key, key))
1856 checked_free((*node_first)->key);
1857 if (destructor_function)
1858 destructor_function((*node_first)->content);
1859 *node_first = (*node_first)->next;
1862 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1865 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1867 if (node_first == NULL)
1870 if (strEqual(node_first->key, key))
1873 return getNodeFromKey(node_first->next, key);
1876 int getNumNodes(ListNode *node_first)
1878 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1881 void dumpList(ListNode *node_first)
1883 ListNode *node = node_first;
1887 printf("['%s' (%d)]\n", node->key,
1888 ((struct ListNodeInfo *)node->content)->num_references);
1892 printf("[%d nodes]\n", getNumNodes(node_first));
1896 /* ------------------------------------------------------------------------- */
1897 /* functions for reading directories */
1898 /* ------------------------------------------------------------------------- */
1900 struct Directory *openDirectory(char *dir_name)
1902 struct Directory *dir = checked_calloc(sizeof(struct Directory));
1904 dir->dir = opendir(dir_name);
1906 if (dir->dir != NULL)
1908 dir->filename = getStringCopy(dir_name);
1913 #if defined(PLATFORM_ANDROID)
1914 char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
1916 dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
1918 checked_free(asset_toc_filename);
1920 if (dir->asset_toc_file != NULL)
1922 dir->directory_is_asset = TRUE;
1923 dir->filename = getStringCopy(dir_name);
1934 int closeDirectory(struct Directory *dir)
1941 #if defined(PLATFORM_ANDROID)
1942 if (dir->asset_toc_file)
1943 result = SDL_RWclose(dir->asset_toc_file);
1947 result = closedir(dir->dir);
1950 freeDirectoryEntry(dir->dir_entry);
1952 checked_free(dir->filename);
1958 struct DirectoryEntry *readDirectory(struct Directory *dir)
1961 freeDirectoryEntry(dir->dir_entry);
1963 dir->dir_entry = NULL;
1965 #if defined(PLATFORM_ANDROID)
1966 if (dir->directory_is_asset)
1968 char line[MAX_LINE_LEN];
1969 char *line_ptr = line;
1970 char *last_line_ptr = line_ptr;
1971 int num_bytes_read = 0;
1973 while (num_bytes_read < MAX_LINE_LEN &&
1974 SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
1977 last_line_ptr = line_ptr;
1984 if (strlen(line) == 0)
1987 dir->dir_entry = checked_calloc(sizeof(struct DirectoryEntry));
1989 dir->dir_entry->is_directory = FALSE;
1990 if (line[strlen(line) - 1] = '/')
1992 dir->dir_entry->is_directory = TRUE;
1994 line[strlen(line) - 1] = '\0';
1997 dir->dir_entry->basename = getStringCopy(line);
1998 dir->dir_entry->filename = getPath2(dir->filename, line);
2000 return dir->dir_entry;
2004 struct dirent *dir_entry = readdir(dir->dir);
2006 if (dir_entry == NULL)
2009 dir->dir_entry = checked_calloc(sizeof(struct DirectoryEntry));
2011 dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2012 dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2014 struct stat file_status;
2016 dir->dir_entry->is_directory =
2017 (stat(dir->dir_entry->filename, &file_status) == 0 &&
2018 (file_status.st_mode & S_IFMT) != S_IFDIR);
2020 return dir->dir_entry;
2023 void freeDirectoryEntry(struct DirectoryEntry *dir_entry)
2025 if (dir_entry == NULL)
2028 checked_free(dir_entry->basename);
2029 checked_free(dir_entry->filename);
2030 checked_free(dir_entry);
2034 /* ------------------------------------------------------------------------- */
2035 /* functions for checking files and filenames */
2036 /* ------------------------------------------------------------------------- */
2038 boolean fileExists(char *filename)
2040 if (filename == NULL)
2043 #if defined(PLATFORM_ANDROID)
2044 // workaround: check if file exists by opening and closing it
2045 SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2046 boolean success = (file != NULL);
2053 return (access(filename, F_OK) == 0);
2057 boolean fileHasPrefix(char *basename, char *prefix)
2059 static char *basename_lower = NULL;
2060 int basename_length, prefix_length;
2062 checked_free(basename_lower);
2064 if (basename == NULL || prefix == NULL)
2067 basename_lower = getStringToLower(basename);
2068 basename_length = strlen(basename_lower);
2069 prefix_length = strlen(prefix);
2071 if (basename_length > prefix_length + 1 &&
2072 basename_lower[prefix_length] == '.' &&
2073 strncmp(basename_lower, prefix, prefix_length) == 0)
2079 boolean fileHasSuffix(char *basename, char *suffix)
2081 static char *basename_lower = NULL;
2082 int basename_length, suffix_length;
2084 checked_free(basename_lower);
2086 if (basename == NULL || suffix == NULL)
2089 basename_lower = getStringToLower(basename);
2090 basename_length = strlen(basename_lower);
2091 suffix_length = strlen(suffix);
2093 if (basename_length > suffix_length + 1 &&
2094 basename_lower[basename_length - suffix_length - 1] == '.' &&
2095 strEqual(&basename_lower[basename_length - suffix_length], suffix))
2101 boolean FileIsGraphic(char *filename)
2103 char *basename = getBaseNamePtr(filename);
2105 return fileHasSuffix(basename, "pcx");
2108 boolean FileIsSound(char *filename)
2110 char *basename = getBaseNamePtr(filename);
2112 return fileHasSuffix(basename, "wav");
2115 boolean FileIsMusic(char *filename)
2117 char *basename = getBaseNamePtr(filename);
2119 if (FileIsSound(basename))
2122 #if defined(TARGET_SDL)
2123 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2124 fileHasSuffix(basename, "mod") ||
2125 fileHasSuffix(basename, "s3m") ||
2126 fileHasSuffix(basename, "it") ||
2127 fileHasSuffix(basename, "xm") ||
2128 fileHasSuffix(basename, "midi") ||
2129 fileHasSuffix(basename, "mid") ||
2130 fileHasSuffix(basename, "mp3") ||
2131 fileHasSuffix(basename, "ogg"))
2138 boolean FileIsArtworkType(char *basename, int type)
2140 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2141 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2142 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2148 /* ------------------------------------------------------------------------- */
2149 /* functions for loading artwork configuration information */
2150 /* ------------------------------------------------------------------------- */
2152 char *get_mapped_token(char *token)
2154 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2155 static char *map_token_prefix[][2] =
2157 { "char_procent", "char_percent" },
2162 for (i = 0; map_token_prefix[i][0] != NULL; i++)
2164 int len_token_prefix = strlen(map_token_prefix[i][0]);
2166 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2167 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2173 /* This function checks if a string <s> of the format "string1, string2, ..."
2174 exactly contains a string <s_contained>. */
2176 static boolean string_has_parameter(char *s, char *s_contained)
2180 if (s == NULL || s_contained == NULL)
2183 if (strlen(s_contained) > strlen(s))
2186 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2188 char next_char = s[strlen(s_contained)];
2190 /* check if next character is delimiter or whitespace */
2191 return (next_char == ',' || next_char == '\0' ||
2192 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2195 /* check if string contains another parameter string after a comma */
2196 substring = strchr(s, ',');
2197 if (substring == NULL) /* string does not contain a comma */
2200 /* advance string pointer to next character after the comma */
2203 /* skip potential whitespaces after the comma */
2204 while (*substring == ' ' || *substring == '\t')
2207 return string_has_parameter(substring, s_contained);
2210 int get_parameter_value(char *value_raw, char *suffix, int type)
2212 char *value = getStringToLower(value_raw);
2213 int result = 0; /* probably a save default value */
2215 if (strEqual(suffix, ".direction"))
2217 result = (strEqual(value, "left") ? MV_LEFT :
2218 strEqual(value, "right") ? MV_RIGHT :
2219 strEqual(value, "up") ? MV_UP :
2220 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2222 else if (strEqual(suffix, ".align"))
2224 result = (strEqual(value, "left") ? ALIGN_LEFT :
2225 strEqual(value, "right") ? ALIGN_RIGHT :
2226 strEqual(value, "center") ? ALIGN_CENTER :
2227 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2229 else if (strEqual(suffix, ".valign"))
2231 result = (strEqual(value, "top") ? VALIGN_TOP :
2232 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2233 strEqual(value, "middle") ? VALIGN_MIDDLE :
2234 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2236 else if (strEqual(suffix, ".anim_mode"))
2238 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2239 string_has_parameter(value, "loop") ? ANIM_LOOP :
2240 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2241 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2242 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2243 string_has_parameter(value, "random") ? ANIM_RANDOM :
2244 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2245 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2246 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2247 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2248 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2249 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2252 if (string_has_parameter(value, "reverse"))
2253 result |= ANIM_REVERSE;
2255 if (string_has_parameter(value, "opaque_player"))
2256 result |= ANIM_OPAQUE_PLAYER;
2258 if (string_has_parameter(value, "static_panel"))
2259 result |= ANIM_STATIC_PANEL;
2261 else if (strEqual(suffix, ".class"))
2263 result = get_hash_from_key(value);
2265 else if (strEqual(suffix, ".style"))
2267 result = STYLE_DEFAULT;
2269 if (string_has_parameter(value, "accurate_borders"))
2270 result |= STYLE_ACCURATE_BORDERS;
2272 if (string_has_parameter(value, "inner_corners"))
2273 result |= STYLE_INNER_CORNERS;
2275 else if (strEqual(suffix, ".fade_mode"))
2277 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2278 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2279 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2280 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2284 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2286 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2289 result = gfx.get_font_from_token_function(value);
2291 else /* generic parameter of type integer or boolean */
2293 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2294 type == TYPE_INTEGER ? get_integer_from_string(value) :
2295 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2296 ARG_UNDEFINED_VALUE);
2304 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2306 static struct ScreenModeInfo screen_mode;
2307 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2308 char *screen_mode_string_copy;
2309 char *screen_mode_string_pos_w;
2310 char *screen_mode_string_pos_h;
2312 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2315 screen_mode_string_copy = getStringCopy(screen_mode_string);
2317 screen_mode_string_pos_w = screen_mode_string_copy;
2318 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2319 *screen_mode_string_pos_h++ = '\0';
2321 screen_mode.width = atoi(screen_mode_string_pos_w);
2322 screen_mode.height = atoi(screen_mode_string_pos_h);
2324 return &screen_mode;
2327 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2330 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2331 float aspect_ratio_new;
2336 *x = i * aspect_ratio + 0.000001;
2339 aspect_ratio_new = (float)*x / (float)*y;
2343 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2346 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2347 struct ListNodeInfo ***, int *);
2349 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2350 struct ConfigTypeInfo *suffix_list,
2351 char **ignore_tokens,
2352 int num_file_list_entries)
2354 struct FileInfo *file_list;
2355 int num_file_list_entries_found = 0;
2356 int num_suffix_list_entries = 0;
2360 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2362 for (i = 0; suffix_list[i].token != NULL; i++)
2363 num_suffix_list_entries++;
2365 /* always start with reliable default values */
2366 for (i = 0; i < num_file_list_entries; i++)
2368 file_list[i].token = NULL;
2370 file_list[i].default_filename = NULL;
2371 file_list[i].filename = NULL;
2373 if (num_suffix_list_entries > 0)
2375 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2377 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2378 file_list[i].parameter = checked_calloc(parameter_array_size);
2380 for (j = 0; j < num_suffix_list_entries; j++)
2382 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2383 setString(&file_list[i].parameter[j], suffix_list[j].value);
2386 file_list[i].redefined = FALSE;
2387 file_list[i].fallback_to_default = FALSE;
2388 file_list[i].default_is_cloned = FALSE;
2393 for (i = 0; config_list[i].token != NULL; i++)
2395 int len_config_token = strlen(config_list[i].token);
2396 int len_config_value = strlen(config_list[i].value);
2397 boolean is_file_entry = TRUE;
2399 for (j = 0; suffix_list[j].token != NULL; j++)
2401 int len_suffix = strlen(suffix_list[j].token);
2403 if (len_suffix < len_config_token &&
2404 strEqual(&config_list[i].token[len_config_token - len_suffix],
2405 suffix_list[j].token))
2407 setString(&file_list[list_pos].default_parameter[j],
2408 config_list[i].value);
2410 is_file_entry = FALSE;
2415 /* the following tokens are no file definitions, but other config tokens */
2416 for (j = 0; ignore_tokens[j] != NULL; j++)
2417 if (strEqual(config_list[i].token, ignore_tokens[j]))
2418 is_file_entry = FALSE;
2425 if (list_pos >= num_file_list_entries)
2428 /* simple sanity check if this is really a file definition */
2429 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2430 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2431 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2433 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2434 config_list[i].token, config_list[i].value);
2435 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2438 file_list[list_pos].token = config_list[i].token;
2439 file_list[list_pos].default_filename = config_list[i].value;
2442 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2446 if (strSuffix(config_list[i].token, ".clone_from"))
2447 file_list[list_pos].default_is_cloned = TRUE;
2450 num_file_list_entries_found = list_pos + 1;
2451 if (num_file_list_entries_found != num_file_list_entries)
2453 Error(ERR_INFO_LINE, "-");
2454 Error(ERR_INFO, "inconsistant config list information:");
2455 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2456 num_file_list_entries);
2457 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2458 num_file_list_entries_found);
2459 Error(ERR_EXIT, "please fix");
2463 printf("::: ---------- DONE ----------\n");
2469 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2471 int len_token = strlen(token);
2472 int len_suffix = strlen(suffix);
2474 if (start_pos < 0) /* compare suffix from end of string */
2475 start_pos += len_token;
2477 if (start_pos < 0 || start_pos + len_suffix > len_token)
2480 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2483 if (token[start_pos + len_suffix] == '\0')
2486 if (token[start_pos + len_suffix] == '.')
2492 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2494 static void read_token_parameters(SetupFileHash *setup_file_hash,
2495 struct ConfigTypeInfo *suffix_list,
2496 struct FileInfo *file_list_entry)
2498 /* check for config token that is the base token without any suffixes */
2499 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2500 char *known_token_value = KNOWN_TOKEN_VALUE;
2503 if (filename != NULL)
2505 setString(&file_list_entry->filename, filename);
2507 /* when file definition found, set all parameters to default values */
2508 for (i = 0; suffix_list[i].token != NULL; i++)
2509 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2511 file_list_entry->redefined = TRUE;
2513 /* mark config file token as well known from default config */
2514 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2517 /* check for config tokens that can be build by base token and suffixes */
2518 for (i = 0; suffix_list[i].token != NULL; i++)
2520 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2521 char *value = getHashEntry(setup_file_hash, token);
2525 setString(&file_list_entry->parameter[i], value);
2527 /* mark config file token as well known from default config */
2528 setHashEntry(setup_file_hash, token, known_token_value);
2535 static void add_dynamic_file_list_entry(struct FileInfo **list,
2536 int *num_list_entries,
2537 SetupFileHash *extra_file_hash,
2538 struct ConfigTypeInfo *suffix_list,
2539 int num_suffix_list_entries,
2542 struct FileInfo *new_list_entry;
2543 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2545 (*num_list_entries)++;
2546 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2547 new_list_entry = &(*list)[*num_list_entries - 1];
2549 new_list_entry->token = getStringCopy(token);
2550 new_list_entry->default_filename = NULL;
2551 new_list_entry->filename = NULL;
2552 new_list_entry->parameter = checked_calloc(parameter_array_size);
2554 new_list_entry->redefined = FALSE;
2555 new_list_entry->fallback_to_default = FALSE;
2556 new_list_entry->default_is_cloned = FALSE;
2558 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2561 static void add_property_mapping(struct PropertyMapping **list,
2562 int *num_list_entries,
2563 int base_index, int ext1_index,
2564 int ext2_index, int ext3_index,
2567 struct PropertyMapping *new_list_entry;
2569 (*num_list_entries)++;
2570 *list = checked_realloc(*list,
2571 *num_list_entries * sizeof(struct PropertyMapping));
2572 new_list_entry = &(*list)[*num_list_entries - 1];
2574 new_list_entry->base_index = base_index;
2575 new_list_entry->ext1_index = ext1_index;
2576 new_list_entry->ext2_index = ext2_index;
2577 new_list_entry->ext3_index = ext3_index;
2579 new_list_entry->artwork_index = artwork_index;
2582 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2585 struct FileInfo *file_list = artwork_info->file_list;
2586 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2587 char **base_prefixes = artwork_info->base_prefixes;
2588 char **ext1_suffixes = artwork_info->ext1_suffixes;
2589 char **ext2_suffixes = artwork_info->ext2_suffixes;
2590 char **ext3_suffixes = artwork_info->ext3_suffixes;
2591 char **ignore_tokens = artwork_info->ignore_tokens;
2592 int num_file_list_entries = artwork_info->num_file_list_entries;
2593 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2594 int num_base_prefixes = artwork_info->num_base_prefixes;
2595 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2596 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2597 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2598 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2599 SetupFileHash *setup_file_hash, *valid_file_hash;
2600 SetupFileHash *extra_file_hash, *empty_file_hash;
2601 char *known_token_value = KNOWN_TOKEN_VALUE;
2604 if (filename == NULL)
2608 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2611 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2614 /* separate valid (defined) from empty (undefined) config token values */
2615 valid_file_hash = newSetupFileHash();
2616 empty_file_hash = newSetupFileHash();
2617 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2619 char *value = HASH_ITERATION_VALUE(itr);
2621 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2622 HASH_ITERATION_TOKEN(itr), value);
2624 END_HASH_ITERATION(setup_file_hash, itr)
2626 /* at this point, we do not need the setup file hash anymore -- free it */
2627 freeSetupFileHash(setup_file_hash);
2629 /* map deprecated to current tokens (using prefix match and replace) */
2630 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2632 char *token = HASH_ITERATION_TOKEN(itr);
2633 char *mapped_token = get_mapped_token(token);
2635 if (mapped_token != NULL)
2637 char *value = HASH_ITERATION_VALUE(itr);
2639 /* add mapped token */
2640 setHashEntry(valid_file_hash, mapped_token, value);
2642 /* ignore old token (by setting it to "known" keyword) */
2643 setHashEntry(valid_file_hash, token, known_token_value);
2648 END_HASH_ITERATION(valid_file_hash, itr)
2650 /* read parameters for all known config file tokens */
2651 for (i = 0; i < num_file_list_entries; i++)
2652 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2654 /* set all tokens that can be ignored here to "known" keyword */
2655 for (i = 0; i < num_ignore_tokens; i++)
2656 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2658 /* copy all unknown config file tokens to extra config hash */
2659 extra_file_hash = newSetupFileHash();
2660 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2662 char *value = HASH_ITERATION_VALUE(itr);
2664 if (!strEqual(value, known_token_value))
2665 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2667 END_HASH_ITERATION(valid_file_hash, itr)
2669 /* at this point, we do not need the valid file hash anymore -- free it */
2670 freeSetupFileHash(valid_file_hash);
2672 /* now try to determine valid, dynamically defined config tokens */
2674 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2676 struct FileInfo **dynamic_file_list =
2677 &artwork_info->dynamic_file_list;
2678 int *num_dynamic_file_list_entries =
2679 &artwork_info->num_dynamic_file_list_entries;
2680 struct PropertyMapping **property_mapping =
2681 &artwork_info->property_mapping;
2682 int *num_property_mapping_entries =
2683 &artwork_info->num_property_mapping_entries;
2684 int current_summarized_file_list_entry =
2685 artwork_info->num_file_list_entries +
2686 artwork_info->num_dynamic_file_list_entries;
2687 char *token = HASH_ITERATION_TOKEN(itr);
2688 int len_token = strlen(token);
2690 boolean base_prefix_found = FALSE;
2691 boolean parameter_suffix_found = FALSE;
2694 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2697 /* skip all parameter definitions (handled by read_token_parameters()) */
2698 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2700 int len_suffix = strlen(suffix_list[i].token);
2702 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2703 parameter_suffix_found = TRUE;
2706 if (parameter_suffix_found)
2709 /* ---------- step 0: search for matching base prefix ---------- */
2712 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2714 char *base_prefix = base_prefixes[i];
2715 int len_base_prefix = strlen(base_prefix);
2716 boolean ext1_suffix_found = FALSE;
2717 boolean ext2_suffix_found = FALSE;
2718 boolean ext3_suffix_found = FALSE;
2719 boolean exact_match = FALSE;
2720 int base_index = -1;
2721 int ext1_index = -1;
2722 int ext2_index = -1;
2723 int ext3_index = -1;
2725 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2727 if (!base_prefix_found)
2733 if (IS_PARENT_PROCESS())
2734 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2737 if (start_pos + len_base_prefix == len_token) /* exact match */
2742 if (IS_PARENT_PROCESS())
2743 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2746 add_dynamic_file_list_entry(dynamic_file_list,
2747 num_dynamic_file_list_entries,
2750 num_suffix_list_entries,
2752 add_property_mapping(property_mapping,
2753 num_property_mapping_entries,
2754 base_index, -1, -1, -1,
2755 current_summarized_file_list_entry);
2760 if (IS_PARENT_PROCESS())
2761 printf("---> examining token '%s': search 1st suffix ...\n", token);
2764 /* ---------- step 1: search for matching first suffix ---------- */
2766 start_pos += len_base_prefix;
2767 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2769 char *ext1_suffix = ext1_suffixes[j];
2770 int len_ext1_suffix = strlen(ext1_suffix);
2772 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2774 if (!ext1_suffix_found)
2780 if (IS_PARENT_PROCESS())
2781 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2784 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2789 if (IS_PARENT_PROCESS())
2790 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2793 add_dynamic_file_list_entry(dynamic_file_list,
2794 num_dynamic_file_list_entries,
2797 num_suffix_list_entries,
2799 add_property_mapping(property_mapping,
2800 num_property_mapping_entries,
2801 base_index, ext1_index, -1, -1,
2802 current_summarized_file_list_entry);
2806 start_pos += len_ext1_suffix;
2813 if (IS_PARENT_PROCESS())
2814 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2817 /* ---------- step 2: search for matching second suffix ---------- */
2819 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2821 char *ext2_suffix = ext2_suffixes[k];
2822 int len_ext2_suffix = strlen(ext2_suffix);
2824 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2826 if (!ext2_suffix_found)
2832 if (IS_PARENT_PROCESS())
2833 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2836 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2841 if (IS_PARENT_PROCESS())
2842 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2845 add_dynamic_file_list_entry(dynamic_file_list,
2846 num_dynamic_file_list_entries,
2849 num_suffix_list_entries,
2851 add_property_mapping(property_mapping,
2852 num_property_mapping_entries,
2853 base_index, ext1_index, ext2_index, -1,
2854 current_summarized_file_list_entry);
2858 start_pos += len_ext2_suffix;
2865 if (IS_PARENT_PROCESS())
2866 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2869 /* ---------- step 3: search for matching third suffix ---------- */
2871 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2873 char *ext3_suffix = ext3_suffixes[l];
2874 int len_ext3_suffix = strlen(ext3_suffix);
2876 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2878 if (!ext3_suffix_found)
2884 if (IS_PARENT_PROCESS())
2885 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2888 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2893 if (IS_PARENT_PROCESS())
2894 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2897 add_dynamic_file_list_entry(dynamic_file_list,
2898 num_dynamic_file_list_entries,
2901 num_suffix_list_entries,
2903 add_property_mapping(property_mapping,
2904 num_property_mapping_entries,
2905 base_index, ext1_index, ext2_index, ext3_index,
2906 current_summarized_file_list_entry);
2912 END_HASH_ITERATION(extra_file_hash, itr)
2914 if (artwork_info->num_dynamic_file_list_entries > 0)
2916 artwork_info->dynamic_artwork_list =
2917 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2918 artwork_info->sizeof_artwork_list_entry);
2921 if (options.verbose && IS_PARENT_PROCESS())
2923 SetupFileList *setup_file_list, *list;
2924 boolean dynamic_tokens_found = FALSE;
2925 boolean unknown_tokens_found = FALSE;
2926 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2928 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2929 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2931 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2933 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2934 dynamic_tokens_found = TRUE;
2936 unknown_tokens_found = TRUE;
2938 END_HASH_ITERATION(extra_file_hash, itr)
2940 if (options.debug && dynamic_tokens_found)
2942 Error(ERR_INFO_LINE, "-");
2943 Error(ERR_INFO, "dynamic token(s) found in config file:");
2944 Error(ERR_INFO, "- config file: '%s'", filename);
2946 for (list = setup_file_list; list != NULL; list = list->next)
2948 char *value = getHashEntry(extra_file_hash, list->token);
2950 if (value != NULL && strEqual(value, known_token_value))
2951 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2954 Error(ERR_INFO_LINE, "-");
2957 if (unknown_tokens_found)
2959 Error(ERR_INFO_LINE, "-");
2960 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2961 Error(ERR_INFO, "- config file: '%s'", filename);
2963 for (list = setup_file_list; list != NULL; list = list->next)
2965 char *value = getHashEntry(extra_file_hash, list->token);
2967 if (value != NULL && !strEqual(value, known_token_value))
2968 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2971 Error(ERR_INFO_LINE, "-");
2974 if (undefined_values_found)
2976 Error(ERR_INFO_LINE, "-");
2977 Error(ERR_INFO, "warning: undefined values found in config file:");
2978 Error(ERR_INFO, "- config file: '%s'", filename);
2980 for (list = setup_file_list; list != NULL; list = list->next)
2982 char *value = getHashEntry(empty_file_hash, list->token);
2985 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2988 Error(ERR_INFO_LINE, "-");
2991 freeSetupFileList(setup_file_list);
2994 freeSetupFileHash(extra_file_hash);
2995 freeSetupFileHash(empty_file_hash);
2998 for (i = 0; i < num_file_list_entries; i++)
3000 printf("'%s' ", file_list[i].token);
3001 if (file_list[i].filename)
3002 printf("-> '%s'\n", file_list[i].filename);
3004 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3009 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3011 struct FileInfo *file_list = artwork_info->file_list;
3012 int num_file_list_entries = artwork_info->num_file_list_entries;
3013 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3014 char *filename_base = UNDEFINED_FILENAME, *filename_local;
3017 DrawInitText("Loading artwork config", 120, FC_GREEN);
3018 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3020 /* always start with reliable default values */
3021 for (i = 0; i < num_file_list_entries; i++)
3023 setString(&file_list[i].filename, file_list[i].default_filename);
3025 for (j = 0; j < num_suffix_list_entries; j++)
3026 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3028 file_list[i].redefined = FALSE;
3029 file_list[i].fallback_to_default = FALSE;
3032 /* free previous dynamic artwork file array */
3033 if (artwork_info->dynamic_file_list != NULL)
3035 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3037 free(artwork_info->dynamic_file_list[i].token);
3038 free(artwork_info->dynamic_file_list[i].filename);
3039 free(artwork_info->dynamic_file_list[i].parameter);
3042 free(artwork_info->dynamic_file_list);
3043 artwork_info->dynamic_file_list = NULL;
3045 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3046 &artwork_info->num_dynamic_file_list_entries);
3049 /* free previous property mapping */
3050 if (artwork_info->property_mapping != NULL)
3052 free(artwork_info->property_mapping);
3054 artwork_info->property_mapping = NULL;
3055 artwork_info->num_property_mapping_entries = 0;
3059 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3061 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3064 /* first look for special artwork configured in level series config */
3065 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3068 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3069 leveldir_current->graphics_set,
3070 leveldir_current->graphics_path);
3073 if (fileExists(filename_base))
3074 LoadArtworkConfigFromFilename(artwork_info, filename_base);
3077 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3079 if (filename_local != NULL && !strEqual(filename_base, filename_local))
3080 LoadArtworkConfigFromFilename(artwork_info, filename_local);
3083 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3084 struct ListNodeInfo **listnode)
3088 char *filename = (*listnode)->source_filename;
3090 if (--(*listnode)->num_references <= 0)
3091 deleteNodeFromList(&artwork_info->content_list, filename,
3092 artwork_info->free_artwork);
3098 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3099 struct ListNodeInfo **listnode,
3100 struct FileInfo *file_list_entry)
3110 char *basename = file_list_entry->filename;
3111 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3113 if (filename == NULL)
3115 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3117 basename = file_list_entry->default_filename;
3119 /* fail for cloned default artwork that has no default filename defined */
3120 if (file_list_entry->default_is_cloned &&
3121 strEqual(basename, UNDEFINED_FILENAME))
3123 int error_mode = ERR_WARN;
3125 /* we can get away without sounds and music, but not without graphics */
3126 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3127 error_mode = ERR_EXIT;
3129 Error(error_mode, "token '%s' was cloned and has no default filename",
3130 file_list_entry->token);
3135 /* dynamic artwork has no default filename / skip empty default artwork */
3136 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3139 file_list_entry->fallback_to_default = TRUE;
3141 Error(ERR_WARN, "trying default artwork file '%s'", basename);
3143 filename = getCustomArtworkFilename(basename, artwork_info->type);
3145 if (filename == NULL)
3147 int error_mode = ERR_WARN;
3149 /* we can get away without sounds and music, but not without graphics */
3150 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3151 error_mode = ERR_EXIT;
3153 Error(error_mode, "cannot find default artwork file '%s'", basename);
3159 /* check if the old and the new artwork file are the same */
3160 if (*listnode && strEqual((*listnode)->source_filename, filename))
3162 /* The old and new artwork are the same (have the same filename and path).
3163 This usually means that this artwork does not exist in this artwork set
3164 and a fallback to the existing artwork is done. */
3167 printf("[artwork '%s' already exists (same list entry)]\n", filename);
3173 /* delete existing artwork file entry */
3174 deleteArtworkListEntry(artwork_info, listnode);
3176 /* check if the new artwork file already exists in the list of artworks */
3177 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3180 printf("[artwork '%s' already exists (other list entry)]\n", filename);
3183 *listnode = (struct ListNodeInfo *)node->content;
3184 (*listnode)->num_references++;
3189 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3190 DrawInitText(basename, 150, FC_YELLOW);
3192 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3195 printf("[adding new artwork '%s']\n", filename);
3198 (*listnode)->num_references = 1;
3199 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3204 int error_mode = ERR_WARN;
3206 /* we can get away without sounds and music, but not without graphics */
3207 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3208 error_mode = ERR_EXIT;
3210 Error(error_mode, "cannot load artwork file '%s'", basename);
3216 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3217 struct ListNodeInfo **listnode,
3218 struct FileInfo *file_list_entry)
3221 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3224 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3226 deleteArtworkListEntry(artwork_info, listnode);
3230 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3233 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3235 struct FileInfo *file_list = artwork_info->file_list;
3236 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3237 int num_file_list_entries = artwork_info->num_file_list_entries;
3238 int num_dynamic_file_list_entries =
3239 artwork_info->num_dynamic_file_list_entries;
3242 for (i = 0; i < num_file_list_entries; i++)
3243 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3246 for (i = 0; i < num_dynamic_file_list_entries; i++)
3247 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3248 &dynamic_file_list[i]);
3251 dumpList(artwork_info->content_list);
3255 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3256 struct ListNodeInfo ***list,
3257 int *num_list_entries)
3264 for (i = 0; i < *num_list_entries; i++)
3265 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3269 *num_list_entries = 0;
3272 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3274 if (artwork_info == NULL)
3277 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3278 &artwork_info->num_file_list_entries);
3280 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3281 &artwork_info->num_dynamic_file_list_entries);
3285 /* ------------------------------------------------------------------------- */
3286 /* functions only needed for non-Unix (non-command-line) systems */
3287 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3288 /* (now also added for Windows, to create files in user data directory) */
3289 /* ------------------------------------------------------------------------- */
3291 char *getErrorFilename(char *basename)
3293 return getPath2(getUserGameDataDir(), basename);
3296 void openErrorFile()
3298 InitUserDataDirectory();
3300 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3302 program.error_file = stderr;
3304 Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3305 program.error_filename, strerror(errno));
3309 void closeErrorFile()
3311 if (program.error_file != stderr) /* do not close stream 'stderr' */
3312 fclose(program.error_file);
3315 void dumpErrorFile()
3317 FILE *error_file = fopen(program.error_filename, MODE_READ);
3319 if (error_file != NULL)
3321 while (!feof(error_file))
3322 fputc(fgetc(error_file), stderr);
3328 void NotifyUserAboutErrorFile()
3330 #if defined(PLATFORM_WIN32)
3331 char *title_text = getStringCat2(program.program_title, " Error Message");
3332 char *error_text = getStringCat2("The program was aborted due to an error; "
3333 "for details, see the following error file:"
3334 STRING_NEWLINE, program.error_filename);
3336 MessageBox(NULL, error_text, title_text, MB_OK);
3341 /* ------------------------------------------------------------------------- */
3342 /* the following is only for debugging purpose and normally not used */
3343 /* ------------------------------------------------------------------------- */
3347 #define DEBUG_NUM_TIMESTAMPS 5
3348 #define DEBUG_TIME_IN_MICROSECONDS 0
3350 #if DEBUG_TIME_IN_MICROSECONDS
3351 static double Counter_Microseconds()
3353 static struct timeval base_time = { 0, 0 };
3354 struct timeval current_time;
3357 gettimeofday(¤t_time, NULL);
3359 /* reset base time in case of wrap-around */
3360 if (current_time.tv_sec < base_time.tv_sec)
3361 base_time = current_time;
3364 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3365 ((double)(current_time.tv_usec - base_time.tv_usec));
3367 return counter; /* return microseconds since last init */
3371 char *debug_print_timestamp_get_padding(int padding_size)
3373 static char *padding = NULL;
3374 int max_padding_size = 100;
3376 if (padding == NULL)
3378 padding = checked_calloc(max_padding_size + 1);
3379 memset(padding, ' ', max_padding_size);
3382 return &padding[MAX(0, max_padding_size - padding_size)];
3385 void debug_print_timestamp(int counter_nr, char *message)
3387 int indent_size = 8;
3388 int padding_size = 40;
3389 float timestamp_interval;
3392 Error(ERR_EXIT, "debugging: invalid negative counter");
3393 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3394 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3396 #if DEBUG_TIME_IN_MICROSECONDS
3397 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3400 counter[counter_nr][0] = Counter_Microseconds();
3402 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3405 counter[counter_nr][0] = Counter();
3408 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3409 counter[counter_nr][1] = counter[counter_nr][0];
3412 printf("%s%s%s %.3f %s\n",
3413 debug_print_timestamp_get_padding(counter_nr * indent_size),
3415 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3416 timestamp_interval / 1000,
3420 void debug_print_parent_only(char *format, ...)
3422 if (!IS_PARENT_PROCESS())
3429 va_start(ap, format);
3430 vprintf(format, ap);