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>
25 #if !defined(PLATFORM_WIN32)
27 #include <sys/param.h>
37 /* ========================================================================= */
38 /* some generic helper functions */
39 /* ========================================================================= */
41 /* ------------------------------------------------------------------------- */
42 /* platform independent wrappers for printf() et al. (newline aware) */
43 /* ------------------------------------------------------------------------- */
45 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
47 char *newline = STRING_NEWLINE;
49 vfprintf(stream, format, ap);
51 fprintf(stream, "%s", newline);
54 static void fprintf_newline(FILE *stream, char *format, ...)
61 vfprintf_newline(stream, format, ap);
66 void fprintf_line(FILE *stream, char *line_chars, int line_length)
70 for (i = 0; i < line_length; i++)
71 fprintf(stream, "%s", line_chars);
73 fprintf_newline(stream, "");
76 void printf_line(char *line_chars, int line_length)
78 fprintf_line(stdout, line_chars, line_length);
81 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
83 fprintf(stdout, "%s", prefix);
84 fprintf_line(stdout, line_chars, line_length);
88 /* ------------------------------------------------------------------------- */
89 /* string functions */
90 /* ------------------------------------------------------------------------- */
92 /* int2str() returns a number converted to a string;
93 the used memory is static, but will be overwritten by later calls,
94 so if you want to save the result, copy it to a private string buffer;
95 there can be 10 local calls of int2str() without buffering the result --
96 the 11th call will then destroy the result from the first call and so on.
99 char *int2str(int number, int size)
101 static char shift_array[10][40];
102 static int shift_counter = 0;
103 char *s = shift_array[shift_counter];
105 shift_counter = (shift_counter + 1) % 10;
112 sprintf(s, " %09d", number);
113 return &s[strlen(s) - size];
117 sprintf(s, "%d", number);
123 /* something similar to "int2str()" above, but allocates its own memory
124 and has a different interface; we cannot use "itoa()", because this
125 seems to be already defined when cross-compiling to the win32 target */
127 char *i_to_a(unsigned int i)
129 static char *a = NULL;
133 if (i > 2147483647) /* yes, this is a kludge */
136 a = checked_malloc(10 + 1);
144 /* calculate base-2 logarithm of argument (rounded down to integer;
145 this function returns the number of the highest bit set in argument) */
147 int log_2(unsigned int x)
153 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
160 boolean getTokenValueFromString(char *string, char **token, char **value)
162 return getTokenValueFromSetupLine(string, token, value);
166 /* ------------------------------------------------------------------------- */
167 /* counter functions */
168 /* ------------------------------------------------------------------------- */
170 #if defined(PLATFORM_MSDOS)
171 volatile unsigned int counter = 0;
173 void increment_counter()
178 END_OF_FUNCTION(increment_counter);
182 /* maximal allowed length of a command line option */
183 #define MAX_OPTION_LEN 256
188 static unsigned int getCurrentMS()
190 return SDL_GetTicks();
193 #else /* !TARGET_SDL */
195 #if defined(PLATFORM_UNIX)
196 static unsigned int getCurrentMS()
198 struct timeval current_time;
200 gettimeofday(¤t_time, NULL);
202 return current_time.tv_sec * 1000 + current_time.tv_usec / 1000;
204 #endif /* PLATFORM_UNIX */
205 #endif /* !TARGET_SDL */
207 static unsigned int mainCounter(int mode)
209 static unsigned int base_ms = 0;
210 unsigned int current_ms;
212 /* get current system milliseconds */
213 current_ms = getCurrentMS();
215 /* reset base timestamp in case of counter reset or wrap-around */
216 if (mode == INIT_COUNTER || current_ms < base_ms)
217 base_ms = current_ms;
219 /* return milliseconds since last counter reset */
220 return current_ms - base_ms;
226 static unsigned int mainCounter(int mode)
228 static unsigned int base_ms = 0;
229 unsigned int current_ms;
230 unsigned int counter_ms;
232 current_ms = SDL_GetTicks();
234 /* reset base time in case of counter initializing or wrap-around */
235 if (mode == INIT_COUNTER || current_ms < base_ms)
236 base_ms = current_ms;
238 counter_ms = current_ms - base_ms;
240 return counter_ms; /* return milliseconds since last init */
243 #else /* !TARGET_SDL */
245 #if defined(PLATFORM_UNIX)
246 static unsigned int mainCounter(int mode)
248 static struct timeval base_time = { 0, 0 };
249 struct timeval current_time;
250 unsigned int counter_ms;
252 gettimeofday(¤t_time, NULL);
254 /* reset base time in case of counter initializing or wrap-around */
255 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
256 base_time = current_time;
258 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
259 + (current_time.tv_usec - base_time.tv_usec) / 1000;
261 return counter_ms; /* return milliseconds since last init */
263 #endif /* PLATFORM_UNIX */
264 #endif /* !TARGET_SDL */
268 void InitCounter() /* set counter back to zero */
270 #if !defined(PLATFORM_MSDOS)
271 mainCounter(INIT_COUNTER);
273 LOCK_VARIABLE(counter);
274 LOCK_FUNCTION(increment_counter);
275 install_int_ex(increment_counter, BPS_TO_TIMER(100));
279 unsigned int Counter() /* get milliseconds since last call of InitCounter() */
281 #if !defined(PLATFORM_MSDOS)
282 return mainCounter(READ_COUNTER);
284 return (counter * 10);
288 static void sleep_milliseconds(unsigned int milliseconds_delay)
290 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
294 /* we want to wait only a few ms -- if we assume that we have a
295 kernel timer resolution of 10 ms, we would wait far to long;
296 therefore it's better to do a short interval of busy waiting
297 to get our sleeping time more accurate */
299 unsigned int base_counter = Counter(), actual_counter = Counter();
301 while (actual_counter < base_counter + milliseconds_delay &&
302 actual_counter >= base_counter)
303 actual_counter = Counter();
307 #if defined(TARGET_SDL)
308 SDL_Delay(milliseconds_delay);
309 #elif defined(TARGET_ALLEGRO)
310 rest(milliseconds_delay);
312 struct timeval delay;
314 delay.tv_sec = milliseconds_delay / 1000;
315 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
317 if (select(0, NULL, NULL, NULL, &delay) != 0)
318 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
323 void Delay(unsigned int delay) /* Sleep specified number of milliseconds */
325 sleep_milliseconds(delay);
328 boolean FrameReached(unsigned int *frame_counter_var,
329 unsigned int frame_delay)
331 unsigned int actual_frame_counter = FrameCounter;
333 if (actual_frame_counter >= *frame_counter_var &&
334 actual_frame_counter < *frame_counter_var + frame_delay)
337 *frame_counter_var = actual_frame_counter;
342 boolean DelayReached(unsigned int *counter_var,
345 unsigned int actual_counter = Counter();
347 if (actual_counter >= *counter_var &&
348 actual_counter < *counter_var + delay)
351 *counter_var = actual_counter;
356 void WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
358 unsigned int actual_counter;
362 actual_counter = Counter();
364 if (actual_counter >= *counter_var &&
365 actual_counter < *counter_var + delay)
366 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
371 *counter_var = actual_counter;
375 /* ------------------------------------------------------------------------- */
376 /* random generator functions */
377 /* ------------------------------------------------------------------------- */
379 unsigned int init_random_number(int nr, int seed)
381 if (seed == NEW_RANDOMIZE)
383 /* default random seed */
384 seed = (int)time(NULL); // seconds since the epoch
386 #if !defined(PLATFORM_WIN32)
387 /* add some more randomness */
388 struct timeval current_time;
390 gettimeofday(¤t_time, NULL);
392 seed += (int)current_time.tv_usec; // microseconds since the epoch
395 #if defined(TARGET_SDL)
396 /* add some more randomness */
397 seed += (int)SDL_GetTicks(); // milliseconds since SDL init
401 /* add some more randomness */
402 seed += GetSimpleRandom(1000000);
406 srandom_linux_libc(nr, (unsigned int) seed);
408 return (unsigned int) seed;
411 unsigned int get_random_number(int nr, int max)
413 return (max > 0 ? random_linux_libc(nr) % max : 0);
417 /* ------------------------------------------------------------------------- */
418 /* system info functions */
419 /* ------------------------------------------------------------------------- */
421 #if !defined(PLATFORM_MSDOS)
422 static char *get_corrected_real_name(char *real_name)
424 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
425 char *from_ptr = real_name;
426 char *to_ptr = real_name_new;
428 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
429 while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
431 /* the name field read from "passwd" file may also contain additional
432 user information, separated by commas, which will be removed here */
433 if (*from_ptr == ',')
436 /* the user's real name may contain 'ß' characters (german sharp s),
437 which have no equivalent in upper case letters (used by our fonts) */
438 if (*from_ptr == 'ß')
445 *to_ptr++ = *from_ptr++;
450 return real_name_new;
456 static char *login_name = NULL;
458 #if defined(PLATFORM_WIN32)
459 if (login_name == NULL)
461 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
462 login_name = checked_malloc(buffer_size);
464 if (GetUserName(login_name, &buffer_size) == 0)
465 strcpy(login_name, ANONYMOUS_NAME);
468 if (login_name == NULL)
472 if ((pwd = getpwuid(getuid())) == NULL)
473 login_name = ANONYMOUS_NAME;
475 login_name = getStringCopy(pwd->pw_name);
484 static char *real_name = NULL;
486 #if defined(PLATFORM_WIN32)
487 if (real_name == NULL)
489 static char buffer[MAX_USERNAME_LEN + 1];
490 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
492 if (GetUserName(buffer, &buffer_size) != 0)
493 real_name = get_corrected_real_name(buffer);
495 real_name = ANONYMOUS_NAME;
497 #elif defined(PLATFORM_UNIX)
498 if (real_name == NULL)
502 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
503 real_name = get_corrected_real_name(pwd->pw_gecos);
505 real_name = ANONYMOUS_NAME;
508 real_name = ANONYMOUS_NAME;
514 time_t getFileTimestampEpochSeconds(char *filename)
516 struct stat file_status;
518 if (stat(filename, &file_status) != 0) /* cannot stat file */
521 return file_status.st_mtime;
525 /* ------------------------------------------------------------------------- */
526 /* path manipulation functions */
527 /* ------------------------------------------------------------------------- */
529 static char *getLastPathSeparatorPtr(char *filename)
531 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
533 if (last_separator == NULL) /* also try DOS/Windows variant */
534 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
536 return last_separator;
539 char *getBaseNamePtr(char *filename)
541 char *last_separator = getLastPathSeparatorPtr(filename);
543 if (last_separator != NULL)
544 return last_separator + 1; /* separator found: strip base path */
546 return filename; /* no separator found: filename has no path */
549 char *getBaseName(char *filename)
551 return getStringCopy(getBaseNamePtr(filename));
554 char *getBasePath(char *filename)
556 char *basepath = getStringCopy(filename);
557 char *last_separator = getLastPathSeparatorPtr(basepath);
559 if (last_separator != NULL)
560 *last_separator = '\0'; /* separator found: strip basename */
562 basepath = "."; /* no separator found: use current path */
567 static char *getProgramMainDataPath()
569 char *main_data_path = getStringCopy(program.command_basepath);
571 #if defined(PLATFORM_MACOSX)
572 static char *main_data_binary_subdir = NULL;
574 if (main_data_binary_subdir == NULL)
576 main_data_binary_subdir = checked_malloc(strlen(program.program_title) + 1 +
578 strlen(MAC_APP_BINARY_SUBDIR) + 1);
580 sprintf(main_data_binary_subdir, "%s.app/%s",
581 program.program_title, MAC_APP_BINARY_SUBDIR);
584 // cut relative path to Mac OS X application binary directory from path
585 if (strSuffix(main_data_path, main_data_binary_subdir))
586 main_data_path[strlen(main_data_path) -
587 strlen(main_data_binary_subdir)] = '\0';
589 // cut trailing path separator from path (but not if path is root directory)
590 if (strSuffix(main_data_path, "/") && !strEqual(main_data_path, "/"))
591 main_data_path[strlen(main_data_path) - 1] = '\0';
594 return main_data_path;
598 /* ------------------------------------------------------------------------- */
599 /* various string functions */
600 /* ------------------------------------------------------------------------- */
602 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
604 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
607 sprintf(complete_string, "%s%s%s", s1, sep, s2);
609 return complete_string;
612 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
614 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
615 strlen(s2) + strlen(sep) +
618 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
620 return complete_string;
623 char *getStringCat2(char *s1, char *s2)
625 return getStringCat2WithSeparator(s1, s2, "");
628 char *getStringCat3(char *s1, char *s2, char *s3)
630 return getStringCat3WithSeparator(s1, s2, s3, "");
633 char *getPath2(char *path1, char *path2)
635 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
638 char *getPath3(char *path1, char *path2, char *path3)
640 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
643 char *getStringCopy(char *s)
650 s_copy = checked_malloc(strlen(s) + 1);
656 char *getStringCopyN(char *s, int n)
659 int s_len = MAX(0, n);
664 s_copy = checked_malloc(s_len + 1);
665 strncpy(s_copy, s, s_len);
666 s_copy[s_len] = '\0';
671 char *getStringToLower(char *s)
673 char *s_copy = checked_malloc(strlen(s) + 1);
674 char *s_ptr = s_copy;
677 *s_ptr++ = tolower(*s++);
683 void setString(char **old_value, char *new_value)
685 checked_free(*old_value);
687 *old_value = getStringCopy(new_value);
690 boolean strEqual(char *s1, char *s2)
692 return (s1 == NULL && s2 == NULL ? TRUE :
693 s1 == NULL && s2 != NULL ? FALSE :
694 s1 != NULL && s2 == NULL ? FALSE :
695 strcmp(s1, s2) == 0);
698 boolean strEqualN(char *s1, char *s2, int n)
700 return (s1 == NULL && s2 == NULL ? TRUE :
701 s1 == NULL && s2 != NULL ? FALSE :
702 s1 != NULL && s2 == NULL ? FALSE :
703 strncmp(s1, s2, n) == 0);
706 boolean strPrefix(char *s, char *prefix)
708 return (s == NULL && prefix == NULL ? TRUE :
709 s == NULL && prefix != NULL ? FALSE :
710 s != NULL && prefix == NULL ? FALSE :
711 strncmp(s, prefix, strlen(prefix)) == 0);
714 boolean strSuffix(char *s, char *suffix)
716 return (s == NULL && suffix == NULL ? TRUE :
717 s == NULL && suffix != NULL ? FALSE :
718 s != NULL && suffix == NULL ? FALSE :
719 strlen(s) < strlen(suffix) ? FALSE :
720 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
723 boolean strPrefixLower(char *s, char *prefix)
725 char *s_lower = getStringToLower(s);
726 boolean match = strPrefix(s_lower, prefix);
733 boolean strSuffixLower(char *s, char *suffix)
735 char *s_lower = getStringToLower(s);
736 boolean match = strSuffix(s_lower, suffix);
744 /* ------------------------------------------------------------------------- */
745 /* command line option handling functions */
746 /* ------------------------------------------------------------------------- */
748 void GetOptions(char *argv[], void (*print_usage_function)(void))
750 char *ro_base_path = RO_BASE_PATH;
751 char *rw_base_path = RW_BASE_PATH;
752 char **options_left = &argv[1];
755 /* if the program is configured to start from current directory (default),
756 determine program package directory from program binary (some versions
757 of KDE/Konqueror and Mac OS X (especially "Maverick") apparently do not
758 set the current working directory to the program package directory) */
760 if (strEqual(ro_base_path, "."))
761 ro_base_path = getProgramMainDataPath();
762 if (strEqual(rw_base_path, "."))
763 rw_base_path = getProgramMainDataPath();
766 #if !defined(PLATFORM_MACOSX)
767 /* if the program is configured to start from current directory (default),
768 determine program package directory (KDE/Konqueror does not do this by
769 itself and fails otherwise); on Mac OS X, the program binary is stored
770 in an application package directory -- do not try to use this directory
771 as the program data directory (Mac OS X handles this correctly anyway) */
773 if (strEqual(ro_base_path, "."))
774 ro_base_path = program.command_basepath;
775 if (strEqual(rw_base_path, "."))
776 rw_base_path = program.command_basepath;
781 /* initialize global program options */
782 options.display_name = NULL;
783 options.server_host = NULL;
784 options.server_port = 0;
786 options.ro_base_directory = ro_base_path;
787 options.rw_base_directory = rw_base_path;
788 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
789 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
790 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
791 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
792 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
794 options.execute_command = NULL;
795 options.special_flags = NULL;
797 options.serveronly = FALSE;
798 options.network = FALSE;
799 options.verbose = FALSE;
800 options.debug = FALSE;
801 options.debug_x11_sync = FALSE;
803 #if !defined(PLATFORM_UNIX)
804 if (*options_left == NULL) /* no options given -- enable verbose mode */
805 options.verbose = TRUE;
808 while (*options_left)
810 char option_str[MAX_OPTION_LEN];
811 char *option = options_left[0];
812 char *next_option = options_left[1];
813 char *option_arg = NULL;
814 int option_len = strlen(option);
816 if (option_len >= MAX_OPTION_LEN)
817 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
819 strcpy(option_str, option); /* copy argument into buffer */
822 if (strEqual(option, "--")) /* stop scanning arguments */
825 if (strPrefix(option, "--")) /* treat '--' like '-' */
828 option_arg = strchr(option, '=');
829 if (option_arg == NULL) /* no '=' in option */
830 option_arg = next_option;
833 *option_arg++ = '\0'; /* cut argument from option */
834 if (*option_arg == '\0') /* no argument after '=' */
835 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
838 option_len = strlen(option);
840 if (strEqual(option, "-"))
841 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
842 else if (strncmp(option, "-help", option_len) == 0)
844 print_usage_function();
848 else if (strncmp(option, "-display", option_len) == 0)
850 if (option_arg == NULL)
851 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
853 options.display_name = option_arg;
854 if (option_arg == next_option)
857 else if (strncmp(option, "-basepath", option_len) == 0)
859 if (option_arg == NULL)
860 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
862 /* this should be extended to separate options for ro and rw data */
863 options.ro_base_directory = ro_base_path = option_arg;
864 options.rw_base_directory = rw_base_path = option_arg;
865 if (option_arg == next_option)
868 /* adjust paths for sub-directories in base directory accordingly */
869 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
870 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
871 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
872 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
873 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
875 else if (strncmp(option, "-levels", option_len) == 0)
877 if (option_arg == NULL)
878 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
880 options.level_directory = option_arg;
881 if (option_arg == next_option)
884 else if (strncmp(option, "-graphics", option_len) == 0)
886 if (option_arg == NULL)
887 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
889 options.graphics_directory = option_arg;
890 if (option_arg == next_option)
893 else if (strncmp(option, "-sounds", option_len) == 0)
895 if (option_arg == NULL)
896 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
898 options.sounds_directory = option_arg;
899 if (option_arg == next_option)
902 else if (strncmp(option, "-music", option_len) == 0)
904 if (option_arg == NULL)
905 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
907 options.music_directory = option_arg;
908 if (option_arg == next_option)
911 else if (strncmp(option, "-network", option_len) == 0)
913 options.network = TRUE;
915 else if (strncmp(option, "-serveronly", option_len) == 0)
917 options.serveronly = TRUE;
919 else if (strncmp(option, "-verbose", option_len) == 0)
921 options.verbose = TRUE;
923 else if (strncmp(option, "-debug", option_len) == 0)
925 options.debug = TRUE;
927 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
929 options.debug_x11_sync = TRUE;
931 else if (strPrefix(option, "-D"))
934 options.special_flags = getStringCopy(&option[2]);
936 char *flags_string = &option[2];
937 unsigned int flags_value;
939 if (*flags_string == '\0')
940 Error(ERR_EXIT_HELP, "empty flag ignored");
942 flags_value = get_special_flags_function(flags_string);
944 if (flags_value == 0)
945 Error(ERR_EXIT_HELP, "unknown flag '%s'", flags_string);
947 options.special_flags |= flags_value;
950 else if (strncmp(option, "-execute", option_len) == 0)
952 if (option_arg == NULL)
953 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
955 options.execute_command = option_arg;
956 if (option_arg == next_option)
959 /* when doing batch processing, always enable verbose mode (warnings) */
960 options.verbose = TRUE;
962 else if (*option == '-')
964 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
966 else if (options.server_host == NULL)
968 options.server_host = *options_left;
970 else if (options.server_port == 0)
972 options.server_port = atoi(*options_left);
973 if (options.server_port < 1024)
974 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
977 Error(ERR_EXIT_HELP, "too many arguments");
984 /* ------------------------------------------------------------------------- */
985 /* error handling functions */
986 /* ------------------------------------------------------------------------- */
988 /* used by SetError() and GetError() to store internal error messages */
989 static char internal_error[1024]; /* this is bad */
991 void SetError(char *format, ...)
995 va_start(ap, format);
996 vsprintf(internal_error, format, ap);
1002 return internal_error;
1005 void Error(int mode, char *format, ...)
1007 static boolean last_line_was_separator = FALSE;
1008 char *process_name = "";
1011 /* display warnings only when running in verbose mode */
1012 if (mode & ERR_WARN && !options.verbose)
1016 if (mode == ERR_INFO_LINE)
1018 if (!last_line_was_separator)
1019 fprintf_line(program.error_file, format, 79);
1021 last_line_was_separator = TRUE;
1026 last_line_was_separator = FALSE;
1028 if (mode & ERR_SOUND_SERVER)
1029 process_name = " sound server";
1030 else if (mode & ERR_NETWORK_SERVER)
1031 process_name = " network server";
1032 else if (mode & ERR_NETWORK_CLIENT)
1033 process_name = " network client **";
1039 fprintf(program.error_file, "%s%s: ", program.command_basename,
1042 if (mode & ERR_WARN)
1043 fprintf(program.error_file, "warning: ");
1045 va_start(ap, format);
1046 vfprintf_newline(program.error_file, format, ap);
1050 if (mode & ERR_HELP)
1051 fprintf_newline(program.error_file,
1052 "%s: Try option '--help' for more information.",
1053 program.command_basename);
1055 if (mode & ERR_EXIT)
1056 fprintf_newline(program.error_file, "%s%s: aborting",
1057 program.command_basename, process_name);
1059 if (mode & ERR_EXIT)
1061 if (mode & ERR_FROM_SERVER)
1062 exit(1); /* child process: normal exit */
1064 program.exit_function(1); /* main process: clean up stuff */
1069 /* ------------------------------------------------------------------------- */
1070 /* checked memory allocation and freeing functions */
1071 /* ------------------------------------------------------------------------- */
1073 void *checked_malloc(unsigned int size)
1080 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1085 void *checked_calloc(unsigned int size)
1089 ptr = calloc(1, size);
1092 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1097 void *checked_realloc(void *ptr, unsigned int size)
1099 ptr = realloc(ptr, size);
1102 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1107 void checked_free(void *ptr)
1109 if (ptr != NULL) /* this check should be done by free() anyway */
1113 void clear_mem(void *ptr, unsigned int size)
1115 #if defined(PLATFORM_WIN32)
1116 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1117 char *cptr = (char *)ptr;
1122 memset(ptr, 0, size);
1127 /* ------------------------------------------------------------------------- */
1128 /* various helper functions */
1129 /* ------------------------------------------------------------------------- */
1131 inline void swap_numbers(int *i1, int *i2)
1139 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1151 /* the "put" variants of the following file access functions check for the file
1152 pointer being != NULL and return the number of bytes they have or would have
1153 written; this allows for chunk writing functions to first determine the size
1154 of the (not yet written) chunk, write the correct chunk size and finally
1155 write the chunk itself */
1157 int getFile8BitInteger(FILE *file)
1162 int putFile8BitInteger(FILE *file, int value)
1170 int getFile16BitInteger(FILE *file, int byte_order)
1172 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1173 return ((fgetc(file) << 8) |
1174 (fgetc(file) << 0));
1175 else /* BYTE_ORDER_LITTLE_ENDIAN */
1176 return ((fgetc(file) << 0) |
1177 (fgetc(file) << 8));
1180 int putFile16BitInteger(FILE *file, int value, int byte_order)
1184 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1186 fputc((value >> 8) & 0xff, file);
1187 fputc((value >> 0) & 0xff, file);
1189 else /* BYTE_ORDER_LITTLE_ENDIAN */
1191 fputc((value >> 0) & 0xff, file);
1192 fputc((value >> 8) & 0xff, file);
1199 int getFile32BitInteger(FILE *file, int byte_order)
1201 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1202 return ((fgetc(file) << 24) |
1203 (fgetc(file) << 16) |
1204 (fgetc(file) << 8) |
1205 (fgetc(file) << 0));
1206 else /* BYTE_ORDER_LITTLE_ENDIAN */
1207 return ((fgetc(file) << 0) |
1208 (fgetc(file) << 8) |
1209 (fgetc(file) << 16) |
1210 (fgetc(file) << 24));
1213 int putFile32BitInteger(FILE *file, int value, int byte_order)
1217 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1219 fputc((value >> 24) & 0xff, file);
1220 fputc((value >> 16) & 0xff, file);
1221 fputc((value >> 8) & 0xff, file);
1222 fputc((value >> 0) & 0xff, file);
1224 else /* BYTE_ORDER_LITTLE_ENDIAN */
1226 fputc((value >> 0) & 0xff, file);
1227 fputc((value >> 8) & 0xff, file);
1228 fputc((value >> 16) & 0xff, file);
1229 fputc((value >> 24) & 0xff, file);
1236 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1239 const int chunk_name_length = 4;
1241 /* read chunk name */
1242 if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1245 if (chunk_size != NULL)
1247 /* read chunk size */
1248 *chunk_size = getFile32BitInteger(file, byte_order);
1251 return (feof(file) || ferror(file) ? FALSE : TRUE);
1254 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1259 /* write chunk name */
1261 fputs(chunk_name, file);
1263 num_bytes += strlen(chunk_name);
1265 if (chunk_size >= 0)
1267 /* write chunk size */
1269 putFile32BitInteger(file, chunk_size, byte_order);
1277 int getFileVersion(FILE *file)
1279 int version_major = fgetc(file);
1280 int version_minor = fgetc(file);
1281 int version_patch = fgetc(file);
1282 int version_build = fgetc(file);
1284 return VERSION_IDENT(version_major, version_minor, version_patch,
1288 int putFileVersion(FILE *file, int version)
1292 int version_major = VERSION_MAJOR(version);
1293 int version_minor = VERSION_MINOR(version);
1294 int version_patch = VERSION_PATCH(version);
1295 int version_build = VERSION_BUILD(version);
1297 fputc(version_major, file);
1298 fputc(version_minor, file);
1299 fputc(version_patch, file);
1300 fputc(version_build, file);
1306 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1310 for(i = 0; i < bytes && !feof(file); i++)
1311 buffer[i] = fgetc(file);
1314 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1318 for(i = 0; i < bytes; i++)
1319 fputc(buffer[i], file);
1322 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1324 while (bytes-- && !feof(file))
1328 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1335 /* ------------------------------------------------------------------------- */
1336 /* functions to translate key identifiers between different format */
1337 /* ------------------------------------------------------------------------- */
1339 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1340 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1341 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1342 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1344 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1353 /* normal cursor keys */
1354 { KSYM_Left, "XK_Left", "cursor left" },
1355 { KSYM_Right, "XK_Right", "cursor right" },
1356 { KSYM_Up, "XK_Up", "cursor up" },
1357 { KSYM_Down, "XK_Down", "cursor down" },
1359 /* keypad cursor keys */
1361 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1362 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1363 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1364 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1367 /* other keypad keys */
1368 #ifdef KSYM_KP_Enter
1369 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1370 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1371 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1372 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1373 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1374 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1378 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1379 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1380 { KSYM_Control_L, "XK_Control_L", "left control" },
1381 { KSYM_Control_R, "XK_Control_R", "right control" },
1382 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1383 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1384 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1385 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1386 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1387 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1388 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1389 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1391 /* some special keys */
1392 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1393 { KSYM_Delete, "XK_Delete", "delete" },
1394 { KSYM_Insert, "XK_Insert", "insert" },
1395 { KSYM_Tab, "XK_Tab", "tab" },
1396 { KSYM_Home, "XK_Home", "home" },
1397 { KSYM_End, "XK_End", "end" },
1398 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1399 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1400 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1402 /* ASCII 0x20 to 0x40 keys (except numbers) */
1403 { KSYM_space, "XK_space", "space" },
1404 { KSYM_exclam, "XK_exclam", "!" },
1405 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1406 { KSYM_numbersign, "XK_numbersign", "#" },
1407 { KSYM_dollar, "XK_dollar", "$" },
1408 { KSYM_percent, "XK_percent", "%" },
1409 { KSYM_ampersand, "XK_ampersand", "&" },
1410 { KSYM_apostrophe, "XK_apostrophe", "'" },
1411 { KSYM_parenleft, "XK_parenleft", "(" },
1412 { KSYM_parenright, "XK_parenright", ")" },
1413 { KSYM_asterisk, "XK_asterisk", "*" },
1414 { KSYM_plus, "XK_plus", "+" },
1415 { KSYM_comma, "XK_comma", "," },
1416 { KSYM_minus, "XK_minus", "-" },
1417 { KSYM_period, "XK_period", "." },
1418 { KSYM_slash, "XK_slash", "/" },
1419 { KSYM_colon, "XK_colon", ":" },
1420 { KSYM_semicolon, "XK_semicolon", ";" },
1421 { KSYM_less, "XK_less", "<" },
1422 { KSYM_equal, "XK_equal", "=" },
1423 { KSYM_greater, "XK_greater", ">" },
1424 { KSYM_question, "XK_question", "?" },
1425 { KSYM_at, "XK_at", "@" },
1427 /* more ASCII keys */
1428 { KSYM_bracketleft, "XK_bracketleft", "[" },
1429 { KSYM_backslash, "XK_backslash", "\\" },
1430 { KSYM_bracketright,"XK_bracketright", "]" },
1431 { KSYM_asciicircum, "XK_asciicircum", "^" },
1432 { KSYM_underscore, "XK_underscore", "_" },
1433 { KSYM_grave, "XK_grave", "grave" },
1434 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1435 { KSYM_braceleft, "XK_braceleft", "brace left" },
1436 { KSYM_bar, "XK_bar", "bar" },
1437 { KSYM_braceright, "XK_braceright", "brace right" },
1438 { KSYM_asciitilde, "XK_asciitilde", "~" },
1440 /* special (non-ASCII) keys */
1441 { KSYM_degree, "XK_degree", "°" },
1442 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1443 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1444 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1445 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1446 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1447 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1448 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1450 /* end-of-array identifier */
1456 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1458 static char name_buffer[30];
1461 if (key >= KSYM_A && key <= KSYM_Z)
1462 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1463 else if (key >= KSYM_a && key <= KSYM_z)
1464 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1465 else if (key >= KSYM_0 && key <= KSYM_9)
1466 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1467 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1468 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1469 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1470 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1471 else if (key == KSYM_UNDEFINED)
1472 strcpy(name_buffer, "(undefined)");
1479 if (key == translate_key[i].key)
1481 strcpy(name_buffer, translate_key[i].name);
1485 while (translate_key[++i].name);
1487 if (!translate_key[i].name)
1488 strcpy(name_buffer, "(unknown)");
1491 *name = name_buffer;
1493 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1495 static char name_buffer[30];
1498 if (key >= KSYM_A && key <= KSYM_Z)
1499 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1500 else if (key >= KSYM_a && key <= KSYM_z)
1501 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1502 else if (key >= KSYM_0 && key <= KSYM_9)
1503 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1504 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1505 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1506 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1507 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1508 else if (key == KSYM_UNDEFINED)
1509 strcpy(name_buffer, "[undefined]");
1516 if (key == translate_key[i].key)
1518 strcpy(name_buffer, translate_key[i].x11name);
1522 while (translate_key[++i].x11name);
1524 if (!translate_key[i].x11name)
1525 sprintf(name_buffer, "0x%04x", (unsigned int)key);
1528 *x11name = name_buffer;
1530 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1532 Key key = KSYM_UNDEFINED;
1537 if (strEqual(translate_key[i].name, *name))
1539 key = translate_key[i].key;
1543 while (translate_key[++i].x11name);
1545 if (key == KSYM_UNDEFINED)
1546 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1550 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1552 Key key = KSYM_UNDEFINED;
1553 char *name_ptr = *x11name;
1555 if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1557 char c = name_ptr[3];
1559 if (c >= 'A' && c <= 'Z')
1560 key = KSYM_A + (Key)(c - 'A');
1561 else if (c >= 'a' && c <= 'z')
1562 key = KSYM_a + (Key)(c - 'a');
1563 else if (c >= '0' && c <= '9')
1564 key = KSYM_0 + (Key)(c - '0');
1566 else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1568 char c = name_ptr[6];
1570 if (c >= '0' && c <= '9')
1571 key = KSYM_KP_0 + (Key)(c - '0');
1573 else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1575 char c1 = name_ptr[4];
1576 char c2 = name_ptr[5];
1579 if ((c1 >= '0' && c1 <= '9') &&
1580 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1581 d = atoi(&name_ptr[4]);
1583 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1584 key = KSYM_F1 + (Key)(d - 1);
1586 else if (strPrefix(name_ptr, "XK_"))
1592 if (strEqual(name_ptr, translate_key[i].x11name))
1594 key = translate_key[i].key;
1598 while (translate_key[++i].x11name);
1600 else if (strPrefix(name_ptr, "0x"))
1602 unsigned int value = 0;
1608 char c = *name_ptr++;
1611 if (c >= '0' && c <= '9')
1613 else if (c >= 'a' && c <= 'f')
1614 d = (int)(c - 'a' + 10);
1615 else if (c >= 'A' && c <= 'F')
1616 d = (int)(c - 'A' + 10);
1624 value = value * 16 + d;
1635 char *getKeyNameFromKey(Key key)
1639 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1643 char *getX11KeyNameFromKey(Key key)
1647 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1651 Key getKeyFromKeyName(char *name)
1655 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1659 Key getKeyFromX11KeyName(char *x11name)
1663 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1667 char getCharFromKey(Key key)
1669 char *keyname = getKeyNameFromKey(key);
1672 if (strlen(keyname) == 1)
1674 else if (strEqual(keyname, "space"))
1680 char getValidConfigValueChar(char c)
1682 if (c == '#' || /* used to mark comments */
1683 c == '\\') /* used to mark continued lines */
1690 /* ------------------------------------------------------------------------- */
1691 /* functions to translate string identifiers to integer or boolean value */
1692 /* ------------------------------------------------------------------------- */
1694 int get_integer_from_string(char *s)
1696 static char *number_text[][3] =
1698 { "0", "zero", "null", },
1699 { "1", "one", "first" },
1700 { "2", "two", "second" },
1701 { "3", "three", "third" },
1702 { "4", "four", "fourth" },
1703 { "5", "five", "fifth" },
1704 { "6", "six", "sixth" },
1705 { "7", "seven", "seventh" },
1706 { "8", "eight", "eighth" },
1707 { "9", "nine", "ninth" },
1708 { "10", "ten", "tenth" },
1709 { "11", "eleven", "eleventh" },
1710 { "12", "twelve", "twelfth" },
1712 { NULL, NULL, NULL },
1716 char *s_lower = getStringToLower(s);
1719 for (i = 0; number_text[i][0] != NULL; i++)
1720 for (j = 0; j < 3; j++)
1721 if (strEqual(s_lower, number_text[i][j]))
1726 if (strEqual(s_lower, "false") ||
1727 strEqual(s_lower, "no") ||
1728 strEqual(s_lower, "off"))
1730 else if (strEqual(s_lower, "true") ||
1731 strEqual(s_lower, "yes") ||
1732 strEqual(s_lower, "on"))
1743 boolean get_boolean_from_string(char *s)
1745 char *s_lower = getStringToLower(s);
1746 boolean result = FALSE;
1748 if (strEqual(s_lower, "true") ||
1749 strEqual(s_lower, "yes") ||
1750 strEqual(s_lower, "on") ||
1751 get_integer_from_string(s) == 1)
1759 int get_switch3_from_string(char *s)
1761 char *s_lower = getStringToLower(s);
1764 if (strEqual(s_lower, "true") ||
1765 strEqual(s_lower, "yes") ||
1766 strEqual(s_lower, "on") ||
1767 get_integer_from_string(s) == 1)
1769 else if (strEqual(s_lower, "auto"))
1778 /* ------------------------------------------------------------------------- */
1779 /* functions for generic lists */
1780 /* ------------------------------------------------------------------------- */
1782 ListNode *newListNode()
1784 return checked_calloc(sizeof(ListNode));
1787 void addNodeToList(ListNode **node_first, char *key, void *content)
1789 ListNode *node_new = newListNode();
1791 node_new->key = getStringCopy(key);
1792 node_new->content = content;
1793 node_new->next = *node_first;
1794 *node_first = node_new;
1797 void deleteNodeFromList(ListNode **node_first, char *key,
1798 void (*destructor_function)(void *))
1800 if (node_first == NULL || *node_first == NULL)
1803 if (strEqual((*node_first)->key, key))
1805 checked_free((*node_first)->key);
1806 if (destructor_function)
1807 destructor_function((*node_first)->content);
1808 *node_first = (*node_first)->next;
1811 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1814 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1816 if (node_first == NULL)
1819 if (strEqual(node_first->key, key))
1822 return getNodeFromKey(node_first->next, key);
1825 int getNumNodes(ListNode *node_first)
1827 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1830 void dumpList(ListNode *node_first)
1832 ListNode *node = node_first;
1836 printf("['%s' (%d)]\n", node->key,
1837 ((struct ListNodeInfo *)node->content)->num_references);
1841 printf("[%d nodes]\n", getNumNodes(node_first));
1845 /* ------------------------------------------------------------------------- */
1846 /* functions for checking files and filenames */
1847 /* ------------------------------------------------------------------------- */
1849 boolean fileExists(char *filename)
1851 if (filename == NULL)
1854 return (access(filename, F_OK) == 0);
1857 boolean fileHasPrefix(char *basename, char *prefix)
1859 static char *basename_lower = NULL;
1860 int basename_length, prefix_length;
1862 checked_free(basename_lower);
1864 if (basename == NULL || prefix == NULL)
1867 basename_lower = getStringToLower(basename);
1868 basename_length = strlen(basename_lower);
1869 prefix_length = strlen(prefix);
1871 if (basename_length > prefix_length + 1 &&
1872 basename_lower[prefix_length] == '.' &&
1873 strncmp(basename_lower, prefix, prefix_length) == 0)
1879 boolean fileHasSuffix(char *basename, char *suffix)
1881 static char *basename_lower = NULL;
1882 int basename_length, suffix_length;
1884 checked_free(basename_lower);
1886 if (basename == NULL || suffix == NULL)
1889 basename_lower = getStringToLower(basename);
1890 basename_length = strlen(basename_lower);
1891 suffix_length = strlen(suffix);
1893 if (basename_length > suffix_length + 1 &&
1894 basename_lower[basename_length - suffix_length - 1] == '.' &&
1895 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1901 boolean FileIsGraphic(char *filename)
1903 char *basename = getBaseNamePtr(filename);
1905 return fileHasSuffix(basename, "pcx");
1908 boolean FileIsSound(char *filename)
1910 char *basename = getBaseNamePtr(filename);
1912 return fileHasSuffix(basename, "wav");
1915 boolean FileIsMusic(char *filename)
1917 char *basename = getBaseNamePtr(filename);
1919 if (FileIsSound(basename))
1922 #if defined(TARGET_SDL)
1923 if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
1924 fileHasSuffix(basename, "mod") ||
1925 fileHasSuffix(basename, "s3m") ||
1926 fileHasSuffix(basename, "it") ||
1927 fileHasSuffix(basename, "xm") ||
1928 fileHasSuffix(basename, "midi") ||
1929 fileHasSuffix(basename, "mid") ||
1930 fileHasSuffix(basename, "mp3") ||
1931 fileHasSuffix(basename, "ogg"))
1938 boolean FileIsArtworkType(char *basename, int type)
1940 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1941 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1942 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1948 /* ------------------------------------------------------------------------- */
1949 /* functions for loading artwork configuration information */
1950 /* ------------------------------------------------------------------------- */
1952 char *get_mapped_token(char *token)
1954 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1955 static char *map_token_prefix[][2] =
1957 { "char_procent", "char_percent" },
1962 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1964 int len_token_prefix = strlen(map_token_prefix[i][0]);
1966 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1967 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1973 /* This function checks if a string <s> of the format "string1, string2, ..."
1974 exactly contains a string <s_contained>. */
1976 static boolean string_has_parameter(char *s, char *s_contained)
1980 if (s == NULL || s_contained == NULL)
1983 if (strlen(s_contained) > strlen(s))
1986 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1988 char next_char = s[strlen(s_contained)];
1990 /* check if next character is delimiter or whitespace */
1991 return (next_char == ',' || next_char == '\0' ||
1992 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1995 /* check if string contains another parameter string after a comma */
1996 substring = strchr(s, ',');
1997 if (substring == NULL) /* string does not contain a comma */
2000 /* advance string pointer to next character after the comma */
2003 /* skip potential whitespaces after the comma */
2004 while (*substring == ' ' || *substring == '\t')
2007 return string_has_parameter(substring, s_contained);
2010 int get_parameter_value(char *value_raw, char *suffix, int type)
2012 char *value = getStringToLower(value_raw);
2013 int result = 0; /* probably a save default value */
2015 if (strEqual(suffix, ".direction"))
2017 result = (strEqual(value, "left") ? MV_LEFT :
2018 strEqual(value, "right") ? MV_RIGHT :
2019 strEqual(value, "up") ? MV_UP :
2020 strEqual(value, "down") ? MV_DOWN : MV_NONE);
2022 else if (strEqual(suffix, ".align"))
2024 result = (strEqual(value, "left") ? ALIGN_LEFT :
2025 strEqual(value, "right") ? ALIGN_RIGHT :
2026 strEqual(value, "center") ? ALIGN_CENTER :
2027 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2029 else if (strEqual(suffix, ".valign"))
2031 result = (strEqual(value, "top") ? VALIGN_TOP :
2032 strEqual(value, "bottom") ? VALIGN_BOTTOM :
2033 strEqual(value, "middle") ? VALIGN_MIDDLE :
2034 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2036 else if (strEqual(suffix, ".anim_mode"))
2038 result = (string_has_parameter(value, "none") ? ANIM_NONE :
2039 string_has_parameter(value, "loop") ? ANIM_LOOP :
2040 string_has_parameter(value, "linear") ? ANIM_LINEAR :
2041 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
2042 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
2043 string_has_parameter(value, "random") ? ANIM_RANDOM :
2044 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
2045 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
2046 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
2047 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2048 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
2049 string_has_parameter(value, "centered") ? ANIM_CENTERED :
2052 if (string_has_parameter(value, "reverse"))
2053 result |= ANIM_REVERSE;
2055 if (string_has_parameter(value, "opaque_player"))
2056 result |= ANIM_OPAQUE_PLAYER;
2058 if (string_has_parameter(value, "static_panel"))
2059 result |= ANIM_STATIC_PANEL;
2061 else if (strEqual(suffix, ".class"))
2063 result = get_hash_from_key(value);
2065 else if (strEqual(suffix, ".style"))
2067 result = STYLE_DEFAULT;
2069 if (string_has_parameter(value, "accurate_borders"))
2070 result |= STYLE_ACCURATE_BORDERS;
2072 if (string_has_parameter(value, "inner_corners"))
2073 result |= STYLE_INNER_CORNERS;
2075 else if (strEqual(suffix, ".fade_mode"))
2077 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
2078 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
2079 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
2080 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
2084 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
2086 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
2089 result = gfx.get_font_from_token_function(value);
2091 else /* generic parameter of type integer or boolean */
2093 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2094 type == TYPE_INTEGER ? get_integer_from_string(value) :
2095 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2096 ARG_UNDEFINED_VALUE);
2104 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2106 static struct ScreenModeInfo screen_mode;
2107 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2108 char *screen_mode_string_copy;
2109 char *screen_mode_string_pos_w;
2110 char *screen_mode_string_pos_h;
2112 if (screen_mode_string_x == NULL) /* invalid screen mode format */
2115 screen_mode_string_copy = getStringCopy(screen_mode_string);
2117 screen_mode_string_pos_w = screen_mode_string_copy;
2118 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2119 *screen_mode_string_pos_h++ = '\0';
2121 screen_mode.width = atoi(screen_mode_string_pos_w);
2122 screen_mode.height = atoi(screen_mode_string_pos_h);
2124 return &screen_mode;
2127 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2130 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2131 float aspect_ratio_new;
2136 *x = i * aspect_ratio + 0.000001;
2139 aspect_ratio_new = (float)*x / (float)*y;
2143 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2146 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2147 struct ListNodeInfo ***, int *);
2149 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2150 struct ConfigTypeInfo *suffix_list,
2151 char **ignore_tokens,
2152 int num_file_list_entries)
2154 struct FileInfo *file_list;
2155 int num_file_list_entries_found = 0;
2156 int num_suffix_list_entries = 0;
2160 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2162 for (i = 0; suffix_list[i].token != NULL; i++)
2163 num_suffix_list_entries++;
2165 /* always start with reliable default values */
2166 for (i = 0; i < num_file_list_entries; i++)
2168 file_list[i].token = NULL;
2170 file_list[i].default_filename = NULL;
2171 file_list[i].filename = NULL;
2173 if (num_suffix_list_entries > 0)
2175 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2177 file_list[i].default_parameter = checked_calloc(parameter_array_size);
2178 file_list[i].parameter = checked_calloc(parameter_array_size);
2180 for (j = 0; j < num_suffix_list_entries; j++)
2182 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2183 setString(&file_list[i].parameter[j], suffix_list[j].value);
2186 file_list[i].redefined = FALSE;
2187 file_list[i].fallback_to_default = FALSE;
2188 file_list[i].default_is_cloned = FALSE;
2193 for (i = 0; config_list[i].token != NULL; i++)
2195 int len_config_token = strlen(config_list[i].token);
2196 int len_config_value = strlen(config_list[i].value);
2197 boolean is_file_entry = TRUE;
2199 for (j = 0; suffix_list[j].token != NULL; j++)
2201 int len_suffix = strlen(suffix_list[j].token);
2203 if (len_suffix < len_config_token &&
2204 strEqual(&config_list[i].token[len_config_token - len_suffix],
2205 suffix_list[j].token))
2207 setString(&file_list[list_pos].default_parameter[j],
2208 config_list[i].value);
2210 is_file_entry = FALSE;
2215 /* the following tokens are no file definitions, but other config tokens */
2216 for (j = 0; ignore_tokens[j] != NULL; j++)
2217 if (strEqual(config_list[i].token, ignore_tokens[j]))
2218 is_file_entry = FALSE;
2225 if (list_pos >= num_file_list_entries)
2228 /* simple sanity check if this is really a file definition */
2229 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2230 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2231 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2233 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2234 config_list[i].token, config_list[i].value);
2235 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2238 file_list[list_pos].token = config_list[i].token;
2239 file_list[list_pos].default_filename = config_list[i].value;
2242 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2246 if (strSuffix(config_list[i].token, ".clone_from"))
2247 file_list[list_pos].default_is_cloned = TRUE;
2250 num_file_list_entries_found = list_pos + 1;
2251 if (num_file_list_entries_found != num_file_list_entries)
2253 Error(ERR_INFO_LINE, "-");
2254 Error(ERR_INFO, "inconsistant config list information:");
2255 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2256 num_file_list_entries);
2257 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2258 num_file_list_entries_found);
2259 Error(ERR_EXIT, "please fix");
2263 printf("::: ---------- DONE ----------\n");
2269 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2271 int len_token = strlen(token);
2272 int len_suffix = strlen(suffix);
2274 if (start_pos < 0) /* compare suffix from end of string */
2275 start_pos += len_token;
2277 if (start_pos < 0 || start_pos + len_suffix > len_token)
2280 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2283 if (token[start_pos + len_suffix] == '\0')
2286 if (token[start_pos + len_suffix] == '.')
2292 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2294 static void read_token_parameters(SetupFileHash *setup_file_hash,
2295 struct ConfigTypeInfo *suffix_list,
2296 struct FileInfo *file_list_entry)
2298 /* check for config token that is the base token without any suffixes */
2299 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2300 char *known_token_value = KNOWN_TOKEN_VALUE;
2303 if (filename != NULL)
2305 setString(&file_list_entry->filename, filename);
2307 /* when file definition found, set all parameters to default values */
2308 for (i = 0; suffix_list[i].token != NULL; i++)
2309 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2311 file_list_entry->redefined = TRUE;
2313 /* mark config file token as well known from default config */
2314 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2317 /* check for config tokens that can be build by base token and suffixes */
2318 for (i = 0; suffix_list[i].token != NULL; i++)
2320 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2321 char *value = getHashEntry(setup_file_hash, token);
2325 setString(&file_list_entry->parameter[i], value);
2327 /* mark config file token as well known from default config */
2328 setHashEntry(setup_file_hash, token, known_token_value);
2335 static void add_dynamic_file_list_entry(struct FileInfo **list,
2336 int *num_list_entries,
2337 SetupFileHash *extra_file_hash,
2338 struct ConfigTypeInfo *suffix_list,
2339 int num_suffix_list_entries,
2342 struct FileInfo *new_list_entry;
2343 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2345 (*num_list_entries)++;
2346 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2347 new_list_entry = &(*list)[*num_list_entries - 1];
2349 new_list_entry->token = getStringCopy(token);
2350 new_list_entry->default_filename = NULL;
2351 new_list_entry->filename = NULL;
2352 new_list_entry->parameter = checked_calloc(parameter_array_size);
2354 new_list_entry->redefined = FALSE;
2355 new_list_entry->fallback_to_default = FALSE;
2356 new_list_entry->default_is_cloned = FALSE;
2358 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2361 static void add_property_mapping(struct PropertyMapping **list,
2362 int *num_list_entries,
2363 int base_index, int ext1_index,
2364 int ext2_index, int ext3_index,
2367 struct PropertyMapping *new_list_entry;
2369 (*num_list_entries)++;
2370 *list = checked_realloc(*list,
2371 *num_list_entries * sizeof(struct PropertyMapping));
2372 new_list_entry = &(*list)[*num_list_entries - 1];
2374 new_list_entry->base_index = base_index;
2375 new_list_entry->ext1_index = ext1_index;
2376 new_list_entry->ext2_index = ext2_index;
2377 new_list_entry->ext3_index = ext3_index;
2379 new_list_entry->artwork_index = artwork_index;
2382 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2385 struct FileInfo *file_list = artwork_info->file_list;
2386 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2387 char **base_prefixes = artwork_info->base_prefixes;
2388 char **ext1_suffixes = artwork_info->ext1_suffixes;
2389 char **ext2_suffixes = artwork_info->ext2_suffixes;
2390 char **ext3_suffixes = artwork_info->ext3_suffixes;
2391 char **ignore_tokens = artwork_info->ignore_tokens;
2392 int num_file_list_entries = artwork_info->num_file_list_entries;
2393 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2394 int num_base_prefixes = artwork_info->num_base_prefixes;
2395 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2396 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2397 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2398 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2399 SetupFileHash *setup_file_hash, *valid_file_hash;
2400 SetupFileHash *extra_file_hash, *empty_file_hash;
2401 char *known_token_value = KNOWN_TOKEN_VALUE;
2404 if (filename == NULL)
2408 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2411 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2414 /* separate valid (defined) from empty (undefined) config token values */
2415 valid_file_hash = newSetupFileHash();
2416 empty_file_hash = newSetupFileHash();
2417 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2419 char *value = HASH_ITERATION_VALUE(itr);
2421 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2422 HASH_ITERATION_TOKEN(itr), value);
2424 END_HASH_ITERATION(setup_file_hash, itr)
2426 /* at this point, we do not need the setup file hash anymore -- free it */
2427 freeSetupFileHash(setup_file_hash);
2429 /* map deprecated to current tokens (using prefix match and replace) */
2430 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2432 char *token = HASH_ITERATION_TOKEN(itr);
2433 char *mapped_token = get_mapped_token(token);
2435 if (mapped_token != NULL)
2437 char *value = HASH_ITERATION_VALUE(itr);
2439 /* add mapped token */
2440 setHashEntry(valid_file_hash, mapped_token, value);
2442 /* ignore old token (by setting it to "known" keyword) */
2443 setHashEntry(valid_file_hash, token, known_token_value);
2448 END_HASH_ITERATION(valid_file_hash, itr)
2450 /* read parameters for all known config file tokens */
2451 for (i = 0; i < num_file_list_entries; i++)
2452 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2454 /* set all tokens that can be ignored here to "known" keyword */
2455 for (i = 0; i < num_ignore_tokens; i++)
2456 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2458 /* copy all unknown config file tokens to extra config hash */
2459 extra_file_hash = newSetupFileHash();
2460 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2462 char *value = HASH_ITERATION_VALUE(itr);
2464 if (!strEqual(value, known_token_value))
2465 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2467 END_HASH_ITERATION(valid_file_hash, itr)
2469 /* at this point, we do not need the valid file hash anymore -- free it */
2470 freeSetupFileHash(valid_file_hash);
2472 /* now try to determine valid, dynamically defined config tokens */
2474 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2476 struct FileInfo **dynamic_file_list =
2477 &artwork_info->dynamic_file_list;
2478 int *num_dynamic_file_list_entries =
2479 &artwork_info->num_dynamic_file_list_entries;
2480 struct PropertyMapping **property_mapping =
2481 &artwork_info->property_mapping;
2482 int *num_property_mapping_entries =
2483 &artwork_info->num_property_mapping_entries;
2484 int current_summarized_file_list_entry =
2485 artwork_info->num_file_list_entries +
2486 artwork_info->num_dynamic_file_list_entries;
2487 char *token = HASH_ITERATION_TOKEN(itr);
2488 int len_token = strlen(token);
2490 boolean base_prefix_found = FALSE;
2491 boolean parameter_suffix_found = FALSE;
2494 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2497 /* skip all parameter definitions (handled by read_token_parameters()) */
2498 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2500 int len_suffix = strlen(suffix_list[i].token);
2502 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2503 parameter_suffix_found = TRUE;
2506 if (parameter_suffix_found)
2509 /* ---------- step 0: search for matching base prefix ---------- */
2512 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2514 char *base_prefix = base_prefixes[i];
2515 int len_base_prefix = strlen(base_prefix);
2516 boolean ext1_suffix_found = FALSE;
2517 boolean ext2_suffix_found = FALSE;
2518 boolean ext3_suffix_found = FALSE;
2519 boolean exact_match = FALSE;
2520 int base_index = -1;
2521 int ext1_index = -1;
2522 int ext2_index = -1;
2523 int ext3_index = -1;
2525 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2527 if (!base_prefix_found)
2533 if (IS_PARENT_PROCESS())
2534 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2537 if (start_pos + len_base_prefix == len_token) /* exact match */
2542 if (IS_PARENT_PROCESS())
2543 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2546 add_dynamic_file_list_entry(dynamic_file_list,
2547 num_dynamic_file_list_entries,
2550 num_suffix_list_entries,
2552 add_property_mapping(property_mapping,
2553 num_property_mapping_entries,
2554 base_index, -1, -1, -1,
2555 current_summarized_file_list_entry);
2560 if (IS_PARENT_PROCESS())
2561 printf("---> examining token '%s': search 1st suffix ...\n", token);
2564 /* ---------- step 1: search for matching first suffix ---------- */
2566 start_pos += len_base_prefix;
2567 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2569 char *ext1_suffix = ext1_suffixes[j];
2570 int len_ext1_suffix = strlen(ext1_suffix);
2572 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2574 if (!ext1_suffix_found)
2580 if (IS_PARENT_PROCESS())
2581 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2584 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2589 if (IS_PARENT_PROCESS())
2590 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2593 add_dynamic_file_list_entry(dynamic_file_list,
2594 num_dynamic_file_list_entries,
2597 num_suffix_list_entries,
2599 add_property_mapping(property_mapping,
2600 num_property_mapping_entries,
2601 base_index, ext1_index, -1, -1,
2602 current_summarized_file_list_entry);
2606 start_pos += len_ext1_suffix;
2613 if (IS_PARENT_PROCESS())
2614 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2617 /* ---------- step 2: search for matching second suffix ---------- */
2619 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2621 char *ext2_suffix = ext2_suffixes[k];
2622 int len_ext2_suffix = strlen(ext2_suffix);
2624 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2626 if (!ext2_suffix_found)
2632 if (IS_PARENT_PROCESS())
2633 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2636 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2641 if (IS_PARENT_PROCESS())
2642 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2645 add_dynamic_file_list_entry(dynamic_file_list,
2646 num_dynamic_file_list_entries,
2649 num_suffix_list_entries,
2651 add_property_mapping(property_mapping,
2652 num_property_mapping_entries,
2653 base_index, ext1_index, ext2_index, -1,
2654 current_summarized_file_list_entry);
2658 start_pos += len_ext2_suffix;
2665 if (IS_PARENT_PROCESS())
2666 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2669 /* ---------- step 3: search for matching third suffix ---------- */
2671 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2673 char *ext3_suffix = ext3_suffixes[l];
2674 int len_ext3_suffix = strlen(ext3_suffix);
2676 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2678 if (!ext3_suffix_found)
2684 if (IS_PARENT_PROCESS())
2685 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2688 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2693 if (IS_PARENT_PROCESS())
2694 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2697 add_dynamic_file_list_entry(dynamic_file_list,
2698 num_dynamic_file_list_entries,
2701 num_suffix_list_entries,
2703 add_property_mapping(property_mapping,
2704 num_property_mapping_entries,
2705 base_index, ext1_index, ext2_index, ext3_index,
2706 current_summarized_file_list_entry);
2712 END_HASH_ITERATION(extra_file_hash, itr)
2714 if (artwork_info->num_dynamic_file_list_entries > 0)
2716 artwork_info->dynamic_artwork_list =
2717 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2718 artwork_info->sizeof_artwork_list_entry);
2721 if (options.verbose && IS_PARENT_PROCESS())
2723 SetupFileList *setup_file_list, *list;
2724 boolean dynamic_tokens_found = FALSE;
2725 boolean unknown_tokens_found = FALSE;
2726 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2728 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2729 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2731 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2733 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2734 dynamic_tokens_found = TRUE;
2736 unknown_tokens_found = TRUE;
2738 END_HASH_ITERATION(extra_file_hash, itr)
2740 if (options.debug && dynamic_tokens_found)
2742 Error(ERR_INFO_LINE, "-");
2743 Error(ERR_INFO, "dynamic token(s) found in config file:");
2744 Error(ERR_INFO, "- config file: '%s'", filename);
2746 for (list = setup_file_list; list != NULL; list = list->next)
2748 char *value = getHashEntry(extra_file_hash, list->token);
2750 if (value != NULL && strEqual(value, known_token_value))
2751 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2754 Error(ERR_INFO_LINE, "-");
2757 if (unknown_tokens_found)
2759 Error(ERR_INFO_LINE, "-");
2760 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2761 Error(ERR_INFO, "- config file: '%s'", filename);
2763 for (list = setup_file_list; list != NULL; list = list->next)
2765 char *value = getHashEntry(extra_file_hash, list->token);
2767 if (value != NULL && !strEqual(value, known_token_value))
2768 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2771 Error(ERR_INFO_LINE, "-");
2774 if (undefined_values_found)
2776 Error(ERR_INFO_LINE, "-");
2777 Error(ERR_INFO, "warning: undefined values found in config file:");
2778 Error(ERR_INFO, "- config file: '%s'", filename);
2780 for (list = setup_file_list; list != NULL; list = list->next)
2782 char *value = getHashEntry(empty_file_hash, list->token);
2785 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2788 Error(ERR_INFO_LINE, "-");
2791 freeSetupFileList(setup_file_list);
2794 freeSetupFileHash(extra_file_hash);
2795 freeSetupFileHash(empty_file_hash);
2798 for (i = 0; i < num_file_list_entries; i++)
2800 printf("'%s' ", file_list[i].token);
2801 if (file_list[i].filename)
2802 printf("-> '%s'\n", file_list[i].filename);
2804 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2809 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2811 struct FileInfo *file_list = artwork_info->file_list;
2812 int num_file_list_entries = artwork_info->num_file_list_entries;
2813 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2814 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2817 DrawInitText("Loading artwork config", 120, FC_GREEN);
2818 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2820 /* always start with reliable default values */
2821 for (i = 0; i < num_file_list_entries; i++)
2823 setString(&file_list[i].filename, file_list[i].default_filename);
2825 for (j = 0; j < num_suffix_list_entries; j++)
2826 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2828 file_list[i].redefined = FALSE;
2829 file_list[i].fallback_to_default = FALSE;
2832 /* free previous dynamic artwork file array */
2833 if (artwork_info->dynamic_file_list != NULL)
2835 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2837 free(artwork_info->dynamic_file_list[i].token);
2838 free(artwork_info->dynamic_file_list[i].filename);
2839 free(artwork_info->dynamic_file_list[i].parameter);
2842 free(artwork_info->dynamic_file_list);
2843 artwork_info->dynamic_file_list = NULL;
2845 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2846 &artwork_info->num_dynamic_file_list_entries);
2849 /* free previous property mapping */
2850 if (artwork_info->property_mapping != NULL)
2852 free(artwork_info->property_mapping);
2854 artwork_info->property_mapping = NULL;
2855 artwork_info->num_property_mapping_entries = 0;
2859 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2861 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2864 /* first look for special artwork configured in level series config */
2865 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2868 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2869 leveldir_current->graphics_set,
2870 leveldir_current->graphics_path);
2873 if (fileExists(filename_base))
2874 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2877 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2879 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2880 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2883 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2884 struct ListNodeInfo **listnode)
2888 char *filename = (*listnode)->source_filename;
2890 if (--(*listnode)->num_references <= 0)
2891 deleteNodeFromList(&artwork_info->content_list, filename,
2892 artwork_info->free_artwork);
2898 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2899 struct ListNodeInfo **listnode,
2900 struct FileInfo *file_list_entry)
2910 char *basename = file_list_entry->filename;
2911 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2913 if (filename == NULL)
2915 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2917 basename = file_list_entry->default_filename;
2919 /* fail for cloned default artwork that has no default filename defined */
2920 if (file_list_entry->default_is_cloned &&
2921 strEqual(basename, UNDEFINED_FILENAME))
2923 int error_mode = ERR_WARN;
2925 /* we can get away without sounds and music, but not without graphics */
2926 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2927 error_mode = ERR_EXIT;
2929 Error(error_mode, "token '%s' was cloned and has no default filename",
2930 file_list_entry->token);
2935 /* dynamic artwork has no default filename / skip empty default artwork */
2936 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2939 file_list_entry->fallback_to_default = TRUE;
2941 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2943 filename = getCustomArtworkFilename(basename, artwork_info->type);
2945 if (filename == NULL)
2947 int error_mode = ERR_WARN;
2949 /* we can get away without sounds and music, but not without graphics */
2950 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2951 error_mode = ERR_EXIT;
2953 Error(error_mode, "cannot find default artwork file '%s'", basename);
2959 /* check if the old and the new artwork file are the same */
2960 if (*listnode && strEqual((*listnode)->source_filename, filename))
2962 /* The old and new artwork are the same (have the same filename and path).
2963 This usually means that this artwork does not exist in this artwork set
2964 and a fallback to the existing artwork is done. */
2967 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2973 /* delete existing artwork file entry */
2974 deleteArtworkListEntry(artwork_info, listnode);
2976 /* check if the new artwork file already exists in the list of artworks */
2977 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2980 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2983 *listnode = (struct ListNodeInfo *)node->content;
2984 (*listnode)->num_references++;
2989 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2990 DrawInitText(basename, 150, FC_YELLOW);
2992 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2995 printf("[adding new artwork '%s']\n", filename);
2998 (*listnode)->num_references = 1;
2999 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3004 int error_mode = ERR_WARN;
3006 /* we can get away without sounds and music, but not without graphics */
3007 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3008 error_mode = ERR_EXIT;
3010 Error(error_mode, "cannot load artwork file '%s'", basename);
3016 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3017 struct ListNodeInfo **listnode,
3018 struct FileInfo *file_list_entry)
3021 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3024 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3026 deleteArtworkListEntry(artwork_info, listnode);
3030 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3033 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3035 struct FileInfo *file_list = artwork_info->file_list;
3036 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3037 int num_file_list_entries = artwork_info->num_file_list_entries;
3038 int num_dynamic_file_list_entries =
3039 artwork_info->num_dynamic_file_list_entries;
3042 for (i = 0; i < num_file_list_entries; i++)
3043 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3046 for (i = 0; i < num_dynamic_file_list_entries; i++)
3047 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3048 &dynamic_file_list[i]);
3051 dumpList(artwork_info->content_list);
3055 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3056 struct ListNodeInfo ***list,
3057 int *num_list_entries)
3064 for (i = 0; i < *num_list_entries; i++)
3065 deleteArtworkListEntry(artwork_info, &(*list)[i]);
3069 *num_list_entries = 0;
3072 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3074 if (artwork_info == NULL)
3077 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3078 &artwork_info->num_file_list_entries);
3080 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3081 &artwork_info->num_dynamic_file_list_entries);
3085 /* ------------------------------------------------------------------------- */
3086 /* functions only needed for non-Unix (non-command-line) systems */
3087 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
3088 /* (now also added for Windows, to create files in user data directory) */
3089 /* ------------------------------------------------------------------------- */
3091 char *getErrorFilename(char *basename)
3093 return getPath2(getUserGameDataDir(), basename);
3096 void openErrorFile()
3098 InitUserDataDirectory();
3100 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3101 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
3102 program.error_filename);
3105 void closeErrorFile()
3107 if (program.error_file != stderr) /* do not close stream 'stderr' */
3108 fclose(program.error_file);
3111 void dumpErrorFile()
3113 FILE *error_file = fopen(program.error_filename, MODE_READ);
3115 if (error_file != NULL)
3117 while (!feof(error_file))
3118 fputc(fgetc(error_file), stderr);
3124 void NotifyUserAboutErrorFile()
3126 #if defined(PLATFORM_WIN32)
3127 char *title_text = getStringCat2(program.program_title, " Error Message");
3128 char *error_text = getStringCat2("The program was aborted due to an error; "
3129 "for details, see the following error file:"
3130 STRING_NEWLINE, program.error_filename);
3132 MessageBox(NULL, error_text, title_text, MB_OK);
3137 /* ------------------------------------------------------------------------- */
3138 /* the following is only for debugging purpose and normally not used */
3139 /* ------------------------------------------------------------------------- */
3143 #define DEBUG_NUM_TIMESTAMPS 5
3144 #define DEBUG_TIME_IN_MICROSECONDS 0
3146 #if DEBUG_TIME_IN_MICROSECONDS
3147 static double Counter_Microseconds()
3149 static struct timeval base_time = { 0, 0 };
3150 struct timeval current_time;
3153 gettimeofday(¤t_time, NULL);
3155 /* reset base time in case of wrap-around */
3156 if (current_time.tv_sec < base_time.tv_sec)
3157 base_time = current_time;
3160 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
3161 ((double)(current_time.tv_usec - base_time.tv_usec));
3163 return counter; /* return microseconds since last init */
3167 char *debug_print_timestamp_get_padding(int padding_size)
3169 static char *padding = NULL;
3170 int max_padding_size = 100;
3172 if (padding == NULL)
3174 padding = checked_calloc(max_padding_size + 1);
3175 memset(padding, ' ', max_padding_size);
3178 return &padding[MAX(0, max_padding_size - padding_size)];
3181 void debug_print_timestamp(int counter_nr, char *message)
3183 int indent_size = 8;
3184 int padding_size = 40;
3185 float timestamp_interval;
3188 Error(ERR_EXIT, "debugging: invalid negative counter");
3189 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3190 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3192 #if DEBUG_TIME_IN_MICROSECONDS
3193 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3196 counter[counter_nr][0] = Counter_Microseconds();
3198 static int counter[DEBUG_NUM_TIMESTAMPS][2];
3201 counter[counter_nr][0] = Counter();
3204 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3205 counter[counter_nr][1] = counter[counter_nr][0];
3208 printf("%s%s%s %.3f %s\n",
3209 debug_print_timestamp_get_padding(counter_nr * indent_size),
3211 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3212 timestamp_interval / 1000,
3216 void debug_print_parent_only(char *format, ...)
3218 if (!IS_PARENT_PROCESS())
3225 va_start(ap, format);
3226 vprintf(format, ap);