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 /* path manipulation functions */
461 /* ------------------------------------------------------------------------- */
463 static char *getLastPathSeparatorPtr(char *filename)
465 char *last_separator = strrchr(filename, '/');
467 #if !defined(PLATFORM_UNIX)
468 if (last_separator == NULL) /* also try DOS/Windows variant */
469 last_separator = strrchr(filename, '\\');
472 return last_separator;
475 static char *getBaseNamePtr(char *filename)
477 char *last_separator = getLastPathSeparatorPtr(filename);
479 if (last_separator != NULL)
480 return last_separator + 1; /* separator found: strip base path */
482 return filename; /* no separator found: filename has no path */
485 char *getBaseName(char *filename)
487 return getStringCopy(getBaseNamePtr(filename));
490 char *getBasePath(char *filename)
492 char *basepath = getStringCopy(filename);
493 char *last_separator = getLastPathSeparatorPtr(basepath);
495 if (last_separator != NULL)
496 *last_separator = '\0'; /* separator found: strip basename */
498 basepath = "."; /* no separator found: use current path */
504 /* ------------------------------------------------------------------------- */
505 /* various string functions */
506 /* ------------------------------------------------------------------------- */
508 char *getPath2(char *path1, char *path2)
510 char *complete_path = checked_malloc(strlen(path1) + 1 +
513 sprintf(complete_path, "%s/%s", path1, path2);
515 return complete_path;
518 char *getPath3(char *path1, char *path2, char *path3)
520 char *complete_path = checked_malloc(strlen(path1) + 1 +
524 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
526 return complete_path;
529 char *getStringCat2(char *s1, char *s2)
531 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
533 sprintf(complete_string, "%s%s", s1, s2);
535 return complete_string;
538 char *getStringCopy(char *s)
545 s_copy = checked_malloc(strlen(s) + 1);
551 char *getStringToLower(char *s)
553 char *s_copy = checked_malloc(strlen(s) + 1);
554 char *s_ptr = s_copy;
557 *s_ptr++ = tolower(*s++);
563 void setString(char **old_value, char *new_value)
565 checked_free(*old_value);
567 *old_value = getStringCopy(new_value);
571 /* ------------------------------------------------------------------------- */
572 /* command line option handling functions */
573 /* ------------------------------------------------------------------------- */
575 void GetOptions(char *argv[], void (*print_usage_function)(void))
577 char *ro_base_path = RO_BASE_PATH;
578 char *rw_base_path = RW_BASE_PATH;
579 char **options_left = &argv[1];
581 #if !defined(PLATFORM_MACOSX)
582 /* if the program is configured to start from current directory (default),
583 determine program package directory (KDE/Konqueror does not do this by
584 itself and fails otherwise); on Mac OS X, the program binary is stored
585 in an application package directory -- do not try to use this directory
586 as the program data directory (Mac OS X handles this correctly anyway) */
588 if (strcmp(ro_base_path, ".") == 0)
589 ro_base_path = program.command_basepath;
590 if (strcmp(rw_base_path, ".") == 0)
591 rw_base_path = program.command_basepath;
594 /* initialize global program options */
595 options.display_name = NULL;
596 options.server_host = NULL;
597 options.server_port = 0;
598 options.ro_base_directory = ro_base_path;
599 options.rw_base_directory = rw_base_path;
600 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
601 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
602 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
603 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
604 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
605 options.execute_command = NULL;
606 options.serveronly = FALSE;
607 options.network = FALSE;
608 options.verbose = FALSE;
609 options.debug = FALSE;
611 #if !defined(PLATFORM_UNIX)
612 if (*options_left == NULL) /* no options given -- enable verbose mode */
613 options.verbose = TRUE;
616 while (*options_left)
618 char option_str[MAX_OPTION_LEN];
619 char *option = options_left[0];
620 char *next_option = options_left[1];
621 char *option_arg = NULL;
622 int option_len = strlen(option);
624 if (option_len >= MAX_OPTION_LEN)
625 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
627 strcpy(option_str, option); /* copy argument into buffer */
630 if (strcmp(option, "--") == 0) /* stop scanning arguments */
633 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
636 option_arg = strchr(option, '=');
637 if (option_arg == NULL) /* no '=' in option */
638 option_arg = next_option;
641 *option_arg++ = '\0'; /* cut argument from option */
642 if (*option_arg == '\0') /* no argument after '=' */
643 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
646 option_len = strlen(option);
648 if (strcmp(option, "-") == 0)
649 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
650 else if (strncmp(option, "-help", option_len) == 0)
652 print_usage_function();
656 else if (strncmp(option, "-display", option_len) == 0)
658 if (option_arg == NULL)
659 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
661 options.display_name = option_arg;
662 if (option_arg == next_option)
665 else if (strncmp(option, "-basepath", option_len) == 0)
667 if (option_arg == NULL)
668 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
670 /* this should be extended to separate options for ro and rw data */
671 options.ro_base_directory = ro_base_path = option_arg;
672 options.rw_base_directory = rw_base_path = option_arg;
673 if (option_arg == next_option)
676 /* adjust paths for sub-directories in base directory accordingly */
677 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
678 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
679 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
680 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
681 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
683 else if (strncmp(option, "-levels", option_len) == 0)
685 if (option_arg == NULL)
686 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
688 options.level_directory = option_arg;
689 if (option_arg == next_option)
692 else if (strncmp(option, "-graphics", option_len) == 0)
694 if (option_arg == NULL)
695 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
697 options.graphics_directory = option_arg;
698 if (option_arg == next_option)
701 else if (strncmp(option, "-sounds", option_len) == 0)
703 if (option_arg == NULL)
704 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
706 options.sounds_directory = option_arg;
707 if (option_arg == next_option)
710 else if (strncmp(option, "-music", option_len) == 0)
712 if (option_arg == NULL)
713 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
715 options.music_directory = option_arg;
716 if (option_arg == next_option)
719 else if (strncmp(option, "-network", option_len) == 0)
721 options.network = TRUE;
723 else if (strncmp(option, "-serveronly", option_len) == 0)
725 options.serveronly = TRUE;
727 else if (strncmp(option, "-verbose", option_len) == 0)
729 options.verbose = TRUE;
731 else if (strncmp(option, "-debug", option_len) == 0)
733 options.debug = TRUE;
735 else if (strncmp(option, "-execute", option_len) == 0)
737 if (option_arg == NULL)
738 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
740 options.execute_command = option_arg;
741 if (option_arg == next_option)
745 /* when doing batch processing, always enable verbose mode (warnings) */
746 options.verbose = TRUE;
749 else if (*option == '-')
751 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
753 else if (options.server_host == NULL)
755 options.server_host = *options_left;
757 else if (options.server_port == 0)
759 options.server_port = atoi(*options_left);
760 if (options.server_port < 1024)
761 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
764 Error(ERR_EXIT_HELP, "too many arguments");
771 /* ------------------------------------------------------------------------- */
772 /* error handling functions */
773 /* ------------------------------------------------------------------------- */
775 /* used by SetError() and GetError() to store internal error messages */
776 static char internal_error[1024]; /* this is bad */
778 void SetError(char *format, ...)
782 va_start(ap, format);
783 vsprintf(internal_error, format, ap);
789 return internal_error;
792 void Error(int mode, char *format, ...)
794 static boolean last_line_was_separator = FALSE;
795 char *process_name = "";
796 FILE *error = stderr;
797 char *newline = "\n";
799 /* display warnings only when running in verbose mode */
800 if (mode & ERR_WARN && !options.verbose)
803 if (mode == ERR_RETURN_LINE)
805 if (!last_line_was_separator)
806 fprintf_line(error, format, 79);
808 last_line_was_separator = TRUE;
813 last_line_was_separator = FALSE;
815 #if defined(PLATFORM_MSDOS)
818 if ((error = openErrorFile()) == NULL)
820 printf("Cannot write to error output file!%s", newline);
821 program.exit_function(1);
825 if (mode & ERR_SOUND_SERVER)
826 process_name = " sound server";
827 else if (mode & ERR_NETWORK_SERVER)
828 process_name = " network server";
829 else if (mode & ERR_NETWORK_CLIENT)
830 process_name = " network client **";
836 fprintf(error, "%s%s: ", program.command_basename, process_name);
839 fprintf(error, "warning: ");
841 va_start(ap, format);
842 vfprintf(error, format, ap);
845 fprintf(error, "%s", newline);
849 fprintf(error, "%s: Try option '--help' for more information.%s",
850 program.command_basename, newline);
853 fprintf(error, "%s%s: aborting%s",
854 program.command_basename, process_name, newline);
861 if (mode & ERR_FROM_SERVER)
862 exit(1); /* child process: normal exit */
864 program.exit_function(1); /* main process: clean up stuff */
869 /* ------------------------------------------------------------------------- */
870 /* checked memory allocation and freeing functions */
871 /* ------------------------------------------------------------------------- */
873 void *checked_malloc(unsigned long size)
880 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
885 void *checked_calloc(unsigned long size)
889 ptr = calloc(1, size);
892 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
897 void *checked_realloc(void *ptr, unsigned long size)
899 ptr = realloc(ptr, size);
902 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
907 void checked_free(void *ptr)
909 if (ptr != NULL) /* this check should be done by free() anyway */
914 /* ------------------------------------------------------------------------- */
915 /* various helper functions */
916 /* ------------------------------------------------------------------------- */
918 inline void swap_numbers(int *i1, int *i2)
926 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
938 int getFile16BitInteger(FILE *file, int byte_order)
940 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
941 return ((fgetc(file) << 8) |
943 else /* BYTE_ORDER_LITTLE_ENDIAN */
944 return ((fgetc(file) << 0) |
948 void putFile16BitInteger(FILE *file, int value, int byte_order)
950 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
952 fputc((value >> 8) & 0xff, file);
953 fputc((value >> 0) & 0xff, file);
955 else /* BYTE_ORDER_LITTLE_ENDIAN */
957 fputc((value >> 0) & 0xff, file);
958 fputc((value >> 8) & 0xff, file);
962 int getFile32BitInteger(FILE *file, int byte_order)
964 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
965 return ((fgetc(file) << 24) |
966 (fgetc(file) << 16) |
969 else /* BYTE_ORDER_LITTLE_ENDIAN */
970 return ((fgetc(file) << 0) |
972 (fgetc(file) << 16) |
973 (fgetc(file) << 24));
976 void putFile32BitInteger(FILE *file, int value, int byte_order)
978 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
980 fputc((value >> 24) & 0xff, file);
981 fputc((value >> 16) & 0xff, file);
982 fputc((value >> 8) & 0xff, file);
983 fputc((value >> 0) & 0xff, file);
985 else /* BYTE_ORDER_LITTLE_ENDIAN */
987 fputc((value >> 0) & 0xff, file);
988 fputc((value >> 8) & 0xff, file);
989 fputc((value >> 16) & 0xff, file);
990 fputc((value >> 24) & 0xff, file);
994 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
997 const int chunk_name_length = 4;
999 /* read chunk name */
1000 fgets(chunk_name, chunk_name_length + 1, file);
1002 if (chunk_size != NULL)
1004 /* read chunk size */
1005 *chunk_size = getFile32BitInteger(file, byte_order);
1008 return (feof(file) || ferror(file) ? FALSE : TRUE);
1011 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1014 /* write chunk name */
1015 fputs(chunk_name, file);
1017 if (chunk_size >= 0)
1019 /* write chunk size */
1020 putFile32BitInteger(file, chunk_size, byte_order);
1024 int getFileVersion(FILE *file)
1026 int version_major = fgetc(file);
1027 int version_minor = fgetc(file);
1028 int version_patch = fgetc(file);
1029 int version_build = fgetc(file);
1031 return VERSION_IDENT(version_major, version_minor, version_patch,
1035 void putFileVersion(FILE *file, int version)
1037 int version_major = VERSION_MAJOR(version);
1038 int version_minor = VERSION_MINOR(version);
1039 int version_patch = VERSION_PATCH(version);
1040 int version_build = VERSION_BUILD(version);
1042 fputc(version_major, file);
1043 fputc(version_minor, file);
1044 fputc(version_patch, file);
1045 fputc(version_build, file);
1048 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1050 while (bytes-- && !feof(file))
1054 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1061 /* ------------------------------------------------------------------------- */
1062 /* functions to translate key identifiers between different format */
1063 /* ------------------------------------------------------------------------- */
1065 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1066 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1067 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1068 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1070 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1079 /* normal cursor keys */
1080 { KSYM_Left, "XK_Left", "cursor left" },
1081 { KSYM_Right, "XK_Right", "cursor right" },
1082 { KSYM_Up, "XK_Up", "cursor up" },
1083 { KSYM_Down, "XK_Down", "cursor down" },
1085 /* keypad cursor keys */
1087 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1088 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1089 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1090 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1093 /* other keypad keys */
1094 #ifdef KSYM_KP_Enter
1095 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1096 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1097 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1098 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1099 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1100 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1104 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1105 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1106 { KSYM_Control_L, "XK_Control_L", "left control" },
1107 { KSYM_Control_R, "XK_Control_R", "right control" },
1108 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1109 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1110 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1111 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1112 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1113 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1114 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1115 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1117 /* some special keys */
1118 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1119 { KSYM_Delete, "XK_Delete", "delete" },
1120 { KSYM_Insert, "XK_Insert", "insert" },
1121 { KSYM_Tab, "XK_Tab", "tab" },
1122 { KSYM_Home, "XK_Home", "home" },
1123 { KSYM_End, "XK_End", "end" },
1124 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1125 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1126 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1128 /* ASCII 0x20 to 0x40 keys (except numbers) */
1129 { KSYM_space, "XK_space", "space" },
1130 { KSYM_exclam, "XK_exclam", "!" },
1131 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1132 { KSYM_numbersign, "XK_numbersign", "#" },
1133 { KSYM_dollar, "XK_dollar", "$" },
1134 { KSYM_percent, "XK_percent", "%" },
1135 { KSYM_ampersand, "XK_ampersand", "&" },
1136 { KSYM_apostrophe, "XK_apostrophe", "'" },
1137 { KSYM_parenleft, "XK_parenleft", "(" },
1138 { KSYM_parenright, "XK_parenright", ")" },
1139 { KSYM_asterisk, "XK_asterisk", "*" },
1140 { KSYM_plus, "XK_plus", "+" },
1141 { KSYM_comma, "XK_comma", "," },
1142 { KSYM_minus, "XK_minus", "-" },
1143 { KSYM_period, "XK_period", "." },
1144 { KSYM_slash, "XK_slash", "/" },
1145 { KSYM_colon, "XK_colon", ":" },
1146 { KSYM_semicolon, "XK_semicolon", ";" },
1147 { KSYM_less, "XK_less", "<" },
1148 { KSYM_equal, "XK_equal", "=" },
1149 { KSYM_greater, "XK_greater", ">" },
1150 { KSYM_question, "XK_question", "?" },
1151 { KSYM_at, "XK_at", "@" },
1153 /* more ASCII keys */
1154 { KSYM_bracketleft, "XK_bracketleft", "[" },
1155 { KSYM_backslash, "XK_backslash", "backslash" },
1156 { KSYM_bracketright,"XK_bracketright", "]" },
1157 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1158 { KSYM_underscore, "XK_underscore", "_" },
1159 { KSYM_grave, "XK_grave", "grave" },
1160 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1161 { KSYM_braceleft, "XK_braceleft", "brace left" },
1162 { KSYM_bar, "XK_bar", "bar" },
1163 { KSYM_braceright, "XK_braceright", "brace right" },
1164 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1166 /* special (non-ASCII) keys */
1167 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1168 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1169 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1170 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1171 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1172 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1173 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1175 /* end-of-array identifier */
1181 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1183 static char name_buffer[30];
1186 if (key >= KSYM_A && key <= KSYM_Z)
1187 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1188 else if (key >= KSYM_a && key <= KSYM_z)
1189 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1190 else if (key >= KSYM_0 && key <= KSYM_9)
1191 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1192 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1193 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1194 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1195 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1196 else if (key == KSYM_UNDEFINED)
1197 strcpy(name_buffer, "(undefined)");
1204 if (key == translate_key[i].key)
1206 strcpy(name_buffer, translate_key[i].name);
1210 while (translate_key[++i].name);
1212 if (!translate_key[i].name)
1213 strcpy(name_buffer, "(unknown)");
1216 *name = name_buffer;
1218 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1220 static char name_buffer[30];
1223 if (key >= KSYM_A && key <= KSYM_Z)
1224 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1225 else if (key >= KSYM_a && key <= KSYM_z)
1226 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1227 else if (key >= KSYM_0 && key <= KSYM_9)
1228 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1229 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1230 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1231 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1232 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1233 else if (key == KSYM_UNDEFINED)
1234 strcpy(name_buffer, "[undefined]");
1241 if (key == translate_key[i].key)
1243 strcpy(name_buffer, translate_key[i].x11name);
1247 while (translate_key[++i].x11name);
1249 if (!translate_key[i].x11name)
1250 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1253 *x11name = name_buffer;
1255 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1257 Key key = KSYM_UNDEFINED;
1262 if (strcmp(translate_key[i].name, *name) == 0)
1264 key = translate_key[i].key;
1268 while (translate_key[++i].x11name);
1270 if (key == KSYM_UNDEFINED)
1271 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1275 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1277 Key key = KSYM_UNDEFINED;
1278 char *name_ptr = *x11name;
1280 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1282 char c = name_ptr[3];
1284 if (c >= 'A' && c <= 'Z')
1285 key = KSYM_A + (Key)(c - 'A');
1286 else if (c >= 'a' && c <= 'z')
1287 key = KSYM_a + (Key)(c - 'a');
1288 else if (c >= '0' && c <= '9')
1289 key = KSYM_0 + (Key)(c - '0');
1291 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1293 char c = name_ptr[6];
1295 if (c >= '0' && c <= '9')
1296 key = KSYM_KP_0 + (Key)(c - '0');
1298 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1300 char c1 = name_ptr[4];
1301 char c2 = name_ptr[5];
1304 if ((c1 >= '0' && c1 <= '9') &&
1305 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1306 d = atoi(&name_ptr[4]);
1308 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1309 key = KSYM_F1 + (Key)(d - 1);
1311 else if (strncmp(name_ptr, "XK_", 3) == 0)
1317 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1319 key = translate_key[i].key;
1323 while (translate_key[++i].x11name);
1325 else if (strncmp(name_ptr, "0x", 2) == 0)
1327 unsigned long value = 0;
1333 char c = *name_ptr++;
1336 if (c >= '0' && c <= '9')
1338 else if (c >= 'a' && c <= 'f')
1339 d = (int)(c - 'a' + 10);
1340 else if (c >= 'A' && c <= 'F')
1341 d = (int)(c - 'A' + 10);
1349 value = value * 16 + d;
1360 char *getKeyNameFromKey(Key key)
1364 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1368 char *getX11KeyNameFromKey(Key key)
1372 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1376 Key getKeyFromKeyName(char *name)
1380 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1384 Key getKeyFromX11KeyName(char *x11name)
1388 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1392 char getCharFromKey(Key key)
1394 char *keyname = getKeyNameFromKey(key);
1397 if (strlen(keyname) == 1)
1398 letter = keyname[0];
1399 else if (strcmp(keyname, "space") == 0)
1401 else if (strcmp(keyname, "circumflex") == 0)
1408 /* ------------------------------------------------------------------------- */
1409 /* functions to translate string identifiers to integer or boolean value */
1410 /* ------------------------------------------------------------------------- */
1412 int get_integer_from_string(char *s)
1414 static char *number_text[][3] =
1416 { "0", "zero", "null", },
1417 { "1", "one", "first" },
1418 { "2", "two", "second" },
1419 { "3", "three", "third" },
1420 { "4", "four", "fourth" },
1421 { "5", "five", "fifth" },
1422 { "6", "six", "sixth" },
1423 { "7", "seven", "seventh" },
1424 { "8", "eight", "eighth" },
1425 { "9", "nine", "ninth" },
1426 { "10", "ten", "tenth" },
1427 { "11", "eleven", "eleventh" },
1428 { "12", "twelve", "twelfth" },
1430 { NULL, NULL, NULL },
1434 char *s_lower = getStringToLower(s);
1437 for (i = 0; number_text[i][0] != NULL; i++)
1438 for (j = 0; j < 3; j++)
1439 if (strcmp(s_lower, number_text[i][j]) == 0)
1444 if (strcmp(s_lower, "false") == 0)
1446 else if (strcmp(s_lower, "true") == 0)
1457 boolean get_boolean_from_string(char *s)
1459 char *s_lower = getStringToLower(s);
1460 boolean result = FALSE;
1462 if (strcmp(s_lower, "true") == 0 ||
1463 strcmp(s_lower, "yes") == 0 ||
1464 strcmp(s_lower, "on") == 0 ||
1465 get_integer_from_string(s) == 1)
1474 /* ------------------------------------------------------------------------- */
1475 /* functions for generic lists */
1476 /* ------------------------------------------------------------------------- */
1478 ListNode *newListNode()
1480 return checked_calloc(sizeof(ListNode));
1483 void addNodeToList(ListNode **node_first, char *key, void *content)
1485 ListNode *node_new = newListNode();
1488 printf("LIST: adding node with key '%s'\n", key);
1491 node_new->key = getStringCopy(key);
1492 node_new->content = content;
1493 node_new->next = *node_first;
1494 *node_first = node_new;
1497 void deleteNodeFromList(ListNode **node_first, char *key,
1498 void (*destructor_function)(void *))
1500 if (node_first == NULL || *node_first == NULL)
1504 printf("[CHECKING LIST KEY '%s' == '%s']\n",
1505 (*node_first)->key, key);
1508 if (strcmp((*node_first)->key, key) == 0)
1511 printf("[DELETING LIST ENTRY]\n");
1514 free((*node_first)->key);
1515 if (destructor_function)
1516 destructor_function((*node_first)->content);
1517 *node_first = (*node_first)->next;
1520 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1523 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1525 if (node_first == NULL)
1528 if (strcmp(node_first->key, key) == 0)
1531 return getNodeFromKey(node_first->next, key);
1534 int getNumNodes(ListNode *node_first)
1536 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1539 void dumpList(ListNode *node_first)
1541 ListNode *node = node_first;
1545 printf("['%s' (%d)]\n", node->key,
1546 ((struct ListNodeInfo *)node->content)->num_references);
1550 printf("[%d nodes]\n", getNumNodes(node_first));
1554 /* ------------------------------------------------------------------------- */
1555 /* functions for checking files and filenames */
1556 /* ------------------------------------------------------------------------- */
1558 boolean fileExists(char *filename)
1560 if (filename == NULL)
1564 printf("checking file '%s'\n", filename);
1567 return (access(filename, F_OK) == 0);
1570 boolean fileHasPrefix(char *basename, char *prefix)
1572 static char *basename_lower = NULL;
1573 int basename_length, prefix_length;
1575 checked_free(basename_lower);
1577 if (basename == NULL || prefix == NULL)
1580 basename_lower = getStringToLower(basename);
1581 basename_length = strlen(basename_lower);
1582 prefix_length = strlen(prefix);
1584 if (basename_length > prefix_length + 1 &&
1585 basename_lower[prefix_length] == '.' &&
1586 strncmp(basename_lower, prefix, prefix_length) == 0)
1592 boolean fileHasSuffix(char *basename, char *suffix)
1594 static char *basename_lower = NULL;
1595 int basename_length, suffix_length;
1597 checked_free(basename_lower);
1599 if (basename == NULL || suffix == NULL)
1602 basename_lower = getStringToLower(basename);
1603 basename_length = strlen(basename_lower);
1604 suffix_length = strlen(suffix);
1606 if (basename_length > suffix_length + 1 &&
1607 basename_lower[basename_length - suffix_length - 1] == '.' &&
1608 strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0)
1614 boolean FileIsGraphic(char *filename)
1616 char *basename = getBaseNamePtr(filename);
1618 return fileHasSuffix(basename, "pcx");
1621 boolean FileIsSound(char *filename)
1623 char *basename = getBaseNamePtr(filename);
1625 return fileHasSuffix(basename, "wav");
1628 boolean FileIsMusic(char *filename)
1630 char *basename = getBaseNamePtr(filename);
1632 if (FileIsSound(basename))
1635 #if defined(TARGET_SDL)
1636 if (fileHasPrefix(basename, "mod") ||
1637 fileHasSuffix(basename, "mod") ||
1638 fileHasSuffix(basename, "s3m") ||
1639 fileHasSuffix(basename, "it") ||
1640 fileHasSuffix(basename, "xm") ||
1641 fileHasSuffix(basename, "midi") ||
1642 fileHasSuffix(basename, "mid") ||
1643 fileHasSuffix(basename, "mp3") ||
1644 fileHasSuffix(basename, "ogg"))
1651 boolean FileIsArtworkType(char *basename, int type)
1653 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1654 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1655 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1661 /* ------------------------------------------------------------------------- */
1662 /* functions for loading artwork configuration information */
1663 /* ------------------------------------------------------------------------- */
1665 char *get_mapped_token(char *token)
1667 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1668 static char *map_token_prefix[][2] =
1670 { "char_procent", "char_percent" },
1675 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1677 int len_token_prefix = strlen(map_token_prefix[i][0]);
1679 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1680 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1686 /* This function checks if a string <s> of the format "string1, string2, ..."
1687 exactly contains a string <s_contained>. */
1689 static boolean string_has_parameter(char *s, char *s_contained)
1693 if (s == NULL || s_contained == NULL)
1696 if (strlen(s_contained) > strlen(s))
1699 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1701 char next_char = s[strlen(s_contained)];
1703 /* check if next character is delimiter or whitespace */
1704 return (next_char == ',' || next_char == '\0' ||
1705 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1708 /* check if string contains another parameter string after a comma */
1709 substring = strchr(s, ',');
1710 if (substring == NULL) /* string does not contain a comma */
1713 /* advance string pointer to next character after the comma */
1716 /* skip potential whitespaces after the comma */
1717 while (*substring == ' ' || *substring == '\t')
1720 return string_has_parameter(substring, s_contained);
1723 int get_parameter_value(char *suffix, char *value_raw, int type)
1725 char *value = getStringToLower(value_raw);
1726 int result = 0; /* probably a save default value */
1728 if (strcmp(suffix, ".direction") == 0)
1730 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1731 strcmp(value, "right") == 0 ? MV_RIGHT :
1732 strcmp(value, "up") == 0 ? MV_UP :
1733 strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING);
1735 else if (strcmp(suffix, ".anim_mode") == 0)
1737 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1738 string_has_parameter(value, "loop") ? ANIM_LOOP :
1739 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1740 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1741 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1742 string_has_parameter(value, "random") ? ANIM_RANDOM :
1743 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1744 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1747 if (string_has_parameter(value, "reverse"))
1748 result |= ANIM_REVERSE;
1750 else /* generic parameter of type integer or boolean */
1752 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1753 type == TYPE_INTEGER ? get_integer_from_string(value) :
1754 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1755 ARG_UNDEFINED_VALUE);
1763 int get_auto_parameter_value(char *token, char *value_raw)
1767 if (token == NULL || value_raw == NULL)
1768 return ARG_UNDEFINED_VALUE;
1770 suffix = strrchr(token, '.');
1774 return get_parameter_value(suffix, value_raw, TYPE_INTEGER);
1777 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1778 struct ListNodeInfo ***, int *);
1780 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1781 struct ConfigTypeInfo *suffix_list,
1782 char **ignore_tokens,
1783 int num_file_list_entries)
1785 struct FileInfo *file_list;
1786 int num_file_list_entries_found = 0;
1787 int num_suffix_list_entries = 0;
1791 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1793 for (i = 0; suffix_list[i].token != NULL; i++)
1794 num_suffix_list_entries++;
1796 /* always start with reliable default values */
1797 for (i = 0; i < num_file_list_entries; i++)
1799 file_list[i].token = NULL;
1801 file_list[i].default_filename = NULL;
1802 file_list[i].filename = NULL;
1804 if (num_suffix_list_entries > 0)
1806 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1808 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1809 file_list[i].parameter = checked_calloc(parameter_array_size);
1811 for (j = 0; j < num_suffix_list_entries; j++)
1813 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1814 setString(&file_list[i].parameter[j], suffix_list[j].value);
1817 file_list[i].redefined = FALSE;
1818 file_list[i].fallback_to_default = FALSE;
1823 for (i = 0; config_list[i].token != NULL; i++)
1825 int len_config_token = strlen(config_list[i].token);
1826 int len_config_value = strlen(config_list[i].value);
1827 boolean is_file_entry = TRUE;
1829 for (j = 0; suffix_list[j].token != NULL; j++)
1831 int len_suffix = strlen(suffix_list[j].token);
1833 if (len_suffix < len_config_token &&
1834 strcmp(&config_list[i].token[len_config_token - len_suffix],
1835 suffix_list[j].token) == 0)
1837 setString(&file_list[list_pos].default_parameter[j],
1838 config_list[i].value);
1840 is_file_entry = FALSE;
1845 /* the following tokens are no file definitions, but other config tokens */
1846 for (j = 0; ignore_tokens[j] != NULL; j++)
1847 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1848 is_file_entry = FALSE;
1855 if (list_pos >= num_file_list_entries)
1858 /* simple sanity check if this is really a file definition */
1859 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1860 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1861 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1863 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1864 config_list[i].token, config_list[i].value);
1865 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1868 file_list[list_pos].token = config_list[i].token;
1869 file_list[list_pos].default_filename = config_list[i].value;
1873 num_file_list_entries_found = list_pos + 1;
1874 if (num_file_list_entries_found != num_file_list_entries)
1876 Error(ERR_RETURN_LINE, "-");
1877 Error(ERR_RETURN, "inconsistant config list information:");
1878 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1879 num_file_list_entries);
1880 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1881 num_file_list_entries_found);
1882 Error(ERR_EXIT, "please fix");
1888 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1890 int len_token = strlen(token);
1891 int len_suffix = strlen(suffix);
1894 if (IS_PARENT_PROCESS())
1895 printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1898 if (start_pos < 0) /* compare suffix from end of string */
1899 start_pos += len_token;
1901 if (start_pos < 0 || start_pos + len_suffix > len_token)
1904 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1907 if (token[start_pos + len_suffix] == '\0')
1910 if (token[start_pos + len_suffix] == '.')
1916 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1918 static void read_token_parameters(SetupFileHash *setup_file_hash,
1919 struct ConfigTypeInfo *suffix_list,
1920 struct FileInfo *file_list_entry)
1922 /* check for config token that is the base token without any suffixes */
1923 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1924 char *known_token_value = KNOWN_TOKEN_VALUE;
1927 if (filename != NULL)
1929 setString(&file_list_entry->filename, filename);
1931 /* when file definition found, set all parameters to default values */
1932 for (i = 0; suffix_list[i].token != NULL; i++)
1933 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1935 file_list_entry->redefined = TRUE;
1937 /* mark config file token as well known from default config */
1938 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1943 if (strcmp(file_list_entry->filename,
1944 file_list_entry->default_filename) != 0)
1945 printf("___ resetting '%s' to default\n", file_list_entry->token);
1947 setString(&file_list_entry->filename, file_list_entry->default_filename);
1951 /* check for config tokens that can be build by base token and suffixes */
1952 for (i = 0; suffix_list[i].token != NULL; i++)
1954 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1955 char *value = getHashEntry(setup_file_hash, token);
1959 setString(&file_list_entry->parameter[i], value);
1961 /* mark config file token as well known from default config */
1962 setHashEntry(setup_file_hash, token, known_token_value);
1969 static void add_dynamic_file_list_entry(struct FileInfo **list,
1970 int *num_list_entries,
1971 SetupFileHash *extra_file_hash,
1972 struct ConfigTypeInfo *suffix_list,
1973 int num_suffix_list_entries,
1976 struct FileInfo *new_list_entry;
1977 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1980 if (IS_PARENT_PROCESS())
1981 printf("===> found dynamic definition '%s'\n", token);
1984 (*num_list_entries)++;
1985 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1986 new_list_entry = &(*list)[*num_list_entries - 1];
1988 new_list_entry->token = getStringCopy(token);
1989 new_list_entry->default_filename = NULL;
1990 new_list_entry->filename = NULL;
1991 new_list_entry->parameter = checked_calloc(parameter_array_size);
1993 new_list_entry->redefined = FALSE;
1994 new_list_entry->fallback_to_default = FALSE;
1996 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
1999 static void add_property_mapping(struct PropertyMapping **list,
2000 int *num_list_entries,
2001 int base_index, int ext1_index,
2002 int ext2_index, int ext3_index,
2005 struct PropertyMapping *new_list_entry;
2007 (*num_list_entries)++;
2008 *list = checked_realloc(*list,
2009 *num_list_entries * sizeof(struct PropertyMapping));
2010 new_list_entry = &(*list)[*num_list_entries - 1];
2012 new_list_entry->base_index = base_index;
2013 new_list_entry->ext1_index = ext1_index;
2014 new_list_entry->ext2_index = ext2_index;
2015 new_list_entry->ext3_index = ext3_index;
2017 new_list_entry->artwork_index = artwork_index;
2020 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2023 struct FileInfo *file_list = artwork_info->file_list;
2024 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2025 char **base_prefixes = artwork_info->base_prefixes;
2026 char **ext1_suffixes = artwork_info->ext1_suffixes;
2027 char **ext2_suffixes = artwork_info->ext2_suffixes;
2028 char **ext3_suffixes = artwork_info->ext3_suffixes;
2029 char **ignore_tokens = artwork_info->ignore_tokens;
2030 int num_file_list_entries = artwork_info->num_file_list_entries;
2031 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2032 int num_base_prefixes = artwork_info->num_base_prefixes;
2033 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2034 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2035 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2036 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2037 SetupFileHash *setup_file_hash, *valid_file_hash;
2038 SetupFileHash *extra_file_hash, *empty_file_hash;
2039 char *known_token_value = KNOWN_TOKEN_VALUE;
2042 if (filename == NULL)
2046 printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename);
2049 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2052 /* separate valid (defined) from empty (undefined) config token values */
2053 valid_file_hash = newSetupFileHash();
2054 empty_file_hash = newSetupFileHash();
2055 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2057 char *value = HASH_ITERATION_VALUE(itr);
2059 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2060 HASH_ITERATION_TOKEN(itr), value);
2062 END_HASH_ITERATION(setup_file_hash, itr)
2064 /* at this point, we do not need the setup file hash anymore -- free it */
2065 freeSetupFileHash(setup_file_hash);
2068 /* map deprecated to current tokens (using prefix match and replace) */
2069 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2071 char *token = HASH_ITERATION_TOKEN(itr);
2072 char *mapped_token = get_mapped_token(token);
2074 if (mapped_token != NULL)
2076 char *value = HASH_ITERATION_VALUE(itr);
2078 /* add mapped token */
2079 setHashEntry(valid_file_hash, mapped_token, value);
2081 /* ignore old token (by setting it to "known" keyword) */
2082 setHashEntry(valid_file_hash, token, known_token_value);
2087 END_HASH_ITERATION(valid_file_hash, itr)
2090 /* read parameters for all known config file tokens */
2091 for (i = 0; i < num_file_list_entries; i++)
2092 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2094 /* set all tokens that can be ignored here to "known" keyword */
2095 for (i = 0; i < num_ignore_tokens; i++)
2096 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2098 /* copy all unknown config file tokens to extra config hash */
2099 extra_file_hash = newSetupFileHash();
2100 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2102 char *value = HASH_ITERATION_VALUE(itr);
2104 if (strcmp(value, known_token_value) != 0)
2105 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2107 END_HASH_ITERATION(valid_file_hash, itr)
2109 /* at this point, we do not need the valid file hash anymore -- free it */
2110 freeSetupFileHash(valid_file_hash);
2112 /* now try to determine valid, dynamically defined config tokens */
2114 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2116 struct FileInfo **dynamic_file_list =
2117 &artwork_info->dynamic_file_list;
2118 int *num_dynamic_file_list_entries =
2119 &artwork_info->num_dynamic_file_list_entries;
2120 struct PropertyMapping **property_mapping =
2121 &artwork_info->property_mapping;
2122 int *num_property_mapping_entries =
2123 &artwork_info->num_property_mapping_entries;
2124 int current_summarized_file_list_entry =
2125 artwork_info->num_file_list_entries +
2126 artwork_info->num_dynamic_file_list_entries;
2127 char *token = HASH_ITERATION_TOKEN(itr);
2128 int len_token = strlen(token);
2130 boolean base_prefix_found = FALSE;
2131 boolean parameter_suffix_found = FALSE;
2134 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2137 /* skip all parameter definitions (handled by read_token_parameters()) */
2138 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2140 int len_suffix = strlen(suffix_list[i].token);
2142 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2143 parameter_suffix_found = TRUE;
2147 if (IS_PARENT_PROCESS())
2149 if (parameter_suffix_found)
2150 printf("---> skipping token '%s' (parameter token)\n", token);
2152 printf("---> examining token '%s': search prefix ...\n", token);
2156 if (parameter_suffix_found)
2159 /* ---------- step 0: search for matching base prefix ---------- */
2162 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2164 char *base_prefix = base_prefixes[i];
2165 int len_base_prefix = strlen(base_prefix);
2166 boolean ext1_suffix_found = FALSE;
2167 boolean ext2_suffix_found = FALSE;
2168 boolean ext3_suffix_found = FALSE;
2169 boolean exact_match = FALSE;
2170 int base_index = -1;
2171 int ext1_index = -1;
2172 int ext2_index = -1;
2173 int ext3_index = -1;
2175 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2177 if (!base_prefix_found)
2182 if (start_pos + len_base_prefix == len_token) /* exact match */
2186 add_dynamic_file_list_entry(dynamic_file_list,
2187 num_dynamic_file_list_entries,
2190 num_suffix_list_entries,
2192 add_property_mapping(property_mapping,
2193 num_property_mapping_entries,
2194 base_index, -1, -1, -1,
2195 current_summarized_file_list_entry);
2200 if (IS_PARENT_PROCESS())
2201 printf("---> examining token '%s': search 1st suffix ...\n", token);
2204 /* ---------- step 1: search for matching first suffix ---------- */
2206 start_pos += len_base_prefix;
2207 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2209 char *ext1_suffix = ext1_suffixes[j];
2210 int len_ext1_suffix = strlen(ext1_suffix);
2212 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2214 if (!ext1_suffix_found)
2219 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2223 add_dynamic_file_list_entry(dynamic_file_list,
2224 num_dynamic_file_list_entries,
2227 num_suffix_list_entries,
2229 add_property_mapping(property_mapping,
2230 num_property_mapping_entries,
2231 base_index, ext1_index, -1, -1,
2232 current_summarized_file_list_entry);
2236 start_pos += len_ext1_suffix;
2243 if (IS_PARENT_PROCESS())
2244 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2247 /* ---------- step 2: search for matching second suffix ---------- */
2249 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2251 char *ext2_suffix = ext2_suffixes[k];
2252 int len_ext2_suffix = strlen(ext2_suffix);
2254 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2256 if (!ext2_suffix_found)
2261 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2265 add_dynamic_file_list_entry(dynamic_file_list,
2266 num_dynamic_file_list_entries,
2269 num_suffix_list_entries,
2271 add_property_mapping(property_mapping,
2272 num_property_mapping_entries,
2273 base_index, ext1_index, ext2_index, -1,
2274 current_summarized_file_list_entry);
2278 start_pos += len_ext2_suffix;
2285 if (IS_PARENT_PROCESS())
2286 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2289 /* ---------- step 3: search for matching third suffix ---------- */
2291 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2293 char *ext3_suffix = ext3_suffixes[l];
2294 int len_ext3_suffix = strlen(ext3_suffix);
2296 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2298 if (!ext3_suffix_found)
2303 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2307 add_dynamic_file_list_entry(dynamic_file_list,
2308 num_dynamic_file_list_entries,
2311 num_suffix_list_entries,
2313 add_property_mapping(property_mapping,
2314 num_property_mapping_entries,
2315 base_index, ext1_index, ext2_index, ext3_index,
2316 current_summarized_file_list_entry);
2322 END_HASH_ITERATION(extra_file_hash, itr)
2324 if (artwork_info->num_dynamic_file_list_entries > 0)
2326 artwork_info->dynamic_artwork_list =
2327 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2328 artwork_info->sizeof_artwork_list_entry);
2331 if (options.verbose && IS_PARENT_PROCESS())
2333 SetupFileList *setup_file_list, *list;
2334 boolean dynamic_tokens_found = FALSE;
2335 boolean unknown_tokens_found = FALSE;
2336 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2338 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2339 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2341 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2343 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2344 dynamic_tokens_found = TRUE;
2346 unknown_tokens_found = TRUE;
2348 END_HASH_ITERATION(extra_file_hash, itr)
2350 if (options.debug && dynamic_tokens_found)
2352 Error(ERR_RETURN_LINE, "-");
2353 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2354 Error(ERR_RETURN, "- config file: '%s'", filename);
2356 for (list = setup_file_list; list != NULL; list = list->next)
2358 char *value = getHashEntry(extra_file_hash, list->token);
2360 if (value != NULL && strcmp(value, known_token_value) == 0)
2361 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2364 Error(ERR_RETURN_LINE, "-");
2367 if (unknown_tokens_found)
2369 Error(ERR_RETURN_LINE, "-");
2370 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2371 Error(ERR_RETURN, "- config file: '%s'", filename);
2373 for (list = setup_file_list; list != NULL; list = list->next)
2375 char *value = getHashEntry(extra_file_hash, list->token);
2377 if (value != NULL && strcmp(value, known_token_value) != 0)
2378 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2381 Error(ERR_RETURN_LINE, "-");
2384 if (undefined_values_found)
2386 Error(ERR_RETURN_LINE, "-");
2387 Error(ERR_RETURN, "warning: undefined values found in config file:");
2388 Error(ERR_RETURN, "- config file: '%s'", filename);
2390 for (list = setup_file_list; list != NULL; list = list->next)
2392 char *value = getHashEntry(empty_file_hash, list->token);
2395 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2398 Error(ERR_RETURN_LINE, "-");
2401 freeSetupFileList(setup_file_list);
2404 freeSetupFileHash(extra_file_hash);
2405 freeSetupFileHash(empty_file_hash);
2408 for (i = 0; i < num_file_list_entries; i++)
2410 printf("'%s' ", file_list[i].token);
2411 if (file_list[i].filename)
2412 printf("-> '%s'\n", file_list[i].filename);
2414 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2419 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2421 struct FileInfo *file_list = artwork_info->file_list;
2422 int num_file_list_entries = artwork_info->num_file_list_entries;
2423 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2424 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2428 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2431 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2432 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2434 /* always start with reliable default values */
2435 for (i = 0; i < num_file_list_entries; i++)
2437 setString(&file_list[i].filename, file_list[i].default_filename);
2439 for (j = 0; j < num_suffix_list_entries; j++)
2440 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2442 file_list[i].redefined = FALSE;
2443 file_list[i].fallback_to_default = FALSE;
2446 /* free previous dynamic artwork file array */
2447 if (artwork_info->dynamic_file_list != NULL)
2449 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2451 free(artwork_info->dynamic_file_list[i].token);
2452 free(artwork_info->dynamic_file_list[i].filename);
2453 free(artwork_info->dynamic_file_list[i].parameter);
2456 free(artwork_info->dynamic_file_list);
2457 artwork_info->dynamic_file_list = NULL;
2459 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2460 &artwork_info->num_dynamic_file_list_entries);
2463 /* free previous property mapping */
2464 if (artwork_info->property_mapping != NULL)
2466 free(artwork_info->property_mapping);
2468 artwork_info->property_mapping = NULL;
2469 artwork_info->num_property_mapping_entries = 0;
2472 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2474 /* first look for special artwork configured in level series config */
2475 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2477 if (fileExists(filename_base))
2478 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2481 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2483 if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2484 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2487 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2488 struct ListNodeInfo **listnode)
2492 char *filename = (*listnode)->source_filename;
2495 printf("[decrementing reference counter of artwork '%s']\n", filename);
2498 if (--(*listnode)->num_references <= 0)
2501 printf("[deleting artwork '%s']\n", filename);
2504 deleteNodeFromList(&artwork_info->content_list, filename,
2505 artwork_info->free_artwork);
2513 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2514 struct ListNodeInfo **listnode,
2515 struct FileInfo *file_list_entry)
2519 "Loading graphics:",
2525 char *basename = file_list_entry->filename;
2526 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2529 if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2530 printf("::: replaceArtworkListEntry: '%s' => '%s'\n",
2531 basename, filename);
2534 if (filename == NULL)
2536 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2538 basename = file_list_entry->default_filename;
2540 /* dynamic artwork has no default filename / skip empty default artwork */
2541 if (basename == NULL || strcmp(basename, UNDEFINED_FILENAME) == 0)
2544 file_list_entry->fallback_to_default = TRUE;
2546 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2548 filename = getCustomArtworkFilename(basename, artwork_info->type);
2550 if (filename == NULL)
2552 int error_mode = ERR_WARN;
2554 /* we can get away without sounds and music, but not without graphics */
2555 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2556 error_mode = ERR_EXIT;
2558 Error(error_mode, "cannot find default artwork file '%s'", basename);
2564 /* check if the old and the new artwork file are the same */
2565 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2567 /* The old and new artwork are the same (have the same filename and path).
2568 This usually means that this artwork does not exist in this artwork set
2569 and a fallback to the existing artwork is done. */
2572 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2578 /* delete existing artwork file entry */
2579 deleteArtworkListEntry(artwork_info, listnode);
2581 /* check if the new artwork file already exists in the list of artworks */
2582 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2585 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2588 *listnode = (struct ListNodeInfo *)node->content;
2589 (*listnode)->num_references++;
2595 if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2596 printf("::: replaceArtworkListEntry: LOAD IT'\n");
2600 printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2603 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2604 DrawInitText(basename, 150, FC_YELLOW);
2606 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2609 printf("[adding new artwork '%s']\n", filename);
2612 (*listnode)->num_references = 1;
2613 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2618 int error_mode = ERR_WARN;
2621 /* we can get away without sounds and music, but not without graphics */
2622 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2623 error_mode = ERR_EXIT;
2626 Error(error_mode, "cannot load artwork file '%s'", basename);
2633 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2634 struct ListNodeInfo **listnode,
2639 "Loading graphics:",
2645 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2647 if (filename == NULL)
2649 int error_mode = ERR_WARN;
2652 /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2653 /* before failing, try fallback to default artwork */
2655 /* we can get away without sounds and music, but not without graphics */
2656 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2657 error_mode = ERR_EXIT;
2660 Error(error_mode, "cannot find artwork file '%s'", basename);
2664 /* check if the old and the new artwork file are the same */
2665 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2667 /* The old and new artwork are the same (have the same filename and path).
2668 This usually means that this artwork does not exist in this artwork set
2669 and a fallback to the existing artwork is done. */
2672 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2678 /* delete existing artwork file entry */
2679 deleteArtworkListEntry(artwork_info, listnode);
2681 /* check if the new artwork file already exists in the list of artworks */
2682 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2685 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2688 *listnode = (struct ListNodeInfo *)node->content;
2689 (*listnode)->num_references++;
2695 printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2698 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2699 DrawInitText(basename, 150, FC_YELLOW);
2701 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2704 printf("[adding new artwork '%s']\n", filename);
2707 (*listnode)->num_references = 1;
2708 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2713 int error_mode = ERR_WARN;
2716 /* we can get away without sounds and music, but not without graphics */
2717 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2718 error_mode = ERR_EXIT;
2721 Error(error_mode, "cannot load artwork file '%s'", basename);
2728 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2729 struct ListNodeInfo **listnode,
2730 struct FileInfo *file_list_entry)
2733 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2737 if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2738 printf("::: -> '%s' -> '%s'\n",
2739 file_list_entry->token, file_list_entry->filename);
2742 if (strcmp(file_list_entry->filename, UNDEFINED_FILENAME) == 0)
2744 deleteArtworkListEntry(artwork_info, listnode);
2748 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2753 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2754 struct ListNodeInfo **listnode,
2758 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2761 if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2763 deleteArtworkListEntry(artwork_info, listnode);
2767 replaceArtworkListEntry(artwork_info, listnode, basename);
2772 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2773 struct ListNodeInfo **listnode,
2774 struct FileInfo *file_list_entry)
2777 if (artwork_info->artwork_list == NULL ||
2778 list_pos >= artwork_info->num_file_list_entries)
2783 printf("loading artwork '%s' ... [%d]\n",
2784 file_list_entry->filename, getNumNodes(artwork_info->content_list));
2788 LoadCustomArtwork(artwork_info, listnode, file_list_entry);
2790 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2795 printf("loading artwork '%s' done [%d]\n",
2796 basename, getNumNodes(artwork_info->content_list));
2802 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2803 struct ListNodeInfo **listnode,
2804 char *basename, int list_pos)
2807 if (artwork_info->artwork_list == NULL ||
2808 list_pos >= artwork_info->num_file_list_entries)
2813 printf("loading artwork '%s' ... [%d]\n",
2814 basename, getNumNodes(artwork_info->content_list));
2818 LoadCustomArtwork(artwork_info, listnode, basename);
2820 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2825 printf("loading artwork '%s' done [%d]\n",
2826 basename, getNumNodes(artwork_info->content_list));
2831 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2833 struct FileInfo *file_list = artwork_info->file_list;
2834 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2835 int num_file_list_entries = artwork_info->num_file_list_entries;
2836 int num_dynamic_file_list_entries =
2837 artwork_info->num_dynamic_file_list_entries;
2841 printf("DEBUG: reloading %d static artwork files ...\n",
2842 num_file_list_entries);
2845 for (i = 0; i < num_file_list_entries; i++)
2848 if (strcmp(file_list[i].token, "background.DOOR") == 0)
2849 printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename);
2853 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2856 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2857 file_list[i].filename, i);
2861 if (strcmp(file_list[i].token, "background.DOOR") == 0)
2863 Bitmap *bitmap = getBitmapFromImageID(i);
2865 printf("::: BITMAP: %08lx\n", bitmap);
2868 BlitBitmap(bitmap, window, 0, 0, 100, 280, 0, 0);
2874 /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2875 if (artwork_info->artwork_list[i] == NULL &&
2876 strcmp(file_list[i].filename, UNDEFINED_FILENAME) != 0 &&
2877 strcmp(file_list[i].default_filename, file_list[i].filename) != 0 &&
2878 strcmp(file_list[i].default_filename, UNDEFINED_FILENAME) != 0)
2880 Error(ERR_WARN, "trying default artwork file '%s'",
2881 file_list[i].default_filename);
2883 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2884 file_list[i].default_filename, i);
2886 /* even the fallback to default artwork was not successful -- fail now */
2887 if (artwork_info->artwork_list[i] == NULL &&
2888 artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2889 Error(ERR_EXIT, "cannot find artwork file '%s' or default file '%s'",
2890 file_list[i].filename, file_list[i].default_filename);
2892 file_list[i].fallback_to_default = TRUE;
2898 printf("DEBUG: reloading %d dynamic artwork files ...\n",
2899 num_dynamic_file_list_entries);
2902 for (i = 0; i < num_dynamic_file_list_entries; i++)
2905 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2906 &dynamic_file_list[i]);
2908 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2909 dynamic_file_list[i].filename, i);
2913 printf("::: '%s', '0x%08x'\n",
2914 dynamic_file_list[i].filename,
2915 dynamic_file_list[i].default_filename);
2918 /* dynamic artwork does not have default filename! */
2922 dumpList(artwork_info->content_list);
2926 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2927 struct ListNodeInfo ***list,
2928 int *num_list_entries)
2935 for (i = 0; i < *num_list_entries; i++)
2936 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2940 *num_list_entries = 0;
2943 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2945 if (artwork_info == NULL)
2949 printf("%s: FREEING ARTWORK ...\n",
2950 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2953 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2954 &artwork_info->num_file_list_entries);
2956 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2957 &artwork_info->num_dynamic_file_list_entries);
2960 printf("%s: FREEING ARTWORK -- DONE\n",
2961 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2966 /* ------------------------------------------------------------------------- */
2967 /* functions only needed for non-Unix (non-command-line) systems */
2968 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2969 /* ------------------------------------------------------------------------- */
2971 #if defined(PLATFORM_MSDOS)
2973 #define ERROR_FILENAME "stderr.txt"
2975 void initErrorFile()
2977 unlink(ERROR_FILENAME);
2980 FILE *openErrorFile()
2982 return fopen(ERROR_FILENAME, MODE_APPEND);
2985 void dumpErrorFile()
2987 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2989 if (error_file != NULL)
2991 while (!feof(error_file))
2992 fputc(fgetc(error_file), stderr);
3000 /* ------------------------------------------------------------------------- */
3001 /* the following is only for debugging purpose and normally not used */
3002 /* ------------------------------------------------------------------------- */
3004 #define DEBUG_NUM_TIMESTAMPS 3
3006 void debug_print_timestamp(int counter_nr, char *message)
3008 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3010 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3011 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3013 counter[counter_nr][0] = Counter();
3016 printf("%s %.2f seconds\n", message,
3017 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
3019 counter[counter_nr][1] = Counter();
3022 void debug_print_parent_only(char *format, ...)
3024 if (!IS_PARENT_PROCESS())
3031 va_start(ap, format);
3032 vprintf(format, ap);