1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
16 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ------------------------------------------------------------------------- */
37 /* some generic helper functions */
38 /* ------------------------------------------------------------------------- */
40 void fprintf_line(FILE *stream, char *line_string, int line_length)
44 for (i = 0; i < line_length; i++)
45 fprintf(stream, "%s", line_string);
47 fprintf(stream, "\n");
50 void printf_line(char *line_string, int line_length)
52 fprintf_line(stdout, line_string, line_length);
55 /* int2str() returns a number converted to a string;
56 the used memory is static, but will be overwritten by later calls,
57 so if you want to save the result, copy it to a private string buffer;
58 there can be 10 local calls of int2str() without buffering the result --
59 the 11th call will then destroy the result from the first call and so on.
62 char *int2str(int number, int size)
64 static char shift_array[10][40];
65 static int shift_counter = 0;
66 char *s = shift_array[shift_counter];
68 shift_counter = (shift_counter + 1) % 10;
75 sprintf(s, " %09d", number);
76 return &s[strlen(s) - size];
80 sprintf(s, "%d", number);
85 /* something similar to "int2str()" above, but allocates its own memory
86 and has a different interface; we cannot use "itoa()", because this
87 seems to be already defined when cross-compiling to the win32 target */
89 char *i_to_a(unsigned int i)
91 static char *a = NULL;
95 if (i > 2147483647) /* yes, this is a kludge */
98 a = checked_malloc(10 + 1);
106 /* ------------------------------------------------------------------------- */
107 /* counter functions */
108 /* ------------------------------------------------------------------------- */
110 #if defined(PLATFORM_MSDOS)
111 volatile unsigned long counter = 0;
113 void increment_counter()
118 END_OF_FUNCTION(increment_counter);
122 /* maximal allowed length of a command line option */
123 #define MAX_OPTION_LEN 256
126 static unsigned long mainCounter(int mode)
128 static unsigned long base_ms = 0;
129 unsigned long current_ms;
130 unsigned long counter_ms;
132 current_ms = SDL_GetTicks();
134 /* reset base time in case of counter initializing or wrap-around */
135 if (mode == INIT_COUNTER || current_ms < base_ms)
136 base_ms = current_ms;
138 counter_ms = current_ms - base_ms;
140 return counter_ms; /* return milliseconds since last init */
143 #else /* !TARGET_SDL */
145 #if defined(PLATFORM_UNIX)
146 static unsigned long mainCounter(int mode)
148 static struct timeval base_time = { 0, 0 };
149 struct timeval current_time;
150 unsigned long counter_ms;
152 gettimeofday(¤t_time, NULL);
154 /* reset base time in case of counter initializing or wrap-around */
155 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
156 base_time = current_time;
158 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
159 + (current_time.tv_usec - base_time.tv_usec) / 1000;
161 return counter_ms; /* return milliseconds since last init */
163 #endif /* PLATFORM_UNIX */
164 #endif /* !TARGET_SDL */
166 void InitCounter() /* set counter back to zero */
168 #if !defined(PLATFORM_MSDOS)
169 mainCounter(INIT_COUNTER);
171 LOCK_VARIABLE(counter);
172 LOCK_FUNCTION(increment_counter);
173 install_int_ex(increment_counter, BPS_TO_TIMER(100));
177 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
179 #if !defined(PLATFORM_MSDOS)
180 return mainCounter(READ_COUNTER);
182 return (counter * 10);
186 static void sleep_milliseconds(unsigned long milliseconds_delay)
188 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
191 #if defined(PLATFORM_MSDOS)
192 /* don't use select() to perform waiting operations under DOS
193 environment; always use a busy loop for waiting instead */
194 do_busy_waiting = TRUE;
200 /* we want to wait only a few ms -- if we assume that we have a
201 kernel timer resolution of 10 ms, we would wait far to long;
202 therefore it's better to do a short interval of busy waiting
203 to get our sleeping time more accurate */
205 unsigned long base_counter = Counter(), actual_counter = Counter();
207 while (actual_counter < base_counter + milliseconds_delay &&
208 actual_counter >= base_counter)
209 actual_counter = Counter();
213 #if defined(TARGET_SDL)
214 SDL_Delay(milliseconds_delay);
215 #elif defined(TARGET_ALLEGRO)
216 rest(milliseconds_delay);
218 struct timeval delay;
220 delay.tv_sec = milliseconds_delay / 1000;
221 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
223 if (select(0, NULL, NULL, NULL, &delay) != 0)
224 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
229 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
231 sleep_milliseconds(delay);
234 boolean FrameReached(unsigned long *frame_counter_var,
235 unsigned long frame_delay)
237 unsigned long actual_frame_counter = FrameCounter;
239 if (actual_frame_counter >= *frame_counter_var &&
240 actual_frame_counter < *frame_counter_var + frame_delay)
243 *frame_counter_var = actual_frame_counter;
248 boolean DelayReached(unsigned long *counter_var,
251 unsigned long actual_counter = Counter();
253 if (actual_counter >= *counter_var &&
254 actual_counter < *counter_var + delay)
257 *counter_var = actual_counter;
262 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
264 unsigned long actual_counter;
268 actual_counter = Counter();
270 if (actual_counter >= *counter_var &&
271 actual_counter < *counter_var + delay)
272 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
277 *counter_var = actual_counter;
281 /* ------------------------------------------------------------------------- */
282 /* random generator functions */
283 /* ------------------------------------------------------------------------- */
285 unsigned int init_random_number(int nr, long seed)
287 if (seed == NEW_RANDOMIZE)
289 #if defined(TARGET_SDL)
290 seed = (long)SDL_GetTicks();
292 struct timeval current_time;
294 gettimeofday(¤t_time, NULL);
295 seed = (long)current_time.tv_usec;
299 srandom_linux_libc(nr, (unsigned int) seed);
301 return (unsigned int) seed;
304 unsigned int get_random_number(int nr, int max)
306 return (max > 0 ? random_linux_libc(nr) % max : 0);
310 /* ------------------------------------------------------------------------- */
311 /* system info functions */
312 /* ------------------------------------------------------------------------- */
314 #if !defined(PLATFORM_MSDOS)
315 static char *get_corrected_real_name(char *real_name)
317 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
318 char *from_ptr = real_name;
319 char *to_ptr = real_name_new;
321 if (strchr(real_name, 'ß') == NULL) /* name does not contain 'ß' */
323 strncpy(real_name_new, real_name, MAX_USERNAME_LEN);
324 real_name_new[MAX_USERNAME_LEN] = '\0';
326 return real_name_new;
329 /* the user's real name may contain a 'ß' character (german sharp s),
330 which has no equivalent in upper case letters (which our fonts use) */
331 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
333 if (*from_ptr != 'ß')
334 *to_ptr++ = *from_ptr++;
345 return real_name_new;
351 static char *login_name = NULL;
353 #if defined(PLATFORM_WIN32)
354 if (login_name == NULL)
356 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
357 login_name = checked_malloc(buffer_size);
359 if (GetUserName(login_name, &buffer_size) == 0)
360 strcpy(login_name, ANONYMOUS_NAME);
363 if (login_name == NULL)
367 if ((pwd = getpwuid(getuid())) == NULL)
368 login_name = ANONYMOUS_NAME;
370 login_name = getStringCopy(pwd->pw_name);
379 static char *real_name = NULL;
381 #if defined(PLATFORM_WIN32)
382 if (real_name == NULL)
384 static char buffer[MAX_USERNAME_LEN + 1];
385 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
387 if (GetUserName(buffer, &buffer_size) != 0)
388 real_name = get_corrected_real_name(buffer);
390 real_name = ANONYMOUS_NAME;
392 #elif defined(PLATFORM_UNIX)
393 if (real_name == NULL)
397 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
398 real_name = get_corrected_real_name(pwd->pw_gecos);
400 real_name = ANONYMOUS_NAME;
403 real_name = ANONYMOUS_NAME;
411 static char *dir = NULL;
413 #if defined(PLATFORM_WIN32)
416 dir = checked_malloc(MAX_PATH + 1);
418 if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
421 #elif defined(PLATFORM_UNIX)
424 if ((dir = getenv("HOME")) == NULL)
428 if ((pwd = getpwuid(getuid())) != NULL)
429 dir = getStringCopy(pwd->pw_dir);
442 /* ------------------------------------------------------------------------- */
443 /* various string functions */
444 /* ------------------------------------------------------------------------- */
446 char *getPath2(char *path1, char *path2)
448 char *complete_path = checked_malloc(strlen(path1) + 1 +
451 sprintf(complete_path, "%s/%s", path1, path2);
453 return complete_path;
456 char *getPath3(char *path1, char *path2, char *path3)
458 char *complete_path = checked_malloc(strlen(path1) + 1 +
462 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
464 return complete_path;
467 char *getStringCat2(char *s1, char *s2)
469 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
471 sprintf(complete_string, "%s%s", s1, s2);
473 return complete_string;
476 char *getStringCopy(char *s)
483 s_copy = checked_malloc(strlen(s) + 1);
489 char *getStringToLower(char *s)
491 char *s_copy = checked_malloc(strlen(s) + 1);
492 char *s_ptr = s_copy;
495 *s_ptr++ = tolower(*s++);
501 void setString(char **old_value, char *new_value)
503 checked_free(*old_value);
505 *old_value = getStringCopy(new_value);
509 /* ------------------------------------------------------------------------- */
510 /* command line option handling functions */
511 /* ------------------------------------------------------------------------- */
513 void GetOptions(char *argv[], void (*print_usage_function)(void))
515 char **options_left = &argv[1];
517 /* initialize global program options */
518 options.display_name = NULL;
519 options.server_host = NULL;
520 options.server_port = 0;
521 options.ro_base_directory = RO_BASE_PATH;
522 options.rw_base_directory = RW_BASE_PATH;
523 options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
524 options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
525 options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
526 options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
527 options.docs_directory = RO_BASE_PATH "/" DOCS_DIRECTORY;
528 options.execute_command = NULL;
529 options.serveronly = FALSE;
530 options.network = FALSE;
531 options.verbose = FALSE;
532 options.debug = FALSE;
534 #if !defined(PLATFORM_UNIX)
535 if (*options_left == NULL) /* no options given -- enable verbose mode */
536 options.verbose = TRUE;
539 while (*options_left)
541 char option_str[MAX_OPTION_LEN];
542 char *option = options_left[0];
543 char *next_option = options_left[1];
544 char *option_arg = NULL;
545 int option_len = strlen(option);
547 if (option_len >= MAX_OPTION_LEN)
548 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
550 strcpy(option_str, option); /* copy argument into buffer */
553 if (strcmp(option, "--") == 0) /* stop scanning arguments */
556 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
559 option_arg = strchr(option, '=');
560 if (option_arg == NULL) /* no '=' in option */
561 option_arg = next_option;
564 *option_arg++ = '\0'; /* cut argument from option */
565 if (*option_arg == '\0') /* no argument after '=' */
566 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
569 option_len = strlen(option);
571 if (strcmp(option, "-") == 0)
572 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
573 else if (strncmp(option, "-help", option_len) == 0)
575 print_usage_function();
579 else if (strncmp(option, "-display", option_len) == 0)
581 if (option_arg == NULL)
582 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
584 options.display_name = option_arg;
585 if (option_arg == next_option)
588 else if (strncmp(option, "-basepath", option_len) == 0)
590 if (option_arg == NULL)
591 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
593 /* this should be extended to separate options for ro and rw data */
594 options.ro_base_directory = option_arg;
595 options.rw_base_directory = option_arg;
596 if (option_arg == next_option)
599 /* adjust path for level directory accordingly */
600 options.level_directory =
601 getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
603 else if (strncmp(option, "-levels", option_len) == 0)
605 if (option_arg == NULL)
606 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
608 options.level_directory = option_arg;
609 if (option_arg == next_option)
612 else if (strncmp(option, "-graphics", option_len) == 0)
614 if (option_arg == NULL)
615 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
617 options.graphics_directory = option_arg;
618 if (option_arg == next_option)
621 else if (strncmp(option, "-sounds", option_len) == 0)
623 if (option_arg == NULL)
624 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
626 options.sounds_directory = option_arg;
627 if (option_arg == next_option)
630 else if (strncmp(option, "-music", option_len) == 0)
632 if (option_arg == NULL)
633 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
635 options.music_directory = option_arg;
636 if (option_arg == next_option)
639 else if (strncmp(option, "-network", option_len) == 0)
641 options.network = TRUE;
643 else if (strncmp(option, "-serveronly", option_len) == 0)
645 options.serveronly = TRUE;
647 else if (strncmp(option, "-verbose", option_len) == 0)
649 options.verbose = TRUE;
651 else if (strncmp(option, "-debug", option_len) == 0)
653 options.debug = TRUE;
655 else if (strncmp(option, "-execute", option_len) == 0)
657 if (option_arg == NULL)
658 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
660 options.execute_command = option_arg;
661 if (option_arg == next_option)
664 else if (*option == '-')
666 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
668 else if (options.server_host == NULL)
670 options.server_host = *options_left;
672 else if (options.server_port == 0)
674 options.server_port = atoi(*options_left);
675 if (options.server_port < 1024)
676 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
679 Error(ERR_EXIT_HELP, "too many arguments");
686 /* ------------------------------------------------------------------------- */
687 /* error handling functions */
688 /* ------------------------------------------------------------------------- */
690 /* used by SetError() and GetError() to store internal error messages */
691 static char internal_error[1024]; /* this is bad */
693 void SetError(char *format, ...)
697 va_start(ap, format);
698 vsprintf(internal_error, format, ap);
704 return internal_error;
707 void Error(int mode, char *format, ...)
709 static boolean last_line_was_separator = FALSE;
710 char *process_name = "";
711 FILE *error = stderr;
712 char *newline = "\n";
714 /* display warnings only when running in verbose mode */
715 if (mode & ERR_WARN && !options.verbose)
718 if (mode == ERR_RETURN_LINE)
720 if (!last_line_was_separator)
721 fprintf_line(error, format, 79);
723 last_line_was_separator = TRUE;
728 last_line_was_separator = FALSE;
730 #if defined(PLATFORM_MSDOS)
733 if ((error = openErrorFile()) == NULL)
735 printf("Cannot write to error output file!%s", newline);
736 program.exit_function(1);
740 if (mode & ERR_SOUND_SERVER)
741 process_name = " sound server";
742 else if (mode & ERR_NETWORK_SERVER)
743 process_name = " network server";
744 else if (mode & ERR_NETWORK_CLIENT)
745 process_name = " network client **";
751 fprintf(error, "%s%s: ", program.command_basename, process_name);
754 fprintf(error, "warning: ");
756 va_start(ap, format);
757 vfprintf(error, format, ap);
760 fprintf(error, "%s", newline);
764 fprintf(error, "%s: Try option '--help' for more information.%s",
765 program.command_basename, newline);
768 fprintf(error, "%s%s: aborting%s",
769 program.command_basename, process_name, newline);
776 if (mode & ERR_FROM_SERVER)
777 exit(1); /* child process: normal exit */
779 program.exit_function(1); /* main process: clean up stuff */
784 /* ------------------------------------------------------------------------- */
785 /* checked memory allocation and freeing functions */
786 /* ------------------------------------------------------------------------- */
788 void *checked_malloc(unsigned long size)
795 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
800 void *checked_calloc(unsigned long size)
804 ptr = calloc(1, size);
807 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
812 void *checked_realloc(void *ptr, unsigned long size)
814 ptr = realloc(ptr, size);
817 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
822 void checked_free(void *ptr)
824 if (ptr != NULL) /* this check should be done by free() anyway */
829 /* ------------------------------------------------------------------------- */
830 /* various helper functions */
831 /* ------------------------------------------------------------------------- */
833 inline void swap_numbers(int *i1, int *i2)
841 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
853 short getFile16BitInteger(FILE *file, int byte_order)
855 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
856 return ((fgetc(file) << 8) |
858 else /* BYTE_ORDER_LITTLE_ENDIAN */
859 return ((fgetc(file) << 0) |
863 void putFile16BitInteger(FILE *file, short value, int byte_order)
865 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
867 fputc((value >> 8) & 0xff, file);
868 fputc((value >> 0) & 0xff, file);
870 else /* BYTE_ORDER_LITTLE_ENDIAN */
872 fputc((value >> 0) & 0xff, file);
873 fputc((value >> 8) & 0xff, file);
877 int getFile32BitInteger(FILE *file, int byte_order)
879 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
880 return ((fgetc(file) << 24) |
881 (fgetc(file) << 16) |
884 else /* BYTE_ORDER_LITTLE_ENDIAN */
885 return ((fgetc(file) << 0) |
887 (fgetc(file) << 16) |
888 (fgetc(file) << 24));
891 void putFile32BitInteger(FILE *file, int value, int byte_order)
893 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
895 fputc((value >> 24) & 0xff, file);
896 fputc((value >> 16) & 0xff, file);
897 fputc((value >> 8) & 0xff, file);
898 fputc((value >> 0) & 0xff, file);
900 else /* BYTE_ORDER_LITTLE_ENDIAN */
902 fputc((value >> 0) & 0xff, file);
903 fputc((value >> 8) & 0xff, file);
904 fputc((value >> 16) & 0xff, file);
905 fputc((value >> 24) & 0xff, file);
909 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
912 const int chunk_name_length = 4;
914 /* read chunk name */
915 fgets(chunk_name, chunk_name_length + 1, file);
917 if (chunk_size != NULL)
919 /* read chunk size */
920 *chunk_size = getFile32BitInteger(file, byte_order);
923 return (feof(file) || ferror(file) ? FALSE : TRUE);
926 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
929 /* write chunk name */
930 fputs(chunk_name, file);
934 /* write chunk size */
935 putFile32BitInteger(file, chunk_size, byte_order);
939 int getFileVersion(FILE *file)
941 int version_major = fgetc(file);
942 int version_minor = fgetc(file);
943 int version_patch = fgetc(file);
944 int version_build = fgetc(file);
946 return VERSION_IDENT(version_major, version_minor, version_patch,
950 void putFileVersion(FILE *file, int version)
952 int version_major = VERSION_MAJOR(version);
953 int version_minor = VERSION_MINOR(version);
954 int version_patch = VERSION_PATCH(version);
955 int version_build = VERSION_BUILD(version);
957 fputc(version_major, file);
958 fputc(version_minor, file);
959 fputc(version_patch, file);
960 fputc(version_build, file);
963 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
965 while (bytes-- && !feof(file))
969 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
976 /* ------------------------------------------------------------------------- */
977 /* functions to translate key identifiers between different format */
978 /* ------------------------------------------------------------------------- */
980 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
981 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
982 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
983 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
985 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
994 /* normal cursor keys */
995 { KSYM_Left, "XK_Left", "cursor left" },
996 { KSYM_Right, "XK_Right", "cursor right" },
997 { KSYM_Up, "XK_Up", "cursor up" },
998 { KSYM_Down, "XK_Down", "cursor down" },
1000 /* keypad cursor keys */
1002 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1003 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1004 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1005 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1008 /* other keypad keys */
1009 #ifdef KSYM_KP_Enter
1010 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1011 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1012 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1013 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1014 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1015 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1019 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1020 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1021 { KSYM_Control_L, "XK_Control_L", "left control" },
1022 { KSYM_Control_R, "XK_Control_R", "right control" },
1023 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1024 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1025 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1026 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1027 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1028 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1029 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1030 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1032 /* some special keys */
1033 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1034 { KSYM_Delete, "XK_Delete", "delete" },
1035 { KSYM_Insert, "XK_Insert", "insert" },
1036 { KSYM_Tab, "XK_Tab", "tab" },
1037 { KSYM_Home, "XK_Home", "home" },
1038 { KSYM_End, "XK_End", "end" },
1039 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1040 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1041 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1043 /* ASCII 0x20 to 0x40 keys (except numbers) */
1044 { KSYM_space, "XK_space", "space" },
1045 { KSYM_exclam, "XK_exclam", "!" },
1046 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1047 { KSYM_numbersign, "XK_numbersign", "#" },
1048 { KSYM_dollar, "XK_dollar", "$" },
1049 { KSYM_percent, "XK_percent", "%" },
1050 { KSYM_ampersand, "XK_ampersand", "&" },
1051 { KSYM_apostrophe, "XK_apostrophe", "'" },
1052 { KSYM_parenleft, "XK_parenleft", "(" },
1053 { KSYM_parenright, "XK_parenright", ")" },
1054 { KSYM_asterisk, "XK_asterisk", "*" },
1055 { KSYM_plus, "XK_plus", "+" },
1056 { KSYM_comma, "XK_comma", "," },
1057 { KSYM_minus, "XK_minus", "-" },
1058 { KSYM_period, "XK_period", "." },
1059 { KSYM_slash, "XK_slash", "/" },
1060 { KSYM_colon, "XK_colon", ":" },
1061 { KSYM_semicolon, "XK_semicolon", ";" },
1062 { KSYM_less, "XK_less", "<" },
1063 { KSYM_equal, "XK_equal", "=" },
1064 { KSYM_greater, "XK_greater", ">" },
1065 { KSYM_question, "XK_question", "?" },
1066 { KSYM_at, "XK_at", "@" },
1068 /* more ASCII keys */
1069 { KSYM_bracketleft, "XK_bracketleft", "[" },
1070 { KSYM_backslash, "XK_backslash", "backslash" },
1071 { KSYM_bracketright,"XK_bracketright", "]" },
1072 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1073 { KSYM_underscore, "XK_underscore", "_" },
1074 { KSYM_grave, "XK_grave", "grave" },
1075 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1076 { KSYM_braceleft, "XK_braceleft", "brace left" },
1077 { KSYM_bar, "XK_bar", "bar" },
1078 { KSYM_braceright, "XK_braceright", "brace right" },
1079 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1081 /* special (non-ASCII) keys */
1082 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1083 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1084 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1085 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1086 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1087 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1088 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1090 /* end-of-array identifier */
1096 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1098 static char name_buffer[30];
1101 if (key >= KSYM_A && key <= KSYM_Z)
1102 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1103 else if (key >= KSYM_a && key <= KSYM_z)
1104 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1105 else if (key >= KSYM_0 && key <= KSYM_9)
1106 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1107 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1108 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1109 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1110 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1111 else if (key == KSYM_UNDEFINED)
1112 strcpy(name_buffer, "(undefined)");
1119 if (key == translate_key[i].key)
1121 strcpy(name_buffer, translate_key[i].name);
1125 while (translate_key[++i].name);
1127 if (!translate_key[i].name)
1128 strcpy(name_buffer, "(unknown)");
1131 *name = name_buffer;
1133 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1135 static char name_buffer[30];
1138 if (key >= KSYM_A && key <= KSYM_Z)
1139 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1140 else if (key >= KSYM_a && key <= KSYM_z)
1141 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1142 else if (key >= KSYM_0 && key <= KSYM_9)
1143 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1144 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1145 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1146 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1147 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1148 else if (key == KSYM_UNDEFINED)
1149 strcpy(name_buffer, "[undefined]");
1156 if (key == translate_key[i].key)
1158 strcpy(name_buffer, translate_key[i].x11name);
1162 while (translate_key[++i].x11name);
1164 if (!translate_key[i].x11name)
1165 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1168 *x11name = name_buffer;
1170 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1172 Key key = KSYM_UNDEFINED;
1177 if (strcmp(translate_key[i].name, *name) == 0)
1179 key = translate_key[i].key;
1183 while (translate_key[++i].x11name);
1185 if (key == KSYM_UNDEFINED)
1186 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1190 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1192 Key key = KSYM_UNDEFINED;
1193 char *name_ptr = *x11name;
1195 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1197 char c = name_ptr[3];
1199 if (c >= 'A' && c <= 'Z')
1200 key = KSYM_A + (Key)(c - 'A');
1201 else if (c >= 'a' && c <= 'z')
1202 key = KSYM_a + (Key)(c - 'a');
1203 else if (c >= '0' && c <= '9')
1204 key = KSYM_0 + (Key)(c - '0');
1206 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1208 char c = name_ptr[6];
1210 if (c >= '0' && c <= '9')
1211 key = KSYM_0 + (Key)(c - '0');
1213 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1215 char c1 = name_ptr[4];
1216 char c2 = name_ptr[5];
1219 if ((c1 >= '0' && c1 <= '9') &&
1220 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1221 d = atoi(&name_ptr[4]);
1223 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1224 key = KSYM_F1 + (Key)(d - 1);
1226 else if (strncmp(name_ptr, "XK_", 3) == 0)
1232 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1234 key = translate_key[i].key;
1238 while (translate_key[++i].x11name);
1240 else if (strncmp(name_ptr, "0x", 2) == 0)
1242 unsigned long value = 0;
1248 char c = *name_ptr++;
1251 if (c >= '0' && c <= '9')
1253 else if (c >= 'a' && c <= 'f')
1254 d = (int)(c - 'a' + 10);
1255 else if (c >= 'A' && c <= 'F')
1256 d = (int)(c - 'A' + 10);
1264 value = value * 16 + d;
1275 char *getKeyNameFromKey(Key key)
1279 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1283 char *getX11KeyNameFromKey(Key key)
1287 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1291 Key getKeyFromKeyName(char *name)
1295 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1299 Key getKeyFromX11KeyName(char *x11name)
1303 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1307 char getCharFromKey(Key key)
1309 char *keyname = getKeyNameFromKey(key);
1312 if (strlen(keyname) == 1)
1313 letter = keyname[0];
1314 else if (strcmp(keyname, "space") == 0)
1316 else if (strcmp(keyname, "circumflex") == 0)
1323 /* ------------------------------------------------------------------------- */
1324 /* functions to translate string identifiers to integer or boolean value */
1325 /* ------------------------------------------------------------------------- */
1327 int get_integer_from_string(char *s)
1329 static char *number_text[][3] =
1331 { "0", "zero", "null", },
1332 { "1", "one", "first" },
1333 { "2", "two", "second" },
1334 { "3", "three", "third" },
1335 { "4", "four", "fourth" },
1336 { "5", "five", "fifth" },
1337 { "6", "six", "sixth" },
1338 { "7", "seven", "seventh" },
1339 { "8", "eight", "eighth" },
1340 { "9", "nine", "ninth" },
1341 { "10", "ten", "tenth" },
1342 { "11", "eleven", "eleventh" },
1343 { "12", "twelve", "twelfth" },
1345 { NULL, NULL, NULL },
1349 char *s_lower = getStringToLower(s);
1352 for (i = 0; number_text[i][0] != NULL; i++)
1353 for (j = 0; j < 3; j++)
1354 if (strcmp(s_lower, number_text[i][j]) == 0)
1359 if (strcmp(s_lower, "false") == 0)
1361 else if (strcmp(s_lower, "true") == 0)
1372 boolean get_boolean_from_string(char *s)
1374 char *s_lower = getStringToLower(s);
1375 boolean result = FALSE;
1377 if (strcmp(s_lower, "true") == 0 ||
1378 strcmp(s_lower, "yes") == 0 ||
1379 strcmp(s_lower, "on") == 0 ||
1380 get_integer_from_string(s) == 1)
1389 /* ------------------------------------------------------------------------- */
1390 /* functions for generic lists */
1391 /* ------------------------------------------------------------------------- */
1393 ListNode *newListNode()
1395 return checked_calloc(sizeof(ListNode));
1398 void addNodeToList(ListNode **node_first, char *key, void *content)
1400 ListNode *node_new = newListNode();
1403 printf("LIST: adding node with key '%s'\n", key);
1406 node_new->key = getStringCopy(key);
1407 node_new->content = content;
1408 node_new->next = *node_first;
1409 *node_first = node_new;
1412 void deleteNodeFromList(ListNode **node_first, char *key,
1413 void (*destructor_function)(void *))
1415 if (node_first == NULL || *node_first == NULL)
1419 printf("[CHECKING LIST KEY '%s' == '%s']\n",
1420 (*node_first)->key, key);
1423 if (strcmp((*node_first)->key, key) == 0)
1426 printf("[DELETING LIST ENTRY]\n");
1429 free((*node_first)->key);
1430 if (destructor_function)
1431 destructor_function((*node_first)->content);
1432 *node_first = (*node_first)->next;
1435 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1438 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1440 if (node_first == NULL)
1443 if (strcmp(node_first->key, key) == 0)
1446 return getNodeFromKey(node_first->next, key);
1449 int getNumNodes(ListNode *node_first)
1451 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1454 void dumpList(ListNode *node_first)
1456 ListNode *node = node_first;
1460 printf("['%s' (%d)]\n", node->key,
1461 ((struct ListNodeInfo *)node->content)->num_references);
1465 printf("[%d nodes]\n", getNumNodes(node_first));
1469 /* ------------------------------------------------------------------------- */
1470 /* functions for checking files and filenames */
1471 /* ------------------------------------------------------------------------- */
1473 boolean fileExists(char *filename)
1476 printf("checking file '%s'\n", filename);
1479 return (access(filename, F_OK) == 0);
1482 boolean fileHasPrefix(char *basename, char *prefix)
1484 static char *basename_lower = NULL;
1485 int basename_length, prefix_length;
1487 checked_free(basename_lower);
1489 if (basename == NULL || prefix == NULL)
1492 basename_lower = getStringToLower(basename);
1493 basename_length = strlen(basename_lower);
1494 prefix_length = strlen(prefix);
1496 if (basename_length > prefix_length + 1 &&
1497 basename_lower[prefix_length] == '.' &&
1498 strncmp(basename_lower, prefix, prefix_length) == 0)
1504 boolean fileHasSuffix(char *basename, char *suffix)
1506 static char *basename_lower = NULL;
1507 int basename_length, suffix_length;
1509 checked_free(basename_lower);
1511 if (basename == NULL || suffix == NULL)
1514 basename_lower = getStringToLower(basename);
1515 basename_length = strlen(basename_lower);
1516 suffix_length = strlen(suffix);
1518 if (basename_length > suffix_length + 1 &&
1519 basename_lower[basename_length - suffix_length - 1] == '.' &&
1520 strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0)
1526 boolean FileIsGraphic(char *filename)
1528 char *basename = strrchr(filename, '/');
1530 basename = (basename != NULL ? basename + 1 : filename);
1532 return fileHasSuffix(basename, "pcx");
1535 boolean FileIsSound(char *filename)
1537 char *basename = strrchr(filename, '/');
1539 basename = (basename != NULL ? basename + 1 : filename);
1541 return fileHasSuffix(basename, "wav");
1544 boolean FileIsMusic(char *filename)
1546 char *basename = strrchr(filename, '/');
1548 basename = (basename != NULL ? basename + 1 : filename);
1550 if (FileIsSound(basename))
1553 #if defined(TARGET_SDL)
1554 if (fileHasPrefix(basename, "mod") ||
1555 fileHasSuffix(basename, "mod") ||
1556 fileHasSuffix(basename, "s3m") ||
1557 fileHasSuffix(basename, "it") ||
1558 fileHasSuffix(basename, "xm") ||
1559 fileHasSuffix(basename, "midi") ||
1560 fileHasSuffix(basename, "mid") ||
1561 fileHasSuffix(basename, "mp3") ||
1562 fileHasSuffix(basename, "ogg"))
1569 boolean FileIsArtworkType(char *basename, int type)
1571 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1572 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1573 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1579 /* ------------------------------------------------------------------------- */
1580 /* functions for loading artwork configuration information */
1581 /* ------------------------------------------------------------------------- */
1583 /* This function checks if a string <s> of the format "string1, string2, ..."
1584 exactly contains a string <s_contained>. */
1586 static boolean string_has_parameter(char *s, char *s_contained)
1590 if (s == NULL || s_contained == NULL)
1593 if (strlen(s_contained) > strlen(s))
1596 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1598 char next_char = s[strlen(s_contained)];
1600 /* check if next character is delimiter or whitespace */
1601 return (next_char == ',' || next_char == '\0' ||
1602 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1605 /* check if string contains another parameter string after a comma */
1606 substring = strchr(s, ',');
1607 if (substring == NULL) /* string does not contain a comma */
1610 /* advance string pointer to next character after the comma */
1613 /* skip potential whitespaces after the comma */
1614 while (*substring == ' ' || *substring == '\t')
1617 return string_has_parameter(substring, s_contained);
1620 int get_parameter_value(char *suffix, char *value_raw, int type)
1622 char *value = getStringToLower(value_raw);
1623 int result = 0; /* probably a save default value */
1625 if (strcmp(suffix, ".direction") == 0)
1627 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1628 strcmp(value, "right") == 0 ? MV_RIGHT :
1629 strcmp(value, "up") == 0 ? MV_UP :
1630 strcmp(value, "down") == 0 ? MV_DOWN : MV_NO_MOVING);
1632 else if (strcmp(suffix, ".anim_mode") == 0)
1634 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1635 string_has_parameter(value, "loop") ? ANIM_LOOP :
1636 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1637 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1638 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1639 string_has_parameter(value, "random") ? ANIM_RANDOM :
1640 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1641 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1644 if (string_has_parameter(value, "reverse"))
1645 result |= ANIM_REVERSE;
1647 else /* generic parameter of type integer or boolean */
1649 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1650 type == TYPE_INTEGER ? get_integer_from_string(value) :
1651 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1652 ARG_UNDEFINED_VALUE);
1660 int get_auto_parameter_value(char *token, char *value_raw)
1664 if (token == NULL || value_raw == NULL)
1665 return ARG_UNDEFINED_VALUE;
1667 suffix = strrchr(token, '.');
1671 return get_parameter_value(suffix, value_raw, TYPE_INTEGER);
1674 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1675 struct ListNodeInfo ***, int *);
1677 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1678 struct ConfigInfo *suffix_list,
1679 char **ignore_tokens,
1680 int num_file_list_entries)
1682 struct FileInfo *file_list;
1683 int num_file_list_entries_found = 0;
1684 int num_suffix_list_entries = 0;
1688 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1690 for (i = 0; suffix_list[i].token != NULL; i++)
1691 num_suffix_list_entries++;
1693 /* always start with reliable default values */
1694 for (i = 0; i < num_file_list_entries; i++)
1696 file_list[i].token = NULL;
1698 file_list[i].default_filename = NULL;
1699 file_list[i].filename = NULL;
1701 if (num_suffix_list_entries > 0)
1703 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1705 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1706 file_list[i].parameter = checked_calloc(parameter_array_size);
1708 for (j = 0; j < num_suffix_list_entries; j++)
1710 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1711 setString(&file_list[i].parameter[j], suffix_list[j].value);
1717 for (i = 0; config_list[i].token != NULL; i++)
1719 int len_config_token = strlen(config_list[i].token);
1720 int len_config_value = strlen(config_list[i].value);
1721 boolean is_file_entry = TRUE;
1723 for (j = 0; suffix_list[j].token != NULL; j++)
1725 int len_suffix = strlen(suffix_list[j].token);
1727 if (len_suffix < len_config_token &&
1728 strcmp(&config_list[i].token[len_config_token - len_suffix],
1729 suffix_list[j].token) == 0)
1731 setString(&file_list[list_pos].default_parameter[j],
1732 config_list[i].value);
1734 is_file_entry = FALSE;
1739 /* the following tokens are no file definitions, but other config tokens */
1740 for (j = 0; ignore_tokens[j] != NULL; j++)
1741 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1742 is_file_entry = FALSE;
1749 if (list_pos >= num_file_list_entries)
1752 /* simple sanity check if this is really a file definition */
1753 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1754 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1755 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1757 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1758 config_list[i].token, config_list[i].value);
1759 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1762 file_list[list_pos].token = config_list[i].token;
1763 file_list[list_pos].default_filename = config_list[i].value;
1767 num_file_list_entries_found = list_pos + 1;
1768 if (num_file_list_entries_found != num_file_list_entries)
1770 Error(ERR_RETURN_LINE, "-");
1771 Error(ERR_RETURN, "inconsistant config list information:");
1772 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1773 num_file_list_entries);
1774 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1775 num_file_list_entries_found);
1776 Error(ERR_EXIT, "please fix");
1782 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1784 int len_token = strlen(token);
1785 int len_suffix = strlen(suffix);
1788 if (IS_PARENT_PROCESS())
1789 printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1792 if (start_pos < 0) /* compare suffix from end of string */
1793 start_pos += len_token;
1795 if (start_pos < 0 || start_pos + len_suffix > len_token)
1798 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1801 if (token[start_pos + len_suffix] == '\0')
1804 if (token[start_pos + len_suffix] == '.')
1810 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1812 static void read_token_parameters(SetupFileHash *setup_file_hash,
1813 struct ConfigInfo *suffix_list,
1814 struct FileInfo *file_list_entry)
1816 /* check for config token that is the base token without any suffixes */
1817 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1818 char *known_token_value = KNOWN_TOKEN_VALUE;
1821 if (filename != NULL)
1823 setString(&file_list_entry->filename, filename);
1825 /* when file definition found, set all parameters to default values */
1826 for (i = 0; suffix_list[i].token != NULL; i++)
1827 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1829 file_list_entry->redefined = TRUE;
1831 /* mark config file token as well known from default config */
1832 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1837 if (strcmp(file_list_entry->filename,
1838 file_list_entry->default_filename) != 0)
1839 printf("___ resetting '%s' to default\n", file_list_entry->token);
1841 setString(&file_list_entry->filename, file_list_entry->default_filename);
1845 /* check for config tokens that can be build by base token and suffixes */
1846 for (i = 0; suffix_list[i].token != NULL; i++)
1848 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1849 char *value = getHashEntry(setup_file_hash, token);
1853 setString(&file_list_entry->parameter[i], value);
1855 /* mark config file token as well known from default config */
1856 setHashEntry(setup_file_hash, token, known_token_value);
1863 static void add_dynamic_file_list_entry(struct FileInfo **list,
1864 int *num_list_entries,
1865 SetupFileHash *extra_file_hash,
1866 struct ConfigInfo *suffix_list,
1867 int num_suffix_list_entries,
1870 struct FileInfo *new_list_entry;
1871 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1874 if (IS_PARENT_PROCESS())
1875 printf("===> found dynamic definition '%s'\n", token);
1878 (*num_list_entries)++;
1879 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1880 new_list_entry = &(*list)[*num_list_entries - 1];
1882 new_list_entry->token = getStringCopy(token);
1883 new_list_entry->filename = NULL;
1884 new_list_entry->parameter = checked_calloc(parameter_array_size);
1886 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
1889 static void add_property_mapping(struct PropertyMapping **list,
1890 int *num_list_entries,
1891 int base_index, int ext1_index,
1892 int ext2_index, int ext3_index,
1895 struct PropertyMapping *new_list_entry;
1897 (*num_list_entries)++;
1898 *list = checked_realloc(*list,
1899 *num_list_entries * sizeof(struct PropertyMapping));
1900 new_list_entry = &(*list)[*num_list_entries - 1];
1902 new_list_entry->base_index = base_index;
1903 new_list_entry->ext1_index = ext1_index;
1904 new_list_entry->ext2_index = ext2_index;
1905 new_list_entry->ext3_index = ext3_index;
1907 new_list_entry->artwork_index = artwork_index;
1910 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
1913 struct FileInfo *file_list = artwork_info->file_list;
1914 struct ConfigInfo *suffix_list = artwork_info->suffix_list;
1915 char **base_prefixes = artwork_info->base_prefixes;
1916 char **ext1_suffixes = artwork_info->ext1_suffixes;
1917 char **ext2_suffixes = artwork_info->ext2_suffixes;
1918 char **ext3_suffixes = artwork_info->ext3_suffixes;
1919 char **ignore_tokens = artwork_info->ignore_tokens;
1920 int num_file_list_entries = artwork_info->num_file_list_entries;
1921 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1922 int num_base_prefixes = artwork_info->num_base_prefixes;
1923 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
1924 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
1925 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
1926 int num_ignore_tokens = artwork_info->num_ignore_tokens;
1927 SetupFileHash *setup_file_hash, *valid_file_hash;
1928 SetupFileHash *extra_file_hash, *empty_file_hash;
1929 char *known_token_value = KNOWN_TOKEN_VALUE;
1932 if (filename == NULL)
1936 printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename);
1939 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
1942 /* separate valid (defined) from empty (undefined) config token values */
1943 valid_file_hash = newSetupFileHash();
1944 empty_file_hash = newSetupFileHash();
1945 BEGIN_HASH_ITERATION(setup_file_hash, itr)
1947 char *value = HASH_ITERATION_VALUE(itr);
1949 setHashEntry(*value ? valid_file_hash : empty_file_hash,
1950 HASH_ITERATION_TOKEN(itr), value);
1952 END_HASH_ITERATION(setup_file_hash, itr)
1954 /* at this point, we do not need the setup file hash anymore -- free it */
1955 freeSetupFileHash(setup_file_hash);
1957 /* read parameters for all known config file tokens */
1958 for (i = 0; i < num_file_list_entries; i++)
1959 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
1961 /* set all tokens that can be ignored here to "known" keyword */
1962 for (i = 0; i < num_ignore_tokens; i++)
1963 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
1965 /* copy all unknown config file tokens to extra config hash */
1966 extra_file_hash = newSetupFileHash();
1967 BEGIN_HASH_ITERATION(valid_file_hash, itr)
1969 char *value = HASH_ITERATION_VALUE(itr);
1971 if (strcmp(value, known_token_value) != 0)
1972 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
1974 END_HASH_ITERATION(valid_file_hash, itr)
1976 /* at this point, we do not need the valid file hash anymore -- free it */
1977 freeSetupFileHash(valid_file_hash);
1979 /* now try to determine valid, dynamically defined config tokens */
1981 BEGIN_HASH_ITERATION(extra_file_hash, itr)
1983 struct FileInfo **dynamic_file_list =
1984 &artwork_info->dynamic_file_list;
1985 int *num_dynamic_file_list_entries =
1986 &artwork_info->num_dynamic_file_list_entries;
1987 struct PropertyMapping **property_mapping =
1988 &artwork_info->property_mapping;
1989 int *num_property_mapping_entries =
1990 &artwork_info->num_property_mapping_entries;
1991 int current_summarized_file_list_entry =
1992 artwork_info->num_file_list_entries +
1993 artwork_info->num_dynamic_file_list_entries;
1994 char *token = HASH_ITERATION_TOKEN(itr);
1995 int len_token = strlen(token);
1997 boolean base_prefix_found = FALSE;
1998 boolean parameter_suffix_found = FALSE;
2000 /* skip all parameter definitions (handled by read_token_parameters()) */
2001 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2003 int len_suffix = strlen(suffix_list[i].token);
2005 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2006 parameter_suffix_found = TRUE;
2010 if (IS_PARENT_PROCESS())
2012 if (parameter_suffix_found)
2013 printf("---> skipping token '%s' (parameter token)\n", token);
2015 printf("---> examining token '%s': search prefix ...\n", token);
2019 if (parameter_suffix_found)
2022 /* ---------- step 0: search for matching base prefix ---------- */
2025 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2027 char *base_prefix = base_prefixes[i];
2028 int len_base_prefix = strlen(base_prefix);
2029 boolean ext1_suffix_found = FALSE;
2030 boolean ext2_suffix_found = FALSE;
2031 boolean ext3_suffix_found = FALSE;
2032 boolean exact_match = FALSE;
2033 int base_index = -1;
2034 int ext1_index = -1;
2035 int ext2_index = -1;
2036 int ext3_index = -1;
2038 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2040 if (!base_prefix_found)
2045 if (start_pos + len_base_prefix == len_token) /* exact match */
2049 add_dynamic_file_list_entry(dynamic_file_list,
2050 num_dynamic_file_list_entries,
2053 num_suffix_list_entries,
2055 add_property_mapping(property_mapping,
2056 num_property_mapping_entries,
2057 base_index, -1, -1, -1,
2058 current_summarized_file_list_entry);
2063 if (IS_PARENT_PROCESS())
2064 printf("---> examining token '%s': search 1st suffix ...\n", token);
2067 /* ---------- step 1: search for matching first suffix ---------- */
2069 start_pos += len_base_prefix;
2070 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2072 char *ext1_suffix = ext1_suffixes[j];
2073 int len_ext1_suffix = strlen(ext1_suffix);
2075 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2077 if (!ext1_suffix_found)
2082 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2086 add_dynamic_file_list_entry(dynamic_file_list,
2087 num_dynamic_file_list_entries,
2090 num_suffix_list_entries,
2092 add_property_mapping(property_mapping,
2093 num_property_mapping_entries,
2094 base_index, ext1_index, -1, -1,
2095 current_summarized_file_list_entry);
2099 start_pos += len_ext1_suffix;
2106 if (IS_PARENT_PROCESS())
2107 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2110 /* ---------- step 2: search for matching second suffix ---------- */
2112 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2114 char *ext2_suffix = ext2_suffixes[k];
2115 int len_ext2_suffix = strlen(ext2_suffix);
2117 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2119 if (!ext2_suffix_found)
2124 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2128 add_dynamic_file_list_entry(dynamic_file_list,
2129 num_dynamic_file_list_entries,
2132 num_suffix_list_entries,
2134 add_property_mapping(property_mapping,
2135 num_property_mapping_entries,
2136 base_index, ext1_index, ext2_index, -1,
2137 current_summarized_file_list_entry);
2141 start_pos += len_ext2_suffix;
2148 if (IS_PARENT_PROCESS())
2149 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2152 /* ---------- step 3: search for matching third suffix ---------- */
2154 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2156 char *ext3_suffix = ext3_suffixes[l];
2157 int len_ext3_suffix = strlen(ext3_suffix);
2159 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2161 if (!ext3_suffix_found)
2166 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2170 add_dynamic_file_list_entry(dynamic_file_list,
2171 num_dynamic_file_list_entries,
2174 num_suffix_list_entries,
2176 add_property_mapping(property_mapping,
2177 num_property_mapping_entries,
2178 base_index, ext1_index, ext2_index, ext3_index,
2179 current_summarized_file_list_entry);
2185 END_HASH_ITERATION(extra_file_hash, itr)
2187 if (artwork_info->num_dynamic_file_list_entries > 0)
2189 artwork_info->dynamic_artwork_list =
2190 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2191 artwork_info->sizeof_artwork_list_entry);
2194 if (options.verbose && IS_PARENT_PROCESS())
2196 SetupFileList *setup_file_list, *list;
2197 boolean dynamic_tokens_found = FALSE;
2198 boolean unknown_tokens_found = FALSE;
2199 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2201 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2202 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2204 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2206 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2207 dynamic_tokens_found = TRUE;
2209 unknown_tokens_found = TRUE;
2211 END_HASH_ITERATION(extra_file_hash, itr)
2213 if (options.debug && dynamic_tokens_found)
2215 Error(ERR_RETURN_LINE, "-");
2216 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2217 Error(ERR_RETURN, "- config file: '%s'", filename);
2219 for (list = setup_file_list; list != NULL; list = list->next)
2221 char *value = getHashEntry(extra_file_hash, list->token);
2223 if (value != NULL && strcmp(value, known_token_value) == 0)
2224 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2227 Error(ERR_RETURN_LINE, "-");
2230 if (unknown_tokens_found)
2232 Error(ERR_RETURN_LINE, "-");
2233 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2234 Error(ERR_RETURN, "- config file: '%s'", filename);
2236 for (list = setup_file_list; list != NULL; list = list->next)
2238 char *value = getHashEntry(extra_file_hash, list->token);
2240 if (value != NULL && strcmp(value, known_token_value) != 0)
2241 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2244 Error(ERR_RETURN_LINE, "-");
2247 if (undefined_values_found)
2249 Error(ERR_RETURN_LINE, "-");
2250 Error(ERR_RETURN, "warning: undefined values found in config file:");
2251 Error(ERR_RETURN, "- config file: '%s'", filename);
2253 for (list = setup_file_list; list != NULL; list = list->next)
2255 char *value = getHashEntry(empty_file_hash, list->token);
2258 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2261 Error(ERR_RETURN_LINE, "-");
2264 freeSetupFileList(setup_file_list);
2267 freeSetupFileHash(extra_file_hash);
2268 freeSetupFileHash(empty_file_hash);
2271 for (i = 0; i < num_file_list_entries; i++)
2273 printf("'%s' ", file_list[i].token);
2274 if (file_list[i].filename)
2275 printf("-> '%s'\n", file_list[i].filename);
2277 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2282 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2284 struct FileInfo *file_list = artwork_info->file_list;
2285 int num_file_list_entries = artwork_info->num_file_list_entries;
2286 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2287 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2291 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2294 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2295 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2297 /* always start with reliable default values */
2298 for (i = 0; i < num_file_list_entries; i++)
2300 setString(&file_list[i].filename, file_list[i].default_filename);
2302 for (j = 0; j < num_suffix_list_entries; j++)
2303 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2305 file_list[i].redefined = FALSE;
2308 /* free previous dynamic artwork file array */
2309 if (artwork_info->dynamic_file_list != NULL)
2311 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2313 free(artwork_info->dynamic_file_list[i].token);
2314 free(artwork_info->dynamic_file_list[i].filename);
2315 free(artwork_info->dynamic_file_list[i].parameter);
2318 free(artwork_info->dynamic_file_list);
2319 artwork_info->dynamic_file_list = NULL;
2321 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2322 &artwork_info->num_dynamic_file_list_entries);
2325 /* free previous property mapping */
2326 if (artwork_info->property_mapping != NULL)
2328 free(artwork_info->property_mapping);
2330 artwork_info->property_mapping = NULL;
2331 artwork_info->num_property_mapping_entries = 0;
2334 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2336 /* first look for special artwork configured in level series config */
2337 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2339 if (fileExists(filename_base))
2340 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2343 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2345 if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2346 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2349 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2350 struct ListNodeInfo **listnode)
2354 char *filename = (*listnode)->source_filename;
2357 printf("[decrementing reference counter of artwork '%s']\n", filename);
2360 if (--(*listnode)->num_references <= 0)
2363 printf("[deleting artwork '%s']\n", filename);
2366 deleteNodeFromList(&artwork_info->content_list, filename,
2367 artwork_info->free_artwork);
2374 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2375 struct ListNodeInfo **listnode,
2380 "Loading graphics:",
2386 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2388 if (filename == NULL)
2390 int error_mode = ERR_WARN;
2393 /* we can get away without sounds and music, but not without graphics */
2394 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2395 error_mode = ERR_EXIT;
2398 Error(error_mode, "cannot find artwork file '%s'", basename);
2402 /* check if the old and the new artwork file are the same */
2403 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2405 /* The old and new artwork are the same (have the same filename and path).
2406 This usually means that this artwork does not exist in this artwork set
2407 and a fallback to the existing artwork is done. */
2410 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2416 /* delete existing artwork file entry */
2417 deleteArtworkListEntry(artwork_info, listnode);
2419 /* check if the new artwork file already exists in the list of artworks */
2420 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2423 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2426 *listnode = (struct ListNodeInfo *)node->content;
2427 (*listnode)->num_references++;
2433 printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2436 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2437 DrawInitText(basename, 150, FC_YELLOW);
2439 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2442 printf("[adding new artwork '%s']\n", filename);
2445 (*listnode)->num_references = 1;
2446 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2451 int error_mode = ERR_WARN;
2454 /* we can get away without sounds and music, but not without graphics */
2455 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2456 error_mode = ERR_EXIT;
2459 Error(error_mode, "cannot load artwork file '%s'", basename);
2464 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2465 struct ListNodeInfo **listnode,
2469 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2472 if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2474 deleteArtworkListEntry(artwork_info, listnode);
2478 replaceArtworkListEntry(artwork_info, listnode, basename);
2481 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2482 struct ListNodeInfo **listnode,
2483 char *basename, int list_pos)
2486 if (artwork_info->artwork_list == NULL ||
2487 list_pos >= artwork_info->num_file_list_entries)
2492 printf("loading artwork '%s' ... [%d]\n",
2493 basename, getNumNodes(artwork_info->content_list));
2497 LoadCustomArtwork(artwork_info, listnode, basename);
2499 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2504 printf("loading artwork '%s' done [%d]\n",
2505 basename, getNumNodes(artwork_info->content_list));
2509 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2511 struct FileInfo *file_list = artwork_info->file_list;
2512 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2513 int num_file_list_entries = artwork_info->num_file_list_entries;
2514 int num_dynamic_file_list_entries =
2515 artwork_info->num_dynamic_file_list_entries;
2519 printf("DEBUG: reloading %d static artwork files ...\n",
2520 num_file_list_entries);
2523 for (i = 0; i < num_file_list_entries; i++)
2526 if (strcmp(file_list[i].token, "background") == 0)
2527 printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename);
2530 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2531 file_list[i].filename, i);
2534 if (artwork_info->artwork_list[i] == NULL &&
2535 strcmp(file_list[i].default_filename, file_list[i].filename) != 0)
2537 Error(ERR_WARN, "trying default artwork file '%s'",
2538 file_list[i].default_filename);
2540 LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2541 file_list[i].default_filename, i);
2547 printf("DEBUG: reloading %d dynamic artwork files ...\n",
2548 num_dynamic_file_list_entries);
2551 for (i = 0; i < num_dynamic_file_list_entries; i++)
2552 LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2553 dynamic_file_list[i].filename, i);
2556 dumpList(artwork_info->content_list);
2560 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2561 struct ListNodeInfo ***list,
2562 int *num_list_entries)
2569 for (i = 0; i < *num_list_entries; i++)
2570 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2574 *num_list_entries = 0;
2577 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2579 if (artwork_info == NULL)
2583 printf("%s: FREEING ARTWORK ...\n",
2584 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2587 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2588 &artwork_info->num_file_list_entries);
2590 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2591 &artwork_info->num_dynamic_file_list_entries);
2594 printf("%s: FREEING ARTWORK -- DONE\n",
2595 IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2600 /* ------------------------------------------------------------------------- */
2601 /* functions only needed for non-Unix (non-command-line) systems */
2602 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2603 /* ------------------------------------------------------------------------- */
2605 #if defined(PLATFORM_MSDOS)
2607 #define ERROR_FILENAME "stderr.txt"
2609 void initErrorFile()
2611 unlink(ERROR_FILENAME);
2614 FILE *openErrorFile()
2616 return fopen(ERROR_FILENAME, MODE_APPEND);
2619 void dumpErrorFile()
2621 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2623 if (error_file != NULL)
2625 while (!feof(error_file))
2626 fputc(fgetc(error_file), stderr);
2634 /* ------------------------------------------------------------------------- */
2635 /* the following is only for debugging purpose and normally not used */
2636 /* ------------------------------------------------------------------------- */
2638 #define DEBUG_NUM_TIMESTAMPS 3
2640 void debug_print_timestamp(int counter_nr, char *message)
2642 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2644 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2645 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2647 counter[counter_nr][0] = Counter();
2650 printf("%s %.2f seconds\n", message,
2651 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2653 counter[counter_nr][1] = Counter();
2656 void debug_print_parent_only(char *format, ...)
2658 if (!IS_PARENT_PROCESS())
2665 va_start(ap, format);
2666 vprintf(format, ap);