1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 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 void fprintf_line(FILE *stream, char *line_string, int line_length)
44 for (i = 0; i < line_length; i++)
45 fprintf(stream, "%s", line_string);
47 fprintf(stream, "\n");
50 void printf_line(char *line_string, int line_length)
52 fprintf_line(stdout, line_string, line_length);
56 /* int2str() returns a number converted to a string;
57 the used memory is static, but will be overwritten by later calls,
58 so if you want to save the result, copy it to a private string buffer;
59 there can be 10 local calls of int2str() without buffering the result --
60 the 11th call will then destroy the result from the first call and so on.
63 char *int2str(int number, int size)
65 static char shift_array[10][40];
66 static int shift_counter = 0;
67 char *s = shift_array[shift_counter];
69 shift_counter = (shift_counter + 1) % 10;
76 sprintf(s, " %09d", number);
77 return &s[strlen(s) - size];
81 sprintf(s, "%d", number);
87 /* something similar to "int2str()" above, but allocates its own memory
88 and has a different interface; we cannot use "itoa()", because this
89 seems to be already defined when cross-compiling to the win32 target */
91 char *i_to_a(unsigned int i)
93 static char *a = NULL;
97 if (i > 2147483647) /* yes, this is a kludge */
100 a = checked_malloc(10 + 1);
108 /* calculate base-2 logarithm of argument (rounded down to integer;
109 this function returns the number of the highest bit set in argument) */
111 int log_2(unsigned int x)
117 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
125 /* ------------------------------------------------------------------------- */
126 /* counter functions */
127 /* ------------------------------------------------------------------------- */
129 #if defined(PLATFORM_MSDOS)
130 volatile unsigned long counter = 0;
132 void increment_counter()
137 END_OF_FUNCTION(increment_counter);
141 /* maximal allowed length of a command line option */
142 #define MAX_OPTION_LEN 256
145 static unsigned long mainCounter(int mode)
147 static unsigned long base_ms = 0;
148 unsigned long current_ms;
149 unsigned long counter_ms;
151 current_ms = SDL_GetTicks();
153 /* reset base time in case of counter initializing or wrap-around */
154 if (mode == INIT_COUNTER || current_ms < base_ms)
155 base_ms = current_ms;
157 counter_ms = current_ms - base_ms;
159 return counter_ms; /* return milliseconds since last init */
162 #else /* !TARGET_SDL */
164 #if defined(PLATFORM_UNIX)
165 static unsigned long mainCounter(int mode)
167 static struct timeval base_time = { 0, 0 };
168 struct timeval current_time;
169 unsigned long counter_ms;
171 gettimeofday(¤t_time, NULL);
173 /* reset base time in case of counter initializing or wrap-around */
174 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
175 base_time = current_time;
177 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
178 + (current_time.tv_usec - base_time.tv_usec) / 1000;
180 return counter_ms; /* return milliseconds since last init */
182 #endif /* PLATFORM_UNIX */
183 #endif /* !TARGET_SDL */
185 void InitCounter() /* set counter back to zero */
187 #if !defined(PLATFORM_MSDOS)
188 mainCounter(INIT_COUNTER);
190 LOCK_VARIABLE(counter);
191 LOCK_FUNCTION(increment_counter);
192 install_int_ex(increment_counter, BPS_TO_TIMER(100));
196 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
198 #if !defined(PLATFORM_MSDOS)
199 return mainCounter(READ_COUNTER);
201 return (counter * 10);
205 static void sleep_milliseconds(unsigned long milliseconds_delay)
207 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
210 #if defined(PLATFORM_MSDOS)
211 /* don't use select() to perform waiting operations under DOS
212 environment; always use a busy loop for waiting instead */
213 do_busy_waiting = TRUE;
219 /* we want to wait only a few ms -- if we assume that we have a
220 kernel timer resolution of 10 ms, we would wait far to long;
221 therefore it's better to do a short interval of busy waiting
222 to get our sleeping time more accurate */
224 unsigned long base_counter = Counter(), actual_counter = Counter();
226 while (actual_counter < base_counter + milliseconds_delay &&
227 actual_counter >= base_counter)
228 actual_counter = Counter();
232 #if defined(TARGET_SDL)
233 SDL_Delay(milliseconds_delay);
234 #elif defined(TARGET_ALLEGRO)
235 rest(milliseconds_delay);
237 struct timeval delay;
239 delay.tv_sec = milliseconds_delay / 1000;
240 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
242 if (select(0, NULL, NULL, NULL, &delay) != 0)
243 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
248 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
250 sleep_milliseconds(delay);
253 boolean FrameReached(unsigned long *frame_counter_var,
254 unsigned long frame_delay)
256 unsigned long actual_frame_counter = FrameCounter;
258 if (actual_frame_counter >= *frame_counter_var &&
259 actual_frame_counter < *frame_counter_var + frame_delay)
262 *frame_counter_var = actual_frame_counter;
267 boolean DelayReached(unsigned long *counter_var,
270 unsigned long actual_counter = Counter();
272 if (actual_counter >= *counter_var &&
273 actual_counter < *counter_var + delay)
276 *counter_var = actual_counter;
281 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
283 unsigned long actual_counter;
287 actual_counter = Counter();
289 if (actual_counter >= *counter_var &&
290 actual_counter < *counter_var + delay)
291 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
296 *counter_var = actual_counter;
300 /* ------------------------------------------------------------------------- */
301 /* random generator functions */
302 /* ------------------------------------------------------------------------- */
304 unsigned int init_random_number(int nr, long seed)
306 if (seed == NEW_RANDOMIZE)
308 #if defined(TARGET_SDL)
309 seed = (long)SDL_GetTicks();
311 struct timeval current_time;
313 gettimeofday(¤t_time, NULL);
314 seed = (long)current_time.tv_usec;
318 srandom_linux_libc(nr, (unsigned int) seed);
320 return (unsigned int) seed;
323 unsigned int get_random_number(int nr, int max)
325 return (max > 0 ? random_linux_libc(nr) % max : 0);
329 /* ------------------------------------------------------------------------- */
330 /* system info functions */
331 /* ------------------------------------------------------------------------- */
333 #if !defined(PLATFORM_MSDOS)
334 static char *get_corrected_real_name(char *real_name)
336 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
337 char *from_ptr = real_name;
338 char *to_ptr = real_name_new;
340 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
341 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
343 /* the name field read from "passwd" file may also contain additional
344 user information, separated by commas, which will be removed here */
345 if (*from_ptr == ',')
348 /* the user's real name may contain 'ß' characters (german sharp s),
349 which have no equivalent in upper case letters (used by our fonts) */
350 if (*from_ptr == 'ß')
357 *to_ptr++ = *from_ptr++;
362 return real_name_new;
368 static char *login_name = NULL;
370 #if defined(PLATFORM_WIN32)
371 if (login_name == NULL)
373 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
374 login_name = checked_malloc(buffer_size);
376 if (GetUserName(login_name, &buffer_size) == 0)
377 strcpy(login_name, ANONYMOUS_NAME);
380 if (login_name == NULL)
384 if ((pwd = getpwuid(getuid())) == NULL)
385 login_name = ANONYMOUS_NAME;
387 login_name = getStringCopy(pwd->pw_name);
396 static char *real_name = NULL;
398 #if defined(PLATFORM_WIN32)
399 if (real_name == NULL)
401 static char buffer[MAX_USERNAME_LEN + 1];
402 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
404 if (GetUserName(buffer, &buffer_size) != 0)
405 real_name = get_corrected_real_name(buffer);
407 real_name = ANONYMOUS_NAME;
409 #elif defined(PLATFORM_UNIX)
410 if (real_name == NULL)
414 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
415 real_name = get_corrected_real_name(pwd->pw_gecos);
417 real_name = ANONYMOUS_NAME;
420 real_name = ANONYMOUS_NAME;
428 static char *dir = NULL;
430 #if defined(PLATFORM_WIN32)
433 dir = checked_malloc(MAX_PATH + 1);
435 if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
438 #elif defined(PLATFORM_UNIX)
441 if ((dir = getenv("HOME")) == NULL)
445 if ((pwd = getpwuid(getuid())) != NULL)
446 dir = getStringCopy(pwd->pw_dir);
459 /* ------------------------------------------------------------------------- */
460 /* various string functions */
461 /* ------------------------------------------------------------------------- */
463 char *getPath2(char *path1, char *path2)
465 char *complete_path = checked_malloc(strlen(path1) + 1 +
468 sprintf(complete_path, "%s/%s", path1, path2);
470 return complete_path;
473 char *getPath3(char *path1, char *path2, char *path3)
475 char *complete_path = checked_malloc(strlen(path1) + 1 +
479 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
481 return complete_path;
484 char *getStringCat2(char *s1, char *s2)
486 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
488 sprintf(complete_string, "%s%s", s1, s2);
490 return complete_string;
493 char *getStringCopy(char *s)
500 s_copy = checked_malloc(strlen(s) + 1);
506 char *getStringToLower(char *s)
508 char *s_copy = checked_malloc(strlen(s) + 1);
509 char *s_ptr = s_copy;
512 *s_ptr++ = tolower(*s++);
518 void setString(char **old_value, char *new_value)
520 checked_free(*old_value);
522 *old_value = getStringCopy(new_value);
526 /* ------------------------------------------------------------------------- */
527 /* command line option handling functions */
528 /* ------------------------------------------------------------------------- */
530 void GetOptions(char *argv[], void (*print_usage_function)(void))
532 char **options_left = &argv[1];
534 /* initialize global program options */
535 options.display_name = NULL;
536 options.server_host = NULL;
537 options.server_port = 0;
538 options.ro_base_directory = RO_BASE_PATH;
539 options.rw_base_directory = RW_BASE_PATH;
540 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
541 options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
542 options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
543 options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
544 options.docs_directory = RO_BASE_PATH "/" DOCS_DIRECTORY;
545 options.execute_command = NULL;
546 options.serveronly = FALSE;
547 options.network = FALSE;
548 options.verbose = FALSE;
549 options.debug = FALSE;
551 #if !defined(PLATFORM_UNIX)
552 if (*options_left == NULL) /* no options given -- enable verbose mode */
553 options.verbose = TRUE;
556 while (*options_left)
558 char option_str[MAX_OPTION_LEN];
559 char *option = options_left[0];
560 char *next_option = options_left[1];
561 char *option_arg = NULL;
562 int option_len = strlen(option);
564 if (option_len >= MAX_OPTION_LEN)
565 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
567 strcpy(option_str, option); /* copy argument into buffer */
570 if (strcmp(option, "--") == 0) /* stop scanning arguments */
573 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
576 option_arg = strchr(option, '=');
577 if (option_arg == NULL) /* no '=' in option */
578 option_arg = next_option;
581 *option_arg++ = '\0'; /* cut argument from option */
582 if (*option_arg == '\0') /* no argument after '=' */
583 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
586 option_len = strlen(option);
588 if (strcmp(option, "-") == 0)
589 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
590 else if (strncmp(option, "-help", option_len) == 0)
592 print_usage_function();
596 else if (strncmp(option, "-display", option_len) == 0)
598 if (option_arg == NULL)
599 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
601 options.display_name = option_arg;
602 if (option_arg == next_option)
605 else if (strncmp(option, "-basepath", option_len) == 0)
607 if (option_arg == NULL)
608 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
610 /* this should be extended to separate options for ro and rw data */
611 options.ro_base_directory = option_arg;
612 options.rw_base_directory = option_arg;
613 if (option_arg == next_option)
616 /* adjust paths for sub-directories in base directory accordingly */
617 options.level_directory =
618 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
619 options.graphics_directory =
620 getPath2(options.ro_base_directory, GRAPHICS_DIRECTORY);
621 options.sounds_directory =
622 getPath2(options.ro_base_directory, SOUNDS_DIRECTORY);
623 options.music_directory =
624 getPath2(options.ro_base_directory, MUSIC_DIRECTORY);
625 options.docs_directory =
626 getPath2(options.ro_base_directory, DOCS_DIRECTORY);
628 else if (strncmp(option, "-levels", option_len) == 0)
630 if (option_arg == NULL)
631 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
633 options.level_directory = option_arg;
634 if (option_arg == next_option)
637 else if (strncmp(option, "-graphics", option_len) == 0)
639 if (option_arg == NULL)
640 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
642 options.graphics_directory = option_arg;
643 if (option_arg == next_option)
646 else if (strncmp(option, "-sounds", option_len) == 0)
648 if (option_arg == NULL)
649 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
651 options.sounds_directory = option_arg;
652 if (option_arg == next_option)
655 else if (strncmp(option, "-music", option_len) == 0)
657 if (option_arg == NULL)
658 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
660 options.music_directory = option_arg;
661 if (option_arg == next_option)
664 else if (strncmp(option, "-network", option_len) == 0)
666 options.network = TRUE;
668 else if (strncmp(option, "-serveronly", option_len) == 0)
670 options.serveronly = TRUE;
672 else if (strncmp(option, "-verbose", option_len) == 0)
674 options.verbose = TRUE;
676 else if (strncmp(option, "-debug", option_len) == 0)
678 options.debug = TRUE;
680 else if (strncmp(option, "-execute", option_len) == 0)
682 if (option_arg == NULL)
683 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
685 options.execute_command = option_arg;
686 if (option_arg == next_option)
690 /* when doing batch processing, always enable verbose mode (warnings) */
691 options.verbose = TRUE;
694 else if (*option == '-')
696 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
698 else if (options.server_host == NULL)
700 options.server_host = *options_left;
702 else if (options.server_port == 0)
704 options.server_port = atoi(*options_left);
705 if (options.server_port < 1024)
706 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
709 Error(ERR_EXIT_HELP, "too many arguments");
716 /* ------------------------------------------------------------------------- */
717 /* error handling functions */
718 /* ------------------------------------------------------------------------- */
720 /* used by SetError() and GetError() to store internal error messages */
721 static char internal_error[1024]; /* this is bad */
723 void SetError(char *format, ...)
727 va_start(ap, format);
728 vsprintf(internal_error, format, ap);
734 return internal_error;
737 void Error(int mode, char *format, ...)
739 static boolean last_line_was_separator = FALSE;
740 char *process_name = "";
741 FILE *error = stderr;
742 char *newline = "\n";
744 /* display warnings only when running in verbose mode */
745 if (mode & ERR_WARN && !options.verbose)
748 if (mode == ERR_RETURN_LINE)
750 if (!last_line_was_separator)
751 fprintf_line(error, format, 79);
753 last_line_was_separator = TRUE;
758 last_line_was_separator = FALSE;
760 #if defined(PLATFORM_MSDOS)
763 if ((error = openErrorFile()) == NULL)
765 printf("Cannot write to error output file!%s", newline);
766 program.exit_function(1);
770 if (mode & ERR_SOUND_SERVER)
771 process_name = " sound server";
772 else if (mode & ERR_NETWORK_SERVER)
773 process_name = " network server";
774 else if (mode & ERR_NETWORK_CLIENT)
775 process_name = " network client **";
781 fprintf(error, "%s%s: ", program.command_basename, process_name);
784 fprintf(error, "warning: ");
786 va_start(ap, format);
787 vfprintf(error, format, ap);
790 fprintf(error, "%s", newline);
794 fprintf(error, "%s: Try option '--help' for more information.%s",
795 program.command_basename, newline);
798 fprintf(error, "%s%s: aborting%s",
799 program.command_basename, process_name, newline);
806 if (mode & ERR_FROM_SERVER)
807 exit(1); /* child process: normal exit */
809 program.exit_function(1); /* main process: clean up stuff */
814 /* ------------------------------------------------------------------------- */
815 /* checked memory allocation and freeing functions */
816 /* ------------------------------------------------------------------------- */
818 void *checked_malloc(unsigned long size)
825 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
830 void *checked_calloc(unsigned long size)
834 ptr = calloc(1, size);
837 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
842 void *checked_realloc(void *ptr, unsigned long size)
844 ptr = realloc(ptr, size);
847 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
852 void checked_free(void *ptr)
854 if (ptr != NULL) /* this check should be done by free() anyway */
859 /* ------------------------------------------------------------------------- */
860 /* various helper functions */
861 /* ------------------------------------------------------------------------- */
863 inline void swap_numbers(int *i1, int *i2)
871 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
883 int getFile16BitInteger(FILE *file, int byte_order)
885 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
886 return ((fgetc(file) << 8) |
888 else /* BYTE_ORDER_LITTLE_ENDIAN */
889 return ((fgetc(file) << 0) |
893 void putFile16BitInteger(FILE *file, int value, int byte_order)
895 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
897 fputc((value >> 8) & 0xff, file);
898 fputc((value >> 0) & 0xff, file);
900 else /* BYTE_ORDER_LITTLE_ENDIAN */
902 fputc((value >> 0) & 0xff, file);
903 fputc((value >> 8) & 0xff, file);
907 int getFile32BitInteger(FILE *file, int byte_order)
909 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
910 return ((fgetc(file) << 24) |
911 (fgetc(file) << 16) |
914 else /* BYTE_ORDER_LITTLE_ENDIAN */
915 return ((fgetc(file) << 0) |
917 (fgetc(file) << 16) |
918 (fgetc(file) << 24));
921 void putFile32BitInteger(FILE *file, int value, int byte_order)
923 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
925 fputc((value >> 24) & 0xff, file);
926 fputc((value >> 16) & 0xff, file);
927 fputc((value >> 8) & 0xff, file);
928 fputc((value >> 0) & 0xff, file);
930 else /* BYTE_ORDER_LITTLE_ENDIAN */
932 fputc((value >> 0) & 0xff, file);
933 fputc((value >> 8) & 0xff, file);
934 fputc((value >> 16) & 0xff, file);
935 fputc((value >> 24) & 0xff, file);
939 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
942 const int chunk_name_length = 4;
944 /* read chunk name */
945 fgets(chunk_name, chunk_name_length + 1, file);
947 if (chunk_size != NULL)
949 /* read chunk size */
950 *chunk_size = getFile32BitInteger(file, byte_order);
953 return (feof(file) || ferror(file) ? FALSE : TRUE);
956 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
959 /* write chunk name */
960 fputs(chunk_name, file);
964 /* write chunk size */
965 putFile32BitInteger(file, chunk_size, byte_order);
969 int getFileVersion(FILE *file)
971 int version_major = fgetc(file);
972 int version_minor = fgetc(file);
973 int version_patch = fgetc(file);
974 int version_build = fgetc(file);
976 return VERSION_IDENT(version_major, version_minor, version_patch,
980 void putFileVersion(FILE *file, int version)
982 int version_major = VERSION_MAJOR(version);
983 int version_minor = VERSION_MINOR(version);
984 int version_patch = VERSION_PATCH(version);
985 int version_build = VERSION_BUILD(version);
987 fputc(version_major, file);
988 fputc(version_minor, file);
989 fputc(version_patch, file);
990 fputc(version_build, file);
993 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
995 while (bytes-- && !feof(file))
999 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1006 /* ------------------------------------------------------------------------- */
1007 /* functions to translate key identifiers between different format */
1008 /* ------------------------------------------------------------------------- */
1010 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1011 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1012 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1013 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1015 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1024 /* normal cursor keys */
1025 { KSYM_Left, "XK_Left", "cursor left" },
1026 { KSYM_Right, "XK_Right", "cursor right" },
1027 { KSYM_Up, "XK_Up", "cursor up" },
1028 { KSYM_Down, "XK_Down", "cursor down" },
1030 /* keypad cursor keys */
1032 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1033 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1034 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1035 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1038 /* other keypad keys */
1039 #ifdef KSYM_KP_Enter
1040 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1041 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1042 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1043 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1044 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1045 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1049 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1050 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1051 { KSYM_Control_L, "XK_Control_L", "left control" },
1052 { KSYM_Control_R, "XK_Control_R", "right control" },
1053 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1054 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1055 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1056 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1057 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1058 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1059 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1060 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1062 /* some special keys */
1063 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1064 { KSYM_Delete, "XK_Delete", "delete" },
1065 { KSYM_Insert, "XK_Insert", "insert" },
1066 { KSYM_Tab, "XK_Tab", "tab" },
1067 { KSYM_Home, "XK_Home", "home" },
1068 { KSYM_End, "XK_End", "end" },
1069 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1070 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1071 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1073 /* ASCII 0x20 to 0x40 keys (except numbers) */
1074 { KSYM_space, "XK_space", "space" },
1075 { KSYM_exclam, "XK_exclam", "!" },
1076 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1077 { KSYM_numbersign, "XK_numbersign", "#" },
1078 { KSYM_dollar, "XK_dollar", "$" },
1079 { KSYM_percent, "XK_percent", "%" },
1080 { KSYM_ampersand, "XK_ampersand", "&" },
1081 { KSYM_apostrophe, "XK_apostrophe", "'" },
1082 { KSYM_parenleft, "XK_parenleft", "(" },
1083 { KSYM_parenright, "XK_parenright", ")" },
1084 { KSYM_asterisk, "XK_asterisk", "*" },
1085 { KSYM_plus, "XK_plus", "+" },
1086 { KSYM_comma, "XK_comma", "," },
1087 { KSYM_minus, "XK_minus", "-" },
1088 { KSYM_period, "XK_period", "." },
1089 { KSYM_slash, "XK_slash", "/" },
1090 { KSYM_colon, "XK_colon", ":" },
1091 { KSYM_semicolon, "XK_semicolon", ";" },
1092 { KSYM_less, "XK_less", "<" },
1093 { KSYM_equal, "XK_equal", "=" },
1094 { KSYM_greater, "XK_greater", ">" },
1095 { KSYM_question, "XK_question", "?" },
1096 { KSYM_at, "XK_at", "@" },
1098 /* more ASCII keys */
1099 { KSYM_bracketleft, "XK_bracketleft", "[" },
1100 { KSYM_backslash, "XK_backslash", "backslash" },
1101 { KSYM_bracketright,"XK_bracketright", "]" },
1102 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1103 { KSYM_underscore, "XK_underscore", "_" },
1104 { KSYM_grave, "XK_grave", "grave" },
1105 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1106 { KSYM_braceleft, "XK_braceleft", "brace left" },
1107 { KSYM_bar, "XK_bar", "bar" },
1108 { KSYM_braceright, "XK_braceright", "brace right" },
1109 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1111 /* special (non-ASCII) keys */
1112 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1113 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1114 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1115 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1116 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1117 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1118 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1120 /* end-of-array identifier */
1126 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1128 static char name_buffer[30];
1131 if (key >= KSYM_A && key <= KSYM_Z)
1132 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1133 else if (key >= KSYM_a && key <= KSYM_z)
1134 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1135 else if (key >= KSYM_0 && key <= KSYM_9)
1136 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1137 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1138 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1139 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1140 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1141 else if (key == KSYM_UNDEFINED)
1142 strcpy(name_buffer, "(undefined)");
1149 if (key == translate_key[i].key)
1151 strcpy(name_buffer, translate_key[i].name);
1155 while (translate_key[++i].name);
1157 if (!translate_key[i].name)
1158 strcpy(name_buffer, "(unknown)");
1161 *name = name_buffer;
1163 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1165 static char name_buffer[30];
1168 if (key >= KSYM_A && key <= KSYM_Z)
1169 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1170 else if (key >= KSYM_a && key <= KSYM_z)
1171 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1172 else if (key >= KSYM_0 && key <= KSYM_9)
1173 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1174 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1175 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1176 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1177 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1178 else if (key == KSYM_UNDEFINED)
1179 strcpy(name_buffer, "[undefined]");
1186 if (key == translate_key[i].key)
1188 strcpy(name_buffer, translate_key[i].x11name);
1192 while (translate_key[++i].x11name);
1194 if (!translate_key[i].x11name)
1195 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1198 *x11name = name_buffer;
1200 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1202 Key key = KSYM_UNDEFINED;
1207 if (strcmp(translate_key[i].name, *name) == 0)
1209 key = translate_key[i].key;
1213 while (translate_key[++i].x11name);
1215 if (key == KSYM_UNDEFINED)
1216 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1220 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1222 Key key = KSYM_UNDEFINED;
1223 char *name_ptr = *x11name;
1225 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1227 char c = name_ptr[3];
1229 if (c >= 'A' && c <= 'Z')
1230 key = KSYM_A + (Key)(c - 'A');
1231 else if (c >= 'a' && c <= 'z')
1232 key = KSYM_a + (Key)(c - 'a');
1233 else if (c >= '0' && c <= '9')
1234 key = KSYM_0 + (Key)(c - '0');
1236 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1238 char c = name_ptr[6];
1240 if (c >= '0' && c <= '9')
1241 key = KSYM_KP_0 + (Key)(c - '0');
1243 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1245 char c1 = name_ptr[4];
1246 char c2 = name_ptr[5];
1249 if ((c1 >= '0' && c1 <= '9') &&
1250 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1251 d = atoi(&name_ptr[4]);
1253 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1254 key = KSYM_F1 + (Key)(d - 1);
1256 else if (strncmp(name_ptr, "XK_", 3) == 0)
1262 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1264 key = translate_key[i].key;
1268 while (translate_key[++i].x11name);
1270 else if (strncmp(name_ptr, "0x", 2) == 0)
1272 unsigned long value = 0;
1278 char c = *name_ptr++;
1281 if (c >= '0' && c <= '9')
1283 else if (c >= 'a' && c <= 'f')
1284 d = (int)(c - 'a' + 10);
1285 else if (c >= 'A' && c <= 'F')
1286 d = (int)(c - 'A' + 10);
1294 value = value * 16 + d;
1305 char *getKeyNameFromKey(Key key)
1309 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1313 char *getX11KeyNameFromKey(Key key)
1317 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1321 Key getKeyFromKeyName(char *name)
1325 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1329 Key getKeyFromX11KeyName(char *x11name)
1333 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1337 char getCharFromKey(Key key)
1339 char *keyname = getKeyNameFromKey(key);
1342 if (strlen(keyname) == 1)
1343 letter = keyname[0];
1344 else if (strcmp(keyname, "space") == 0)
1346 else if (strcmp(keyname, "circumflex") == 0)
1353 /* ------------------------------------------------------------------------- */
1354 /* functions to translate string identifiers to integer or boolean value */
1355 /* ------------------------------------------------------------------------- */
1357 int get_integer_from_string(char *s)
1359 static char *number_text[][3] =
1361 { "0", "zero", "null", },
1362 { "1", "one", "first" },
1363 { "2", "two", "second" },
1364 { "3", "three", "third" },
1365 { "4", "four", "fourth" },
1366 { "5", "five", "fifth" },
1367 { "6", "six", "sixth" },
1368 { "7", "seven", "seventh" },
1369 { "8", "eight", "eighth" },
1370 { "9", "nine", "ninth" },
1371 { "10", "ten", "tenth" },
1372 { "11", "eleven", "eleventh" },
1373 { "12", "twelve", "twelfth" },
1375 { NULL, NULL, NULL },
1379 char *s_lower = getStringToLower(s);
1382 for (i = 0; number_text[i][0] != NULL; i++)
1383 for (j = 0; j < 3; j++)
1384 if (strcmp(s_lower, number_text[i][j]) == 0)
1389 if (strcmp(s_lower, "false") == 0)
1391 else if (strcmp(s_lower, "true") == 0)
1402 boolean get_boolean_from_string(char *s)
1404 char *s_lower = getStringToLower(s);
1405 boolean result = FALSE;
1407 if (strcmp(s_lower, "true") == 0 ||
1408 strcmp(s_lower, "yes") == 0 ||
1409 strcmp(s_lower, "on") == 0 ||
1410 get_integer_from_string(s) == 1)
1419 /* ------------------------------------------------------------------------- */
1420 /* functions for generic lists */
1421 /* ------------------------------------------------------------------------- */
1423 ListNode *newListNode()
1425 return checked_calloc(sizeof(ListNode));
1428 void addNodeToList(ListNode **node_first, char *key, void *content)
1430 ListNode *node_new = newListNode();
1433 printf("LIST: adding node with key '%s'\n", key);
1436 node_new->key = getStringCopy(key);
1437 node_new->content = content;
1438 node_new->next = *node_first;
1439 *node_first = node_new;
1442 void deleteNodeFromList(ListNode **node_first, char *key,
1443 void (*destructor_function)(void *))
1445 if (node_first == NULL || *node_first == NULL)
1449 printf("[CHECKING LIST KEY '%s' == '%s']\n",
1450 (*node_first)->key, key);
1453 if (strcmp((*node_first)->key, key) == 0)
1456 printf("[DELETING LIST ENTRY]\n");
1459 free((*node_first)->key);
1460 if (destructor_function)
1461 destructor_function((*node_first)->content);
1462 *node_first = (*node_first)->next;
1465 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1468 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1470 if (node_first == NULL)
1473 if (strcmp(node_first->key, key) == 0)
1476 return getNodeFromKey(node_first->next, key);
1479 int getNumNodes(ListNode *node_first)
1481 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1484 void dumpList(ListNode *node_first)
1486 ListNode *node = node_first;
1490 printf("['%s' (%d)]\n", node->key,
1491 ((struct ListNodeInfo *)node->content)->num_references);
1495 printf("[%d nodes]\n", getNumNodes(node_first));
1499 /* ------------------------------------------------------------------------- */
1500 /* functions for checking files and filenames */
1501 /* ------------------------------------------------------------------------- */
1503 boolean fileExists(char *filename)
1505 if (filename == NULL)
1509 printf("checking file '%s'\n", filename);
1512 return (access(filename, F_OK) == 0);
1515 boolean fileHasPrefix(char *basename, char *prefix)
1517 static char *basename_lower = NULL;
1518 int basename_length, prefix_length;
1520 checked_free(basename_lower);
1522 if (basename == NULL || prefix == NULL)
1525 basename_lower = getStringToLower(basename);
1526 basename_length = strlen(basename_lower);
1527 prefix_length = strlen(prefix);
1529 if (basename_length > prefix_length + 1 &&
1530 basename_lower[prefix_length] == '.' &&
1531 strncmp(basename_lower, prefix, prefix_length) == 0)
1537 boolean fileHasSuffix(char *basename, char *suffix)
1539 static char *basename_lower = NULL;
1540 int basename_length, suffix_length;
1542 checked_free(basename_lower);
1544 if (basename == NULL || suffix == NULL)
1547 basename_lower = getStringToLower(basename);
1548 basename_length = strlen(basename_lower);
1549 suffix_length = strlen(suffix);
1551 if (basename_length > suffix_length + 1 &&
1552 basename_lower[basename_length - suffix_length - 1] == '.' &&
1553 strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0)
1559 boolean FileIsGraphic(char *filename)
1561 char *basename = strrchr(filename, '/');
1563 basename = (basename != NULL ? basename + 1 : filename);
1565 return fileHasSuffix(basename, "pcx");
1568 boolean FileIsSound(char *filename)
1570 char *basename = strrchr(filename, '/');
1572 basename = (basename != NULL ? basename + 1 : filename);
1574 return fileHasSuffix(basename, "wav");
1577 boolean FileIsMusic(char *filename)
1579 char *basename = strrchr(filename, '/');
1581 basename = (basename != NULL ? basename + 1 : filename);
1583 if (FileIsSound(basename))
1586 #if defined(TARGET_SDL)
1587 if (fileHasPrefix(basename, "mod") ||
1588 fileHasSuffix(basename, "mod") ||
1589 fileHasSuffix(basename, "s3m") ||
1590 fileHasSuffix(basename, "it") ||
1591 fileHasSuffix(basename, "xm") ||
1592 fileHasSuffix(basename, "midi") ||
1593 fileHasSuffix(basename, "mid") ||
1594 fileHasSuffix(basename, "mp3") ||
1595 fileHasSuffix(basename, "ogg"))
1602 boolean FileIsArtworkType(char *basename, int type)
1604 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1605 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1606 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1612 /* ------------------------------------------------------------------------- */
1613 /* functions for loading artwork configuration information */
1614 /* ------------------------------------------------------------------------- */
1616 char *get_mapped_token(char *token)
1618 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1619 static char *map_token_prefix[][2] =
1621 { "char_procent", "char_percent" },
1626 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1628 int len_token_prefix = strlen(map_token_prefix[i][0]);
1630 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1631 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1637 /* This function checks if a string <s> of the format "string1, string2, ..."
1638 exactly contains a string <s_contained>. */
1640 static boolean string_has_parameter(char *s, char *s_contained)
1644 if (s == NULL || s_contained == NULL)
1647 if (strlen(s_contained) > strlen(s))
1650 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1652 char next_char = s[strlen(s_contained)];
1654 /* check if next character is delimiter or whitespace */
1655 return (next_char == ',' || next_char == '\0' ||
1656 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1659 /* check if string contains another parameter string after a comma */
1660 substring = strchr(s, ',');
1661 if (substring == NULL) /* string does not contain a comma */
1664 /* advance string pointer to next character after the comma */
1667 /* skip potential whitespaces after the comma */
1668 while (*substring == ' ' || *substring == '\t')
1671 return string_has_parameter(substring, s_contained);
1674 int get_parameter_value(char *suffix, char *value_raw, int type)
1676 char *value = getStringToLower(value_raw);
1677 int result = 0; /* probably a save default value */
1679 if (strcmp(suffix, ".direction") == 0)
1681 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1682 strcmp(value, "right") == 0 ? MV_RIGHT :
1683 strcmp(value, "up") == 0 ? MV_UP :
1684 strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING);
1686 else if (strcmp(suffix, ".anim_mode") == 0)
1688 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1689 string_has_parameter(value, "loop") ? ANIM_LOOP :
1690 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1691 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1692 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1693 string_has_parameter(value, "random") ? ANIM_RANDOM :
1694 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1695 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1698 if (string_has_parameter(value, "reverse"))
1699 result |= ANIM_REVERSE;
1701 else /* generic parameter of type integer or boolean */
1703 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1704 type == TYPE_INTEGER ? get_integer_from_string(value) :
1705 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1706 ARG_UNDEFINED_VALUE);
1714 int get_auto_parameter_value(char *token, char *value_raw)
1718 if (token == NULL || value_raw == NULL)
1719 return ARG_UNDEFINED_VALUE;
1721 suffix = strrchr(token, '.');
1725 return get_parameter_value(suffix, value_raw, TYPE_INTEGER);
1728 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1729 struct ListNodeInfo ***, int *);
1731 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1732 struct ConfigTypeInfo *suffix_list,
1733 char **ignore_tokens,
1734 int num_file_list_entries)
1736 struct FileInfo *file_list;
1737 int num_file_list_entries_found = 0;
1738 int num_suffix_list_entries = 0;
1742 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1744 for (i = 0; suffix_list[i].token != NULL; i++)
1745 num_suffix_list_entries++;
1747 /* always start with reliable default values */
1748 for (i = 0; i < num_file_list_entries; i++)
1750 file_list[i].token = NULL;
1752 file_list[i].default_filename = NULL;
1753 file_list[i].filename = NULL;
1755 if (num_suffix_list_entries > 0)
1757 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1759 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1760 file_list[i].parameter = checked_calloc(parameter_array_size);
1762 for (j = 0; j < num_suffix_list_entries; j++)
1764 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1765 setString(&file_list[i].parameter[j], suffix_list[j].value);
1768 file_list[i].redefined = FALSE;
1769 file_list[i].fallback_to_default = FALSE;
1774 for (i = 0; config_list[i].token != NULL; i++)
1776 int len_config_token = strlen(config_list[i].token);
1777 int len_config_value = strlen(config_list[i].value);
1778 boolean is_file_entry = TRUE;
1780 for (j = 0; suffix_list[j].token != NULL; j++)
1782 int len_suffix = strlen(suffix_list[j].token);
1784 if (len_suffix < len_config_token &&
1785 strcmp(&config_list[i].token[len_config_token - len_suffix],
1786 suffix_list[j].token) == 0)
1788 setString(&file_list[list_pos].default_parameter[j],
1789 config_list[i].value);
1791 is_file_entry = FALSE;
1796 /* the following tokens are no file definitions, but other config tokens */
1797 for (j = 0; ignore_tokens[j] != NULL; j++)
1798 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1799 is_file_entry = FALSE;
1806 if (list_pos >= num_file_list_entries)
1809 /* simple sanity check if this is really a file definition */
1810 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1811 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1812 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1814 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1815 config_list[i].token, config_list[i].value);
1816 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1819 file_list[list_pos].token = config_list[i].token;
1820 file_list[list_pos].default_filename = config_list[i].value;
1824 num_file_list_entries_found = list_pos + 1;
1825 if (num_file_list_entries_found != num_file_list_entries)
1827 Error(ERR_RETURN_LINE, "-");
1828 Error(ERR_RETURN, "inconsistant config list information:");
1829 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1830 num_file_list_entries);
1831 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1832 num_file_list_entries_found);
1833 Error(ERR_EXIT, "please fix");
1839 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1841 int len_token = strlen(token);
1842 int len_suffix = strlen(suffix);
1845 if (IS_PARENT_PROCESS())
1846 printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1849 if (start_pos < 0) /* compare suffix from end of string */
1850 start_pos += len_token;
1852 if (start_pos < 0 || start_pos + len_suffix > len_token)
1855 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1858 if (token[start_pos + len_suffix] == '\0')
1861 if (token[start_pos + len_suffix] == '.')
1867 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1869 static void read_token_parameters(SetupFileHash *setup_file_hash,
1870 struct ConfigTypeInfo *suffix_list,
1871 struct FileInfo *file_list_entry)
1873 /* check for config token that is the base token without any suffixes */
1874 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1875 char *known_token_value = KNOWN_TOKEN_VALUE;
1878 if (filename != NULL)
1880 setString(&file_list_entry->filename, filename);
1882 /* when file definition found, set all parameters to default values */
1883 for (i = 0; suffix_list[i].token != NULL; i++)
1884 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1886 file_list_entry->redefined = TRUE;
1888 /* mark config file token as well known from default config */
1889 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1894 if (strcmp(file_list_entry->filename,
1895 file_list_entry->default_filename) != 0)
1896 printf("___ resetting '%s' to default\n", file_list_entry->token);
1898 setString(&file_list_entry->filename, file_list_entry->default_filename);
1902 /* check for config tokens that can be build by base token and suffixes */
1903 for (i = 0; suffix_list[i].token != NULL; i++)
1905 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1906 char *value = getHashEntry(setup_file_hash, token);
1910 setString(&file_list_entry->parameter[i], value);
1912 /* mark config file token as well known from default config */
1913 setHashEntry(setup_file_hash, token, known_token_value);
1920 static void add_dynamic_file_list_entry(struct FileInfo **list,
1921 int *num_list_entries,
1922 SetupFileHash *extra_file_hash,
1923 struct ConfigTypeInfo *suffix_list,
1924 int num_suffix_list_entries,
1927 struct FileInfo *new_list_entry;
1928 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1931 if (IS_PARENT_PROCESS())
1932 printf("===> found dynamic definition '%s'\n", token);
1935 (*num_list_entries)++;
1936 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1937 new_list_entry = &(*list)[*num_list_entries - 1];
1939 new_list_entry->token = getStringCopy(token);
1940 new_list_entry->default_filename = NULL;
1941 new_list_entry->filename = NULL;
1942 new_list_entry->parameter = checked_calloc(parameter_array_size);
1944 new_list_entry->redefined = FALSE;
1945 new_list_entry->fallback_to_default = FALSE;
1947 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
1950 static void add_property_mapping(struct PropertyMapping **list,
1951 int *num_list_entries,
1952 int base_index, int ext1_index,
1953 int ext2_index, int ext3_index,
1956 struct PropertyMapping *new_list_entry;
1958 (*num_list_entries)++;
1959 *list = checked_realloc(*list,
1960 *num_list_entries * sizeof(struct PropertyMapping));
1961 new_list_entry = &(*list)[*num_list_entries - 1];
1963 new_list_entry->base_index = base_index;
1964 new_list_entry->ext1_index = ext1_index;
1965 new_list_entry->ext2_index = ext2_index;
1966 new_list_entry->ext3_index = ext3_index;
1968 new_list_entry->artwork_index = artwork_index;
1971 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
1974 struct FileInfo *file_list = artwork_info->file_list;
1975 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
1976 char **base_prefixes = artwork_info->base_prefixes;
1977 char **ext1_suffixes = artwork_info->ext1_suffixes;
1978 char **ext2_suffixes = artwork_info->ext2_suffixes;
1979 char **ext3_suffixes = artwork_info->ext3_suffixes;
1980 char **ignore_tokens = artwork_info->ignore_tokens;
1981 int num_file_list_entries = artwork_info->num_file_list_entries;
1982 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1983 int num_base_prefixes = artwork_info->num_base_prefixes;
1984 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
1985 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
1986 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
1987 int num_ignore_tokens = artwork_info->num_ignore_tokens;
1988 SetupFileHash *setup_file_hash, *valid_file_hash;
1989 SetupFileHash *extra_file_hash, *empty_file_hash;
1990 char *known_token_value = KNOWN_TOKEN_VALUE;
1993 if (filename == NULL)
1997 printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename);
2000 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2003 /* separate valid (defined) from empty (undefined) config token values */
2004 valid_file_hash = newSetupFileHash();
2005 empty_file_hash = newSetupFileHash();
2006 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2008 char *value = HASH_ITERATION_VALUE(itr);
2010 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2011 HASH_ITERATION_TOKEN(itr), value);
2013 END_HASH_ITERATION(setup_file_hash, itr)
2015 /* at this point, we do not need the setup file hash anymore -- free it */
2016 freeSetupFileHash(setup_file_hash);
2019 /* map deprecated to current tokens (using prefix match and replace) */
2020 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2022 char *token = HASH_ITERATION_TOKEN(itr);
2023 char *mapped_token = get_mapped_token(token);
2025 if (mapped_token != NULL)
2027 char *value = HASH_ITERATION_VALUE(itr);
2029 /* add mapped token */
2030 setHashEntry(valid_file_hash, mapped_token, value);
2032 /* ignore old token (by setting it to "known" keyword) */
2033 setHashEntry(valid_file_hash, token, known_token_value);
2038 END_HASH_ITERATION(valid_file_hash, itr)
2041 /* read parameters for all known config file tokens */
2042 for (i = 0; i < num_file_list_entries; i++)
2043 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2045 /* set all tokens that can be ignored here to "known" keyword */
2046 for (i = 0; i < num_ignore_tokens; i++)
2047 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2049 /* copy all unknown config file tokens to extra config hash */
2050 extra_file_hash = newSetupFileHash();
2051 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2053 char *value = HASH_ITERATION_VALUE(itr);
2055 if (strcmp(value, known_token_value) != 0)
2056 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2058 END_HASH_ITERATION(valid_file_hash, itr)
2060 /* at this point, we do not need the valid file hash anymore -- free it */
2061 freeSetupFileHash(valid_file_hash);
2063 /* now try to determine valid, dynamically defined config tokens */
2065 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2067 struct FileInfo **dynamic_file_list =
2068 &artwork_info->dynamic_file_list;
2069 int *num_dynamic_file_list_entries =
2070 &artwork_info->num_dynamic_file_list_entries;
2071 struct PropertyMapping **property_mapping =
2072 &artwork_info->property_mapping;
2073 int *num_property_mapping_entries =
2074 &artwork_info->num_property_mapping_entries;
2075 int current_summarized_file_list_entry =
2076 artwork_info->num_file_list_entries +
2077 artwork_info->num_dynamic_file_list_entries;
2078 char *token = HASH_ITERATION_TOKEN(itr);
2079 int len_token = strlen(token);
2081 boolean base_prefix_found = FALSE;
2082 boolean parameter_suffix_found = FALSE;
2084 /* skip all parameter definitions (handled by read_token_parameters()) */
2085 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2087 int len_suffix = strlen(suffix_list[i].token);
2089 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2090 parameter_suffix_found = TRUE;
2094 if (IS_PARENT_PROCESS())
2096 if (parameter_suffix_found)
2097 printf("---> skipping token '%s' (parameter token)\n", token);
2099 printf("---> examining token '%s': search prefix ...\n", token);
2103 if (parameter_suffix_found)
2106 /* ---------- step 0: search for matching base prefix ---------- */
2109 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2111 char *base_prefix = base_prefixes[i];
2112 int len_base_prefix = strlen(base_prefix);
2113 boolean ext1_suffix_found = FALSE;
2114 boolean ext2_suffix_found = FALSE;
2115 boolean ext3_suffix_found = FALSE;
2116 boolean exact_match = FALSE;
2117 int base_index = -1;
2118 int ext1_index = -1;
2119 int ext2_index = -1;
2120 int ext3_index = -1;
2122 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2124 if (!base_prefix_found)
2129 if (start_pos + len_base_prefix == len_token) /* exact match */
2133 add_dynamic_file_list_entry(dynamic_file_list,
2134 num_dynamic_file_list_entries,
2137 num_suffix_list_entries,
2139 add_property_mapping(property_mapping,
2140 num_property_mapping_entries,
2141 base_index, -1, -1, -1,
2142 current_summarized_file_list_entry);
2147 if (IS_PARENT_PROCESS())
2148 printf("---> examining token '%s': search 1st suffix ...\n", token);
2151 /* ---------- step 1: search for matching first suffix ---------- */
2153 start_pos += len_base_prefix;
2154 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2156 char *ext1_suffix = ext1_suffixes[j];
2157 int len_ext1_suffix = strlen(ext1_suffix);
2159 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2161 if (!ext1_suffix_found)
2166 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2170 add_dynamic_file_list_entry(dynamic_file_list,
2171 num_dynamic_file_list_entries,
2174 num_suffix_list_entries,
2176 add_property_mapping(property_mapping,
2177 num_property_mapping_entries,
2178 base_index, ext1_index, -1, -1,
2179 current_summarized_file_list_entry);
2183 start_pos += len_ext1_suffix;
2190 if (IS_PARENT_PROCESS())
2191 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2194 /* ---------- step 2: search for matching second suffix ---------- */
2196 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2198 char *ext2_suffix = ext2_suffixes[k];
2199 int len_ext2_suffix = strlen(ext2_suffix);
2201 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2203 if (!ext2_suffix_found)
2208 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2212 add_dynamic_file_list_entry(dynamic_file_list,
2213 num_dynamic_file_list_entries,
2216 num_suffix_list_entries,
2218 add_property_mapping(property_mapping,
2219 num_property_mapping_entries,
2220 base_index, ext1_index, ext2_index, -1,
2221 current_summarized_file_list_entry);
2225 start_pos += len_ext2_suffix;
2232 if (IS_PARENT_PROCESS())
2233 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2236 /* ---------- step 3: search for matching third suffix ---------- */
2238 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2240 char *ext3_suffix = ext3_suffixes[l];
2241 int len_ext3_suffix = strlen(ext3_suffix);
2243 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2245 if (!ext3_suffix_found)
2250 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2254 add_dynamic_file_list_entry(dynamic_file_list,
2255 num_dynamic_file_list_entries,
2258 num_suffix_list_entries,
2260 add_property_mapping(property_mapping,
2261 num_property_mapping_entries,
2262 base_index, ext1_index, ext2_index, ext3_index,
2263 current_summarized_file_list_entry);
2269 END_HASH_ITERATION(extra_file_hash, itr)
2271 if (artwork_info->num_dynamic_file_list_entries > 0)
2273 artwork_info->dynamic_artwork_list =
2274 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2275 artwork_info->sizeof_artwork_list_entry);
2278 if (options.verbose && IS_PARENT_PROCESS())
2280 SetupFileList *setup_file_list, *list;
2281 boolean dynamic_tokens_found = FALSE;
2282 boolean unknown_tokens_found = FALSE;
2283 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2285 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2286 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2288 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2290 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2291 dynamic_tokens_found = TRUE;
2293 unknown_tokens_found = TRUE;
2295 END_HASH_ITERATION(extra_file_hash, itr)
2297 if (options.debug && dynamic_tokens_found)
2299 Error(ERR_RETURN_LINE, "-");
2300 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2301 Error(ERR_RETURN, "- config file: '%s'", filename);
2303 for (list = setup_file_list; list != NULL; list = list->next)
2305 char *value = getHashEntry(extra_file_hash, list->token);
2307 if (value != NULL && strcmp(value, known_token_value) == 0)
2308 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2311 Error(ERR_RETURN_LINE, "-");
2314 if (unknown_tokens_found)
2316 Error(ERR_RETURN_LINE, "-");
2317 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2318 Error(ERR_RETURN, "- config file: '%s'", filename);
2320 for (list = setup_file_list; list != NULL; list = list->next)
2322 char *value = getHashEntry(extra_file_hash, list->token);
2324 if (value != NULL && strcmp(value, known_token_value) != 0)
2325 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2328 Error(ERR_RETURN_LINE, "-");
2331 if (undefined_values_found)
2333 Error(ERR_RETURN_LINE, "-");
2334 Error(ERR_RETURN, "warning: undefined values found in config file:");
2335 Error(ERR_RETURN, "- config file: '%s'", filename);
2337 for (list = setup_file_list; list != NULL; list = list->next)
2339 char *value = getHashEntry(empty_file_hash, list->token);
2342 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2345 Error(ERR_RETURN_LINE, "-");
2348 freeSetupFileList(setup_file_list);
2351 freeSetupFileHash(extra_file_hash);
2352 freeSetupFileHash(empty_file_hash);
2355 for (i = 0; i < num_file_list_entries; i++)
2357 printf("'%s' ", file_list[i].token);
2358 if (file_list[i].filename)
2359 printf("-> '%s'\n", file_list[i].filename);
2361 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2366 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2368 struct FileInfo *file_list = artwork_info->file_list;
2369 int num_file_list_entries = artwork_info->num_file_list_entries;
2370 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2371 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2375 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2378 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2379 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2381 /* always start with reliable default values */
2382 for (i = 0; i < num_file_list_entries; i++)
2384 setString(&file_list[i].filename, file_list[i].default_filename);
2386 for (j = 0; j < num_suffix_list_entries; j++)
2387 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2389 file_list[i].redefined = FALSE;
2390 file_list[i].fallback_to_default = FALSE;
2393 /* free previous dynamic artwork file array */
2394 if (artwork_info->dynamic_file_list != NULL)
2396 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2398 free(artwork_info->dynamic_file_list[i].token);
2399 free(artwork_info->dynamic_file_list[i].filename);
2400 free(artwork_info->dynamic_file_list[i].parameter);
2403 free(artwork_info->dynamic_file_list);
2404 artwork_info->dynamic_file_list = NULL;
2406 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2407 &artwork_info->num_dynamic_file_list_entries);
2410 /* free previous property mapping */
2411 if (artwork_info->property_mapping != NULL)
2413 free(artwork_info->property_mapping);
2415 artwork_info->property_mapping = NULL;
2416 artwork_info->num_property_mapping_entries = 0;
2419 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2421 /* first look for special artwork configured in level series config */
2422 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2424 if (fileExists(filename_base))
2425 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2428 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2430 if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2431 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2434 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2435 struct ListNodeInfo **listnode)
2439 char *filename = (*listnode)->source_filename;
2442 printf("[decrementing reference counter of artwork '%s']\n", filename);
2445 if (--(*listnode)->num_references <= 0)
2448 printf("[deleting artwork '%s']\n", filename);
2451 deleteNodeFromList(&artwork_info->content_list, filename,
2452 artwork_info->free_artwork);
2460 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2461 struct ListNodeInfo **listnode,
2462 struct FileInfo *file_list_entry)
2466 "Loading graphics:",
2472 char *basename = file_list_entry->filename;
2473 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2475 if (filename == NULL)
2477 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2479 basename = file_list_entry->default_filename;
2481 /* dynamic artwork has no default filename / skip empty default artwork */
2482 if (basename == NULL || strcmp(basename, UNDEFINED_FILENAME) == 0)
2485 file_list_entry->fallback_to_default = TRUE;
2487 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2489 filename = getCustomArtworkFilename(basename, artwork_info->type);
2491 if (filename == NULL)
2493 int error_mode = ERR_WARN;
2495 /* we can get away without sounds and music, but not without graphics */
2496 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2497 error_mode = ERR_EXIT;
2499 Error(error_mode, "cannot find default artwork file '%s'", basename);
2505 /* check if the old and the new artwork file are the same */
2506 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2508 /* The old and new artwork are the same (have the same filename and path).
2509 This usually means that this artwork does not exist in this artwork set
2510 and a fallback to the existing artwork is done. */
2513 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2519 /* delete existing artwork file entry */
2520 deleteArtworkListEntry(artwork_info, listnode);
2522 /* check if the new artwork file already exists in the list of artworks */
2523 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2526 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2529 *listnode = (struct ListNodeInfo *)node->content;
2530 (*listnode)->num_references++;
2536 printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2539 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2540 DrawInitText(basename, 150, FC_YELLOW);
2542 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2545 printf("[adding new artwork '%s']\n", filename);
2548 (*listnode)->num_references = 1;
2549 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2554 int error_mode = ERR_WARN;
2557 /* we can get away without sounds and music, but not without graphics */
2558 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2559 error_mode = ERR_EXIT;
2562 Error(error_mode, "cannot load artwork file '%s'", basename);
2569 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2570 struct ListNodeInfo **listnode,
2575 "Loading graphics:",
2581 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2583 if (filename == NULL)
2585 int error_mode = ERR_WARN;
2588 /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2589 /* before failing, try fallback to default artwork */
2591 /* we can get away without sounds and music, but not without graphics */
2592 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2593 error_mode = ERR_EXIT;
2596 Error(error_mode, "cannot find artwork file '%s'", basename);
2600 /* check if the old and the new artwork file are the same */
2601 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2603 /* The old and new artwork are the same (have the same filename and path).
2604 This usually means that this artwork does not exist in this artwork set
2605 and a fallback to the existing artwork is done. */
2608 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2614 /* delete existing artwork file entry */
2615 deleteArtworkListEntry(artwork_info, listnode);
2617 /* check if the new artwork file already exists in the list of artworks */
2618 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2621 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2624 *listnode = (struct ListNodeInfo *)node->content;
2625 (*listnode)->num_references++;
2631 printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2634 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2635 DrawInitText(basename, 150, FC_YELLOW);
2637 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2640 printf("[adding new artwork '%s']\n", filename);
2643 (*listnode)->num_references = 1;
2644 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2649 int error_mode = ERR_WARN;
2652 /* we can get away without sounds and music, but not without graphics */
2653 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2654 error_mode = ERR_EXIT;
2657 Error(error_mode, "cannot load artwork file '%s'", basename);
2664 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2665 struct ListNodeInfo **listnode,
2666 struct FileInfo *file_list_entry)
2669 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2672 if (strcmp(file_list_entry->filename, UNDEFINED_FILENAME) == 0)
2674 deleteArtworkListEntry(artwork_info, listnode);
2678 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2683 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2684 struct ListNodeInfo **listnode,
2688 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2691 if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2693 deleteArtworkListEntry(artwork_info, listnode);
2697 replaceArtworkListEntry(artwork_info, listnode, basename);
2702 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2703 struct ListNodeInfo **listnode,
2704 struct FileInfo *file_list_entry)
2707 if (artwork_info->artwork_list == NULL ||
2708 list_pos >= artwork_info->num_file_list_entries)
2713 printf("loading artwork '%s' ... [%d]\n",
2714 basename, getNumNodes(artwork_info->content_list));
2718 LoadCustomArtwork(artwork_info, listnode, file_list_entry);
2720 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2725 printf("loading artwork '%s' done [%d]\n",
2726 basename, getNumNodes(artwork_info->content_list));
2732 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2733 struct ListNodeInfo **listnode,
2734 char *basename, int list_pos)
2737 if (artwork_info->artwork_list == NULL ||
2738 list_pos >= artwork_info->num_file_list_entries)
2743 printf("loading artwork '%s' ... [%d]\n",
2744 basename, getNumNodes(artwork_info->content_list));
2748 LoadCustomArtwork(artwork_info, listnode, basename);
2750 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2755 printf("loading artwork '%s' done [%d]\n",
2756 basename, getNumNodes(artwork_info->content_list));
2761 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2763 struct FileInfo *file_list = artwork_info->file_list;
2764 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2765 int num_file_list_entries = artwork_info->num_file_list_entries;
2766 int num_dynamic_file_list_entries =
2767 artwork_info->num_dynamic_file_list_entries;
2771 printf("DEBUG: reloading %d static artwork files ...\n",
2772 num_file_list_entries);
2775 for (i = 0; i < num_file_list_entries; i++)
2778 if (strcmp(file_list[i].token, "background") == 0)
2779 printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename);
2783 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2786 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2787 file_list[i].filename, i);
2791 /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2792 if (artwork_info->artwork_list[i] == NULL &&
2793 strcmp(file_list[i].filename, UNDEFINED_FILENAME) != 0 &&
2794 strcmp(file_list[i].default_filename, file_list[i].filename) != 0 &&
2795 strcmp(file_list[i].default_filename, UNDEFINED_FILENAME) != 0)
2797 Error(ERR_WARN, "trying default artwork file '%s'",
2798 file_list[i].default_filename);
2800 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2801 file_list[i].default_filename, i);
2803 /* even the fallback to default artwork was not successful -- fail now */
2804 if (artwork_info->artwork_list[i] == NULL &&
2805 artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2806 Error(ERR_EXIT, "cannot find artwork file '%s' or default file '%s'",
2807 file_list[i].filename, file_list[i].default_filename);
2809 file_list[i].fallback_to_default = TRUE;
2815 printf("DEBUG: reloading %d dynamic artwork files ...\n",
2816 num_dynamic_file_list_entries);
2819 for (i = 0; i < num_dynamic_file_list_entries; i++)
2822 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2823 &dynamic_file_list[i]);
2825 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2826 dynamic_file_list[i].filename, i);
2830 printf("::: '%s', '0x%08x'\n",
2831 dynamic_file_list[i].filename,
2832 dynamic_file_list[i].default_filename);
2835 /* dynamic artwork does not have default filename! */
2839 dumpList(artwork_info->content_list);
2843 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2844 struct ListNodeInfo ***list,
2845 int *num_list_entries)
2852 for (i = 0; i < *num_list_entries; i++)
2853 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2857 *num_list_entries = 0;
2860 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2862 if (artwork_info == NULL)
2866 printf("%s: FREEING ARTWORK ...\n",
2867 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2870 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2871 &artwork_info->num_file_list_entries);
2873 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2874 &artwork_info->num_dynamic_file_list_entries);
2877 printf("%s: FREEING ARTWORK -- DONE\n",
2878 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2883 /* ------------------------------------------------------------------------- */
2884 /* functions only needed for non-Unix (non-command-line) systems */
2885 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2886 /* ------------------------------------------------------------------------- */
2888 #if defined(PLATFORM_MSDOS)
2890 #define ERROR_FILENAME "stderr.txt"
2892 void initErrorFile()
2894 unlink(ERROR_FILENAME);
2897 FILE *openErrorFile()
2899 return fopen(ERROR_FILENAME, MODE_APPEND);
2902 void dumpErrorFile()
2904 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2906 if (error_file != NULL)
2908 while (!feof(error_file))
2909 fputc(fgetc(error_file), stderr);
2917 /* ------------------------------------------------------------------------- */
2918 /* the following is only for debugging purpose and normally not used */
2919 /* ------------------------------------------------------------------------- */
2921 #define DEBUG_NUM_TIMESTAMPS 3
2923 void debug_print_timestamp(int counter_nr, char *message)
2925 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2927 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2928 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2930 counter[counter_nr][0] = Counter();
2933 printf("%s %.2f seconds\n", message,
2934 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2936 counter[counter_nr][1] = Counter();
2939 void debug_print_parent_only(char *format, ...)
2941 if (!IS_PARENT_PROCESS())
2948 va_start(ap, format);
2949 vprintf(format, ap);