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>
35 /* ------------------------------------------------------------------------- */
36 /* some generic helper functions */
37 /* ------------------------------------------------------------------------- */
39 void fprintf_line(FILE *stream, char *line_string, int line_length)
43 for (i=0; i<line_length; i++)
44 fprintf(stream, "%s", line_string);
46 fprintf(stream, "\n");
49 void printf_line(char *line_string, int line_length)
51 fprintf_line(stdout, line_string, line_length);
54 /* int2str() returns a number converted to a string;
55 the used memory is static, but will be overwritten by later calls,
56 so if you want to save the result, copy it to a private string buffer;
57 there can be 10 local calls of int2str() without buffering the result --
58 the 11th call will then destroy the result from the first call and so on.
61 char *int2str(int number, int size)
63 static char shift_array[10][40];
64 static int shift_counter = 0;
65 char *s = shift_array[shift_counter];
67 shift_counter = (shift_counter + 1) % 10;
74 sprintf(s, " %09d", number);
75 return &s[strlen(s) - size];
79 sprintf(s, "%d", number);
85 /* ------------------------------------------------------------------------- */
86 /* counter functions */
87 /* ------------------------------------------------------------------------- */
89 #if defined(PLATFORM_MSDOS)
90 volatile unsigned long counter = 0;
92 void increment_counter()
97 END_OF_FUNCTION(increment_counter);
101 /* maximal allowed length of a command line option */
102 #define MAX_OPTION_LEN 256
105 static unsigned long mainCounter(int mode)
107 static unsigned long base_ms = 0;
108 unsigned long current_ms;
109 unsigned long counter_ms;
111 current_ms = SDL_GetTicks();
113 /* reset base time in case of counter initializing or wrap-around */
114 if (mode == INIT_COUNTER || current_ms < base_ms)
115 base_ms = current_ms;
117 counter_ms = current_ms - base_ms;
119 return counter_ms; /* return milliseconds since last init */
122 #else /* !TARGET_SDL */
124 #if defined(PLATFORM_UNIX)
125 static unsigned long mainCounter(int mode)
127 static struct timeval base_time = { 0, 0 };
128 struct timeval current_time;
129 unsigned long counter_ms;
131 gettimeofday(¤t_time, NULL);
133 /* reset base time in case of counter initializing or wrap-around */
134 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
135 base_time = current_time;
137 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
138 + (current_time.tv_usec - base_time.tv_usec) / 1000;
140 return counter_ms; /* return milliseconds since last init */
142 #endif /* PLATFORM_UNIX */
143 #endif /* !TARGET_SDL */
145 void InitCounter() /* set counter back to zero */
147 #if !defined(PLATFORM_MSDOS)
148 mainCounter(INIT_COUNTER);
150 LOCK_VARIABLE(counter);
151 LOCK_FUNCTION(increment_counter);
152 install_int_ex(increment_counter, BPS_TO_TIMER(100));
156 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
158 #if !defined(PLATFORM_MSDOS)
159 return mainCounter(READ_COUNTER);
161 return (counter * 10);
165 static void sleep_milliseconds(unsigned long milliseconds_delay)
167 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
170 #if defined(PLATFORM_MSDOS)
171 /* don't use select() to perform waiting operations under DOS
172 environment; always use a busy loop for waiting instead */
173 do_busy_waiting = TRUE;
179 /* we want to wait only a few ms -- if we assume that we have a
180 kernel timer resolution of 10 ms, we would wait far to long;
181 therefore it's better to do a short interval of busy waiting
182 to get our sleeping time more accurate */
184 unsigned long base_counter = Counter(), actual_counter = Counter();
186 while (actual_counter < base_counter + milliseconds_delay &&
187 actual_counter >= base_counter)
188 actual_counter = Counter();
192 #if defined(TARGET_SDL)
193 SDL_Delay(milliseconds_delay);
194 #elif defined(TARGET_ALLEGRO)
195 rest(milliseconds_delay);
197 struct timeval delay;
199 delay.tv_sec = milliseconds_delay / 1000;
200 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
202 if (select(0, NULL, NULL, NULL, &delay) != 0)
203 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
208 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
210 sleep_milliseconds(delay);
213 boolean FrameReached(unsigned long *frame_counter_var,
214 unsigned long frame_delay)
216 unsigned long actual_frame_counter = FrameCounter;
218 if (actual_frame_counter >= *frame_counter_var &&
219 actual_frame_counter < *frame_counter_var + frame_delay)
222 *frame_counter_var = actual_frame_counter;
227 boolean DelayReached(unsigned long *counter_var,
230 unsigned long actual_counter = Counter();
232 if (actual_counter >= *counter_var &&
233 actual_counter < *counter_var + delay)
236 *counter_var = actual_counter;
241 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
243 unsigned long actual_counter;
247 actual_counter = Counter();
249 if (actual_counter >= *counter_var &&
250 actual_counter < *counter_var + delay)
251 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
256 *counter_var = actual_counter;
260 /* ------------------------------------------------------------------------- */
261 /* random generator functions */
262 /* ------------------------------------------------------------------------- */
265 unsigned int SimpleRND(unsigned int max)
267 return (random_linux_libc(RND_FREE) % max);
270 unsigned int InitSimpleRND(long seed)
272 if (seed == NEW_RANDOMIZE)
274 struct timeval current_time;
276 gettimeofday(¤t_time, NULL);
277 seed = (long)current_time.tv_usec;
280 srandom_linux_libc(RND_FREE, (unsigned int) seed);
282 return (unsigned int) seed;
285 unsigned int RND(unsigned int max)
287 return (random_linux_libc(RND_GAME) % max);
290 unsigned int InitRND(long seed)
292 if (seed == NEW_RANDOMIZE)
294 struct timeval current_time;
296 gettimeofday(¤t_time, NULL);
297 seed = (long)current_time.tv_usec;
300 srandom_linux_libc(RND_GAME, (unsigned int) seed);
302 return (unsigned int) seed;
306 unsigned int init_random_number(int nr, long seed)
308 if (seed == NEW_RANDOMIZE)
310 #if defined(TARGET_SDL)
311 seed = (long)SDL_GetTicks();
313 struct timeval current_time;
315 gettimeofday(¤t_time, NULL);
316 seed = (long)current_time.tv_usec;
320 srandom_linux_libc(nr, (unsigned int) seed);
322 return (unsigned int) seed;
325 unsigned int get_random_number(int nr, unsigned int max)
327 return (max > 0 ? random_linux_libc(nr) % max : 0);
331 /* ------------------------------------------------------------------------- */
332 /* system info functions */
333 /* ------------------------------------------------------------------------- */
335 static char *get_corrected_real_name(char *real_name)
337 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
338 char *from_ptr = real_name;
339 char *to_ptr = real_name_new;
341 if (strchr(real_name, 'ß') == NULL) /* name does not contain 'ß' */
343 strncpy(real_name_new, real_name, MAX_USERNAME_LEN);
344 real_name_new[MAX_USERNAME_LEN] = '\0';
346 return real_name_new;
349 /* the user's real name may contain a 'ß' character (german sharp s),
350 which has no equivalent in upper case letters (which our fonts use) */
351 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
353 if (*from_ptr != 'ß')
354 *to_ptr++ = *from_ptr++;
365 return real_name_new;
370 static char *login_name = NULL;
372 #if defined(PLATFORM_WIN32)
373 if (login_name == NULL)
375 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
376 login_name = checked_malloc(buffer_size);
378 if (GetUserName(login_name, &buffer_size) == 0)
379 strcpy(login_name, ANONYMOUS_NAME);
382 if (login_name == NULL)
386 if ((pwd = getpwuid(getuid())) == NULL)
387 login_name = ANONYMOUS_NAME;
389 login_name = getStringCopy(pwd->pw_name);
398 static char *real_name = NULL;
400 #if defined(PLATFORM_WIN32)
401 if (real_name == NULL)
403 static char buffer[MAX_USERNAME_LEN + 1];
404 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
406 if (GetUserName(buffer, &buffer_size) != 0)
407 real_name = get_corrected_real_name(buffer);
409 real_name = ANONYMOUS_NAME;
411 #elif defined(PLATFORM_UNIX)
412 if (real_name == NULL)
416 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
417 real_name = get_corrected_real_name(pwd->pw_gecos);
419 real_name = ANONYMOUS_NAME;
422 real_name = ANONYMOUS_NAME;
430 static char *dir = NULL;
432 #if defined(PLATFORM_WIN32)
435 dir = checked_malloc(MAX_PATH + 1);
437 if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
440 #elif defined(PLATFORM_UNIX)
443 if ((dir = getenv("HOME")) == NULL)
447 if ((pwd = getpwuid(getuid())) != NULL)
448 dir = getStringCopy(pwd->pw_dir);
461 /* ------------------------------------------------------------------------- */
462 /* various string functions */
463 /* ------------------------------------------------------------------------- */
465 char *getPath2(char *path1, char *path2)
467 char *complete_path = checked_malloc(strlen(path1) + 1 +
470 sprintf(complete_path, "%s/%s", path1, path2);
472 return complete_path;
475 char *getPath3(char *path1, char *path2, char *path3)
477 char *complete_path = checked_malloc(strlen(path1) + 1 +
481 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
483 return complete_path;
486 char *getStringCat2(char *s1, char *s2)
488 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
490 sprintf(complete_string, "%s%s", s1, s2);
492 return complete_string;
495 char *getStringCopy(char *s)
502 s_copy = checked_malloc(strlen(s) + 1);
508 char *getStringToLower(char *s)
510 char *s_copy = checked_malloc(strlen(s) + 1);
511 char *s_ptr = s_copy;
514 *s_ptr++ = tolower(*s++);
520 void setString(char **old_value, char *new_value)
522 if (*old_value != NULL)
525 *old_value = getStringCopy(new_value);
529 /* ------------------------------------------------------------------------- */
530 /* command line option handling functions */
531 /* ------------------------------------------------------------------------- */
533 static void printUsage()
536 "Usage: %s [OPTION]... [HOSTNAME [PORT]]\n"
539 " -d, --display HOSTNAME[:SCREEN] specify X server display\n"
540 " -b, --basepath DIRECTORY alternative base DIRECTORY\n"
541 " -l, --level DIRECTORY alternative level DIRECTORY\n"
542 " -g, --graphics DIRECTORY alternative graphics DIRECTORY\n"
543 " -s, --sounds DIRECTORY alternative sounds DIRECTORY\n"
544 " -m, --music DIRECTORY alternative music DIRECTORY\n"
545 " -n, --network network multiplayer game\n"
546 " --serveronly only start network server\n"
547 " -v, --verbose verbose mode\n"
548 " --debug display debugging information\n"
549 " -e, --execute COMMAND execute batch COMMAND:\n"
551 "Valid commands for '--execute' option:\n"
552 " \"print graphicsinfo.conf\" print default graphics config\n"
553 " \"print soundsinfo.conf\" print default sounds config\n"
554 " \"print musicinfo.conf\" print default music config\n"
555 " \"dump level FILE\" dump level data from FILE\n"
556 " \"dump tape FILE\" dump tape data from FILE\n"
557 " \"autoplay LEVELDIR\" play level tapes for LEVELDIR\n"
559 program.command_basename);
562 void GetOptions(char *argv[])
564 char **options_left = &argv[1];
566 /* initialize global program options */
567 options.display_name = NULL;
568 options.server_host = NULL;
569 options.server_port = 0;
570 options.ro_base_directory = RO_BASE_PATH;
571 options.rw_base_directory = RW_BASE_PATH;
572 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
573 options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
574 options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
575 options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
576 options.docs_directory = RO_BASE_PATH "/" DOCS_DIRECTORY;
577 options.execute_command = NULL;
578 options.serveronly = FALSE;
579 options.network = FALSE;
580 options.verbose = FALSE;
581 options.debug = FALSE;
583 #if !defined(PLATFORM_UNIX)
584 if (*options_left == NULL) /* no options given -- enable verbose mode */
585 options.verbose = TRUE;
588 while (*options_left)
590 char option_str[MAX_OPTION_LEN];
591 char *option = options_left[0];
592 char *next_option = options_left[1];
593 char *option_arg = NULL;
594 int option_len = strlen(option);
596 if (option_len >= MAX_OPTION_LEN)
597 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
599 strcpy(option_str, option); /* copy argument into buffer */
602 if (strcmp(option, "--") == 0) /* stop scanning arguments */
605 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
608 option_arg = strchr(option, '=');
609 if (option_arg == NULL) /* no '=' in option */
610 option_arg = next_option;
613 *option_arg++ = '\0'; /* cut argument from option */
614 if (*option_arg == '\0') /* no argument after '=' */
615 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
618 option_len = strlen(option);
620 if (strcmp(option, "-") == 0)
621 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
622 else if (strncmp(option, "-help", option_len) == 0)
628 else if (strncmp(option, "-display", option_len) == 0)
630 if (option_arg == NULL)
631 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
633 options.display_name = option_arg;
634 if (option_arg == next_option)
637 else if (strncmp(option, "-basepath", option_len) == 0)
639 if (option_arg == NULL)
640 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
642 /* this should be extended to separate options for ro and rw data */
643 options.ro_base_directory = option_arg;
644 options.rw_base_directory = option_arg;
645 if (option_arg == next_option)
648 /* adjust path for level directory accordingly */
649 options.level_directory =
650 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
652 else if (strncmp(option, "-levels", option_len) == 0)
654 if (option_arg == NULL)
655 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
657 options.level_directory = option_arg;
658 if (option_arg == next_option)
661 else if (strncmp(option, "-graphics", option_len) == 0)
663 if (option_arg == NULL)
664 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
666 options.graphics_directory = option_arg;
667 if (option_arg == next_option)
670 else if (strncmp(option, "-sounds", option_len) == 0)
672 if (option_arg == NULL)
673 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
675 options.sounds_directory = option_arg;
676 if (option_arg == next_option)
679 else if (strncmp(option, "-music", option_len) == 0)
681 if (option_arg == NULL)
682 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
684 options.music_directory = option_arg;
685 if (option_arg == next_option)
688 else if (strncmp(option, "-network", option_len) == 0)
690 options.network = TRUE;
692 else if (strncmp(option, "-serveronly", option_len) == 0)
694 options.serveronly = TRUE;
696 else if (strncmp(option, "-verbose", option_len) == 0)
698 options.verbose = TRUE;
700 else if (strncmp(option, "-debug", option_len) == 0)
702 options.debug = TRUE;
704 else if (strncmp(option, "-execute", option_len) == 0)
706 if (option_arg == NULL)
707 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
709 options.execute_command = option_arg;
710 if (option_arg == next_option)
713 else if (*option == '-')
715 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
717 else if (options.server_host == NULL)
719 options.server_host = *options_left;
721 else if (options.server_port == 0)
723 options.server_port = atoi(*options_left);
724 if (options.server_port < 1024)
725 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
728 Error(ERR_EXIT_HELP, "too many arguments");
735 /* ------------------------------------------------------------------------- */
736 /* error handling functions */
737 /* ------------------------------------------------------------------------- */
739 /* used by SetError() and GetError() to store internal error messages */
740 static char internal_error[1024]; /* this is bad */
742 void SetError(char *format, ...)
746 va_start(ap, format);
747 vsprintf(internal_error, format, ap);
753 return internal_error;
756 void Error(int mode, char *format, ...)
758 static boolean last_line_was_separator = FALSE;
759 char *process_name = "";
760 FILE *error = stderr;
761 char *newline = "\n";
763 /* display warnings only when running in verbose mode */
764 if (mode & ERR_WARN && !options.verbose)
767 if (mode == ERR_RETURN_LINE)
769 if (!last_line_was_separator)
770 fprintf_line(error, format, 79);
772 last_line_was_separator = TRUE;
777 last_line_was_separator = FALSE;
779 #if defined(PLATFORM_MSDOS)
782 if ((error = openErrorFile()) == NULL)
784 printf("Cannot write to error output file!%s", newline);
785 program.exit_function(1);
789 if (mode & ERR_SOUND_SERVER)
790 process_name = " sound server";
791 else if (mode & ERR_NETWORK_SERVER)
792 process_name = " network server";
793 else if (mode & ERR_NETWORK_CLIENT)
794 process_name = " network client **";
800 fprintf(error, "%s%s: ", program.command_basename, process_name);
803 fprintf(error, "warning: ");
805 va_start(ap, format);
806 vfprintf(error, format, ap);
809 fprintf(error, "%s", newline);
813 fprintf(error, "%s: Try option '--help' for more information.%s",
814 program.command_basename, newline);
817 fprintf(error, "%s%s: aborting%s",
818 program.command_basename, process_name, newline);
825 if (mode & ERR_FROM_SERVER)
826 exit(1); /* child process: normal exit */
828 program.exit_function(1); /* main process: clean up stuff */
833 /* ------------------------------------------------------------------------- */
834 /* memory allocation functions */
835 /* ------------------------------------------------------------------------- */
837 void *checked_malloc(unsigned long size)
844 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
849 void *checked_calloc(unsigned long size)
853 ptr = calloc(1, size);
856 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
861 void *checked_realloc(void *ptr, unsigned long size)
863 ptr = realloc(ptr, size);
866 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
872 /* ------------------------------------------------------------------------- */
873 /* various helper functions */
874 /* ------------------------------------------------------------------------- */
876 inline void swap_numbers(int *i1, int *i2)
884 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
896 short getFile16BitInteger(FILE *file, int byte_order)
898 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
899 return ((fgetc(file) << 8) |
901 else /* BYTE_ORDER_LITTLE_ENDIAN */
902 return ((fgetc(file) << 0) |
906 void putFile16BitInteger(FILE *file, short value, int byte_order)
908 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
910 fputc((value >> 8) & 0xff, file);
911 fputc((value >> 0) & 0xff, file);
913 else /* BYTE_ORDER_LITTLE_ENDIAN */
915 fputc((value >> 0) & 0xff, file);
916 fputc((value >> 8) & 0xff, file);
920 int getFile32BitInteger(FILE *file, int byte_order)
922 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
923 return ((fgetc(file) << 24) |
924 (fgetc(file) << 16) |
927 else /* BYTE_ORDER_LITTLE_ENDIAN */
928 return ((fgetc(file) << 0) |
930 (fgetc(file) << 16) |
931 (fgetc(file) << 24));
934 void putFile32BitInteger(FILE *file, int value, int byte_order)
936 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
938 fputc((value >> 24) & 0xff, file);
939 fputc((value >> 16) & 0xff, file);
940 fputc((value >> 8) & 0xff, file);
941 fputc((value >> 0) & 0xff, file);
943 else /* BYTE_ORDER_LITTLE_ENDIAN */
945 fputc((value >> 0) & 0xff, file);
946 fputc((value >> 8) & 0xff, file);
947 fputc((value >> 16) & 0xff, file);
948 fputc((value >> 24) & 0xff, file);
952 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
955 const int chunk_name_length = 4;
957 /* read chunk name */
958 fgets(chunk_name, chunk_name_length + 1, file);
960 if (chunk_size != NULL)
962 /* read chunk size */
963 *chunk_size = getFile32BitInteger(file, byte_order);
966 return (feof(file) || ferror(file) ? FALSE : TRUE);
969 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
972 /* write chunk name */
973 fputs(chunk_name, file);
977 /* write chunk size */
978 putFile32BitInteger(file, chunk_size, byte_order);
982 int getFileVersion(FILE *file)
984 int version_major, version_minor, version_patch, version_release;
986 version_major = fgetc(file);
987 version_minor = fgetc(file);
988 version_patch = fgetc(file);
989 version_release = fgetc(file);
991 return RELEASE_IDENT(version_major, version_minor, version_patch,
995 void putFileVersion(FILE *file, int version)
997 int version_major = VERSION_MAJOR(version);
998 int version_minor = VERSION_MINOR(version);
999 int version_patch = VERSION_PATCH(version);
1000 int version_release = VERSION_RELEASE(version);
1002 fputc(version_major, file);
1003 fputc(version_minor, file);
1004 fputc(version_patch, file);
1005 fputc(version_release, file);
1008 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1010 while (bytes-- && !feof(file))
1014 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1021 /* ------------------------------------------------------------------------- */
1022 /* functions to translate key identifiers between different format */
1023 /* ------------------------------------------------------------------------- */
1025 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1026 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1027 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1028 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1030 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1039 /* normal cursor keys */
1040 { KSYM_Left, "XK_Left", "cursor left" },
1041 { KSYM_Right, "XK_Right", "cursor right" },
1042 { KSYM_Up, "XK_Up", "cursor up" },
1043 { KSYM_Down, "XK_Down", "cursor down" },
1045 /* keypad cursor keys */
1047 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1048 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1049 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1050 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1053 /* other keypad keys */
1054 #ifdef KSYM_KP_Enter
1055 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1056 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1057 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1058 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1059 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1060 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1064 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1065 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1066 { KSYM_Control_L, "XK_Control_L", "left control" },
1067 { KSYM_Control_R, "XK_Control_R", "right control" },
1068 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1069 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1070 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1071 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1072 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1073 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1074 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1075 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1077 /* some special keys */
1078 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1079 { KSYM_Delete, "XK_Delete", "delete" },
1080 { KSYM_Insert, "XK_Insert", "insert" },
1081 { KSYM_Tab, "XK_Tab", "tab" },
1082 { KSYM_Home, "XK_Home", "home" },
1083 { KSYM_End, "XK_End", "end" },
1084 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1085 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1086 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1088 /* ASCII 0x20 to 0x40 keys (except numbers) */
1089 { KSYM_space, "XK_space", "space" },
1090 { KSYM_exclam, "XK_exclam", "!" },
1091 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1092 { KSYM_numbersign, "XK_numbersign", "#" },
1093 { KSYM_dollar, "XK_dollar", "$" },
1094 { KSYM_percent, "XK_percent", "%" },
1095 { KSYM_ampersand, "XK_ampersand", "&" },
1096 { KSYM_apostrophe, "XK_apostrophe", "'" },
1097 { KSYM_parenleft, "XK_parenleft", "(" },
1098 { KSYM_parenright, "XK_parenright", ")" },
1099 { KSYM_asterisk, "XK_asterisk", "*" },
1100 { KSYM_plus, "XK_plus", "+" },
1101 { KSYM_comma, "XK_comma", "," },
1102 { KSYM_minus, "XK_minus", "-" },
1103 { KSYM_period, "XK_period", "." },
1104 { KSYM_slash, "XK_slash", "/" },
1105 { KSYM_colon, "XK_colon", ":" },
1106 { KSYM_semicolon, "XK_semicolon", ";" },
1107 { KSYM_less, "XK_less", "<" },
1108 { KSYM_equal, "XK_equal", "=" },
1109 { KSYM_greater, "XK_greater", ">" },
1110 { KSYM_question, "XK_question", "?" },
1111 { KSYM_at, "XK_at", "@" },
1113 /* more ASCII keys */
1114 { KSYM_bracketleft, "XK_bracketleft", "[" },
1115 { KSYM_backslash, "XK_backslash", "backslash" },
1116 { KSYM_bracketright,"XK_bracketright", "]" },
1117 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1118 { KSYM_underscore, "XK_underscore", "_" },
1119 { KSYM_grave, "XK_grave", "grave" },
1120 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1121 { KSYM_braceleft, "XK_braceleft", "brace left" },
1122 { KSYM_bar, "XK_bar", "bar" },
1123 { KSYM_braceright, "XK_braceright", "brace right" },
1124 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1126 /* special (non-ASCII) keys */
1127 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1128 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1129 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1130 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1131 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1132 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1133 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1135 /* end-of-array identifier */
1141 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1143 static char name_buffer[30];
1146 if (key >= KSYM_A && key <= KSYM_Z)
1147 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1148 else if (key >= KSYM_a && key <= KSYM_z)
1149 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1150 else if (key >= KSYM_0 && key <= KSYM_9)
1151 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1152 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1153 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1154 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1155 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1156 else if (key == KSYM_UNDEFINED)
1157 strcpy(name_buffer, "(undefined)");
1164 if (key == translate_key[i].key)
1166 strcpy(name_buffer, translate_key[i].name);
1170 while (translate_key[++i].name);
1172 if (!translate_key[i].name)
1173 strcpy(name_buffer, "(unknown)");
1176 *name = name_buffer;
1178 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1180 static char name_buffer[30];
1183 if (key >= KSYM_A && key <= KSYM_Z)
1184 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1185 else if (key >= KSYM_a && key <= KSYM_z)
1186 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1187 else if (key >= KSYM_0 && key <= KSYM_9)
1188 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1189 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1190 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1191 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1192 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1193 else if (key == KSYM_UNDEFINED)
1194 strcpy(name_buffer, "[undefined]");
1201 if (key == translate_key[i].key)
1203 strcpy(name_buffer, translate_key[i].x11name);
1207 while (translate_key[++i].x11name);
1209 if (!translate_key[i].x11name)
1210 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1213 *x11name = name_buffer;
1215 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1217 Key key = KSYM_UNDEFINED;
1222 if (strcmp(translate_key[i].name, *name) == 0)
1224 key = translate_key[i].key;
1228 while (translate_key[++i].x11name);
1230 if (key == KSYM_UNDEFINED)
1231 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1235 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1237 Key key = KSYM_UNDEFINED;
1238 char *name_ptr = *x11name;
1240 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1242 char c = name_ptr[3];
1244 if (c >= 'A' && c <= 'Z')
1245 key = KSYM_A + (Key)(c - 'A');
1246 else if (c >= 'a' && c <= 'z')
1247 key = KSYM_a + (Key)(c - 'a');
1248 else if (c >= '0' && c <= '9')
1249 key = KSYM_0 + (Key)(c - '0');
1251 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1253 char c = name_ptr[6];
1255 if (c >= '0' && c <= '9')
1256 key = KSYM_0 + (Key)(c - '0');
1258 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1260 char c1 = name_ptr[4];
1261 char c2 = name_ptr[5];
1264 if ((c1 >= '0' && c1 <= '9') &&
1265 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1266 d = atoi(&name_ptr[4]);
1268 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1269 key = KSYM_F1 + (Key)(d - 1);
1271 else if (strncmp(name_ptr, "XK_", 3) == 0)
1277 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1279 key = translate_key[i].key;
1283 while (translate_key[++i].x11name);
1285 else if (strncmp(name_ptr, "0x", 2) == 0)
1287 unsigned long value = 0;
1293 char c = *name_ptr++;
1296 if (c >= '0' && c <= '9')
1298 else if (c >= 'a' && c <= 'f')
1299 d = (int)(c - 'a' + 10);
1300 else if (c >= 'A' && c <= 'F')
1301 d = (int)(c - 'A' + 10);
1309 value = value * 16 + d;
1320 char *getKeyNameFromKey(Key key)
1324 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1328 char *getX11KeyNameFromKey(Key key)
1332 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1336 Key getKeyFromKeyName(char *name)
1340 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1344 Key getKeyFromX11KeyName(char *x11name)
1348 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1352 char getCharFromKey(Key key)
1354 char *keyname = getKeyNameFromKey(key);
1357 if (strlen(keyname) == 1)
1358 letter = keyname[0];
1359 else if (strcmp(keyname, "space") == 0)
1361 else if (strcmp(keyname, "circumflex") == 0)
1368 /* ------------------------------------------------------------------------- */
1369 /* functions to translate string identifiers to integer or boolean value */
1370 /* ------------------------------------------------------------------------- */
1372 int get_integer_from_string(char *s)
1374 static char *number_text[][3] =
1376 { "0", "zero", "null", },
1377 { "1", "one", "first" },
1378 { "2", "two", "second" },
1379 { "3", "three", "third" },
1380 { "4", "four", "fourth" },
1381 { "5", "five", "fifth" },
1382 { "6", "six", "sixth" },
1383 { "7", "seven", "seventh" },
1384 { "8", "eight", "eighth" },
1385 { "9", "nine", "ninth" },
1386 { "10", "ten", "tenth" },
1387 { "11", "eleven", "eleventh" },
1388 { "12", "twelve", "twelfth" },
1392 char *s_lower = getStringToLower(s);
1395 for (i=0; i<13; i++)
1397 if (strcmp(s_lower, number_text[i][j]) == 0)
1408 boolean get_boolean_from_string(char *s)
1410 char *s_lower = getStringToLower(s);
1411 boolean result = FALSE;
1413 if (strcmp(s_lower, "true") == 0 ||
1414 strcmp(s_lower, "yes") == 0 ||
1415 strcmp(s_lower, "on") == 0 ||
1416 get_integer_from_string(s) == 1)
1425 /* ------------------------------------------------------------------------- */
1426 /* functions for generic lists */
1427 /* ------------------------------------------------------------------------- */
1429 ListNode *newListNode()
1431 return checked_calloc(sizeof(ListNode));
1434 void addNodeToList(ListNode **node_first, char *key, void *content)
1436 ListNode *node_new = newListNode();
1439 printf("LIST: adding node with key '%s'\n", key);
1442 node_new->key = getStringCopy(key);
1443 node_new->content = content;
1444 node_new->next = *node_first;
1445 *node_first = node_new;
1448 void deleteNodeFromList(ListNode **node_first, char *key,
1449 void (*destructor_function)(void *))
1451 if (node_first == NULL || *node_first == NULL)
1455 printf("[CHECKING LIST KEY '%s' == '%s']\n",
1456 (*node_first)->key, key);
1459 if (strcmp((*node_first)->key, key) == 0)
1462 printf("[DELETING LIST ENTRY]\n");
1465 free((*node_first)->key);
1466 if (destructor_function)
1467 destructor_function((*node_first)->content);
1468 *node_first = (*node_first)->next;
1471 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1474 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1476 if (node_first == NULL)
1479 if (strcmp(node_first->key, key) == 0)
1482 return getNodeFromKey(node_first->next, key);
1485 int getNumNodes(ListNode *node_first)
1487 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1490 void dumpList(ListNode *node_first)
1492 ListNode *node = node_first;
1496 printf("['%s' (%d)]\n", node->key,
1497 ((struct ListNodeInfo *)node->content)->num_references);
1501 printf("[%d nodes]\n", getNumNodes(node_first));
1505 /* ------------------------------------------------------------------------- */
1506 /* functions for checking files and filenames */
1507 /* ------------------------------------------------------------------------- */
1509 boolean fileExists(char *filename)
1512 printf("checking file '%s'\n", filename);
1515 return (access(filename, F_OK) == 0);
1518 boolean FileIsGraphic(char *filename)
1520 if (strlen(filename) > 4 &&
1521 strcmp(&filename[strlen(filename) - 4], ".pcx") == 0)
1527 boolean FileIsSound(char *basename)
1529 if (strlen(basename) > 4 &&
1530 strcmp(&basename[strlen(basename) - 4], ".wav") == 0)
1536 boolean FileIsMusic(char *basename)
1538 /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */
1540 if (FileIsSound(basename))
1543 #if defined(TARGET_SDL)
1544 if (strlen(basename) > 4 &&
1545 (strcmp(&basename[strlen(basename) - 4], ".mod") == 0 ||
1546 strcmp(&basename[strlen(basename) - 4], ".MOD") == 0 ||
1547 strncmp(basename, "mod.", 4) == 0 ||
1548 strncmp(basename, "MOD.", 4) == 0))
1555 boolean FileIsArtworkType(char *basename, int type)
1557 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1558 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1559 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1565 /* ------------------------------------------------------------------------- */
1566 /* functions for loading artwork configuration information */
1567 /* ------------------------------------------------------------------------- */
1569 /* This function checks if a string <s> of the format "string1, string2, ..."
1570 exactly contains a string <s_contained>. */
1572 static boolean string_has_parameter(char *s, char *s_contained)
1576 if (s == NULL || s_contained == NULL)
1579 if (strlen(s_contained) > strlen(s))
1582 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1584 char next_char = s[strlen(s_contained)];
1586 /* check if next character is delimiter or whitespace */
1587 return (next_char == ',' || next_char == '\0' ||
1588 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1591 /* check if string contains another parameter string after a comma */
1592 substring = strchr(s, ',');
1593 if (substring == NULL) /* string does not contain a comma */
1596 /* advance string pointer to next character after the comma */
1599 /* skip potential whitespaces after the comma */
1600 while (*substring == ' ' || *substring == '\t')
1603 return string_has_parameter(substring, s_contained);
1606 int get_parameter_value(char *token, char *value_raw, int type)
1608 char *value = getStringToLower(value_raw);
1609 int result = 0; /* probably a save default value */
1611 if (strcmp(token, ".direction") == 0)
1613 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1614 strcmp(value, "right") == 0 ? MV_RIGHT :
1615 strcmp(value, "up") == 0 ? MV_UP :
1616 strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING);
1618 else if (strcmp(token, ".anim_mode") == 0)
1620 result = (string_has_parameter(value, "loop") ? ANIM_LOOP :
1621 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1622 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1623 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1624 string_has_parameter(value, "random") ? ANIM_RANDOM :
1625 string_has_parameter(value, "none") ? ANIM_NONE :
1628 if (string_has_parameter(value, "reverse"))
1629 result |= ANIM_REVERSE;
1631 else /* generic parameter of type integer or boolean */
1633 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1634 type == TYPE_INTEGER ? get_integer_from_string(value) :
1635 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1636 ARG_UNDEFINED_VALUE);
1644 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1645 struct ListNodeInfo ***, int *);
1647 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1648 struct ConfigInfo *suffix_list,
1649 char **ignore_tokens,
1650 int num_file_list_entries)
1652 struct FileInfo *file_list;
1653 int num_file_list_entries_found = 0;
1654 int num_suffix_list_entries = 0;
1658 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1660 for (i=0; suffix_list[i].token != NULL; i++)
1661 num_suffix_list_entries++;
1663 /* always start with reliable default values */
1664 for (i=0; i<num_file_list_entries; i++)
1666 file_list[i].token = NULL;
1668 file_list[i].default_filename = NULL;
1669 file_list[i].filename = NULL;
1671 if (num_suffix_list_entries > 0)
1673 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1675 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1676 file_list[i].parameter = checked_calloc(parameter_array_size);
1678 for (j=0; j<num_suffix_list_entries; j++)
1680 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1681 setString(&file_list[i].parameter[j], suffix_list[j].value);
1687 for (i=0; config_list[i].token != NULL; i++)
1689 int len_config_token = strlen(config_list[i].token);
1690 int len_config_value = strlen(config_list[i].value);
1691 boolean is_file_entry = TRUE;
1693 for (j=0; suffix_list[j].token != NULL; j++)
1695 int len_suffix = strlen(suffix_list[j].token);
1697 if (len_suffix < len_config_token &&
1698 strcmp(&config_list[i].token[len_config_token - len_suffix],
1699 suffix_list[j].token) == 0)
1701 setString(&file_list[list_pos].default_parameter[j],
1702 config_list[i].value);
1704 is_file_entry = FALSE;
1709 /* the following tokens are no file definitions, but other config tokens */
1710 for (j=0; ignore_tokens[j] != NULL; j++)
1711 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1712 is_file_entry = FALSE;
1719 if (list_pos >= num_file_list_entries)
1722 /* simple sanity check if this is really a file definition */
1723 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1724 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1725 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1727 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1728 config_list[i].token, config_list[i].value);
1729 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1732 file_list[list_pos].token = config_list[i].token;
1733 file_list[list_pos].default_filename = config_list[i].value;
1737 num_file_list_entries_found = list_pos + 1;
1738 if (num_file_list_entries_found != num_file_list_entries)
1740 Error(ERR_RETURN_LINE, "-");
1741 Error(ERR_RETURN, "inconsistant config list information:");
1742 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1743 num_file_list_entries);
1744 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1745 num_file_list_entries_found);
1746 Error(ERR_EXIT, "please fix");
1752 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1754 int len_token = strlen(token);
1755 int len_suffix = strlen(suffix);
1758 if (IS_PARENT_PROCESS())
1759 printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1762 if (start_pos < 0) /* compare suffix from end of string */
1763 start_pos += len_token;
1765 if (start_pos < 0 || start_pos + len_suffix > len_token)
1768 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1771 if (token[start_pos + len_suffix] == '\0')
1774 if (token[start_pos + len_suffix] == '.')
1780 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN]"
1782 static void read_token_parameters(SetupFileHash *setup_file_hash,
1783 struct ConfigInfo *suffix_list,
1784 struct FileInfo *file_list_entry)
1786 /* check for config token that is the base token without any suffixes */
1787 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1788 char *known_token_value = KNOWN_TOKEN_VALUE;
1791 if (filename != NULL)
1793 setString(&file_list_entry->filename, filename);
1795 /* when file definition found, set all parameters to default values */
1796 for (i=0; suffix_list[i].token != NULL; i++)
1797 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1799 file_list_entry->redefined = TRUE;
1801 /* mark config file token as well known from default config */
1802 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1807 if (strcmp(file_list_entry->filename,
1808 file_list_entry->default_filename) != 0)
1809 printf("___ resetting '%s' to default\n", file_list_entry->token);
1811 setString(&file_list_entry->filename, file_list_entry->default_filename);
1815 /* check for config tokens that can be build by base token and suffixes */
1816 for (i=0; suffix_list[i].token != NULL; i++)
1818 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1819 char *value = getHashEntry(setup_file_hash, token);
1823 setString(&file_list_entry->parameter[i], value);
1825 /* mark config file token as well known from default config */
1826 setHashEntry(setup_file_hash, token, known_token_value);
1833 static void add_dynamic_file_list_entry(struct FileInfo **list,
1834 int *num_list_entries,
1835 SetupFileHash *extra_file_hash,
1836 struct ConfigInfo *suffix_list,
1837 int num_suffix_list_entries,
1840 struct FileInfo *new_list_entry;
1841 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1844 if (IS_PARENT_PROCESS())
1845 printf("===> found dynamic definition '%s'\n", token);
1848 (*num_list_entries)++;
1849 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1850 new_list_entry = &(*list)[*num_list_entries - 1];
1852 new_list_entry->token = getStringCopy(token);
1853 new_list_entry->filename = NULL;
1854 new_list_entry->parameter = checked_calloc(parameter_array_size);
1856 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
1859 static void add_property_mapping(struct PropertyMapping **list,
1860 int *num_list_entries,
1861 int base_index, int ext1_index,
1862 int ext2_index, int ext3_index,
1865 struct PropertyMapping *new_list_entry;
1867 (*num_list_entries)++;
1868 *list = checked_realloc(*list,
1869 *num_list_entries * sizeof(struct PropertyMapping));
1870 new_list_entry = &(*list)[*num_list_entries - 1];
1872 new_list_entry->base_index = base_index;
1873 new_list_entry->ext1_index = ext1_index;
1874 new_list_entry->ext2_index = ext2_index;
1875 new_list_entry->ext3_index = ext3_index;
1877 new_list_entry->artwork_index = artwork_index;
1880 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
1883 struct FileInfo *file_list = artwork_info->file_list;
1884 struct ConfigInfo *suffix_list = artwork_info->suffix_list;
1885 char **base_prefixes = artwork_info->base_prefixes;
1886 char **ext1_suffixes = artwork_info->ext1_suffixes;
1887 char **ext2_suffixes = artwork_info->ext2_suffixes;
1888 char **ext3_suffixes = artwork_info->ext3_suffixes;
1889 char **ignore_tokens = artwork_info->ignore_tokens;
1890 int num_file_list_entries = artwork_info->num_file_list_entries;
1891 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1892 int num_base_prefixes = artwork_info->num_base_prefixes;
1893 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
1894 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
1895 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
1896 int num_ignore_tokens = artwork_info->num_ignore_tokens;
1897 SetupFileHash *setup_file_hash, *extra_file_hash;
1898 char *known_token_value = KNOWN_TOKEN_VALUE;
1901 if (filename == NULL)
1905 printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename);
1908 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
1911 /* read parameters for all known config file tokens */
1912 for (i=0; i<num_file_list_entries; i++)
1913 read_token_parameters(setup_file_hash, suffix_list, &file_list[i]);
1915 /* set all tokens that can be ignored here to "known" keyword */
1916 for (i=0; i < num_ignore_tokens; i++)
1917 setHashEntry(setup_file_hash, ignore_tokens[i], known_token_value);
1919 /* copy all unknown config file tokens to extra config list */
1920 extra_file_hash = newSetupFileHash();
1921 BEGIN_HASH_ITERATION(setup_file_hash, itr)
1923 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) != 0)
1924 setHashEntry(extra_file_hash,
1925 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
1927 END_HASH_ITERATION(setup_file_hash, itr)
1929 /* at this point, we do not need the config file hash anymore -- free it */
1930 freeSetupFileHash(setup_file_hash);
1932 /* now try to determine valid, dynamically defined config tokens */
1934 BEGIN_HASH_ITERATION(extra_file_hash, itr)
1936 struct FileInfo **dynamic_file_list =
1937 &artwork_info->dynamic_file_list;
1938 int *num_dynamic_file_list_entries =
1939 &artwork_info->num_dynamic_file_list_entries;
1940 struct PropertyMapping **property_mapping =
1941 &artwork_info->property_mapping;
1942 int *num_property_mapping_entries =
1943 &artwork_info->num_property_mapping_entries;
1944 int current_summarized_file_list_entry =
1945 artwork_info->num_file_list_entries +
1946 artwork_info->num_dynamic_file_list_entries;
1947 char *token = HASH_ITERATION_TOKEN(itr);
1948 int len_token = strlen(token);
1950 boolean base_prefix_found = FALSE;
1951 boolean parameter_suffix_found = FALSE;
1953 /* skip all parameter definitions (handled by read_token_parameters()) */
1954 for (i=0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
1956 int len_suffix = strlen(suffix_list[i].token);
1958 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
1959 parameter_suffix_found = TRUE;
1963 if (IS_PARENT_PROCESS())
1965 if (parameter_suffix_found)
1966 printf("---> skipping token '%s' (parameter token)\n", token);
1968 printf("---> examining token '%s': search prefix ...\n", token);
1972 if (parameter_suffix_found)
1975 /* ---------- step 0: search for matching base prefix ---------- */
1978 for (i=0; i<num_base_prefixes && !base_prefix_found; i++)
1980 char *base_prefix = base_prefixes[i];
1981 int len_base_prefix = strlen(base_prefix);
1982 boolean ext1_suffix_found = FALSE;
1983 boolean ext2_suffix_found = FALSE;
1984 boolean ext3_suffix_found = FALSE;
1985 boolean exact_match = FALSE;
1986 int base_index = -1;
1987 int ext1_index = -1;
1988 int ext2_index = -1;
1989 int ext3_index = -1;
1991 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
1993 if (!base_prefix_found)
1998 if (start_pos + len_base_prefix == len_token) /* exact match */
2002 add_dynamic_file_list_entry(dynamic_file_list,
2003 num_dynamic_file_list_entries,
2006 num_suffix_list_entries,
2008 add_property_mapping(property_mapping,
2009 num_property_mapping_entries,
2010 base_index, -1, -1, -1,
2011 current_summarized_file_list_entry);
2016 if (IS_PARENT_PROCESS())
2017 printf("---> examining token '%s': search 1st suffix ...\n", token);
2020 /* ---------- step 1: search for matching first suffix ---------- */
2022 start_pos += len_base_prefix;
2023 for (j=0; j<num_ext1_suffixes && !ext1_suffix_found; j++)
2025 char *ext1_suffix = ext1_suffixes[j];
2026 int len_ext1_suffix = strlen(ext1_suffix);
2028 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2030 if (!ext1_suffix_found)
2035 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2039 add_dynamic_file_list_entry(dynamic_file_list,
2040 num_dynamic_file_list_entries,
2043 num_suffix_list_entries,
2045 add_property_mapping(property_mapping,
2046 num_property_mapping_entries,
2047 base_index, ext1_index, -1, -1,
2048 current_summarized_file_list_entry);
2052 start_pos += len_ext1_suffix;
2059 if (IS_PARENT_PROCESS())
2060 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2063 /* ---------- step 2: search for matching second suffix ---------- */
2065 for (k=0; k<num_ext2_suffixes && !ext2_suffix_found; k++)
2067 char *ext2_suffix = ext2_suffixes[k];
2068 int len_ext2_suffix = strlen(ext2_suffix);
2070 ext2_suffix_found = token_suffix_match(token, ext2_suffix,start_pos);
2072 if (!ext2_suffix_found)
2077 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2081 add_dynamic_file_list_entry(dynamic_file_list,
2082 num_dynamic_file_list_entries,
2085 num_suffix_list_entries,
2087 add_property_mapping(property_mapping,
2088 num_property_mapping_entries,
2089 base_index, ext1_index, ext2_index, -1,
2090 current_summarized_file_list_entry);
2094 start_pos += len_ext2_suffix;
2101 if (IS_PARENT_PROCESS())
2102 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2105 /* ---------- step 3: search for matching third suffix ---------- */
2107 for (l=0; l<num_ext3_suffixes && !ext3_suffix_found; l++)
2109 char *ext3_suffix = ext3_suffixes[l];
2110 int len_ext3_suffix = strlen(ext3_suffix);
2112 ext3_suffix_found =token_suffix_match(token,ext3_suffix,start_pos);
2114 if (!ext3_suffix_found)
2119 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2123 add_dynamic_file_list_entry(dynamic_file_list,
2124 num_dynamic_file_list_entries,
2127 num_suffix_list_entries,
2129 add_property_mapping(property_mapping,
2130 num_property_mapping_entries,
2131 base_index, ext1_index, ext2_index, ext3_index,
2132 current_summarized_file_list_entry);
2138 END_HASH_ITERATION(extra_file_hash, itr)
2140 if (artwork_info->num_dynamic_file_list_entries > 0)
2142 artwork_info->dynamic_artwork_list =
2143 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2144 artwork_info->sizeof_artwork_list_entry);
2147 if (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS())
2149 SetupFileList *setup_file_list, *list;
2150 boolean dynamic_tokens_found = FALSE;
2151 boolean unknown_tokens_found = FALSE;
2153 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2154 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2156 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2158 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2159 dynamic_tokens_found = TRUE;
2161 unknown_tokens_found = TRUE;
2163 END_HASH_ITERATION(extra_file_hash, itr)
2166 if (dynamic_tokens_found)
2168 Error(ERR_RETURN_LINE, "-");
2169 Error(ERR_RETURN, "dynamic token(s) found:");
2171 for (list = setup_file_list; list != NULL; list = list->next)
2173 char *value = getHashEntry(extra_file_hash, list->token);
2175 if (value != NULL && strcmp(value, known_token_value) == 0)
2176 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2179 Error(ERR_RETURN_LINE, "-");
2183 if (unknown_tokens_found)
2185 Error(ERR_RETURN_LINE, "-");
2186 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2187 Error(ERR_RETURN, "- config file: '%s'", filename);
2189 for (list = setup_file_list; list != NULL; list = list->next)
2191 char *value = getHashEntry(extra_file_hash, list->token);
2193 if (value != NULL && strcmp(value, known_token_value) != 0)
2194 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2197 Error(ERR_RETURN_LINE, "-");
2200 freeSetupFileList(setup_file_list);
2203 freeSetupFileHash(extra_file_hash);
2206 for (i=0; i<num_file_list_entries; i++)
2208 printf("'%s' ", file_list[i].token);
2209 if (file_list[i].filename)
2210 printf("-> '%s'\n", file_list[i].filename);
2212 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2217 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2220 struct FileInfo *file_list = artwork_info->file_list;
2221 struct ConfigInfo *suffix_list = artwork_info->suffix_list;
2222 char **base_prefixes = artwork_info->base_prefixes;
2223 char **ext1_suffixes = artwork_info->ext1_suffixes;
2224 char **ext2_suffixes = artwork_info->ext2_suffixes;
2225 char **ext3_suffixes = artwork_info->ext3_suffixes;
2226 char **ignore_tokens = artwork_info->ignore_tokens;
2227 int num_file_list_entries = artwork_info->num_file_list_entries;
2228 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2229 int num_base_prefixes = artwork_info->num_base_prefixes;
2230 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2231 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2232 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2233 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2234 char *filename = getCustomArtworkConfigFilename(artwork_info->type);
2235 SetupFileHash *setup_file_hash, *extra_file_hash;
2236 char *known_token_value = KNOWN_TOKEN_VALUE;
2239 struct FileInfo *file_list = artwork_info->file_list;
2240 int num_file_list_entries = artwork_info->num_file_list_entries;
2241 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2242 char *filename_base, *filename_local;
2247 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2250 /* always start with reliable default values */
2251 for (i=0; i<num_file_list_entries; i++)
2253 setString(&file_list[i].filename, file_list[i].default_filename);
2255 for (j=0; j<num_suffix_list_entries; j++)
2256 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2258 file_list[i].redefined = FALSE;
2261 /* free previous dynamic artwork file array */
2262 if (artwork_info->dynamic_file_list != NULL)
2264 for (i=0; i<artwork_info->num_dynamic_file_list_entries; i++)
2266 free(artwork_info->dynamic_file_list[i].token);
2267 free(artwork_info->dynamic_file_list[i].filename);
2268 free(artwork_info->dynamic_file_list[i].parameter);
2271 free(artwork_info->dynamic_file_list);
2272 artwork_info->dynamic_file_list = NULL;
2274 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2275 &artwork_info->num_dynamic_file_list_entries);
2278 /* free previous property mapping */
2279 if (artwork_info->property_mapping != NULL)
2281 free(artwork_info->property_mapping);
2283 artwork_info->property_mapping = NULL;
2284 artwork_info->num_property_mapping_entries = 0;
2288 /* first look for special artwork configured in level series config */
2289 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2291 if (fileExists(filename_base))
2292 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2295 for(i=0; i<num_file_list_entries; i++)
2296 if (strcmp(file_list[i].token, "background") == 0)
2297 printf("!!! base !!! -- '%s' -> '%s'\n",
2298 file_list[i].token, file_list[i].filename);
2302 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2304 if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2305 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2308 for(i=0; i<num_file_list_entries; i++)
2309 if (strcmp(file_list[i].token, "background") == 0)
2310 printf("!!! local !!! -- '%s' -> '%s'\n",
2311 file_list[i].token, file_list[i].filename);
2319 if (filename == NULL)
2322 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2325 /* read parameters for all known config file tokens */
2326 for (i=0; i<num_file_list_entries; i++)
2327 read_token_parameters(setup_file_hash, suffix_list, &file_list[i]);
2329 /* set all tokens that can be ignored here to "known" keyword */
2330 for (i=0; i < num_ignore_tokens; i++)
2331 setHashEntry(setup_file_hash, ignore_tokens[i], known_token_value);
2333 /* copy all unknown config file tokens to extra config list */
2334 extra_file_hash = newSetupFileHash();
2335 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2337 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) != 0)
2338 setHashEntry(extra_file_hash,
2339 HASH_ITERATION_TOKEN(itr), HASH_ITERATION_VALUE(itr));
2341 END_HASH_ITERATION(setup_file_hash, itr)
2343 /* at this point, we do not need the config file hash anymore -- free it */
2344 freeSetupFileHash(setup_file_hash);
2346 /* now try to determine valid, dynamically defined config tokens */
2348 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2350 struct FileInfo **dynamic_file_list =
2351 &artwork_info->dynamic_file_list;
2352 int *num_dynamic_file_list_entries =
2353 &artwork_info->num_dynamic_file_list_entries;
2354 struct PropertyMapping **property_mapping =
2355 &artwork_info->property_mapping;
2356 int *num_property_mapping_entries =
2357 &artwork_info->num_property_mapping_entries;
2358 int current_summarized_file_list_entry =
2359 artwork_info->num_file_list_entries +
2360 artwork_info->num_dynamic_file_list_entries;
2361 char *token = HASH_ITERATION_TOKEN(itr);
2362 int len_token = strlen(token);
2364 boolean base_prefix_found = FALSE;
2365 boolean parameter_suffix_found = FALSE;
2367 /* skip all parameter definitions (handled by read_token_parameters()) */
2368 for (i=0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2370 int len_suffix = strlen(suffix_list[i].token);
2372 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2373 parameter_suffix_found = TRUE;
2377 if (IS_PARENT_PROCESS())
2379 if (parameter_suffix_found)
2380 printf("---> skipping token '%s' (parameter token)\n", token);
2382 printf("---> examining token '%s': search prefix ...\n", token);
2386 if (parameter_suffix_found)
2389 /* ---------- step 0: search for matching base prefix ---------- */
2392 for (i=0; i<num_base_prefixes && !base_prefix_found; i++)
2394 char *base_prefix = base_prefixes[i];
2395 int len_base_prefix = strlen(base_prefix);
2396 boolean ext1_suffix_found = FALSE;
2397 boolean ext2_suffix_found = FALSE;
2398 boolean ext3_suffix_found = FALSE;
2399 boolean exact_match = FALSE;
2400 int base_index = -1;
2401 int ext1_index = -1;
2402 int ext2_index = -1;
2403 int ext3_index = -1;
2405 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2407 if (!base_prefix_found)
2412 if (start_pos + len_base_prefix == len_token) /* exact match */
2416 add_dynamic_file_list_entry(dynamic_file_list,
2417 num_dynamic_file_list_entries,
2420 num_suffix_list_entries,
2422 add_property_mapping(property_mapping,
2423 num_property_mapping_entries,
2424 base_index, -1, -1, -1,
2425 current_summarized_file_list_entry);
2430 if (IS_PARENT_PROCESS())
2431 printf("---> examining token '%s': search 1st suffix ...\n", token);
2434 /* ---------- step 1: search for matching first suffix ---------- */
2436 start_pos += len_base_prefix;
2437 for (j=0; j<num_ext1_suffixes && !ext1_suffix_found; j++)
2439 char *ext1_suffix = ext1_suffixes[j];
2440 int len_ext1_suffix = strlen(ext1_suffix);
2442 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2444 if (!ext1_suffix_found)
2449 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2453 add_dynamic_file_list_entry(dynamic_file_list,
2454 num_dynamic_file_list_entries,
2457 num_suffix_list_entries,
2459 add_property_mapping(property_mapping,
2460 num_property_mapping_entries,
2461 base_index, ext1_index, -1, -1,
2462 current_summarized_file_list_entry);
2466 start_pos += len_ext1_suffix;
2473 if (IS_PARENT_PROCESS())
2474 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2477 /* ---------- step 2: search for matching second suffix ---------- */
2479 for (k=0; k<num_ext2_suffixes && !ext2_suffix_found; k++)
2481 char *ext2_suffix = ext2_suffixes[k];
2482 int len_ext2_suffix = strlen(ext2_suffix);
2484 ext2_suffix_found = token_suffix_match(token, ext2_suffix,start_pos);
2486 if (!ext2_suffix_found)
2491 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2495 add_dynamic_file_list_entry(dynamic_file_list,
2496 num_dynamic_file_list_entries,
2499 num_suffix_list_entries,
2501 add_property_mapping(property_mapping,
2502 num_property_mapping_entries,
2503 base_index, ext1_index, ext2_index, -1,
2504 current_summarized_file_list_entry);
2508 start_pos += len_ext2_suffix;
2515 if (IS_PARENT_PROCESS())
2516 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2519 /* ---------- step 3: search for matching third suffix ---------- */
2521 for (l=0; l<num_ext3_suffixes && !ext3_suffix_found; l++)
2523 char *ext3_suffix = ext3_suffixes[l];
2524 int len_ext3_suffix = strlen(ext3_suffix);
2526 ext3_suffix_found =token_suffix_match(token,ext3_suffix,start_pos);
2528 if (!ext3_suffix_found)
2533 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2537 add_dynamic_file_list_entry(dynamic_file_list,
2538 num_dynamic_file_list_entries,
2541 num_suffix_list_entries,
2543 add_property_mapping(property_mapping,
2544 num_property_mapping_entries,
2545 base_index, ext1_index, ext2_index, ext3_index,
2546 current_summarized_file_list_entry);
2552 END_HASH_ITERATION(extra_file_hash, itr)
2554 if (artwork_info->num_dynamic_file_list_entries > 0)
2556 artwork_info->dynamic_artwork_list =
2557 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2558 artwork_info->sizeof_artwork_list_entry);
2561 if (extra_file_hash != NULL && options.verbose && IS_PARENT_PROCESS())
2563 SetupFileList *setup_file_list, *list;
2564 boolean dynamic_tokens_found = FALSE;
2565 boolean unknown_tokens_found = FALSE;
2567 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2568 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2570 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2572 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2573 dynamic_tokens_found = TRUE;
2575 unknown_tokens_found = TRUE;
2577 END_HASH_ITERATION(extra_file_hash, itr)
2580 if (dynamic_tokens_found)
2582 Error(ERR_RETURN_LINE, "-");
2583 Error(ERR_RETURN, "dynamic token(s) found:");
2585 for (list = setup_file_list; list != NULL; list = list->next)
2587 char *value = getHashEntry(extra_file_hash, list->token);
2589 if (value != NULL && strcmp(value, known_token_value) == 0)
2590 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2593 Error(ERR_RETURN_LINE, "-");
2597 if (unknown_tokens_found)
2599 Error(ERR_RETURN_LINE, "-");
2600 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2601 Error(ERR_RETURN, "- config file: '%s'", filename);
2603 for (list = setup_file_list; list != NULL; list = list->next)
2605 char *value = getHashEntry(extra_file_hash, list->token);
2607 if (value != NULL && strcmp(value, known_token_value) != 0)
2608 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2611 Error(ERR_RETURN_LINE, "-");
2614 freeSetupFileList(setup_file_list);
2617 freeSetupFileHash(extra_file_hash);
2620 for (i=0; i<num_file_list_entries; i++)
2622 printf("'%s' ", file_list[i].token);
2623 if (file_list[i].filename)
2624 printf("-> '%s'\n", file_list[i].filename);
2626 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2633 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2634 struct ListNodeInfo **listnode)
2638 char *filename = (*listnode)->source_filename;
2641 printf("[decrementing reference counter of artwork '%s']\n", filename);
2644 if (--(*listnode)->num_references <= 0)
2647 printf("[deleting artwork '%s']\n", filename);
2650 deleteNodeFromList(&artwork_info->content_list, filename,
2651 artwork_info->free_artwork);
2658 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2659 struct ListNodeInfo **listnode,
2664 "Loading graphics:",
2670 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2672 if (filename == NULL)
2674 int error_mode = ERR_WARN;
2676 /* we can get away without sounds and music, but not without graphics */
2677 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2678 error_mode = ERR_EXIT;
2680 Error(error_mode, "cannot find artwork file '%s'", basename);
2684 /* check if the old and the new artwork file are the same */
2685 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2687 /* The old and new artwork are the same (have the same filename and path).
2688 This usually means that this artwork does not exist in this artwork set
2689 and a fallback to the existing artwork is done. */
2692 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2698 /* delete existing artwork file entry */
2699 deleteArtworkListEntry(artwork_info, listnode);
2701 /* check if the new artwork file already exists in the list of artworks */
2702 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2705 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2708 *listnode = (struct ListNodeInfo *)node->content;
2709 (*listnode)->num_references++;
2714 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2715 DrawInitText(basename, 150, FC_YELLOW);
2717 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2720 printf("[adding new artwork '%s']\n", filename);
2723 (*listnode)->num_references = 1;
2724 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2729 int error_mode = ERR_WARN;
2731 /* we can get away without sounds and music, but not without graphics */
2732 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2733 error_mode = ERR_EXIT;
2735 Error(error_mode, "cannot load artwork file '%s'", basename);
2740 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2741 struct ListNodeInfo **listnode,
2745 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2748 if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2750 deleteArtworkListEntry(artwork_info, listnode);
2754 replaceArtworkListEntry(artwork_info, listnode, basename);
2757 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2758 struct ListNodeInfo **listnode,
2759 char *basename, int list_pos)
2762 if (artwork_info->artwork_list == NULL ||
2763 list_pos >= artwork_info->num_file_list_entries)
2768 printf("loading artwork '%s' ... [%d]\n",
2769 basename, getNumNodes(artwork_info->content_list));
2773 LoadCustomArtwork(artwork_info, listnode, basename);
2775 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2780 printf("loading artwork '%s' done [%d]\n",
2781 basename, getNumNodes(artwork_info->content_list));
2785 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2787 struct FileInfo *file_list = artwork_info->file_list;
2788 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2789 int num_file_list_entries = artwork_info->num_file_list_entries;
2790 int num_dynamic_file_list_entries =
2791 artwork_info->num_dynamic_file_list_entries;
2795 printf("DEBUG: reloading %d static artwork files ...\n",
2796 num_file_list_entries);
2799 for(i=0; i<num_file_list_entries; i++)
2802 if (strcmp(file_list[i].token, "background") == 0)
2803 printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename);
2806 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2807 file_list[i].filename, i);
2811 printf("DEBUG: reloading %d dynamic artwork files ...\n",
2812 num_dynamic_file_list_entries);
2815 for(i=0; i<num_dynamic_file_list_entries; i++)
2816 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2817 dynamic_file_list[i].filename, i);
2820 dumpList(artwork_info->content_list);
2824 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2825 struct ListNodeInfo ***list,
2826 int *num_list_entries)
2833 for(i=0; i<*num_list_entries; i++)
2834 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2838 *num_list_entries = 0;
2841 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2843 if (artwork_info == NULL)
2847 printf("%s: FREEING ARTWORK ...\n",
2848 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2851 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2852 &artwork_info->num_file_list_entries);
2854 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2855 &artwork_info->num_dynamic_file_list_entries);
2858 printf("%s: FREEING ARTWORK -- DONE\n",
2859 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2864 /* ------------------------------------------------------------------------- */
2865 /* functions only needed for non-Unix (non-command-line) systems */
2866 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2867 /* ------------------------------------------------------------------------- */
2869 #if defined(PLATFORM_MSDOS)
2871 #define ERROR_FILENAME "stderr.txt"
2873 void initErrorFile()
2875 unlink(ERROR_FILENAME);
2878 FILE *openErrorFile()
2880 return fopen(ERROR_FILENAME, MODE_APPEND);
2883 void dumpErrorFile()
2885 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2887 if (error_file != NULL)
2889 while (!feof(error_file))
2890 fputc(fgetc(error_file), stderr);
2898 /* ------------------------------------------------------------------------- */
2899 /* the following is only for debugging purpose and normally not used */
2900 /* ------------------------------------------------------------------------- */
2902 #define DEBUG_NUM_TIMESTAMPS 3
2904 void debug_print_timestamp(int counter_nr, char *message)
2906 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2908 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2909 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2911 counter[counter_nr][0] = Counter();
2914 printf("%s %.2f seconds\n", message,
2915 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2917 counter[counter_nr][1] = Counter();
2920 void debug_print_parent_only(char *format, ...)
2922 if (!IS_PARENT_PROCESS())
2929 va_start(ap, format);
2930 vprintf(format, ap);