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>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ========================================================================= */
37 /* some generic helper functions */
38 /* ========================================================================= */
40 /* ------------------------------------------------------------------------- */
41 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
46 char *newline = STRING_NEWLINE;
48 vfprintf(stream, format, ap);
50 fprintf(stream, "%s", newline);
53 static void fprintf_newline(FILE *stream, char *format, ...)
60 vfprintf_newline(stream, format, ap);
65 void fprintf_line(FILE *stream, char *line_chars, int line_length)
69 for (i = 0; i < line_length; i++)
70 fprintf(stream, "%s", line_chars);
72 fprintf_newline(stream, "");
75 void printf_line(char *line_chars, int line_length)
77 fprintf_line(stdout, line_chars, line_length);
80 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
82 fprintf(stdout, "%s", prefix);
83 fprintf_line(stdout, line_chars, line_length);
87 /* ------------------------------------------------------------------------- */
88 /* string functions */
89 /* ------------------------------------------------------------------------- */
91 /* int2str() returns a number converted to a string;
92 the used memory is static, but will be overwritten by later calls,
93 so if you want to save the result, copy it to a private string buffer;
94 there can be 10 local calls of int2str() without buffering the result --
95 the 11th call will then destroy the result from the first call and so on.
98 char *int2str(int number, int size)
100 static char shift_array[10][40];
101 static int shift_counter = 0;
102 char *s = shift_array[shift_counter];
104 shift_counter = (shift_counter + 1) % 10;
111 sprintf(s, " %09d", number);
112 return &s[strlen(s) - size];
116 sprintf(s, "%d", number);
122 /* something similar to "int2str()" above, but allocates its own memory
123 and has a different interface; we cannot use "itoa()", because this
124 seems to be already defined when cross-compiling to the win32 target */
126 char *i_to_a(unsigned int i)
128 static char *a = NULL;
132 if (i > 2147483647) /* yes, this is a kludge */
135 a = checked_malloc(10 + 1);
143 /* calculate base-2 logarithm of argument (rounded down to integer;
144 this function returns the number of the highest bit set in argument) */
146 int log_2(unsigned int x)
152 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
159 boolean getTokenValueFromString(char *string, char **token, char **value)
161 return getTokenValueFromSetupLine(string, token, value);
165 /* ------------------------------------------------------------------------- */
166 /* counter functions */
167 /* ------------------------------------------------------------------------- */
169 #if defined(PLATFORM_MSDOS)
170 volatile unsigned long counter = 0;
172 void increment_counter()
177 END_OF_FUNCTION(increment_counter);
181 /* maximal allowed length of a command line option */
182 #define MAX_OPTION_LEN 256
185 static unsigned long mainCounter(int mode)
187 static unsigned long base_ms = 0;
188 unsigned long current_ms;
189 unsigned long counter_ms;
191 current_ms = SDL_GetTicks();
193 /* reset base time in case of counter initializing or wrap-around */
194 if (mode == INIT_COUNTER || current_ms < base_ms)
195 base_ms = current_ms;
197 counter_ms = current_ms - base_ms;
199 return counter_ms; /* return milliseconds since last init */
202 #else /* !TARGET_SDL */
204 #if defined(PLATFORM_UNIX)
205 static unsigned long mainCounter(int mode)
207 static struct timeval base_time = { 0, 0 };
208 struct timeval current_time;
209 unsigned long counter_ms;
211 gettimeofday(¤t_time, NULL);
213 /* reset base time in case of counter initializing or wrap-around */
214 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
215 base_time = current_time;
217 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
218 + (current_time.tv_usec - base_time.tv_usec) / 1000;
220 return counter_ms; /* return milliseconds since last init */
222 #endif /* PLATFORM_UNIX */
223 #endif /* !TARGET_SDL */
225 void InitCounter() /* set counter back to zero */
227 #if !defined(PLATFORM_MSDOS)
228 mainCounter(INIT_COUNTER);
230 LOCK_VARIABLE(counter);
231 LOCK_FUNCTION(increment_counter);
232 install_int_ex(increment_counter, BPS_TO_TIMER(100));
236 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
238 #if !defined(PLATFORM_MSDOS)
239 return mainCounter(READ_COUNTER);
241 return (counter * 10);
245 static void sleep_milliseconds(unsigned long milliseconds_delay)
247 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
251 /* we want to wait only a few ms -- if we assume that we have a
252 kernel timer resolution of 10 ms, we would wait far to long;
253 therefore it's better to do a short interval of busy waiting
254 to get our sleeping time more accurate */
256 unsigned long base_counter = Counter(), actual_counter = Counter();
258 while (actual_counter < base_counter + milliseconds_delay &&
259 actual_counter >= base_counter)
260 actual_counter = Counter();
264 #if defined(TARGET_SDL)
265 SDL_Delay(milliseconds_delay);
266 #elif defined(TARGET_ALLEGRO)
267 rest(milliseconds_delay);
269 struct timeval delay;
271 delay.tv_sec = milliseconds_delay / 1000;
272 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
274 if (select(0, NULL, NULL, NULL, &delay) != 0)
275 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
280 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
282 sleep_milliseconds(delay);
285 boolean FrameReached(unsigned long *frame_counter_var,
286 unsigned long frame_delay)
288 unsigned long actual_frame_counter = FrameCounter;
290 if (actual_frame_counter >= *frame_counter_var &&
291 actual_frame_counter < *frame_counter_var + frame_delay)
294 *frame_counter_var = actual_frame_counter;
299 boolean DelayReached(unsigned long *counter_var,
302 unsigned long actual_counter = Counter();
304 if (actual_counter >= *counter_var &&
305 actual_counter < *counter_var + delay)
308 *counter_var = actual_counter;
313 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
315 unsigned long actual_counter;
319 actual_counter = Counter();
321 if (actual_counter >= *counter_var &&
322 actual_counter < *counter_var + delay)
323 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
328 *counter_var = actual_counter;
332 /* ------------------------------------------------------------------------- */
333 /* random generator functions */
334 /* ------------------------------------------------------------------------- */
336 unsigned int init_random_number(int nr, long seed)
338 if (seed == NEW_RANDOMIZE)
340 #if defined(TARGET_SDL)
341 seed = (long)SDL_GetTicks();
343 struct timeval current_time;
345 gettimeofday(¤t_time, NULL);
346 seed = (long)current_time.tv_usec;
350 srandom_linux_libc(nr, (unsigned int) seed);
352 return (unsigned int) seed;
355 unsigned int get_random_number(int nr, int max)
357 return (max > 0 ? random_linux_libc(nr) % max : 0);
361 /* ------------------------------------------------------------------------- */
362 /* system info functions */
363 /* ------------------------------------------------------------------------- */
365 #if !defined(PLATFORM_MSDOS)
366 static char *get_corrected_real_name(char *real_name)
368 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
369 char *from_ptr = real_name;
370 char *to_ptr = real_name_new;
372 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
373 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
375 /* the name field read from "passwd" file may also contain additional
376 user information, separated by commas, which will be removed here */
377 if (*from_ptr == ',')
380 /* the user's real name may contain 'ß' characters (german sharp s),
381 which have no equivalent in upper case letters (used by our fonts) */
382 if (*from_ptr == 'ß')
389 *to_ptr++ = *from_ptr++;
394 return real_name_new;
400 static char *login_name = NULL;
402 #if defined(PLATFORM_WIN32)
403 if (login_name == NULL)
405 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
406 login_name = checked_malloc(buffer_size);
408 if (GetUserName(login_name, &buffer_size) == 0)
409 strcpy(login_name, ANONYMOUS_NAME);
412 if (login_name == NULL)
416 if ((pwd = getpwuid(getuid())) == NULL)
417 login_name = ANONYMOUS_NAME;
419 login_name = getStringCopy(pwd->pw_name);
428 static char *real_name = NULL;
430 #if defined(PLATFORM_WIN32)
431 if (real_name == NULL)
433 static char buffer[MAX_USERNAME_LEN + 1];
434 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
436 if (GetUserName(buffer, &buffer_size) != 0)
437 real_name = get_corrected_real_name(buffer);
439 real_name = ANONYMOUS_NAME;
441 #elif defined(PLATFORM_UNIX)
442 if (real_name == NULL)
446 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
447 real_name = get_corrected_real_name(pwd->pw_gecos);
449 real_name = ANONYMOUS_NAME;
452 real_name = ANONYMOUS_NAME;
459 /* ------------------------------------------------------------------------- */
460 /* path manipulation functions */
461 /* ------------------------------------------------------------------------- */
463 static char *getLastPathSeparatorPtr(char *filename)
465 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
467 if (last_separator == NULL) /* also try DOS/Windows variant */
468 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
470 return last_separator;
473 char *getBaseNamePtr(char *filename)
475 char *last_separator = getLastPathSeparatorPtr(filename);
477 if (last_separator != NULL)
478 return last_separator + 1; /* separator found: strip base path */
480 return filename; /* no separator found: filename has no path */
483 char *getBaseName(char *filename)
485 return getStringCopy(getBaseNamePtr(filename));
488 char *getBasePath(char *filename)
490 char *basepath = getStringCopy(filename);
491 char *last_separator = getLastPathSeparatorPtr(basepath);
493 if (last_separator != NULL)
494 *last_separator = '\0'; /* separator found: strip basename */
496 basepath = "."; /* no separator found: use current path */
502 /* ------------------------------------------------------------------------- */
503 /* various string functions */
504 /* ------------------------------------------------------------------------- */
506 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
508 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
511 sprintf(complete_string, "%s%s%s", s1, sep, s2);
513 return complete_string;
516 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
518 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
519 strlen(s2) + strlen(sep) +
522 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
524 return complete_string;
527 char *getStringCat2(char *s1, char *s2)
529 return getStringCat2WithSeparator(s1, s2, "");
532 char *getStringCat3(char *s1, char *s2, char *s3)
534 return getStringCat3WithSeparator(s1, s2, s3, "");
537 char *getPath2(char *path1, char *path2)
539 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
542 char *getPath3(char *path1, char *path2, char *path3)
544 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
547 char *getStringCopy(char *s)
554 s_copy = checked_malloc(strlen(s) + 1);
560 char *getStringCopyN(char *s, int n)
563 int s_len = MAX(0, n);
568 s_copy = checked_malloc(s_len + 1);
569 strncpy(s_copy, s, s_len);
570 s_copy[s_len] = '\0';
575 char *getStringToLower(char *s)
577 char *s_copy = checked_malloc(strlen(s) + 1);
578 char *s_ptr = s_copy;
581 *s_ptr++ = tolower(*s++);
587 void setString(char **old_value, char *new_value)
589 checked_free(*old_value);
591 *old_value = getStringCopy(new_value);
594 boolean strEqual(char *s1, char *s2)
596 return (s1 == NULL && s2 == NULL ? TRUE :
597 s1 == NULL && s2 != NULL ? FALSE :
598 s1 != NULL && s2 == NULL ? FALSE :
599 strcmp(s1, s2) == 0);
602 boolean strEqualN(char *s1, char *s2, int n)
604 return (s1 == NULL && s2 == NULL ? TRUE :
605 s1 == NULL && s2 != NULL ? FALSE :
606 s1 != NULL && s2 == NULL ? FALSE :
607 strncmp(s1, s2, n) == 0);
610 boolean strPrefix(char *s, char *prefix)
612 return (s == NULL && prefix == NULL ? TRUE :
613 s == NULL && prefix != NULL ? FALSE :
614 s != NULL && prefix == NULL ? FALSE :
615 strncmp(s, prefix, strlen(prefix)) == 0);
618 boolean strSuffix(char *s, char *suffix)
620 return (s == NULL && suffix == NULL ? TRUE :
621 s == NULL && suffix != NULL ? FALSE :
622 s != NULL && suffix == NULL ? FALSE :
623 strlen(s) < strlen(suffix) ? FALSE :
624 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
628 /* ------------------------------------------------------------------------- */
629 /* command line option handling functions */
630 /* ------------------------------------------------------------------------- */
632 void GetOptions(char *argv[], void (*print_usage_function)(void))
634 char *ro_base_path = RO_BASE_PATH;
635 char *rw_base_path = RW_BASE_PATH;
636 char **options_left = &argv[1];
638 #if !defined(PLATFORM_MACOSX)
639 /* if the program is configured to start from current directory (default),
640 determine program package directory (KDE/Konqueror does not do this by
641 itself and fails otherwise); on Mac OS X, the program binary is stored
642 in an application package directory -- do not try to use this directory
643 as the program data directory (Mac OS X handles this correctly anyway) */
645 if (strEqual(ro_base_path, "."))
646 ro_base_path = program.command_basepath;
647 if (strEqual(rw_base_path, "."))
648 rw_base_path = program.command_basepath;
651 /* initialize global program options */
652 options.display_name = NULL;
653 options.server_host = NULL;
654 options.server_port = 0;
655 options.ro_base_directory = ro_base_path;
656 options.rw_base_directory = rw_base_path;
657 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
658 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
659 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
660 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
661 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
662 options.execute_command = NULL;
663 options.serveronly = FALSE;
664 options.network = FALSE;
665 options.verbose = FALSE;
666 options.debug = FALSE;
668 #if !defined(PLATFORM_UNIX)
669 if (*options_left == NULL) /* no options given -- enable verbose mode */
670 options.verbose = TRUE;
673 while (*options_left)
675 char option_str[MAX_OPTION_LEN];
676 char *option = options_left[0];
677 char *next_option = options_left[1];
678 char *option_arg = NULL;
679 int option_len = strlen(option);
681 if (option_len >= MAX_OPTION_LEN)
682 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
684 strcpy(option_str, option); /* copy argument into buffer */
687 if (strEqual(option, "--")) /* stop scanning arguments */
690 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
693 option_arg = strchr(option, '=');
694 if (option_arg == NULL) /* no '=' in option */
695 option_arg = next_option;
698 *option_arg++ = '\0'; /* cut argument from option */
699 if (*option_arg == '\0') /* no argument after '=' */
700 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
703 option_len = strlen(option);
705 if (strEqual(option, "-"))
706 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
707 else if (strncmp(option, "-help", option_len) == 0)
709 print_usage_function();
713 else if (strncmp(option, "-display", option_len) == 0)
715 if (option_arg == NULL)
716 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
718 options.display_name = option_arg;
719 if (option_arg == next_option)
722 else if (strncmp(option, "-basepath", option_len) == 0)
724 if (option_arg == NULL)
725 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
727 /* this should be extended to separate options for ro and rw data */
728 options.ro_base_directory = ro_base_path = option_arg;
729 options.rw_base_directory = rw_base_path = option_arg;
730 if (option_arg == next_option)
733 /* adjust paths for sub-directories in base directory accordingly */
734 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
735 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
736 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
737 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
738 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
740 else if (strncmp(option, "-levels", option_len) == 0)
742 if (option_arg == NULL)
743 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
745 options.level_directory = option_arg;
746 if (option_arg == next_option)
749 else if (strncmp(option, "-graphics", option_len) == 0)
751 if (option_arg == NULL)
752 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
754 options.graphics_directory = option_arg;
755 if (option_arg == next_option)
758 else if (strncmp(option, "-sounds", option_len) == 0)
760 if (option_arg == NULL)
761 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
763 options.sounds_directory = option_arg;
764 if (option_arg == next_option)
767 else if (strncmp(option, "-music", option_len) == 0)
769 if (option_arg == NULL)
770 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
772 options.music_directory = option_arg;
773 if (option_arg == next_option)
776 else if (strncmp(option, "-network", option_len) == 0)
778 options.network = TRUE;
780 else if (strncmp(option, "-serveronly", option_len) == 0)
782 options.serveronly = TRUE;
784 else if (strncmp(option, "-verbose", option_len) == 0)
786 options.verbose = TRUE;
788 else if (strncmp(option, "-debug", option_len) == 0)
790 options.debug = TRUE;
792 else if (strncmp(option, "-execute", option_len) == 0)
794 if (option_arg == NULL)
795 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
797 options.execute_command = option_arg;
798 if (option_arg == next_option)
801 /* when doing batch processing, always enable verbose mode (warnings) */
802 options.verbose = TRUE;
804 else if (*option == '-')
806 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
808 else if (options.server_host == NULL)
810 options.server_host = *options_left;
812 else if (options.server_port == 0)
814 options.server_port = atoi(*options_left);
815 if (options.server_port < 1024)
816 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
819 Error(ERR_EXIT_HELP, "too many arguments");
826 /* ------------------------------------------------------------------------- */
827 /* error handling functions */
828 /* ------------------------------------------------------------------------- */
830 /* used by SetError() and GetError() to store internal error messages */
831 static char internal_error[1024]; /* this is bad */
833 void SetError(char *format, ...)
837 va_start(ap, format);
838 vsprintf(internal_error, format, ap);
844 return internal_error;
847 void Error(int mode, char *format, ...)
849 static boolean last_line_was_separator = FALSE;
850 char *process_name = "";
852 /* display warnings only when running in verbose mode */
853 if (mode & ERR_WARN && !options.verbose)
856 if (mode == ERR_INFO_LINE)
858 if (!last_line_was_separator)
859 fprintf_line(program.error_file, format, 79);
861 last_line_was_separator = TRUE;
866 last_line_was_separator = FALSE;
868 if (mode & ERR_SOUND_SERVER)
869 process_name = " sound server";
870 else if (mode & ERR_NETWORK_SERVER)
871 process_name = " network server";
872 else if (mode & ERR_NETWORK_CLIENT)
873 process_name = " network client **";
879 fprintf(program.error_file, "%s%s: ", program.command_basename,
883 fprintf(program.error_file, "warning: ");
885 va_start(ap, format);
886 vfprintf_newline(program.error_file, format, ap);
891 fprintf_newline(program.error_file,
892 "%s: Try option '--help' for more information.",
893 program.command_basename);
896 fprintf_newline(program.error_file, "%s%s: aborting",
897 program.command_basename, process_name);
901 if (mode & ERR_FROM_SERVER)
902 exit(1); /* child process: normal exit */
904 program.exit_function(1); /* main process: clean up stuff */
909 /* ------------------------------------------------------------------------- */
910 /* checked memory allocation and freeing functions */
911 /* ------------------------------------------------------------------------- */
913 void *checked_malloc(unsigned long size)
920 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
925 void *checked_calloc(unsigned long size)
929 ptr = calloc(1, size);
932 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
937 void *checked_realloc(void *ptr, unsigned long size)
939 ptr = realloc(ptr, size);
942 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
947 void checked_free(void *ptr)
949 if (ptr != NULL) /* this check should be done by free() anyway */
953 void clear_mem(void *ptr, unsigned long size)
955 #if defined(PLATFORM_WIN32)
956 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
957 char *cptr = (char *)ptr;
962 memset(ptr, 0, size);
967 /* ------------------------------------------------------------------------- */
968 /* various helper functions */
969 /* ------------------------------------------------------------------------- */
971 inline void swap_numbers(int *i1, int *i2)
979 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
991 /* the "put" variants of the following file access functions check for the file
992 pointer being != NULL and return the number of bytes they have or would have
993 written; this allows for chunk writing functions to first determine the size
994 of the (not yet written) chunk, write the correct chunk size and finally
995 write the chunk itself */
997 int getFile8BitInteger(FILE *file)
1002 int putFile8BitInteger(FILE *file, int value)
1010 int getFile16BitInteger(FILE *file, int byte_order)
1012 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1013 return ((fgetc(file) << 8) |
1014 (fgetc(file) << 0));
1015 else /* BYTE_ORDER_LITTLE_ENDIAN */
1016 return ((fgetc(file) << 0) |
1017 (fgetc(file) << 8));
1020 int putFile16BitInteger(FILE *file, int value, int byte_order)
1024 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1026 fputc((value >> 8) & 0xff, file);
1027 fputc((value >> 0) & 0xff, file);
1029 else /* BYTE_ORDER_LITTLE_ENDIAN */
1031 fputc((value >> 0) & 0xff, file);
1032 fputc((value >> 8) & 0xff, file);
1039 int getFile32BitInteger(FILE *file, int byte_order)
1041 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1042 return ((fgetc(file) << 24) |
1043 (fgetc(file) << 16) |
1044 (fgetc(file) << 8) |
1045 (fgetc(file) << 0));
1046 else /* BYTE_ORDER_LITTLE_ENDIAN */
1047 return ((fgetc(file) << 0) |
1048 (fgetc(file) << 8) |
1049 (fgetc(file) << 16) |
1050 (fgetc(file) << 24));
1053 int putFile32BitInteger(FILE *file, int value, int byte_order)
1057 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1059 fputc((value >> 24) & 0xff, file);
1060 fputc((value >> 16) & 0xff, file);
1061 fputc((value >> 8) & 0xff, file);
1062 fputc((value >> 0) & 0xff, file);
1064 else /* BYTE_ORDER_LITTLE_ENDIAN */
1066 fputc((value >> 0) & 0xff, file);
1067 fputc((value >> 8) & 0xff, file);
1068 fputc((value >> 16) & 0xff, file);
1069 fputc((value >> 24) & 0xff, file);
1076 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1079 const int chunk_name_length = 4;
1081 /* read chunk name */
1082 fgets(chunk_name, chunk_name_length + 1, file);
1084 if (chunk_size != NULL)
1086 /* read chunk size */
1087 *chunk_size = getFile32BitInteger(file, byte_order);
1090 return (feof(file) || ferror(file) ? FALSE : TRUE);
1093 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1098 /* write chunk name */
1100 fputs(chunk_name, file);
1102 num_bytes += strlen(chunk_name);
1104 if (chunk_size >= 0)
1106 /* write chunk size */
1108 putFile32BitInteger(file, chunk_size, byte_order);
1116 int getFileVersion(FILE *file)
1118 int version_major = fgetc(file);
1119 int version_minor = fgetc(file);
1120 int version_patch = fgetc(file);
1121 int version_build = fgetc(file);
1123 return VERSION_IDENT(version_major, version_minor, version_patch,
1127 int putFileVersion(FILE *file, int version)
1131 int version_major = VERSION_MAJOR(version);
1132 int version_minor = VERSION_MINOR(version);
1133 int version_patch = VERSION_PATCH(version);
1134 int version_build = VERSION_BUILD(version);
1136 fputc(version_major, file);
1137 fputc(version_minor, file);
1138 fputc(version_patch, file);
1139 fputc(version_build, file);
1145 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1149 for(i = 0; i < bytes && !feof(file); i++)
1150 buffer[i] = fgetc(file);
1153 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1157 for(i = 0; i < bytes; i++)
1158 fputc(buffer[i], file);
1161 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1163 while (bytes-- && !feof(file))
1167 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1174 /* ------------------------------------------------------------------------- */
1175 /* functions to translate key identifiers between different format */
1176 /* ------------------------------------------------------------------------- */
1178 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1179 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1180 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1181 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1183 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1192 /* normal cursor keys */
1193 { KSYM_Left, "XK_Left", "cursor left" },
1194 { KSYM_Right, "XK_Right", "cursor right" },
1195 { KSYM_Up, "XK_Up", "cursor up" },
1196 { KSYM_Down, "XK_Down", "cursor down" },
1198 /* keypad cursor keys */
1200 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1201 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1202 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1203 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1206 /* other keypad keys */
1207 #ifdef KSYM_KP_Enter
1208 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1209 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1210 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1211 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1212 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1213 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1217 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1218 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1219 { KSYM_Control_L, "XK_Control_L", "left control" },
1220 { KSYM_Control_R, "XK_Control_R", "right control" },
1221 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1222 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1223 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1224 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1225 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1226 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1227 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1228 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1230 /* some special keys */
1231 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1232 { KSYM_Delete, "XK_Delete", "delete" },
1233 { KSYM_Insert, "XK_Insert", "insert" },
1234 { KSYM_Tab, "XK_Tab", "tab" },
1235 { KSYM_Home, "XK_Home", "home" },
1236 { KSYM_End, "XK_End", "end" },
1237 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1238 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1239 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1241 /* ASCII 0x20 to 0x40 keys (except numbers) */
1242 { KSYM_space, "XK_space", "space" },
1243 { KSYM_exclam, "XK_exclam", "!" },
1244 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1245 { KSYM_numbersign, "XK_numbersign", "#" },
1246 { KSYM_dollar, "XK_dollar", "$" },
1247 { KSYM_percent, "XK_percent", "%" },
1248 { KSYM_ampersand, "XK_ampersand", "&" },
1249 { KSYM_apostrophe, "XK_apostrophe", "'" },
1250 { KSYM_parenleft, "XK_parenleft", "(" },
1251 { KSYM_parenright, "XK_parenright", ")" },
1252 { KSYM_asterisk, "XK_asterisk", "*" },
1253 { KSYM_plus, "XK_plus", "+" },
1254 { KSYM_comma, "XK_comma", "," },
1255 { KSYM_minus, "XK_minus", "-" },
1256 { KSYM_period, "XK_period", "." },
1257 { KSYM_slash, "XK_slash", "/" },
1258 { KSYM_colon, "XK_colon", ":" },
1259 { KSYM_semicolon, "XK_semicolon", ";" },
1260 { KSYM_less, "XK_less", "<" },
1261 { KSYM_equal, "XK_equal", "=" },
1262 { KSYM_greater, "XK_greater", ">" },
1263 { KSYM_question, "XK_question", "?" },
1264 { KSYM_at, "XK_at", "@" },
1266 /* more ASCII keys */
1267 { KSYM_bracketleft, "XK_bracketleft", "[" },
1268 { KSYM_backslash, "XK_backslash", "\\" },
1269 { KSYM_bracketright,"XK_bracketright", "]" },
1270 { KSYM_asciicircum, "XK_asciicircum", "^" },
1271 { KSYM_underscore, "XK_underscore", "_" },
1272 { KSYM_grave, "XK_grave", "grave" },
1273 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1274 { KSYM_braceleft, "XK_braceleft", "brace left" },
1275 { KSYM_bar, "XK_bar", "bar" },
1276 { KSYM_braceright, "XK_braceright", "brace right" },
1277 { KSYM_asciitilde, "XK_asciitilde", "~" },
1279 /* special (non-ASCII) keys */
1280 { KSYM_degree, "XK_degree", "°" },
1281 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1282 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1283 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1284 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1285 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1286 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1287 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1289 /* end-of-array identifier */
1295 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1297 static char name_buffer[30];
1300 if (key >= KSYM_A && key <= KSYM_Z)
1301 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1302 else if (key >= KSYM_a && key <= KSYM_z)
1303 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1304 else if (key >= KSYM_0 && key <= KSYM_9)
1305 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1306 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1307 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1308 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1309 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1310 else if (key == KSYM_UNDEFINED)
1311 strcpy(name_buffer, "(undefined)");
1318 if (key == translate_key[i].key)
1320 strcpy(name_buffer, translate_key[i].name);
1324 while (translate_key[++i].name);
1326 if (!translate_key[i].name)
1327 strcpy(name_buffer, "(unknown)");
1330 *name = name_buffer;
1332 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1334 static char name_buffer[30];
1337 if (key >= KSYM_A && key <= KSYM_Z)
1338 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1339 else if (key >= KSYM_a && key <= KSYM_z)
1340 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1341 else if (key >= KSYM_0 && key <= KSYM_9)
1342 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1343 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1344 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1345 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1346 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1347 else if (key == KSYM_UNDEFINED)
1348 strcpy(name_buffer, "[undefined]");
1355 if (key == translate_key[i].key)
1357 strcpy(name_buffer, translate_key[i].x11name);
1361 while (translate_key[++i].x11name);
1363 if (!translate_key[i].x11name)
1364 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1367 *x11name = name_buffer;
1369 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1371 Key key = KSYM_UNDEFINED;
1376 if (strEqual(translate_key[i].name, *name))
1378 key = translate_key[i].key;
1382 while (translate_key[++i].x11name);
1384 if (key == KSYM_UNDEFINED)
1385 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1389 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1391 Key key = KSYM_UNDEFINED;
1392 char *name_ptr = *x11name;
1394 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1396 char c = name_ptr[3];
1398 if (c >= 'A' && c <= 'Z')
1399 key = KSYM_A + (Key)(c - 'A');
1400 else if (c >= 'a' && c <= 'z')
1401 key = KSYM_a + (Key)(c - 'a');
1402 else if (c >= '0' && c <= '9')
1403 key = KSYM_0 + (Key)(c - '0');
1405 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1407 char c = name_ptr[6];
1409 if (c >= '0' && c <= '9')
1410 key = KSYM_KP_0 + (Key)(c - '0');
1412 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1414 char c1 = name_ptr[4];
1415 char c2 = name_ptr[5];
1418 if ((c1 >= '0' && c1 <= '9') &&
1419 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1420 d = atoi(&name_ptr[4]);
1422 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1423 key = KSYM_F1 + (Key)(d - 1);
1425 else if (strncmp(name_ptr, "XK_", 3) == 0)
1431 if (strEqual(name_ptr, translate_key[i].x11name))
1433 key = translate_key[i].key;
1437 while (translate_key[++i].x11name);
1439 else if (strncmp(name_ptr, "0x", 2) == 0)
1441 unsigned long value = 0;
1447 char c = *name_ptr++;
1450 if (c >= '0' && c <= '9')
1452 else if (c >= 'a' && c <= 'f')
1453 d = (int)(c - 'a' + 10);
1454 else if (c >= 'A' && c <= 'F')
1455 d = (int)(c - 'A' + 10);
1463 value = value * 16 + d;
1474 char *getKeyNameFromKey(Key key)
1478 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1482 char *getX11KeyNameFromKey(Key key)
1486 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1490 Key getKeyFromKeyName(char *name)
1494 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1498 Key getKeyFromX11KeyName(char *x11name)
1502 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1506 char getCharFromKey(Key key)
1508 char *keyname = getKeyNameFromKey(key);
1511 if (strlen(keyname) == 1)
1513 else if (strEqual(keyname, "space"))
1519 char getValidConfigValueChar(char c)
1521 if (c == '#' || /* used to mark comments */
1522 c == '\\') /* used to mark continued lines */
1529 /* ------------------------------------------------------------------------- */
1530 /* functions to translate string identifiers to integer or boolean value */
1531 /* ------------------------------------------------------------------------- */
1533 int get_integer_from_string(char *s)
1535 static char *number_text[][3] =
1537 { "0", "zero", "null", },
1538 { "1", "one", "first" },
1539 { "2", "two", "second" },
1540 { "3", "three", "third" },
1541 { "4", "four", "fourth" },
1542 { "5", "five", "fifth" },
1543 { "6", "six", "sixth" },
1544 { "7", "seven", "seventh" },
1545 { "8", "eight", "eighth" },
1546 { "9", "nine", "ninth" },
1547 { "10", "ten", "tenth" },
1548 { "11", "eleven", "eleventh" },
1549 { "12", "twelve", "twelfth" },
1551 { NULL, NULL, NULL },
1555 char *s_lower = getStringToLower(s);
1558 for (i = 0; number_text[i][0] != NULL; i++)
1559 for (j = 0; j < 3; j++)
1560 if (strEqual(s_lower, number_text[i][j]))
1565 if (strEqual(s_lower, "false") ||
1566 strEqual(s_lower, "no") ||
1567 strEqual(s_lower, "off"))
1569 else if (strEqual(s_lower, "true") ||
1570 strEqual(s_lower, "yes") ||
1571 strEqual(s_lower, "on"))
1582 boolean get_boolean_from_string(char *s)
1584 char *s_lower = getStringToLower(s);
1585 boolean result = FALSE;
1587 if (strEqual(s_lower, "true") ||
1588 strEqual(s_lower, "yes") ||
1589 strEqual(s_lower, "on") ||
1590 get_integer_from_string(s) == 1)
1599 /* ------------------------------------------------------------------------- */
1600 /* functions for generic lists */
1601 /* ------------------------------------------------------------------------- */
1603 ListNode *newListNode()
1605 return checked_calloc(sizeof(ListNode));
1608 void addNodeToList(ListNode **node_first, char *key, void *content)
1610 ListNode *node_new = newListNode();
1612 node_new->key = getStringCopy(key);
1613 node_new->content = content;
1614 node_new->next = *node_first;
1615 *node_first = node_new;
1618 void deleteNodeFromList(ListNode **node_first, char *key,
1619 void (*destructor_function)(void *))
1621 if (node_first == NULL || *node_first == NULL)
1624 if (strEqual((*node_first)->key, key))
1626 checked_free((*node_first)->key);
1627 if (destructor_function)
1628 destructor_function((*node_first)->content);
1629 *node_first = (*node_first)->next;
1632 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1635 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1637 if (node_first == NULL)
1640 if (strEqual(node_first->key, key))
1643 return getNodeFromKey(node_first->next, key);
1646 int getNumNodes(ListNode *node_first)
1648 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1651 void dumpList(ListNode *node_first)
1653 ListNode *node = node_first;
1657 printf("['%s' (%d)]\n", node->key,
1658 ((struct ListNodeInfo *)node->content)->num_references);
1662 printf("[%d nodes]\n", getNumNodes(node_first));
1666 /* ------------------------------------------------------------------------- */
1667 /* functions for checking files and filenames */
1668 /* ------------------------------------------------------------------------- */
1670 boolean fileExists(char *filename)
1672 if (filename == NULL)
1675 return (access(filename, F_OK) == 0);
1678 boolean fileHasPrefix(char *basename, char *prefix)
1680 static char *basename_lower = NULL;
1681 int basename_length, prefix_length;
1683 checked_free(basename_lower);
1685 if (basename == NULL || prefix == NULL)
1688 basename_lower = getStringToLower(basename);
1689 basename_length = strlen(basename_lower);
1690 prefix_length = strlen(prefix);
1692 if (basename_length > prefix_length + 1 &&
1693 basename_lower[prefix_length] == '.' &&
1694 strncmp(basename_lower, prefix, prefix_length) == 0)
1700 boolean fileHasSuffix(char *basename, char *suffix)
1702 static char *basename_lower = NULL;
1703 int basename_length, suffix_length;
1705 checked_free(basename_lower);
1707 if (basename == NULL || suffix == NULL)
1710 basename_lower = getStringToLower(basename);
1711 basename_length = strlen(basename_lower);
1712 suffix_length = strlen(suffix);
1714 if (basename_length > suffix_length + 1 &&
1715 basename_lower[basename_length - suffix_length - 1] == '.' &&
1716 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1722 boolean FileIsGraphic(char *filename)
1724 char *basename = getBaseNamePtr(filename);
1726 return fileHasSuffix(basename, "pcx");
1729 boolean FileIsSound(char *filename)
1731 char *basename = getBaseNamePtr(filename);
1733 return fileHasSuffix(basename, "wav");
1736 boolean FileIsMusic(char *filename)
1738 char *basename = getBaseNamePtr(filename);
1740 if (FileIsSound(basename))
1743 #if defined(TARGET_SDL)
1744 if (fileHasPrefix(basename, "mod") ||
1745 fileHasSuffix(basename, "mod") ||
1746 fileHasSuffix(basename, "s3m") ||
1747 fileHasSuffix(basename, "it") ||
1748 fileHasSuffix(basename, "xm") ||
1749 fileHasSuffix(basename, "midi") ||
1750 fileHasSuffix(basename, "mid") ||
1751 fileHasSuffix(basename, "mp3") ||
1752 fileHasSuffix(basename, "ogg"))
1759 boolean FileIsArtworkType(char *basename, int type)
1761 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1762 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1763 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1769 /* ------------------------------------------------------------------------- */
1770 /* functions for loading artwork configuration information */
1771 /* ------------------------------------------------------------------------- */
1773 char *get_mapped_token(char *token)
1775 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1776 static char *map_token_prefix[][2] =
1778 { "char_procent", "char_percent" },
1783 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1785 int len_token_prefix = strlen(map_token_prefix[i][0]);
1787 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1788 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1794 /* This function checks if a string <s> of the format "string1, string2, ..."
1795 exactly contains a string <s_contained>. */
1797 static boolean string_has_parameter(char *s, char *s_contained)
1801 if (s == NULL || s_contained == NULL)
1804 if (strlen(s_contained) > strlen(s))
1807 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1809 char next_char = s[strlen(s_contained)];
1811 /* check if next character is delimiter or whitespace */
1812 return (next_char == ',' || next_char == '\0' ||
1813 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1816 /* check if string contains another parameter string after a comma */
1817 substring = strchr(s, ',');
1818 if (substring == NULL) /* string does not contain a comma */
1821 /* advance string pointer to next character after the comma */
1824 /* skip potential whitespaces after the comma */
1825 while (*substring == ' ' || *substring == '\t')
1828 return string_has_parameter(substring, s_contained);
1831 int get_parameter_value(char *value_raw, char *suffix, int type)
1833 char *value = getStringToLower(value_raw);
1834 int result = 0; /* probably a save default value */
1836 if (strEqual(suffix, ".direction"))
1838 result = (strEqual(value, "left") ? MV_LEFT :
1839 strEqual(value, "right") ? MV_RIGHT :
1840 strEqual(value, "up") ? MV_UP :
1841 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1843 else if (strEqual(suffix, ".align"))
1845 result = (strEqual(value, "left") ? ALIGN_LEFT :
1846 strEqual(value, "right") ? ALIGN_RIGHT :
1847 strEqual(value, "center") ? ALIGN_CENTER :
1848 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1850 else if (strEqual(suffix, ".valign"))
1852 result = (strEqual(value, "top") ? VALIGN_TOP :
1853 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1854 strEqual(value, "middle") ? VALIGN_MIDDLE :
1855 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1857 else if (strEqual(suffix, ".anim_mode"))
1859 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1860 string_has_parameter(value, "loop") ? ANIM_LOOP :
1861 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1862 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1863 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1864 string_has_parameter(value, "random") ? ANIM_RANDOM :
1865 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1866 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1867 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1868 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1869 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1870 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1873 if (string_has_parameter(value, "reverse"))
1874 result |= ANIM_REVERSE;
1876 if (string_has_parameter(value, "opaque_player"))
1877 result |= ANIM_OPAQUE_PLAYER;
1879 if (string_has_parameter(value, "static_panel"))
1880 result |= ANIM_STATIC_PANEL;
1882 else if (strEqual(suffix, ".fade_mode"))
1884 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
1885 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
1886 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
1887 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
1891 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
1893 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
1896 result = gfx.get_font_from_token_function(value);
1898 else /* generic parameter of type integer or boolean */
1900 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1901 type == TYPE_INTEGER ? get_integer_from_string(value) :
1902 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1903 ARG_UNDEFINED_VALUE);
1911 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1913 static struct ScreenModeInfo screen_mode;
1914 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1915 char *screen_mode_string_copy;
1916 char *screen_mode_string_pos_w;
1917 char *screen_mode_string_pos_h;
1919 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1922 screen_mode_string_copy = getStringCopy(screen_mode_string);
1924 screen_mode_string_pos_w = screen_mode_string_copy;
1925 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1926 *screen_mode_string_pos_h++ = '\0';
1928 screen_mode.width = atoi(screen_mode_string_pos_w);
1929 screen_mode.height = atoi(screen_mode_string_pos_h);
1931 return &screen_mode;
1934 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1937 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1938 float aspect_ratio_new;
1943 *x = i * aspect_ratio + 0.000001;
1946 aspect_ratio_new = (float)*x / (float)*y;
1950 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1953 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1954 struct ListNodeInfo ***, int *);
1956 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1957 struct ConfigTypeInfo *suffix_list,
1958 char **ignore_tokens,
1959 int num_file_list_entries)
1961 struct FileInfo *file_list;
1962 int num_file_list_entries_found = 0;
1963 int num_suffix_list_entries = 0;
1967 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1969 for (i = 0; suffix_list[i].token != NULL; i++)
1970 num_suffix_list_entries++;
1972 /* always start with reliable default values */
1973 for (i = 0; i < num_file_list_entries; i++)
1975 file_list[i].token = NULL;
1977 file_list[i].default_filename = NULL;
1978 file_list[i].filename = NULL;
1980 if (num_suffix_list_entries > 0)
1982 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1984 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1985 file_list[i].parameter = checked_calloc(parameter_array_size);
1987 for (j = 0; j < num_suffix_list_entries; j++)
1989 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1990 setString(&file_list[i].parameter[j], suffix_list[j].value);
1993 file_list[i].redefined = FALSE;
1994 file_list[i].fallback_to_default = FALSE;
1995 file_list[i].default_is_cloned = FALSE;
2000 for (i = 0; config_list[i].token != NULL; i++)
2002 int len_config_token = strlen(config_list[i].token);
2003 int len_config_value = strlen(config_list[i].value);
2004 boolean is_file_entry = TRUE;
2006 for (j = 0; suffix_list[j].token != NULL; j++)
2008 int len_suffix = strlen(suffix_list[j].token);
2010 if (len_suffix < len_config_token &&
2011 strEqual(&config_list[i].token[len_config_token - len_suffix],
2012 suffix_list[j].token))
2014 setString(&file_list[list_pos].default_parameter[j],
2015 config_list[i].value);
2017 is_file_entry = FALSE;
2022 /* the following tokens are no file definitions, but other config tokens */
2023 for (j = 0; ignore_tokens[j] != NULL; j++)
2024 if (strEqual(config_list[i].token, ignore_tokens[j]))
2025 is_file_entry = FALSE;
2032 if (list_pos >= num_file_list_entries)
2035 /* simple sanity check if this is really a file definition */
2036 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2037 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2038 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2040 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2041 config_list[i].token, config_list[i].value);
2042 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2045 file_list[list_pos].token = config_list[i].token;
2046 file_list[list_pos].default_filename = config_list[i].value;
2049 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2053 if (strSuffix(config_list[i].token, ".clone_from"))
2054 file_list[list_pos].default_is_cloned = TRUE;
2057 num_file_list_entries_found = list_pos + 1;
2058 if (num_file_list_entries_found != num_file_list_entries)
2060 Error(ERR_INFO_LINE, "-");
2061 Error(ERR_INFO, "inconsistant config list information:");
2062 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2063 num_file_list_entries);
2064 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2065 num_file_list_entries_found);
2066 Error(ERR_EXIT, "please fix");
2070 printf("::: ---------- DONE ----------\n");
2076 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2078 int len_token = strlen(token);
2079 int len_suffix = strlen(suffix);
2081 if (start_pos < 0) /* compare suffix from end of string */
2082 start_pos += len_token;
2084 if (start_pos < 0 || start_pos + len_suffix > len_token)
2087 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2090 if (token[start_pos + len_suffix] == '\0')
2093 if (token[start_pos + len_suffix] == '.')
2099 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2101 static void read_token_parameters(SetupFileHash *setup_file_hash,
2102 struct ConfigTypeInfo *suffix_list,
2103 struct FileInfo *file_list_entry)
2105 /* check for config token that is the base token without any suffixes */
2106 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2107 char *known_token_value = KNOWN_TOKEN_VALUE;
2110 if (filename != NULL)
2112 setString(&file_list_entry->filename, filename);
2114 /* when file definition found, set all parameters to default values */
2115 for (i = 0; suffix_list[i].token != NULL; i++)
2116 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2118 file_list_entry->redefined = TRUE;
2120 /* mark config file token as well known from default config */
2121 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2124 /* check for config tokens that can be build by base token and suffixes */
2125 for (i = 0; suffix_list[i].token != NULL; i++)
2127 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2128 char *value = getHashEntry(setup_file_hash, token);
2132 setString(&file_list_entry->parameter[i], value);
2134 /* mark config file token as well known from default config */
2135 setHashEntry(setup_file_hash, token, known_token_value);
2142 static void add_dynamic_file_list_entry(struct FileInfo **list,
2143 int *num_list_entries,
2144 SetupFileHash *extra_file_hash,
2145 struct ConfigTypeInfo *suffix_list,
2146 int num_suffix_list_entries,
2149 struct FileInfo *new_list_entry;
2150 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2152 (*num_list_entries)++;
2153 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2154 new_list_entry = &(*list)[*num_list_entries - 1];
2156 new_list_entry->token = getStringCopy(token);
2157 new_list_entry->default_filename = NULL;
2158 new_list_entry->filename = NULL;
2159 new_list_entry->parameter = checked_calloc(parameter_array_size);
2161 new_list_entry->redefined = FALSE;
2162 new_list_entry->fallback_to_default = FALSE;
2163 new_list_entry->default_is_cloned = FALSE;
2165 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2168 static void add_property_mapping(struct PropertyMapping **list,
2169 int *num_list_entries,
2170 int base_index, int ext1_index,
2171 int ext2_index, int ext3_index,
2174 struct PropertyMapping *new_list_entry;
2176 (*num_list_entries)++;
2177 *list = checked_realloc(*list,
2178 *num_list_entries * sizeof(struct PropertyMapping));
2179 new_list_entry = &(*list)[*num_list_entries - 1];
2181 new_list_entry->base_index = base_index;
2182 new_list_entry->ext1_index = ext1_index;
2183 new_list_entry->ext2_index = ext2_index;
2184 new_list_entry->ext3_index = ext3_index;
2186 new_list_entry->artwork_index = artwork_index;
2189 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2192 struct FileInfo *file_list = artwork_info->file_list;
2193 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2194 char **base_prefixes = artwork_info->base_prefixes;
2195 char **ext1_suffixes = artwork_info->ext1_suffixes;
2196 char **ext2_suffixes = artwork_info->ext2_suffixes;
2197 char **ext3_suffixes = artwork_info->ext3_suffixes;
2198 char **ignore_tokens = artwork_info->ignore_tokens;
2199 int num_file_list_entries = artwork_info->num_file_list_entries;
2200 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2201 int num_base_prefixes = artwork_info->num_base_prefixes;
2202 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2203 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2204 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2205 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2206 SetupFileHash *setup_file_hash, *valid_file_hash;
2207 SetupFileHash *extra_file_hash, *empty_file_hash;
2208 char *known_token_value = KNOWN_TOKEN_VALUE;
2211 if (filename == NULL)
2215 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2218 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2221 /* separate valid (defined) from empty (undefined) config token values */
2222 valid_file_hash = newSetupFileHash();
2223 empty_file_hash = newSetupFileHash();
2224 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2226 char *value = HASH_ITERATION_VALUE(itr);
2228 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2229 HASH_ITERATION_TOKEN(itr), value);
2231 END_HASH_ITERATION(setup_file_hash, itr)
2233 /* at this point, we do not need the setup file hash anymore -- free it */
2234 freeSetupFileHash(setup_file_hash);
2236 /* map deprecated to current tokens (using prefix match and replace) */
2237 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2239 char *token = HASH_ITERATION_TOKEN(itr);
2240 char *mapped_token = get_mapped_token(token);
2242 if (mapped_token != NULL)
2244 char *value = HASH_ITERATION_VALUE(itr);
2246 /* add mapped token */
2247 setHashEntry(valid_file_hash, mapped_token, value);
2249 /* ignore old token (by setting it to "known" keyword) */
2250 setHashEntry(valid_file_hash, token, known_token_value);
2255 END_HASH_ITERATION(valid_file_hash, itr)
2257 /* read parameters for all known config file tokens */
2258 for (i = 0; i < num_file_list_entries; i++)
2259 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2261 /* set all tokens that can be ignored here to "known" keyword */
2262 for (i = 0; i < num_ignore_tokens; i++)
2263 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2265 /* copy all unknown config file tokens to extra config hash */
2266 extra_file_hash = newSetupFileHash();
2267 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2269 char *value = HASH_ITERATION_VALUE(itr);
2271 if (!strEqual(value, known_token_value))
2272 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2274 END_HASH_ITERATION(valid_file_hash, itr)
2276 /* at this point, we do not need the valid file hash anymore -- free it */
2277 freeSetupFileHash(valid_file_hash);
2279 /* now try to determine valid, dynamically defined config tokens */
2281 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2283 struct FileInfo **dynamic_file_list =
2284 &artwork_info->dynamic_file_list;
2285 int *num_dynamic_file_list_entries =
2286 &artwork_info->num_dynamic_file_list_entries;
2287 struct PropertyMapping **property_mapping =
2288 &artwork_info->property_mapping;
2289 int *num_property_mapping_entries =
2290 &artwork_info->num_property_mapping_entries;
2291 int current_summarized_file_list_entry =
2292 artwork_info->num_file_list_entries +
2293 artwork_info->num_dynamic_file_list_entries;
2294 char *token = HASH_ITERATION_TOKEN(itr);
2295 int len_token = strlen(token);
2297 boolean base_prefix_found = FALSE;
2298 boolean parameter_suffix_found = FALSE;
2301 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2304 /* skip all parameter definitions (handled by read_token_parameters()) */
2305 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2307 int len_suffix = strlen(suffix_list[i].token);
2309 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2310 parameter_suffix_found = TRUE;
2313 if (parameter_suffix_found)
2316 /* ---------- step 0: search for matching base prefix ---------- */
2319 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2321 char *base_prefix = base_prefixes[i];
2322 int len_base_prefix = strlen(base_prefix);
2323 boolean ext1_suffix_found = FALSE;
2324 boolean ext2_suffix_found = FALSE;
2325 boolean ext3_suffix_found = FALSE;
2326 boolean exact_match = FALSE;
2327 int base_index = -1;
2328 int ext1_index = -1;
2329 int ext2_index = -1;
2330 int ext3_index = -1;
2332 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2334 if (!base_prefix_found)
2340 if (IS_PARENT_PROCESS())
2341 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2344 if (start_pos + len_base_prefix == len_token) /* exact match */
2349 if (IS_PARENT_PROCESS())
2350 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2353 add_dynamic_file_list_entry(dynamic_file_list,
2354 num_dynamic_file_list_entries,
2357 num_suffix_list_entries,
2359 add_property_mapping(property_mapping,
2360 num_property_mapping_entries,
2361 base_index, -1, -1, -1,
2362 current_summarized_file_list_entry);
2367 if (IS_PARENT_PROCESS())
2368 printf("---> examining token '%s': search 1st suffix ...\n", token);
2371 /* ---------- step 1: search for matching first suffix ---------- */
2373 start_pos += len_base_prefix;
2374 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2376 char *ext1_suffix = ext1_suffixes[j];
2377 int len_ext1_suffix = strlen(ext1_suffix);
2379 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2381 if (!ext1_suffix_found)
2387 if (IS_PARENT_PROCESS())
2388 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2391 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2396 if (IS_PARENT_PROCESS())
2397 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2400 add_dynamic_file_list_entry(dynamic_file_list,
2401 num_dynamic_file_list_entries,
2404 num_suffix_list_entries,
2406 add_property_mapping(property_mapping,
2407 num_property_mapping_entries,
2408 base_index, ext1_index, -1, -1,
2409 current_summarized_file_list_entry);
2413 start_pos += len_ext1_suffix;
2420 if (IS_PARENT_PROCESS())
2421 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2424 /* ---------- step 2: search for matching second suffix ---------- */
2426 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2428 char *ext2_suffix = ext2_suffixes[k];
2429 int len_ext2_suffix = strlen(ext2_suffix);
2431 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2433 if (!ext2_suffix_found)
2439 if (IS_PARENT_PROCESS())
2440 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2443 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2448 if (IS_PARENT_PROCESS())
2449 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2452 add_dynamic_file_list_entry(dynamic_file_list,
2453 num_dynamic_file_list_entries,
2456 num_suffix_list_entries,
2458 add_property_mapping(property_mapping,
2459 num_property_mapping_entries,
2460 base_index, ext1_index, ext2_index, -1,
2461 current_summarized_file_list_entry);
2465 start_pos += len_ext2_suffix;
2472 if (IS_PARENT_PROCESS())
2473 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2476 /* ---------- step 3: search for matching third suffix ---------- */
2478 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2480 char *ext3_suffix = ext3_suffixes[l];
2481 int len_ext3_suffix = strlen(ext3_suffix);
2483 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2485 if (!ext3_suffix_found)
2491 if (IS_PARENT_PROCESS())
2492 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2495 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2500 if (IS_PARENT_PROCESS())
2501 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2504 add_dynamic_file_list_entry(dynamic_file_list,
2505 num_dynamic_file_list_entries,
2508 num_suffix_list_entries,
2510 add_property_mapping(property_mapping,
2511 num_property_mapping_entries,
2512 base_index, ext1_index, ext2_index, ext3_index,
2513 current_summarized_file_list_entry);
2519 END_HASH_ITERATION(extra_file_hash, itr)
2521 if (artwork_info->num_dynamic_file_list_entries > 0)
2523 artwork_info->dynamic_artwork_list =
2524 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2525 artwork_info->sizeof_artwork_list_entry);
2528 if (options.verbose && IS_PARENT_PROCESS())
2530 SetupFileList *setup_file_list, *list;
2531 boolean dynamic_tokens_found = FALSE;
2532 boolean unknown_tokens_found = FALSE;
2533 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2535 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2536 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2538 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2540 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2541 dynamic_tokens_found = TRUE;
2543 unknown_tokens_found = TRUE;
2545 END_HASH_ITERATION(extra_file_hash, itr)
2547 if (options.debug && dynamic_tokens_found)
2549 Error(ERR_INFO_LINE, "-");
2550 Error(ERR_INFO, "dynamic token(s) found in config file:");
2551 Error(ERR_INFO, "- config file: '%s'", filename);
2553 for (list = setup_file_list; list != NULL; list = list->next)
2555 char *value = getHashEntry(extra_file_hash, list->token);
2557 if (value != NULL && strEqual(value, known_token_value))
2558 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2561 Error(ERR_INFO_LINE, "-");
2564 if (unknown_tokens_found)
2566 Error(ERR_INFO_LINE, "-");
2567 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2568 Error(ERR_INFO, "- config file: '%s'", filename);
2570 for (list = setup_file_list; list != NULL; list = list->next)
2572 char *value = getHashEntry(extra_file_hash, list->token);
2574 if (value != NULL && !strEqual(value, known_token_value))
2575 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2578 Error(ERR_INFO_LINE, "-");
2581 if (undefined_values_found)
2583 Error(ERR_INFO_LINE, "-");
2584 Error(ERR_INFO, "warning: undefined values found in config file:");
2585 Error(ERR_INFO, "- config file: '%s'", filename);
2587 for (list = setup_file_list; list != NULL; list = list->next)
2589 char *value = getHashEntry(empty_file_hash, list->token);
2592 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2595 Error(ERR_INFO_LINE, "-");
2598 freeSetupFileList(setup_file_list);
2601 freeSetupFileHash(extra_file_hash);
2602 freeSetupFileHash(empty_file_hash);
2605 for (i = 0; i < num_file_list_entries; i++)
2607 printf("'%s' ", file_list[i].token);
2608 if (file_list[i].filename)
2609 printf("-> '%s'\n", file_list[i].filename);
2611 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2616 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2618 struct FileInfo *file_list = artwork_info->file_list;
2619 int num_file_list_entries = artwork_info->num_file_list_entries;
2620 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2621 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2624 DrawInitText("Loading artwork config", 120, FC_GREEN);
2625 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2627 /* always start with reliable default values */
2628 for (i = 0; i < num_file_list_entries; i++)
2630 setString(&file_list[i].filename, file_list[i].default_filename);
2632 for (j = 0; j < num_suffix_list_entries; j++)
2633 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2635 file_list[i].redefined = FALSE;
2636 file_list[i].fallback_to_default = FALSE;
2639 /* free previous dynamic artwork file array */
2640 if (artwork_info->dynamic_file_list != NULL)
2642 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2644 free(artwork_info->dynamic_file_list[i].token);
2645 free(artwork_info->dynamic_file_list[i].filename);
2646 free(artwork_info->dynamic_file_list[i].parameter);
2649 free(artwork_info->dynamic_file_list);
2650 artwork_info->dynamic_file_list = NULL;
2652 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2653 &artwork_info->num_dynamic_file_list_entries);
2656 /* free previous property mapping */
2657 if (artwork_info->property_mapping != NULL)
2659 free(artwork_info->property_mapping);
2661 artwork_info->property_mapping = NULL;
2662 artwork_info->num_property_mapping_entries = 0;
2666 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2668 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2671 /* first look for special artwork configured in level series config */
2672 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2675 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2676 leveldir_current->graphics_set,
2677 leveldir_current->graphics_path);
2680 if (fileExists(filename_base))
2681 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2684 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2686 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2687 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2690 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2691 struct ListNodeInfo **listnode)
2695 char *filename = (*listnode)->source_filename;
2697 if (--(*listnode)->num_references <= 0)
2698 deleteNodeFromList(&artwork_info->content_list, filename,
2699 artwork_info->free_artwork);
2705 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2706 struct ListNodeInfo **listnode,
2707 struct FileInfo *file_list_entry)
2717 char *basename = file_list_entry->filename;
2718 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2720 if (filename == NULL)
2722 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2724 basename = file_list_entry->default_filename;
2726 /* fail for cloned default artwork that has no default filename defined */
2727 if (file_list_entry->default_is_cloned &&
2728 strEqual(basename, UNDEFINED_FILENAME))
2730 int error_mode = ERR_WARN;
2732 /* we can get away without sounds and music, but not without graphics */
2733 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2734 error_mode = ERR_EXIT;
2736 Error(error_mode, "token '%s' was cloned and has no default filename",
2737 file_list_entry->token);
2742 /* dynamic artwork has no default filename / skip empty default artwork */
2743 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2746 file_list_entry->fallback_to_default = TRUE;
2748 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2750 filename = getCustomArtworkFilename(basename, artwork_info->type);
2752 if (filename == NULL)
2754 int error_mode = ERR_WARN;
2756 /* we can get away without sounds and music, but not without graphics */
2757 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2758 error_mode = ERR_EXIT;
2760 Error(error_mode, "cannot find default artwork file '%s'", basename);
2766 /* check if the old and the new artwork file are the same */
2767 if (*listnode && strEqual((*listnode)->source_filename, filename))
2769 /* The old and new artwork are the same (have the same filename and path).
2770 This usually means that this artwork does not exist in this artwork set
2771 and a fallback to the existing artwork is done. */
2774 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2780 /* delete existing artwork file entry */
2781 deleteArtworkListEntry(artwork_info, listnode);
2783 /* check if the new artwork file already exists in the list of artworks */
2784 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2787 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2790 *listnode = (struct ListNodeInfo *)node->content;
2791 (*listnode)->num_references++;
2796 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2797 DrawInitText(basename, 150, FC_YELLOW);
2799 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2802 printf("[adding new artwork '%s']\n", filename);
2805 (*listnode)->num_references = 1;
2806 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2811 int error_mode = ERR_WARN;
2813 /* we can get away without sounds and music, but not without graphics */
2814 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2815 error_mode = ERR_EXIT;
2817 Error(error_mode, "cannot load artwork file '%s'", basename);
2823 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2824 struct ListNodeInfo **listnode,
2825 struct FileInfo *file_list_entry)
2828 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2831 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2833 deleteArtworkListEntry(artwork_info, listnode);
2837 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2840 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2842 struct FileInfo *file_list = artwork_info->file_list;
2843 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2844 int num_file_list_entries = artwork_info->num_file_list_entries;
2845 int num_dynamic_file_list_entries =
2846 artwork_info->num_dynamic_file_list_entries;
2849 for (i = 0; i < num_file_list_entries; i++)
2850 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2853 for (i = 0; i < num_dynamic_file_list_entries; i++)
2854 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2855 &dynamic_file_list[i]);
2858 dumpList(artwork_info->content_list);
2862 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2863 struct ListNodeInfo ***list,
2864 int *num_list_entries)
2871 for (i = 0; i < *num_list_entries; i++)
2872 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2876 *num_list_entries = 0;
2879 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2881 if (artwork_info == NULL)
2884 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2885 &artwork_info->num_file_list_entries);
2887 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2888 &artwork_info->num_dynamic_file_list_entries);
2892 /* ------------------------------------------------------------------------- */
2893 /* functions only needed for non-Unix (non-command-line) systems */
2894 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2895 /* (now also added for Windows, to create files in user data directory) */
2896 /* ------------------------------------------------------------------------- */
2898 char *getErrorFilename(char *basename)
2900 return getPath2(getUserGameDataDir(), basename);
2903 void openErrorFile()
2905 InitUserDataDirectory();
2907 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2908 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2909 program.error_filename);
2912 void closeErrorFile()
2914 if (program.error_file != stderr) /* do not close stream 'stderr' */
2915 fclose(program.error_file);
2918 void dumpErrorFile()
2920 FILE *error_file = fopen(program.error_filename, MODE_READ);
2922 if (error_file != NULL)
2924 while (!feof(error_file))
2925 fputc(fgetc(error_file), stderr);
2931 void NotifyUserAboutErrorFile()
2933 #if defined(PLATFORM_WIN32)
2934 char *title_text = getStringCat2(program.program_title, " Error Message");
2935 char *error_text = getStringCat2("The program was aborted due to an error; "
2936 "for details, see the following error file:"
2937 STRING_NEWLINE, program.error_filename);
2939 MessageBox(NULL, error_text, title_text, MB_OK);
2944 /* ------------------------------------------------------------------------- */
2945 /* the following is only for debugging purpose and normally not used */
2946 /* ------------------------------------------------------------------------- */
2950 #define DEBUG_NUM_TIMESTAMPS 5
2951 #define DEBUG_TIME_IN_MICROSECONDS 0
2953 #if DEBUG_TIME_IN_MICROSECONDS
2954 static double Counter_Microseconds()
2956 static struct timeval base_time = { 0, 0 };
2957 struct timeval current_time;
2960 gettimeofday(¤t_time, NULL);
2962 /* reset base time in case of wrap-around */
2963 if (current_time.tv_sec < base_time.tv_sec)
2964 base_time = current_time;
2967 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
2968 ((double)(current_time.tv_usec - base_time.tv_usec));
2970 return counter; /* return microseconds since last init */
2974 char *debug_print_timestamp_get_padding(int padding_size)
2976 static char *padding = NULL;
2977 int max_padding_size = 100;
2979 if (padding == NULL)
2981 padding = checked_calloc(max_padding_size + 1);
2982 memset(padding, ' ', max_padding_size);
2985 return &padding[MAX(0, max_padding_size - padding_size)];
2988 void debug_print_timestamp(int counter_nr, char *message)
2990 int indent_size = 8;
2991 int padding_size = 40;
2992 float timestamp_interval;
2995 Error(ERR_EXIT, "debugging: invalid negative counter");
2996 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2997 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2999 #if DEBUG_TIME_IN_MICROSECONDS
3000 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3003 counter[counter_nr][0] = Counter_Microseconds();
3005 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3008 counter[counter_nr][0] = Counter();
3011 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3012 counter[counter_nr][1] = counter[counter_nr][0];
3015 printf("%s%s%s %.3f %s\n",
3016 debug_print_timestamp_get_padding(counter_nr * indent_size),
3018 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3019 timestamp_interval / 1000,
3023 void debug_print_parent_only(char *format, ...)
3025 if (!IS_PARENT_PROCESS())
3032 va_start(ap, format);
3033 vprintf(format, ap);