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 + frame_delay &&
219 actual_frame_counter >= *frame_counter_var)
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 + delay &&
233 actual_counter >= *counter_var)
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 + delay &&
250 actual_counter >= *counter_var)
251 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
256 *counter_var = actual_counter;
260 /* ------------------------------------------------------------------------- */
261 /* random generator functions */
262 /* ------------------------------------------------------------------------- */
264 unsigned int SimpleRND(unsigned int max)
266 #if defined(TARGET_SDL)
267 static unsigned long root = 654321;
268 unsigned long current_ms;
270 current_ms = SDL_GetTicks();
271 root = root * 4253261 + current_ms;
274 static unsigned long root = 654321;
275 struct timeval current_time;
277 gettimeofday(¤t_time, NULL);
278 root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
284 static unsigned int last_RND_value = 0;
286 unsigned int last_RND()
288 return last_RND_value;
292 unsigned int RND(unsigned int max)
295 return (last_RND_value = random_linux_libc() % max);
297 return (random_linux_libc() % max);
301 unsigned int InitRND(long seed)
303 #if defined(TARGET_SDL)
304 unsigned long current_ms;
306 if (seed == NEW_RANDOMIZE)
308 current_ms = SDL_GetTicks();
309 srandom_linux_libc((unsigned int) current_ms);
310 return (unsigned int) current_ms;
314 srandom_linux_libc((unsigned int) seed);
315 return (unsigned int) seed;
318 struct timeval current_time;
320 if (seed == NEW_RANDOMIZE)
322 gettimeofday(¤t_time, NULL);
323 srandom_linux_libc((unsigned int) current_time.tv_usec);
324 return (unsigned int) current_time.tv_usec;
328 srandom_linux_libc((unsigned int) seed);
329 return (unsigned int) seed;
335 /* ------------------------------------------------------------------------- */
336 /* system info functions */
337 /* ------------------------------------------------------------------------- */
341 #if defined(PLATFORM_WIN32)
342 return ANONYMOUS_NAME;
344 static char *login_name = NULL;
346 if (login_name == NULL)
350 if ((pwd = getpwuid(getuid())) == NULL)
351 login_name = ANONYMOUS_NAME;
353 login_name = getStringCopy(pwd->pw_name);
362 #if defined(PLATFORM_UNIX)
365 if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
366 return ANONYMOUS_NAME;
369 static char real_name[1024];
370 char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
372 if (strchr(pwd->pw_gecos, 'ß') == NULL)
373 return pwd->pw_gecos;
375 /* the user's real name contains a 'ß' character (german sharp s),
376 which has no equivalent in upper case letters (which our fonts use) */
377 while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
379 if (*from_ptr != 'ß')
380 *to_ptr++ = *from_ptr++;
392 #else /* !PLATFORM_UNIX */
393 return ANONYMOUS_NAME;
399 #if defined(PLATFORM_UNIX)
400 static char *home_dir = NULL;
402 if (home_dir == NULL)
404 if ((home_dir = getenv("HOME")) == NULL)
408 if ((pwd = getpwuid(getuid())) == NULL)
411 home_dir = getStringCopy(pwd->pw_dir);
422 /* ------------------------------------------------------------------------- */
423 /* various string functions */
424 /* ------------------------------------------------------------------------- */
426 char *getPath2(char *path1, char *path2)
428 char *complete_path = checked_malloc(strlen(path1) + 1 +
431 sprintf(complete_path, "%s/%s", path1, path2);
433 return complete_path;
436 char *getPath3(char *path1, char *path2, char *path3)
438 char *complete_path = checked_malloc(strlen(path1) + 1 +
442 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
444 return complete_path;
447 char *getStringCat2(char *s1, char *s2)
449 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
451 sprintf(complete_string, "%s%s", s1, s2);
453 return complete_string;
456 char *getStringCopy(char *s)
463 s_copy = checked_malloc(strlen(s) + 1);
469 char *getStringToLower(char *s)
471 char *s_copy = checked_malloc(strlen(s) + 1);
472 char *s_ptr = s_copy;
475 *s_ptr++ = tolower(*s++);
481 void setString(char **old_value, char *new_value)
483 if (*old_value != NULL)
486 *old_value = getStringCopy(new_value);
490 /* ------------------------------------------------------------------------- */
491 /* command line option handling functions */
492 /* ------------------------------------------------------------------------- */
494 static void printUsage()
497 "Usage: %s [OPTION]... [HOSTNAME [PORT]]\n"
500 " -d, --display HOSTNAME[:SCREEN] specify X server display\n"
501 " -b, --basepath DIRECTORY alternative base DIRECTORY\n"
502 " -l, --level DIRECTORY alternative level DIRECTORY\n"
503 " -g, --graphics DIRECTORY alternative graphics DIRECTORY\n"
504 " -s, --sounds DIRECTORY alternative sounds DIRECTORY\n"
505 " -m, --music DIRECTORY alternative music DIRECTORY\n"
506 " -n, --network network multiplayer game\n"
507 " --serveronly only start network server\n"
508 " -v, --verbose verbose mode\n"
509 " --debug display debugging information\n"
510 " -e, --execute COMMAND execute batch COMMAND:\n"
512 "Valid commands for '--execute' option:\n"
513 " \"print graphicsinfo.conf\" print default graphics config\n"
514 " \"print soundsinfo.conf\" print default sounds config\n"
515 " \"print musicinfo.conf\" print default music config\n"
516 " \"dump level FILE\" dump level data from FILE\n"
517 " \"dump tape FILE\" dump tape data from FILE\n"
518 " \"autoplay LEVELDIR\" play level tapes for LEVELDIR\n"
520 program.command_basename);
523 void GetOptions(char *argv[])
525 char **options_left = &argv[1];
527 /* initialize global program options */
528 options.display_name = NULL;
529 options.server_host = NULL;
530 options.server_port = 0;
531 options.ro_base_directory = RO_BASE_PATH;
532 options.rw_base_directory = RW_BASE_PATH;
533 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
534 options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
535 options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
536 options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
537 options.execute_command = NULL;
538 options.serveronly = FALSE;
539 options.network = FALSE;
540 options.verbose = FALSE;
541 options.debug = FALSE;
543 #if !defined(PLATFORM_UNIX)
544 if (*options_left == NULL) /* no options given -- enable verbose mode */
545 options.verbose = TRUE;
548 while (*options_left)
550 char option_str[MAX_OPTION_LEN];
551 char *option = options_left[0];
552 char *next_option = options_left[1];
553 char *option_arg = NULL;
554 int option_len = strlen(option);
556 if (option_len >= MAX_OPTION_LEN)
557 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
559 strcpy(option_str, option); /* copy argument into buffer */
562 if (strcmp(option, "--") == 0) /* stop scanning arguments */
565 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
568 option_arg = strchr(option, '=');
569 if (option_arg == NULL) /* no '=' in option */
570 option_arg = next_option;
573 *option_arg++ = '\0'; /* cut argument from option */
574 if (*option_arg == '\0') /* no argument after '=' */
575 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
578 option_len = strlen(option);
580 if (strcmp(option, "-") == 0)
581 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
582 else if (strncmp(option, "-help", option_len) == 0)
588 else if (strncmp(option, "-display", option_len) == 0)
590 if (option_arg == NULL)
591 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
593 options.display_name = option_arg;
594 if (option_arg == next_option)
597 else if (strncmp(option, "-basepath", option_len) == 0)
599 if (option_arg == NULL)
600 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
602 /* this should be extended to separate options for ro and rw data */
603 options.ro_base_directory = option_arg;
604 options.rw_base_directory = option_arg;
605 if (option_arg == next_option)
608 /* adjust path for level directory accordingly */
609 options.level_directory =
610 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
612 else if (strncmp(option, "-levels", option_len) == 0)
614 if (option_arg == NULL)
615 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
617 options.level_directory = option_arg;
618 if (option_arg == next_option)
621 else if (strncmp(option, "-graphics", option_len) == 0)
623 if (option_arg == NULL)
624 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
626 options.graphics_directory = option_arg;
627 if (option_arg == next_option)
630 else if (strncmp(option, "-sounds", option_len) == 0)
632 if (option_arg == NULL)
633 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
635 options.sounds_directory = option_arg;
636 if (option_arg == next_option)
639 else if (strncmp(option, "-music", option_len) == 0)
641 if (option_arg == NULL)
642 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
644 options.music_directory = option_arg;
645 if (option_arg == next_option)
648 else if (strncmp(option, "-network", option_len) == 0)
650 options.network = TRUE;
652 else if (strncmp(option, "-serveronly", option_len) == 0)
654 options.serveronly = TRUE;
656 else if (strncmp(option, "-verbose", option_len) == 0)
658 options.verbose = TRUE;
660 else if (strncmp(option, "-debug", option_len) == 0)
662 options.debug = TRUE;
664 else if (strncmp(option, "-execute", option_len) == 0)
666 if (option_arg == NULL)
667 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
669 options.execute_command = option_arg;
670 if (option_arg == next_option)
673 else if (*option == '-')
675 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
677 else if (options.server_host == NULL)
679 options.server_host = *options_left;
681 else if (options.server_port == 0)
683 options.server_port = atoi(*options_left);
684 if (options.server_port < 1024)
685 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
688 Error(ERR_EXIT_HELP, "too many arguments");
695 /* ------------------------------------------------------------------------- */
696 /* error handling functions */
697 /* ------------------------------------------------------------------------- */
699 /* used by SetError() and GetError() to store internal error messages */
700 static char internal_error[1024]; /* this is bad */
702 void SetError(char *format, ...)
706 va_start(ap, format);
707 vsprintf(internal_error, format, ap);
713 return internal_error;
716 void Error(int mode, char *format, ...)
718 static boolean last_line_was_separator = FALSE;
719 char *process_name = "";
720 FILE *error = stderr;
721 char *newline = "\n";
723 /* display warnings only when running in verbose mode */
724 if (mode & ERR_WARN && !options.verbose)
727 if (mode == ERR_RETURN_LINE)
729 if (!last_line_was_separator)
730 fprintf_line(error, format, 79);
732 last_line_was_separator = TRUE;
737 last_line_was_separator = FALSE;
739 #if defined(PLATFORM_MSDOS)
742 if ((error = openErrorFile()) == NULL)
744 printf("Cannot write to error output file!%s", newline);
745 program.exit_function(1);
749 if (mode & ERR_SOUND_SERVER)
750 process_name = " sound server";
751 else if (mode & ERR_NETWORK_SERVER)
752 process_name = " network server";
753 else if (mode & ERR_NETWORK_CLIENT)
754 process_name = " network client **";
760 fprintf(error, "%s%s: ", program.command_basename, process_name);
763 fprintf(error, "warning: ");
765 va_start(ap, format);
766 vfprintf(error, format, ap);
769 fprintf(error, "%s", newline);
773 fprintf(error, "%s: Try option '--help' for more information.%s",
774 program.command_basename, newline);
777 fprintf(error, "%s%s: aborting%s",
778 program.command_basename, process_name, newline);
785 if (mode & ERR_FROM_SERVER)
786 exit(1); /* child process: normal exit */
788 program.exit_function(1); /* main process: clean up stuff */
793 /* ------------------------------------------------------------------------- */
794 /* memory allocation functions */
795 /* ------------------------------------------------------------------------- */
797 void *checked_malloc(unsigned long size)
804 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
809 void *checked_calloc(unsigned long size)
813 ptr = calloc(1, size);
816 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
821 void *checked_realloc(void *ptr, unsigned long size)
823 ptr = realloc(ptr, size);
826 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
832 /* ------------------------------------------------------------------------- */
833 /* various helper functions */
834 /* ------------------------------------------------------------------------- */
836 inline void swap_numbers(int *i1, int *i2)
844 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
856 short getFile16BitInteger(FILE *file, int byte_order)
858 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
859 return ((fgetc(file) << 8) |
861 else /* BYTE_ORDER_LITTLE_ENDIAN */
862 return ((fgetc(file) << 0) |
866 void putFile16BitInteger(FILE *file, short value, int byte_order)
868 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
870 fputc((value >> 8) & 0xff, file);
871 fputc((value >> 0) & 0xff, file);
873 else /* BYTE_ORDER_LITTLE_ENDIAN */
875 fputc((value >> 0) & 0xff, file);
876 fputc((value >> 8) & 0xff, file);
880 int getFile32BitInteger(FILE *file, int byte_order)
882 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
883 return ((fgetc(file) << 24) |
884 (fgetc(file) << 16) |
887 else /* BYTE_ORDER_LITTLE_ENDIAN */
888 return ((fgetc(file) << 0) |
890 (fgetc(file) << 16) |
891 (fgetc(file) << 24));
894 void putFile32BitInteger(FILE *file, int value, int byte_order)
896 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
898 fputc((value >> 24) & 0xff, file);
899 fputc((value >> 16) & 0xff, file);
900 fputc((value >> 8) & 0xff, file);
901 fputc((value >> 0) & 0xff, file);
903 else /* BYTE_ORDER_LITTLE_ENDIAN */
905 fputc((value >> 0) & 0xff, file);
906 fputc((value >> 8) & 0xff, file);
907 fputc((value >> 16) & 0xff, file);
908 fputc((value >> 24) & 0xff, file);
912 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
915 const int chunk_name_length = 4;
917 /* read chunk name */
918 fgets(chunk_name, chunk_name_length + 1, file);
920 if (chunk_size != NULL)
922 /* read chunk size */
923 *chunk_size = getFile32BitInteger(file, byte_order);
926 return (feof(file) || ferror(file) ? FALSE : TRUE);
929 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
932 /* write chunk name */
933 fputs(chunk_name, file);
937 /* write chunk size */
938 putFile32BitInteger(file, chunk_size, byte_order);
942 int getFileVersion(FILE *file)
944 int version_major, version_minor, version_patch;
946 version_major = fgetc(file);
947 version_minor = fgetc(file);
948 version_patch = fgetc(file);
949 fgetc(file); /* not used */
951 return VERSION_IDENT(version_major, version_minor, version_patch);
954 void putFileVersion(FILE *file, int version)
956 int version_major = VERSION_MAJOR(version);
957 int version_minor = VERSION_MINOR(version);
958 int version_patch = VERSION_PATCH(version);
960 fputc(version_major, file);
961 fputc(version_minor, file);
962 fputc(version_patch, file);
963 fputc(0, file); /* not used */
966 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
968 while (bytes-- && !feof(file))
972 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
979 /* ------------------------------------------------------------------------- */
980 /* functions to translate key identifiers between different format */
981 /* ------------------------------------------------------------------------- */
983 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
984 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
985 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
986 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
988 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
997 /* normal cursor keys */
998 { KSYM_Left, "XK_Left", "cursor left" },
999 { KSYM_Right, "XK_Right", "cursor right" },
1000 { KSYM_Up, "XK_Up", "cursor up" },
1001 { KSYM_Down, "XK_Down", "cursor down" },
1003 /* keypad cursor keys */
1005 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1006 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1007 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1008 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1011 /* other keypad keys */
1012 #ifdef KSYM_KP_Enter
1013 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1014 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1015 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1016 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1017 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1018 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1022 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1023 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1024 { KSYM_Control_L, "XK_Control_L", "left control" },
1025 { KSYM_Control_R, "XK_Control_R", "right control" },
1026 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1027 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1028 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1029 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1030 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1031 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1032 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1033 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1035 /* some special keys */
1036 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1037 { KSYM_Delete, "XK_Delete", "delete" },
1038 { KSYM_Insert, "XK_Insert", "insert" },
1039 { KSYM_Tab, "XK_Tab", "tab" },
1040 { KSYM_Home, "XK_Home", "home" },
1041 { KSYM_End, "XK_End", "end" },
1042 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1043 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1044 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1046 /* ASCII 0x20 to 0x40 keys (except numbers) */
1047 { KSYM_space, "XK_space", "space" },
1048 { KSYM_exclam, "XK_exclam", "!" },
1049 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1050 { KSYM_numbersign, "XK_numbersign", "#" },
1051 { KSYM_dollar, "XK_dollar", "$" },
1052 { KSYM_percent, "XK_percent", "%" },
1053 { KSYM_ampersand, "XK_ampersand", "&" },
1054 { KSYM_apostrophe, "XK_apostrophe", "'" },
1055 { KSYM_parenleft, "XK_parenleft", "(" },
1056 { KSYM_parenright, "XK_parenright", ")" },
1057 { KSYM_asterisk, "XK_asterisk", "*" },
1058 { KSYM_plus, "XK_plus", "+" },
1059 { KSYM_comma, "XK_comma", "," },
1060 { KSYM_minus, "XK_minus", "-" },
1061 { KSYM_period, "XK_period", "." },
1062 { KSYM_slash, "XK_slash", "/" },
1063 { KSYM_colon, "XK_colon", ":" },
1064 { KSYM_semicolon, "XK_semicolon", ";" },
1065 { KSYM_less, "XK_less", "<" },
1066 { KSYM_equal, "XK_equal", "=" },
1067 { KSYM_greater, "XK_greater", ">" },
1068 { KSYM_question, "XK_question", "?" },
1069 { KSYM_at, "XK_at", "@" },
1071 /* more ASCII keys */
1072 { KSYM_bracketleft, "XK_bracketleft", "[" },
1073 { KSYM_backslash, "XK_backslash", "backslash" },
1074 { KSYM_bracketright,"XK_bracketright", "]" },
1075 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1076 { KSYM_underscore, "XK_underscore", "_" },
1077 { KSYM_grave, "XK_grave", "grave" },
1078 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1079 { KSYM_braceleft, "XK_braceleft", "brace left" },
1080 { KSYM_bar, "XK_bar", "bar" },
1081 { KSYM_braceright, "XK_braceright", "brace right" },
1082 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1084 /* special (non-ASCII) keys */
1085 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1086 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1087 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1088 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1089 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1090 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1091 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1093 /* end-of-array identifier */
1099 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1101 static char name_buffer[30];
1104 if (key >= KSYM_A && key <= KSYM_Z)
1105 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1106 else if (key >= KSYM_a && key <= KSYM_z)
1107 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1108 else if (key >= KSYM_0 && key <= KSYM_9)
1109 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1110 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1111 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1112 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1113 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1114 else if (key == KSYM_UNDEFINED)
1115 strcpy(name_buffer, "(undefined)");
1122 if (key == translate_key[i].key)
1124 strcpy(name_buffer, translate_key[i].name);
1128 while (translate_key[++i].name);
1130 if (!translate_key[i].name)
1131 strcpy(name_buffer, "(unknown)");
1134 *name = name_buffer;
1136 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1138 static char name_buffer[30];
1141 if (key >= KSYM_A && key <= KSYM_Z)
1142 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1143 else if (key >= KSYM_a && key <= KSYM_z)
1144 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1145 else if (key >= KSYM_0 && key <= KSYM_9)
1146 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1147 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1148 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1149 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1150 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1151 else if (key == KSYM_UNDEFINED)
1152 strcpy(name_buffer, "[undefined]");
1159 if (key == translate_key[i].key)
1161 strcpy(name_buffer, translate_key[i].x11name);
1165 while (translate_key[++i].x11name);
1167 if (!translate_key[i].x11name)
1168 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1171 *x11name = name_buffer;
1173 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1175 Key key = KSYM_UNDEFINED;
1180 if (strcmp(translate_key[i].name, *name) == 0)
1182 key = translate_key[i].key;
1186 while (translate_key[++i].x11name);
1188 if (key == KSYM_UNDEFINED)
1189 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1193 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1195 Key key = KSYM_UNDEFINED;
1196 char *name_ptr = *x11name;
1198 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1200 char c = name_ptr[3];
1202 if (c >= 'A' && c <= 'Z')
1203 key = KSYM_A + (Key)(c - 'A');
1204 else if (c >= 'a' && c <= 'z')
1205 key = KSYM_a + (Key)(c - 'a');
1206 else if (c >= '0' && c <= '9')
1207 key = KSYM_0 + (Key)(c - '0');
1209 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1211 char c = name_ptr[6];
1213 if (c >= '0' && c <= '9')
1214 key = KSYM_0 + (Key)(c - '0');
1216 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1218 char c1 = name_ptr[4];
1219 char c2 = name_ptr[5];
1222 if ((c1 >= '0' && c1 <= '9') &&
1223 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1224 d = atoi(&name_ptr[4]);
1226 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1227 key = KSYM_F1 + (Key)(d - 1);
1229 else if (strncmp(name_ptr, "XK_", 3) == 0)
1235 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1237 key = translate_key[i].key;
1241 while (translate_key[++i].x11name);
1243 else if (strncmp(name_ptr, "0x", 2) == 0)
1245 unsigned long value = 0;
1251 char c = *name_ptr++;
1254 if (c >= '0' && c <= '9')
1256 else if (c >= 'a' && c <= 'f')
1257 d = (int)(c - 'a' + 10);
1258 else if (c >= 'A' && c <= 'F')
1259 d = (int)(c - 'A' + 10);
1267 value = value * 16 + d;
1278 char *getKeyNameFromKey(Key key)
1282 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1286 char *getX11KeyNameFromKey(Key key)
1290 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1294 Key getKeyFromKeyName(char *name)
1298 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1302 Key getKeyFromX11KeyName(char *x11name)
1306 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1310 char getCharFromKey(Key key)
1312 char *keyname = getKeyNameFromKey(key);
1315 if (strlen(keyname) == 1)
1316 letter = keyname[0];
1317 else if (strcmp(keyname, "space") == 0)
1319 else if (strcmp(keyname, "circumflex") == 0)
1326 /* ------------------------------------------------------------------------- */
1327 /* functions to translate string identifiers to integer or boolean value */
1328 /* ------------------------------------------------------------------------- */
1330 int get_integer_from_string(char *s)
1332 static char *number_text[][3] =
1334 { "0", "zero", "null", },
1335 { "1", "one", "first" },
1336 { "2", "two", "second" },
1337 { "3", "three", "third" },
1338 { "4", "four", "fourth" },
1339 { "5", "five", "fifth" },
1340 { "6", "six", "sixth" },
1341 { "7", "seven", "seventh" },
1342 { "8", "eight", "eighth" },
1343 { "9", "nine", "ninth" },
1344 { "10", "ten", "tenth" },
1345 { "11", "eleven", "eleventh" },
1346 { "12", "twelve", "twelfth" },
1350 char *s_lower = getStringToLower(s);
1353 for (i=0; i<13; i++)
1355 if (strcmp(s_lower, number_text[i][j]) == 0)
1366 boolean get_boolean_from_string(char *s)
1368 char *s_lower = getStringToLower(s);
1369 boolean result = FALSE;
1371 if (strcmp(s_lower, "true") == 0 ||
1372 strcmp(s_lower, "yes") == 0 ||
1373 strcmp(s_lower, "on") == 0 ||
1374 get_integer_from_string(s) == 1)
1383 /* ------------------------------------------------------------------------- */
1384 /* functions for generic lists */
1385 /* ------------------------------------------------------------------------- */
1387 ListNode *newListNode()
1389 return checked_calloc(sizeof(ListNode));
1392 void addNodeToList(ListNode **node_first, char *key, void *content)
1394 ListNode *node_new = newListNode();
1397 printf("LIST: adding node with key '%s'\n", key);
1400 node_new->key = getStringCopy(key);
1401 node_new->content = content;
1402 node_new->next = *node_first;
1403 *node_first = node_new;
1406 void deleteNodeFromList(ListNode **node_first, char *key,
1407 void (*destructor_function)(void *))
1409 if (node_first == NULL || *node_first == NULL)
1413 printf("[CHECKING LIST KEY '%s' == '%s']\n",
1414 (*node_first)->key, key);
1417 if (strcmp((*node_first)->key, key) == 0)
1420 printf("[DELETING LIST ENTRY]\n");
1423 free((*node_first)->key);
1424 if (destructor_function)
1425 destructor_function((*node_first)->content);
1426 *node_first = (*node_first)->next;
1429 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1432 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1434 if (node_first == NULL)
1437 if (strcmp(node_first->key, key) == 0)
1440 return getNodeFromKey(node_first->next, key);
1443 int getNumNodes(ListNode *node_first)
1445 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1448 void dumpList(ListNode *node_first)
1450 ListNode *node = node_first;
1454 printf("['%s' (%d)]\n", node->key,
1455 ((struct ListNodeInfo *)node->content)->num_references);
1459 printf("[%d nodes]\n", getNumNodes(node_first));
1463 /* ------------------------------------------------------------------------- */
1464 /* functions for checking filenames */
1465 /* ------------------------------------------------------------------------- */
1467 boolean FileIsGraphic(char *filename)
1469 if (strlen(filename) > 4 &&
1470 strcmp(&filename[strlen(filename) - 4], ".pcx") == 0)
1476 boolean FileIsSound(char *basename)
1478 if (strlen(basename) > 4 &&
1479 strcmp(&basename[strlen(basename) - 4], ".wav") == 0)
1485 boolean FileIsMusic(char *basename)
1487 /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */
1489 if (FileIsSound(basename))
1492 #if defined(TARGET_SDL)
1493 if (strlen(basename) > 4 &&
1494 (strcmp(&basename[strlen(basename) - 4], ".mod") == 0 ||
1495 strcmp(&basename[strlen(basename) - 4], ".MOD") == 0 ||
1496 strncmp(basename, "mod.", 4) == 0 ||
1497 strncmp(basename, "MOD.", 4) == 0))
1504 boolean FileIsArtworkType(char *basename, int type)
1506 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1507 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1508 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1514 /* ------------------------------------------------------------------------- */
1515 /* functions for loading artwork configuration information */
1516 /* ------------------------------------------------------------------------- */
1518 /* This function checks if a string <s> of the format "string1, string2, ..."
1519 exactly contains a string <s_contained>. */
1521 static boolean string_has_parameter(char *s, char *s_contained)
1525 if (s == NULL || s_contained == NULL)
1528 if (strlen(s_contained) > strlen(s))
1531 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1533 char next_char = s[strlen(s_contained)];
1535 /* check if next character is delimiter or whitespace */
1536 return (next_char == ',' || next_char == '\0' ||
1537 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1540 /* check if string contains another parameter string after a comma */
1541 substring = strchr(s, ',');
1542 if (substring == NULL) /* string does not contain a comma */
1545 /* advance string pointer to next character after the comma */
1548 /* skip potential whitespaces after the comma */
1549 while (*substring == ' ' || *substring == '\t')
1552 return string_has_parameter(substring, s_contained);
1555 int get_parameter_value(char *token, char *value_raw, int type)
1557 char *value = getStringToLower(value_raw);
1558 int result = 0; /* probably a save default value */
1560 if (strcmp(token, ".direction") == 0)
1562 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1563 strcmp(value, "right") == 0 ? MV_RIGHT :
1564 strcmp(value, "up") == 0 ? MV_UP :
1565 strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING);
1567 else if (strcmp(token, ".anim_mode") == 0)
1569 result = (string_has_parameter(value, "loop") ? ANIM_LOOP :
1570 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1571 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1572 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1573 string_has_parameter(value, "random") ? ANIM_RANDOM :
1576 if (string_has_parameter(value, "reverse"))
1577 result |= ANIM_REVERSE;
1579 else /* generic parameter of type integer or boolean */
1581 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1582 type == TYPE_INTEGER ? get_integer_from_string(value) :
1583 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1584 ARG_UNDEFINED_VALUE);
1592 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1593 struct ListNodeInfo ***, int *);
1595 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1596 struct ConfigInfo *suffix_list,
1597 char **ignore_tokens,
1598 int num_file_list_entries)
1600 struct FileInfo *file_list;
1601 int num_file_list_entries_found = 0;
1602 int num_suffix_list_entries = 0;
1606 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1608 for (i=0; suffix_list[i].token != NULL; i++)
1609 num_suffix_list_entries++;
1611 /* always start with reliable default values */
1612 for (i=0; i<num_file_list_entries; i++)
1614 file_list[i].token = NULL;
1616 file_list[i].default_filename = NULL;
1617 file_list[i].filename = NULL;
1619 if (num_suffix_list_entries > 0)
1621 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1623 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1624 file_list[i].parameter = checked_calloc(parameter_array_size);
1626 for (j=0; j<num_suffix_list_entries; j++)
1628 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1629 setString(&file_list[i].parameter[j], suffix_list[j].value);
1635 for (i=0; config_list[i].token != NULL; i++)
1637 int len_config_token = strlen(config_list[i].token);
1638 int len_config_value = strlen(config_list[i].value);
1639 boolean is_file_entry = TRUE;
1641 for (j=0; suffix_list[j].token != NULL; j++)
1643 int len_suffix = strlen(suffix_list[j].token);
1645 if (len_suffix < len_config_token &&
1646 strcmp(&config_list[i].token[len_config_token - len_suffix],
1647 suffix_list[j].token) == 0)
1649 setString(&file_list[list_pos].default_parameter[j],
1650 config_list[i].value);
1652 is_file_entry = FALSE;
1657 /* the following tokens are no file definitions, but other config tokens */
1658 for (j=0; ignore_tokens[j] != NULL; j++)
1659 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1660 is_file_entry = FALSE;
1667 if (list_pos >= num_file_list_entries)
1670 /* simple sanity check if this is really a file definition */
1671 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1672 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1673 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1675 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1676 config_list[i].token, config_list[i].value);
1677 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1680 file_list[list_pos].token = config_list[i].token;
1681 file_list[list_pos].default_filename = config_list[i].value;
1685 num_file_list_entries_found = list_pos + 1;
1686 if (num_file_list_entries_found != num_file_list_entries)
1688 Error(ERR_RETURN_LINE, "-");
1689 Error(ERR_RETURN, "inconsistant config list information:");
1690 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1691 num_file_list_entries);
1692 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1693 num_file_list_entries_found);
1694 Error(ERR_EXIT, "please fix");
1700 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1702 int len_token = strlen(token);
1703 int len_suffix = strlen(suffix);
1706 if (IS_PARENT_PROCESS())
1707 printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1710 if (start_pos < 0) /* compare suffix from end of string */
1711 start_pos += len_token;
1713 if (start_pos < 0 || start_pos + len_suffix > len_token)
1716 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1719 if (token[start_pos + len_suffix] == '\0')
1722 if (token[start_pos + len_suffix] == '.')
1728 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN]"
1730 static void read_token_parameters(struct SetupFileList *setup_file_list,
1731 struct ConfigInfo *suffix_list,
1732 struct FileInfo *file_list_entry)
1734 /* check for config token that is the base token without any suffixes */
1735 char *filename = getTokenValue(setup_file_list, file_list_entry->token);
1736 char *known_token_value = KNOWN_TOKEN_VALUE;
1739 if (filename != NULL)
1741 setString(&file_list_entry->filename, filename);
1743 /* when file definition found, set all parameters to default values */
1744 for (i=0; suffix_list[i].token != NULL; i++)
1745 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1747 file_list_entry->redefined = TRUE;
1749 /* mark config file token as well known from default config */
1750 setTokenValue(setup_file_list, file_list_entry->token, known_token_value);
1753 setString(&file_list_entry->filename, file_list_entry->default_filename);
1755 /* check for config tokens that can be build by base token and suffixes */
1756 for (i=0; suffix_list[i].token != NULL; i++)
1758 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1759 char *value = getTokenValue(setup_file_list, token);
1763 setString(&file_list_entry->parameter[i], value);
1765 /* mark config file token as well known from default config */
1766 setTokenValue(setup_file_list, token, known_token_value);
1773 static void add_dynamic_file_list_entry(struct FileInfo **list,
1774 int *num_list_entries,
1775 struct SetupFileList *extra_file_list,
1776 struct ConfigInfo *suffix_list,
1777 int num_suffix_list_entries,
1780 struct FileInfo *new_list_entry;
1781 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1784 if (IS_PARENT_PROCESS())
1785 printf("===> found dynamic definition '%s'\n", token);
1788 (*num_list_entries)++;
1789 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1790 new_list_entry = &(*list)[*num_list_entries - 1];
1792 new_list_entry->token = getStringCopy(token);
1793 new_list_entry->filename = NULL;
1794 new_list_entry->parameter = checked_calloc(parameter_array_size);
1796 read_token_parameters(extra_file_list, suffix_list, new_list_entry);
1799 static void add_property_mapping(struct PropertyMapping **list,
1800 int *num_list_entries,
1801 int base_index, int ext1_index,
1802 int ext2_index, int ext3_index,
1805 struct PropertyMapping *new_list_entry;
1807 (*num_list_entries)++;
1808 *list = checked_realloc(*list,
1809 *num_list_entries * sizeof(struct PropertyMapping));
1810 new_list_entry = &(*list)[*num_list_entries - 1];
1812 new_list_entry->base_index = base_index;
1813 new_list_entry->ext1_index = ext1_index;
1814 new_list_entry->ext2_index = ext2_index;
1815 new_list_entry->ext3_index = ext3_index;
1817 new_list_entry->artwork_index = artwork_index;
1820 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
1822 struct FileInfo *file_list = artwork_info->file_list;
1823 struct ConfigInfo *suffix_list = artwork_info->suffix_list;
1824 char **base_prefixes = artwork_info->base_prefixes;
1825 char **ext1_suffixes = artwork_info->ext1_suffixes;
1826 char **ext2_suffixes = artwork_info->ext2_suffixes;
1827 char **ext3_suffixes = artwork_info->ext3_suffixes;
1828 char **ignore_tokens = artwork_info->ignore_tokens;
1829 int num_file_list_entries = artwork_info->num_file_list_entries;
1830 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1831 int num_base_prefixes = artwork_info->num_base_prefixes;
1832 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
1833 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
1834 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
1835 int num_ignore_tokens = artwork_info->num_ignore_tokens;
1836 char *filename = getCustomArtworkConfigFilename(artwork_info->type);
1837 struct SetupFileList *setup_file_list;
1838 struct SetupFileList *extra_file_list = NULL;
1839 struct SetupFileList *list;
1840 char *known_token_value = KNOWN_TOKEN_VALUE;
1844 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
1847 /* always start with reliable default values */
1848 for (i=0; i<num_file_list_entries; i++)
1850 setString(&file_list[i].filename, file_list[i].default_filename);
1852 for (j=0; j<num_suffix_list_entries; j++)
1853 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
1855 file_list[i].redefined = FALSE;
1858 /* free previous dynamic artwork file array */
1859 if (artwork_info->dynamic_file_list != NULL)
1861 for (i=0; i<artwork_info->num_dynamic_file_list_entries; i++)
1863 free(artwork_info->dynamic_file_list[i].token);
1864 free(artwork_info->dynamic_file_list[i].filename);
1865 free(artwork_info->dynamic_file_list[i].parameter);
1868 free(artwork_info->dynamic_file_list);
1869 artwork_info->dynamic_file_list = NULL;
1871 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
1872 &artwork_info->num_dynamic_file_list_entries);
1875 /* free previous property mapping */
1876 if (artwork_info->property_mapping != NULL)
1878 free(artwork_info->property_mapping);
1880 artwork_info->property_mapping = NULL;
1881 artwork_info->num_property_mapping_entries = 0;
1884 if (filename == NULL)
1887 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
1890 /* read parameters for all known config file tokens */
1891 for (i=0; i<num_file_list_entries; i++)
1892 read_token_parameters(setup_file_list, suffix_list, &file_list[i]);
1894 /* set all tokens that can be ignored here to "known" keyword */
1895 for (i=0; i < num_ignore_tokens; i++)
1896 setTokenValue(setup_file_list, ignore_tokens[i], known_token_value);
1898 /* copy all unknown config file tokens to extra config list */
1899 for (list = setup_file_list; list != NULL; list = list->next)
1901 if (strcmp(list->value, known_token_value) != 0)
1903 if (extra_file_list == NULL)
1904 extra_file_list = newSetupFileList(list->token, list->value);
1906 setTokenValue(extra_file_list, list->token, list->value);
1910 /* at this point, we do not need the config file list anymore -- free it */
1911 freeSetupFileList(setup_file_list);
1913 /* now try to determine valid, dynamically defined config tokens */
1915 for (list = extra_file_list; list != NULL; list = list->next)
1917 struct FileInfo **dynamic_file_list =
1918 &artwork_info->dynamic_file_list;
1919 int *num_dynamic_file_list_entries =
1920 &artwork_info->num_dynamic_file_list_entries;
1921 struct PropertyMapping **property_mapping =
1922 &artwork_info->property_mapping;
1923 int *num_property_mapping_entries =
1924 &artwork_info->num_property_mapping_entries;
1925 int current_summarized_file_list_entry =
1926 artwork_info->num_file_list_entries +
1927 artwork_info->num_dynamic_file_list_entries;
1928 char *token = list->token;
1929 int len_token = strlen(token);
1931 boolean base_prefix_found = FALSE;
1932 boolean parameter_suffix_found = FALSE;
1934 /* skip all parameter definitions (handled by read_token_parameters()) */
1935 for (i=0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
1937 int len_suffix = strlen(suffix_list[i].token);
1939 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
1940 parameter_suffix_found = TRUE;
1944 if (IS_PARENT_PROCESS())
1946 if (parameter_suffix_found)
1947 printf("---> skipping token '%s' (parameter token)\n", token);
1949 printf("---> examining token '%s': search prefix ...\n", token);
1953 if (parameter_suffix_found)
1956 /* ---------- step 0: search for matching base prefix ---------- */
1959 for (i=0; i<num_base_prefixes && !base_prefix_found; i++)
1961 char *base_prefix = base_prefixes[i];
1962 int len_base_prefix = strlen(base_prefix);
1963 boolean ext1_suffix_found = FALSE;
1964 boolean ext2_suffix_found = FALSE;
1965 boolean ext3_suffix_found = FALSE;
1966 boolean exact_match = FALSE;
1967 int base_index = -1;
1968 int ext1_index = -1;
1969 int ext2_index = -1;
1970 int ext3_index = -1;
1972 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
1974 if (!base_prefix_found)
1979 if (start_pos + len_base_prefix == len_token) /* exact match */
1983 add_dynamic_file_list_entry(dynamic_file_list,
1984 num_dynamic_file_list_entries,
1987 num_suffix_list_entries,
1989 add_property_mapping(property_mapping,
1990 num_property_mapping_entries,
1991 base_index, -1, -1, -1,
1992 current_summarized_file_list_entry);
1997 if (IS_PARENT_PROCESS())
1998 printf("---> examining token '%s': search 1st suffix ...\n", token);
2001 /* ---------- step 1: search for matching first suffix ---------- */
2003 start_pos += len_base_prefix;
2004 for (j=0; j<num_ext1_suffixes && !ext1_suffix_found; j++)
2006 char *ext1_suffix = ext1_suffixes[j];
2007 int len_ext1_suffix = strlen(ext1_suffix);
2009 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2011 if (!ext1_suffix_found)
2016 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2020 add_dynamic_file_list_entry(dynamic_file_list,
2021 num_dynamic_file_list_entries,
2024 num_suffix_list_entries,
2026 add_property_mapping(property_mapping,
2027 num_property_mapping_entries,
2028 base_index, ext1_index, -1, -1,
2029 current_summarized_file_list_entry);
2033 start_pos += len_ext1_suffix;
2040 if (IS_PARENT_PROCESS())
2041 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2044 /* ---------- step 2: search for matching second suffix ---------- */
2046 for (k=0; k<num_ext2_suffixes && !ext2_suffix_found; k++)
2048 char *ext2_suffix = ext2_suffixes[k];
2049 int len_ext2_suffix = strlen(ext2_suffix);
2051 ext2_suffix_found = token_suffix_match(token, ext2_suffix,start_pos);
2053 if (!ext2_suffix_found)
2058 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2062 add_dynamic_file_list_entry(dynamic_file_list,
2063 num_dynamic_file_list_entries,
2066 num_suffix_list_entries,
2068 add_property_mapping(property_mapping,
2069 num_property_mapping_entries,
2070 base_index, ext1_index, ext2_index, -1,
2071 current_summarized_file_list_entry);
2075 start_pos += len_ext2_suffix;
2082 if (IS_PARENT_PROCESS())
2083 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2086 /* ---------- step 3: search for matching third suffix ---------- */
2088 for (l=0; l<num_ext3_suffixes && !ext3_suffix_found; l++)
2090 char *ext3_suffix = ext3_suffixes[l];
2091 int len_ext3_suffix = strlen(ext3_suffix);
2093 ext3_suffix_found =token_suffix_match(token,ext3_suffix,start_pos);
2095 if (!ext3_suffix_found)
2100 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2104 add_dynamic_file_list_entry(dynamic_file_list,
2105 num_dynamic_file_list_entries,
2108 num_suffix_list_entries,
2110 add_property_mapping(property_mapping,
2111 num_property_mapping_entries,
2112 base_index, ext1_index, ext2_index, ext3_index,
2113 current_summarized_file_list_entry);
2120 if (artwork_info->num_dynamic_file_list_entries > 0)
2122 artwork_info->dynamic_artwork_list =
2123 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2124 artwork_info->sizeof_artwork_list_entry);
2127 if (extra_file_list != NULL && options.verbose && IS_PARENT_PROCESS())
2129 boolean dynamic_tokens_found = FALSE;
2130 boolean unknown_tokens_found = FALSE;
2132 for (list = extra_file_list; list != NULL; list = list->next)
2134 if (strcmp(list->value, known_token_value) == 0)
2135 dynamic_tokens_found = TRUE;
2137 unknown_tokens_found = TRUE;
2141 if (dynamic_tokens_found)
2143 Error(ERR_RETURN_LINE, "-");
2144 Error(ERR_RETURN, "dynamic token(s) found:");
2146 for (list = extra_file_list; list != NULL; list = list->next)
2147 if (strcmp(list->value, known_token_value) == 0)
2148 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2150 Error(ERR_RETURN_LINE, "-");
2154 if (unknown_tokens_found)
2156 Error(ERR_RETURN_LINE, "-");
2157 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2158 Error(ERR_RETURN, "- config file: '%s'", filename);
2160 for (list = extra_file_list; list != NULL; list = list->next)
2161 if (strcmp(list->value, known_token_value) != 0)
2162 Error(ERR_RETURN, "- unknown token: '%s'", list->token);
2164 Error(ERR_RETURN_LINE, "-");
2168 freeSetupFileList(extra_file_list);
2171 for (i=0; i<num_file_list_entries; i++)
2173 printf("'%s' ", file_list[i].token);
2174 if (file_list[i].filename)
2175 printf("-> '%s'\n", file_list[i].filename);
2177 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2182 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2183 struct ListNodeInfo **listnode)
2187 char *filename = (*listnode)->source_filename;
2190 printf("[decrementing reference counter of artwork '%s']\n", filename);
2193 if (--(*listnode)->num_references <= 0)
2196 printf("[deleting artwork '%s']\n", filename);
2199 deleteNodeFromList(&artwork_info->content_list, filename,
2200 artwork_info->free_artwork);
2207 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2208 struct ListNodeInfo **listnode,
2213 "Loading graphics:",
2219 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2221 if (filename == NULL)
2223 int error_mode = ERR_WARN;
2225 /* we can get away without sounds and music, but not without graphics */
2226 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2227 error_mode = ERR_EXIT;
2229 Error(error_mode, "cannot find artwork file '%s'", basename);
2233 /* check if the old and the new artwork file are the same */
2234 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2236 /* The old and new artwork are the same (have the same filename and path).
2237 This usually means that this artwork does not exist in this artwork set
2238 and a fallback to the existing artwork is done. */
2241 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2247 /* delete existing artwork file entry */
2248 deleteArtworkListEntry(artwork_info, listnode);
2250 /* check if the new artwork file already exists in the list of artworks */
2251 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2254 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2257 *listnode = (struct ListNodeInfo *)node->content;
2258 (*listnode)->num_references++;
2263 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2264 DrawInitText(basename, 150, FC_YELLOW);
2266 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2269 printf("[adding new artwork '%s']\n", filename);
2272 (*listnode)->num_references = 1;
2273 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2278 int error_mode = ERR_WARN;
2280 /* we can get away without sounds and music, but not without graphics */
2281 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2282 error_mode = ERR_EXIT;
2284 Error(error_mode, "cannot load artwork file '%s'", basename);
2289 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2290 struct ListNodeInfo **listnode,
2294 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2297 if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2299 deleteArtworkListEntry(artwork_info, listnode);
2303 replaceArtworkListEntry(artwork_info, listnode, basename);
2306 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2307 struct ListNodeInfo **listnode,
2308 char *basename, int list_pos)
2311 if (artwork_info->artwork_list == NULL ||
2312 list_pos >= artwork_info->num_file_list_entries)
2317 printf("loading artwork '%s' ... [%d]\n",
2318 basename, getNumNodes(artwork_info->content_list));
2322 LoadCustomArtwork(artwork_info, listnode, basename);
2324 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2329 printf("loading artwork '%s' done [%d]\n",
2330 basename, getNumNodes(artwork_info->content_list));
2334 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2336 struct FileInfo *file_list = artwork_info->file_list;
2337 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2338 int num_file_list_entries = artwork_info->num_file_list_entries;
2339 int num_dynamic_file_list_entries =
2340 artwork_info->num_dynamic_file_list_entries;
2344 printf("DEBUG: reloading %d static artwork files ...\n",
2345 num_file_list_entries);
2348 for(i=0; i<num_file_list_entries; i++)
2349 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2350 file_list[i].filename, i);
2353 printf("DEBUG: reloading %d dynamic artwork files ...\n",
2354 num_dynamic_file_list_entries);
2357 for(i=0; i<num_dynamic_file_list_entries; i++)
2358 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2359 dynamic_file_list[i].filename, i);
2362 dumpList(artwork_info->content_list);
2366 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2367 struct ListNodeInfo ***list,
2368 int *num_list_entries)
2375 for(i=0; i<*num_list_entries; i++)
2376 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2380 *num_list_entries = 0;
2383 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2385 if (artwork_info == NULL)
2389 printf("%s: FREEING ARTWORK ...\n",
2390 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2393 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2394 &artwork_info->num_file_list_entries);
2396 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2397 &artwork_info->num_dynamic_file_list_entries);
2400 printf("%s: FREEING ARTWORK -- DONE\n",
2401 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2406 /* ------------------------------------------------------------------------- */
2407 /* functions only needed for non-Unix (non-command-line) systems */
2408 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2409 /* ------------------------------------------------------------------------- */
2411 #if defined(PLATFORM_MSDOS)
2413 #define ERROR_FILENAME "stderr.txt"
2415 void initErrorFile()
2417 unlink(ERROR_FILENAME);
2420 FILE *openErrorFile()
2422 return fopen(ERROR_FILENAME, MODE_APPEND);
2425 void dumpErrorFile()
2427 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2429 if (error_file != NULL)
2431 while (!feof(error_file))
2432 fputc(fgetc(error_file), stderr);
2440 /* ------------------------------------------------------------------------- */
2441 /* the following is only for debugging purpose and normally not used */
2442 /* ------------------------------------------------------------------------- */
2444 #define DEBUG_NUM_TIMESTAMPS 3
2446 void debug_print_timestamp(int counter_nr, char *message)
2448 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2450 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2451 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2453 counter[counter_nr][0] = Counter();
2456 printf("%s %.2f seconds\n", message,
2457 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2459 counter[counter_nr][1] = Counter();
2462 void debug_print_parent_only(char *format, ...)
2464 if (!IS_PARENT_PROCESS())
2471 va_start(ap, format);
2472 vprintf(format, ap);