1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 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 /* ------------------------------------------------------------------------- */
41 /* platform independent wrappers for printf() et al. (newline aware) */
42 /* ------------------------------------------------------------------------- */
44 static void vfprintf_newline(FILE *stream, char *format, va_list ap)
46 char *newline = STRING_NEWLINE;
48 vfprintf(stream, format, ap);
50 fprintf(stream, "%s", newline);
53 static void fprintf_newline(FILE *stream, char *format, ...)
60 vfprintf_newline(stream, format, ap);
65 void fprintf_line(FILE *stream, char *line_chars, int line_length)
69 for (i = 0; i < line_length; i++)
70 fprintf(stream, "%s", line_chars);
72 fprintf_newline(stream, "");
75 void printf_line(char *line_chars, int line_length)
77 fprintf_line(stdout, line_chars, line_length);
80 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
82 fprintf(stdout, "%s", prefix);
83 fprintf_line(stdout, line_chars, line_length);
87 /* ------------------------------------------------------------------------- */
88 /* string functions */
89 /* ------------------------------------------------------------------------- */
91 /* int2str() returns a number converted to a string;
92 the used memory is static, but will be overwritten by later calls,
93 so if you want to save the result, copy it to a private string buffer;
94 there can be 10 local calls of int2str() without buffering the result --
95 the 11th call will then destroy the result from the first call and so on.
98 char *int2str(int number, int size)
100 static char shift_array[10][40];
101 static int shift_counter = 0;
102 char *s = shift_array[shift_counter];
104 shift_counter = (shift_counter + 1) % 10;
111 sprintf(s, " %09d", number);
112 return &s[strlen(s) - size];
116 sprintf(s, "%d", number);
122 /* something similar to "int2str()" above, but allocates its own memory
123 and has a different interface; we cannot use "itoa()", because this
124 seems to be already defined when cross-compiling to the win32 target */
126 char *i_to_a(unsigned int i)
128 static char *a = NULL;
132 if (i > 2147483647) /* yes, this is a kludge */
135 a = checked_malloc(10 + 1);
143 /* calculate base-2 logarithm of argument (rounded down to integer;
144 this function returns the number of the highest bit set in argument) */
146 int log_2(unsigned int x)
152 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
159 boolean getTokenValueFromString(char *string, char **token, char **value)
161 return getTokenValueFromSetupLine(string, token, value);
165 /* ------------------------------------------------------------------------- */
166 /* counter functions */
167 /* ------------------------------------------------------------------------- */
169 #if defined(PLATFORM_MSDOS)
170 volatile unsigned long counter = 0;
172 void increment_counter()
177 END_OF_FUNCTION(increment_counter);
181 /* maximal allowed length of a command line option */
182 #define MAX_OPTION_LEN 256
185 static unsigned long mainCounter(int mode)
187 static unsigned long base_ms = 0;
188 unsigned long current_ms;
189 unsigned long counter_ms;
191 current_ms = SDL_GetTicks();
193 /* reset base time in case of counter initializing or wrap-around */
194 if (mode == INIT_COUNTER || current_ms < base_ms)
195 base_ms = current_ms;
197 counter_ms = current_ms - base_ms;
199 return counter_ms; /* return milliseconds since last init */
202 #else /* !TARGET_SDL */
204 #if defined(PLATFORM_UNIX)
205 static unsigned long mainCounter(int mode)
207 static struct timeval base_time = { 0, 0 };
208 struct timeval current_time;
209 unsigned long counter_ms;
211 gettimeofday(¤t_time, NULL);
213 /* reset base time in case of counter initializing or wrap-around */
214 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
215 base_time = current_time;
217 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
218 + (current_time.tv_usec - base_time.tv_usec) / 1000;
220 return counter_ms; /* return milliseconds since last init */
222 #endif /* PLATFORM_UNIX */
223 #endif /* !TARGET_SDL */
225 void InitCounter() /* set counter back to zero */
227 #if !defined(PLATFORM_MSDOS)
228 mainCounter(INIT_COUNTER);
230 LOCK_VARIABLE(counter);
231 LOCK_FUNCTION(increment_counter);
232 install_int_ex(increment_counter, BPS_TO_TIMER(100));
236 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
238 #if !defined(PLATFORM_MSDOS)
239 return mainCounter(READ_COUNTER);
241 return (counter * 10);
245 static void sleep_milliseconds(unsigned long milliseconds_delay)
247 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
251 /* we want to wait only a few ms -- if we assume that we have a
252 kernel timer resolution of 10 ms, we would wait far to long;
253 therefore it's better to do a short interval of busy waiting
254 to get our sleeping time more accurate */
256 unsigned long base_counter = Counter(), actual_counter = Counter();
258 while (actual_counter < base_counter + milliseconds_delay &&
259 actual_counter >= base_counter)
260 actual_counter = Counter();
264 #if defined(TARGET_SDL)
265 SDL_Delay(milliseconds_delay);
266 #elif defined(TARGET_ALLEGRO)
267 rest(milliseconds_delay);
269 struct timeval delay;
271 delay.tv_sec = milliseconds_delay / 1000;
272 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
274 if (select(0, NULL, NULL, NULL, &delay) != 0)
275 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
280 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
282 sleep_milliseconds(delay);
285 boolean FrameReached(unsigned long *frame_counter_var,
286 unsigned long frame_delay)
288 unsigned long actual_frame_counter = FrameCounter;
290 if (actual_frame_counter >= *frame_counter_var &&
291 actual_frame_counter < *frame_counter_var + frame_delay)
294 *frame_counter_var = actual_frame_counter;
299 boolean DelayReached(unsigned long *counter_var,
302 unsigned long actual_counter = Counter();
304 if (actual_counter >= *counter_var &&
305 actual_counter < *counter_var + delay)
308 *counter_var = actual_counter;
313 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
315 unsigned long actual_counter;
319 actual_counter = Counter();
321 if (actual_counter >= *counter_var &&
322 actual_counter < *counter_var + delay)
323 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
328 *counter_var = actual_counter;
332 /* ------------------------------------------------------------------------- */
333 /* random generator functions */
334 /* ------------------------------------------------------------------------- */
336 unsigned int init_random_number(int nr, long seed)
338 if (seed == NEW_RANDOMIZE)
340 #if defined(TARGET_SDL)
341 seed = (long)SDL_GetTicks();
343 struct timeval current_time;
345 gettimeofday(¤t_time, NULL);
346 seed = (long)current_time.tv_usec;
350 srandom_linux_libc(nr, (unsigned int) seed);
352 return (unsigned int) seed;
355 unsigned int get_random_number(int nr, int max)
357 return (max > 0 ? random_linux_libc(nr) % max : 0);
361 /* ------------------------------------------------------------------------- */
362 /* system info functions */
363 /* ------------------------------------------------------------------------- */
365 #if !defined(PLATFORM_MSDOS)
366 static char *get_corrected_real_name(char *real_name)
368 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
369 char *from_ptr = real_name;
370 char *to_ptr = real_name_new;
372 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
373 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
375 /* the name field read from "passwd" file may also contain additional
376 user information, separated by commas, which will be removed here */
377 if (*from_ptr == ',')
380 /* the user's real name may contain 'ß' characters (german sharp s),
381 which have no equivalent in upper case letters (used by our fonts) */
382 if (*from_ptr == 'ß')
389 *to_ptr++ = *from_ptr++;
394 return real_name_new;
400 static char *login_name = NULL;
402 #if defined(PLATFORM_WIN32)
403 if (login_name == NULL)
405 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
406 login_name = checked_malloc(buffer_size);
408 if (GetUserName(login_name, &buffer_size) == 0)
409 strcpy(login_name, ANONYMOUS_NAME);
412 if (login_name == NULL)
416 if ((pwd = getpwuid(getuid())) == NULL)
417 login_name = ANONYMOUS_NAME;
419 login_name = getStringCopy(pwd->pw_name);
428 static char *real_name = NULL;
430 #if defined(PLATFORM_WIN32)
431 if (real_name == NULL)
433 static char buffer[MAX_USERNAME_LEN + 1];
434 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
436 if (GetUserName(buffer, &buffer_size) != 0)
437 real_name = get_corrected_real_name(buffer);
439 real_name = ANONYMOUS_NAME;
441 #elif defined(PLATFORM_UNIX)
442 if (real_name == NULL)
446 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
447 real_name = get_corrected_real_name(pwd->pw_gecos);
449 real_name = ANONYMOUS_NAME;
452 real_name = ANONYMOUS_NAME;
459 /* ------------------------------------------------------------------------- */
460 /* path manipulation functions */
461 /* ------------------------------------------------------------------------- */
463 static char *getLastPathSeparatorPtr(char *filename)
465 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
467 if (last_separator == NULL) /* also try DOS/Windows variant */
468 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
470 return last_separator;
473 char *getBaseNamePtr(char *filename)
475 char *last_separator = getLastPathSeparatorPtr(filename);
477 if (last_separator != NULL)
478 return last_separator + 1; /* separator found: strip base path */
480 return filename; /* no separator found: filename has no path */
483 char *getBaseName(char *filename)
485 return getStringCopy(getBaseNamePtr(filename));
488 char *getBasePath(char *filename)
490 char *basepath = getStringCopy(filename);
491 char *last_separator = getLastPathSeparatorPtr(basepath);
493 if (last_separator != NULL)
494 *last_separator = '\0'; /* separator found: strip basename */
496 basepath = "."; /* no separator found: use current path */
502 /* ------------------------------------------------------------------------- */
503 /* various string functions */
504 /* ------------------------------------------------------------------------- */
506 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
508 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
511 sprintf(complete_string, "%s%s%s", s1, sep, s2);
513 return complete_string;
516 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
518 char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
519 strlen(s2) + strlen(sep) +
522 sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
524 return complete_string;
527 char *getStringCat2(char *s1, char *s2)
529 return getStringCat2WithSeparator(s1, s2, "");
532 char *getStringCat3(char *s1, char *s2, char *s3)
534 return getStringCat3WithSeparator(s1, s2, s3, "");
537 char *getPath2(char *path1, char *path2)
539 return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
542 char *getPath3(char *path1, char *path2, char *path3)
544 return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
547 char *getStringCopy(char *s)
554 s_copy = checked_malloc(strlen(s) + 1);
560 char *getStringCopyN(char *s, int n)
563 int s_len = MAX(0, n);
568 s_copy = checked_malloc(s_len + 1);
569 strncpy(s_copy, s, s_len);
570 s_copy[s_len] = '\0';
575 char *getStringToLower(char *s)
577 char *s_copy = checked_malloc(strlen(s) + 1);
578 char *s_ptr = s_copy;
581 *s_ptr++ = tolower(*s++);
587 void setString(char **old_value, char *new_value)
589 checked_free(*old_value);
591 *old_value = getStringCopy(new_value);
594 boolean strEqual(char *s1, char *s2)
596 return (s1 == NULL && s2 == NULL ? TRUE :
597 s1 == NULL && s2 != NULL ? FALSE :
598 s1 != NULL && s2 == NULL ? FALSE :
599 strcmp(s1, s2) == 0);
602 boolean strEqualN(char *s1, char *s2, int n)
604 return (s1 == NULL && s2 == NULL ? TRUE :
605 s1 == NULL && s2 != NULL ? FALSE :
606 s1 != NULL && s2 == NULL ? FALSE :
607 strncmp(s1, s2, n) == 0);
610 boolean strPrefix(char *s, char *prefix)
612 return (s == NULL && prefix == NULL ? TRUE :
613 s == NULL && prefix != NULL ? FALSE :
614 s != NULL && prefix == NULL ? FALSE :
615 strncmp(s, prefix, strlen(prefix)) == 0);
618 boolean strSuffix(char *s, char *suffix)
620 return (s == NULL && suffix == NULL ? TRUE :
621 s == NULL && suffix != NULL ? FALSE :
622 s != NULL && suffix == NULL ? FALSE :
623 strlen(s) < strlen(suffix) ? FALSE :
624 strncmp(&s[strlen(s) - strlen(suffix)], suffix, strlen(suffix)) == 0);
628 /* ------------------------------------------------------------------------- */
629 /* command line option handling functions */
630 /* ------------------------------------------------------------------------- */
632 void GetOptions(char *argv[], void (*print_usage_function)(void))
634 char *ro_base_path = RO_BASE_PATH;
635 char *rw_base_path = RW_BASE_PATH;
636 char **options_left = &argv[1];
638 #if !defined(PLATFORM_MACOSX)
639 /* if the program is configured to start from current directory (default),
640 determine program package directory (KDE/Konqueror does not do this by
641 itself and fails otherwise); on Mac OS X, the program binary is stored
642 in an application package directory -- do not try to use this directory
643 as the program data directory (Mac OS X handles this correctly anyway) */
645 if (strEqual(ro_base_path, "."))
646 ro_base_path = program.command_basepath;
647 if (strEqual(rw_base_path, "."))
648 rw_base_path = program.command_basepath;
651 /* initialize global program options */
652 options.display_name = NULL;
653 options.server_host = NULL;
654 options.server_port = 0;
655 options.ro_base_directory = ro_base_path;
656 options.rw_base_directory = rw_base_path;
657 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
658 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
659 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
660 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
661 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
662 options.execute_command = NULL;
663 options.serveronly = FALSE;
664 options.network = FALSE;
665 options.verbose = FALSE;
666 options.debug = FALSE;
667 options.debug_x11_sync = FALSE;
669 #if !defined(PLATFORM_UNIX)
670 if (*options_left == NULL) /* no options given -- enable verbose mode */
671 options.verbose = TRUE;
674 while (*options_left)
676 char option_str[MAX_OPTION_LEN];
677 char *option = options_left[0];
678 char *next_option = options_left[1];
679 char *option_arg = NULL;
680 int option_len = strlen(option);
682 if (option_len >= MAX_OPTION_LEN)
683 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
685 strcpy(option_str, option); /* copy argument into buffer */
688 if (strEqual(option, "--")) /* stop scanning arguments */
691 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
694 option_arg = strchr(option, '=');
695 if (option_arg == NULL) /* no '=' in option */
696 option_arg = next_option;
699 *option_arg++ = '\0'; /* cut argument from option */
700 if (*option_arg == '\0') /* no argument after '=' */
701 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
704 option_len = strlen(option);
706 if (strEqual(option, "-"))
707 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
708 else if (strncmp(option, "-help", option_len) == 0)
710 print_usage_function();
714 else if (strncmp(option, "-display", option_len) == 0)
716 if (option_arg == NULL)
717 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
719 options.display_name = option_arg;
720 if (option_arg == next_option)
723 else if (strncmp(option, "-basepath", option_len) == 0)
725 if (option_arg == NULL)
726 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
728 /* this should be extended to separate options for ro and rw data */
729 options.ro_base_directory = ro_base_path = option_arg;
730 options.rw_base_directory = rw_base_path = option_arg;
731 if (option_arg == next_option)
734 /* adjust paths for sub-directories in base directory accordingly */
735 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
736 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
737 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
738 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
739 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
741 else if (strncmp(option, "-levels", option_len) == 0)
743 if (option_arg == NULL)
744 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
746 options.level_directory = option_arg;
747 if (option_arg == next_option)
750 else if (strncmp(option, "-graphics", option_len) == 0)
752 if (option_arg == NULL)
753 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
755 options.graphics_directory = option_arg;
756 if (option_arg == next_option)
759 else if (strncmp(option, "-sounds", option_len) == 0)
761 if (option_arg == NULL)
762 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
764 options.sounds_directory = option_arg;
765 if (option_arg == next_option)
768 else if (strncmp(option, "-music", option_len) == 0)
770 if (option_arg == NULL)
771 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
773 options.music_directory = option_arg;
774 if (option_arg == next_option)
777 else if (strncmp(option, "-network", option_len) == 0)
779 options.network = TRUE;
781 else if (strncmp(option, "-serveronly", option_len) == 0)
783 options.serveronly = TRUE;
785 else if (strncmp(option, "-verbose", option_len) == 0)
787 options.verbose = TRUE;
789 else if (strncmp(option, "-debug", option_len) == 0)
791 options.debug = TRUE;
793 else if (strncmp(option, "-debug-x11-sync", option_len) == 0)
795 options.debug_x11_sync = TRUE;
797 else if (strncmp(option, "-execute", option_len) == 0)
799 if (option_arg == NULL)
800 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
802 options.execute_command = option_arg;
803 if (option_arg == next_option)
806 /* when doing batch processing, always enable verbose mode (warnings) */
807 options.verbose = TRUE;
809 else if (*option == '-')
811 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
813 else if (options.server_host == NULL)
815 options.server_host = *options_left;
817 else if (options.server_port == 0)
819 options.server_port = atoi(*options_left);
820 if (options.server_port < 1024)
821 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
824 Error(ERR_EXIT_HELP, "too many arguments");
831 /* ------------------------------------------------------------------------- */
832 /* error handling functions */
833 /* ------------------------------------------------------------------------- */
835 /* used by SetError() and GetError() to store internal error messages */
836 static char internal_error[1024]; /* this is bad */
838 void SetError(char *format, ...)
842 va_start(ap, format);
843 vsprintf(internal_error, format, ap);
849 return internal_error;
852 void Error(int mode, char *format, ...)
854 static boolean last_line_was_separator = FALSE;
855 char *process_name = "";
857 /* display warnings only when running in verbose mode */
858 if (mode & ERR_WARN && !options.verbose)
861 if (mode == ERR_INFO_LINE)
863 if (!last_line_was_separator)
864 fprintf_line(program.error_file, format, 79);
866 last_line_was_separator = TRUE;
871 last_line_was_separator = FALSE;
873 if (mode & ERR_SOUND_SERVER)
874 process_name = " sound server";
875 else if (mode & ERR_NETWORK_SERVER)
876 process_name = " network server";
877 else if (mode & ERR_NETWORK_CLIENT)
878 process_name = " network client **";
884 fprintf(program.error_file, "%s%s: ", program.command_basename,
888 fprintf(program.error_file, "warning: ");
890 va_start(ap, format);
891 vfprintf_newline(program.error_file, format, ap);
896 fprintf_newline(program.error_file,
897 "%s: Try option '--help' for more information.",
898 program.command_basename);
901 fprintf_newline(program.error_file, "%s%s: aborting",
902 program.command_basename, process_name);
906 if (mode & ERR_FROM_SERVER)
907 exit(1); /* child process: normal exit */
909 program.exit_function(1); /* main process: clean up stuff */
914 /* ------------------------------------------------------------------------- */
915 /* checked memory allocation and freeing functions */
916 /* ------------------------------------------------------------------------- */
918 void *checked_malloc(unsigned long size)
925 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
930 void *checked_calloc(unsigned long size)
934 ptr = calloc(1, size);
937 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
942 void *checked_realloc(void *ptr, unsigned long size)
944 ptr = realloc(ptr, size);
947 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
952 void checked_free(void *ptr)
954 if (ptr != NULL) /* this check should be done by free() anyway */
958 void clear_mem(void *ptr, unsigned long size)
960 #if defined(PLATFORM_WIN32)
961 /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
962 char *cptr = (char *)ptr;
967 memset(ptr, 0, size);
972 /* ------------------------------------------------------------------------- */
973 /* various helper functions */
974 /* ------------------------------------------------------------------------- */
976 inline void swap_numbers(int *i1, int *i2)
984 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
996 /* the "put" variants of the following file access functions check for the file
997 pointer being != NULL and return the number of bytes they have or would have
998 written; this allows for chunk writing functions to first determine the size
999 of the (not yet written) chunk, write the correct chunk size and finally
1000 write the chunk itself */
1002 int getFile8BitInteger(FILE *file)
1007 int putFile8BitInteger(FILE *file, int value)
1015 int getFile16BitInteger(FILE *file, int byte_order)
1017 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1018 return ((fgetc(file) << 8) |
1019 (fgetc(file) << 0));
1020 else /* BYTE_ORDER_LITTLE_ENDIAN */
1021 return ((fgetc(file) << 0) |
1022 (fgetc(file) << 8));
1025 int putFile16BitInteger(FILE *file, int value, int byte_order)
1029 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1031 fputc((value >> 8) & 0xff, file);
1032 fputc((value >> 0) & 0xff, file);
1034 else /* BYTE_ORDER_LITTLE_ENDIAN */
1036 fputc((value >> 0) & 0xff, file);
1037 fputc((value >> 8) & 0xff, file);
1044 int getFile32BitInteger(FILE *file, int byte_order)
1046 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1047 return ((fgetc(file) << 24) |
1048 (fgetc(file) << 16) |
1049 (fgetc(file) << 8) |
1050 (fgetc(file) << 0));
1051 else /* BYTE_ORDER_LITTLE_ENDIAN */
1052 return ((fgetc(file) << 0) |
1053 (fgetc(file) << 8) |
1054 (fgetc(file) << 16) |
1055 (fgetc(file) << 24));
1058 int putFile32BitInteger(FILE *file, int value, int byte_order)
1062 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1064 fputc((value >> 24) & 0xff, file);
1065 fputc((value >> 16) & 0xff, file);
1066 fputc((value >> 8) & 0xff, file);
1067 fputc((value >> 0) & 0xff, file);
1069 else /* BYTE_ORDER_LITTLE_ENDIAN */
1071 fputc((value >> 0) & 0xff, file);
1072 fputc((value >> 8) & 0xff, file);
1073 fputc((value >> 16) & 0xff, file);
1074 fputc((value >> 24) & 0xff, file);
1081 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1084 const int chunk_name_length = 4;
1086 /* read chunk name */
1087 fgets(chunk_name, chunk_name_length + 1, file);
1089 if (chunk_size != NULL)
1091 /* read chunk size */
1092 *chunk_size = getFile32BitInteger(file, byte_order);
1095 return (feof(file) || ferror(file) ? FALSE : TRUE);
1098 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1103 /* write chunk name */
1105 fputs(chunk_name, file);
1107 num_bytes += strlen(chunk_name);
1109 if (chunk_size >= 0)
1111 /* write chunk size */
1113 putFile32BitInteger(file, chunk_size, byte_order);
1121 int getFileVersion(FILE *file)
1123 int version_major = fgetc(file);
1124 int version_minor = fgetc(file);
1125 int version_patch = fgetc(file);
1126 int version_build = fgetc(file);
1128 return VERSION_IDENT(version_major, version_minor, version_patch,
1132 int putFileVersion(FILE *file, int version)
1136 int version_major = VERSION_MAJOR(version);
1137 int version_minor = VERSION_MINOR(version);
1138 int version_patch = VERSION_PATCH(version);
1139 int version_build = VERSION_BUILD(version);
1141 fputc(version_major, file);
1142 fputc(version_minor, file);
1143 fputc(version_patch, file);
1144 fputc(version_build, file);
1150 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1154 for(i = 0; i < bytes && !feof(file); i++)
1155 buffer[i] = fgetc(file);
1158 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1162 for(i = 0; i < bytes; i++)
1163 fputc(buffer[i], file);
1166 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1168 while (bytes-- && !feof(file))
1172 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1179 /* ------------------------------------------------------------------------- */
1180 /* functions to translate key identifiers between different format */
1181 /* ------------------------------------------------------------------------- */
1183 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1184 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1185 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1186 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1188 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1197 /* normal cursor keys */
1198 { KSYM_Left, "XK_Left", "cursor left" },
1199 { KSYM_Right, "XK_Right", "cursor right" },
1200 { KSYM_Up, "XK_Up", "cursor up" },
1201 { KSYM_Down, "XK_Down", "cursor down" },
1203 /* keypad cursor keys */
1205 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1206 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1207 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1208 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1211 /* other keypad keys */
1212 #ifdef KSYM_KP_Enter
1213 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1214 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1215 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1216 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1217 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1218 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1222 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1223 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1224 { KSYM_Control_L, "XK_Control_L", "left control" },
1225 { KSYM_Control_R, "XK_Control_R", "right control" },
1226 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1227 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1228 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1229 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1230 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1231 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1232 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1233 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1235 /* some special keys */
1236 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1237 { KSYM_Delete, "XK_Delete", "delete" },
1238 { KSYM_Insert, "XK_Insert", "insert" },
1239 { KSYM_Tab, "XK_Tab", "tab" },
1240 { KSYM_Home, "XK_Home", "home" },
1241 { KSYM_End, "XK_End", "end" },
1242 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1243 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1244 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1246 /* ASCII 0x20 to 0x40 keys (except numbers) */
1247 { KSYM_space, "XK_space", "space" },
1248 { KSYM_exclam, "XK_exclam", "!" },
1249 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1250 { KSYM_numbersign, "XK_numbersign", "#" },
1251 { KSYM_dollar, "XK_dollar", "$" },
1252 { KSYM_percent, "XK_percent", "%" },
1253 { KSYM_ampersand, "XK_ampersand", "&" },
1254 { KSYM_apostrophe, "XK_apostrophe", "'" },
1255 { KSYM_parenleft, "XK_parenleft", "(" },
1256 { KSYM_parenright, "XK_parenright", ")" },
1257 { KSYM_asterisk, "XK_asterisk", "*" },
1258 { KSYM_plus, "XK_plus", "+" },
1259 { KSYM_comma, "XK_comma", "," },
1260 { KSYM_minus, "XK_minus", "-" },
1261 { KSYM_period, "XK_period", "." },
1262 { KSYM_slash, "XK_slash", "/" },
1263 { KSYM_colon, "XK_colon", ":" },
1264 { KSYM_semicolon, "XK_semicolon", ";" },
1265 { KSYM_less, "XK_less", "<" },
1266 { KSYM_equal, "XK_equal", "=" },
1267 { KSYM_greater, "XK_greater", ">" },
1268 { KSYM_question, "XK_question", "?" },
1269 { KSYM_at, "XK_at", "@" },
1271 /* more ASCII keys */
1272 { KSYM_bracketleft, "XK_bracketleft", "[" },
1273 { KSYM_backslash, "XK_backslash", "\\" },
1274 { KSYM_bracketright,"XK_bracketright", "]" },
1275 { KSYM_asciicircum, "XK_asciicircum", "^" },
1276 { KSYM_underscore, "XK_underscore", "_" },
1277 { KSYM_grave, "XK_grave", "grave" },
1278 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1279 { KSYM_braceleft, "XK_braceleft", "brace left" },
1280 { KSYM_bar, "XK_bar", "bar" },
1281 { KSYM_braceright, "XK_braceright", "brace right" },
1282 { KSYM_asciitilde, "XK_asciitilde", "~" },
1284 /* special (non-ASCII) keys */
1285 { KSYM_degree, "XK_degree", "°" },
1286 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1287 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1288 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1289 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1290 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1291 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1292 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1294 /* end-of-array identifier */
1300 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1302 static char name_buffer[30];
1305 if (key >= KSYM_A && key <= KSYM_Z)
1306 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1307 else if (key >= KSYM_a && key <= KSYM_z)
1308 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1309 else if (key >= KSYM_0 && key <= KSYM_9)
1310 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1311 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1312 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1313 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1314 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1315 else if (key == KSYM_UNDEFINED)
1316 strcpy(name_buffer, "(undefined)");
1323 if (key == translate_key[i].key)
1325 strcpy(name_buffer, translate_key[i].name);
1329 while (translate_key[++i].name);
1331 if (!translate_key[i].name)
1332 strcpy(name_buffer, "(unknown)");
1335 *name = name_buffer;
1337 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1339 static char name_buffer[30];
1342 if (key >= KSYM_A && key <= KSYM_Z)
1343 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1344 else if (key >= KSYM_a && key <= KSYM_z)
1345 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1346 else if (key >= KSYM_0 && key <= KSYM_9)
1347 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1348 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1349 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1350 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1351 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1352 else if (key == KSYM_UNDEFINED)
1353 strcpy(name_buffer, "[undefined]");
1360 if (key == translate_key[i].key)
1362 strcpy(name_buffer, translate_key[i].x11name);
1366 while (translate_key[++i].x11name);
1368 if (!translate_key[i].x11name)
1369 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1372 *x11name = name_buffer;
1374 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1376 Key key = KSYM_UNDEFINED;
1381 if (strEqual(translate_key[i].name, *name))
1383 key = translate_key[i].key;
1387 while (translate_key[++i].x11name);
1389 if (key == KSYM_UNDEFINED)
1390 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1394 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1396 Key key = KSYM_UNDEFINED;
1397 char *name_ptr = *x11name;
1399 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1401 char c = name_ptr[3];
1403 if (c >= 'A' && c <= 'Z')
1404 key = KSYM_A + (Key)(c - 'A');
1405 else if (c >= 'a' && c <= 'z')
1406 key = KSYM_a + (Key)(c - 'a');
1407 else if (c >= '0' && c <= '9')
1408 key = KSYM_0 + (Key)(c - '0');
1410 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1412 char c = name_ptr[6];
1414 if (c >= '0' && c <= '9')
1415 key = KSYM_KP_0 + (Key)(c - '0');
1417 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1419 char c1 = name_ptr[4];
1420 char c2 = name_ptr[5];
1423 if ((c1 >= '0' && c1 <= '9') &&
1424 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1425 d = atoi(&name_ptr[4]);
1427 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1428 key = KSYM_F1 + (Key)(d - 1);
1430 else if (strncmp(name_ptr, "XK_", 3) == 0)
1436 if (strEqual(name_ptr, translate_key[i].x11name))
1438 key = translate_key[i].key;
1442 while (translate_key[++i].x11name);
1444 else if (strncmp(name_ptr, "0x", 2) == 0)
1446 unsigned long value = 0;
1452 char c = *name_ptr++;
1455 if (c >= '0' && c <= '9')
1457 else if (c >= 'a' && c <= 'f')
1458 d = (int)(c - 'a' + 10);
1459 else if (c >= 'A' && c <= 'F')
1460 d = (int)(c - 'A' + 10);
1468 value = value * 16 + d;
1479 char *getKeyNameFromKey(Key key)
1483 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1487 char *getX11KeyNameFromKey(Key key)
1491 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1495 Key getKeyFromKeyName(char *name)
1499 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1503 Key getKeyFromX11KeyName(char *x11name)
1507 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1511 char getCharFromKey(Key key)
1513 char *keyname = getKeyNameFromKey(key);
1516 if (strlen(keyname) == 1)
1518 else if (strEqual(keyname, "space"))
1524 char getValidConfigValueChar(char c)
1526 if (c == '#' || /* used to mark comments */
1527 c == '\\') /* used to mark continued lines */
1534 /* ------------------------------------------------------------------------- */
1535 /* functions to translate string identifiers to integer or boolean value */
1536 /* ------------------------------------------------------------------------- */
1538 int get_integer_from_string(char *s)
1540 static char *number_text[][3] =
1542 { "0", "zero", "null", },
1543 { "1", "one", "first" },
1544 { "2", "two", "second" },
1545 { "3", "three", "third" },
1546 { "4", "four", "fourth" },
1547 { "5", "five", "fifth" },
1548 { "6", "six", "sixth" },
1549 { "7", "seven", "seventh" },
1550 { "8", "eight", "eighth" },
1551 { "9", "nine", "ninth" },
1552 { "10", "ten", "tenth" },
1553 { "11", "eleven", "eleventh" },
1554 { "12", "twelve", "twelfth" },
1556 { NULL, NULL, NULL },
1560 char *s_lower = getStringToLower(s);
1563 for (i = 0; number_text[i][0] != NULL; i++)
1564 for (j = 0; j < 3; j++)
1565 if (strEqual(s_lower, number_text[i][j]))
1570 if (strEqual(s_lower, "false") ||
1571 strEqual(s_lower, "no") ||
1572 strEqual(s_lower, "off"))
1574 else if (strEqual(s_lower, "true") ||
1575 strEqual(s_lower, "yes") ||
1576 strEqual(s_lower, "on"))
1587 boolean get_boolean_from_string(char *s)
1589 char *s_lower = getStringToLower(s);
1590 boolean result = FALSE;
1592 if (strEqual(s_lower, "true") ||
1593 strEqual(s_lower, "yes") ||
1594 strEqual(s_lower, "on") ||
1595 get_integer_from_string(s) == 1)
1604 /* ------------------------------------------------------------------------- */
1605 /* functions for generic lists */
1606 /* ------------------------------------------------------------------------- */
1608 ListNode *newListNode()
1610 return checked_calloc(sizeof(ListNode));
1613 void addNodeToList(ListNode **node_first, char *key, void *content)
1615 ListNode *node_new = newListNode();
1617 node_new->key = getStringCopy(key);
1618 node_new->content = content;
1619 node_new->next = *node_first;
1620 *node_first = node_new;
1623 void deleteNodeFromList(ListNode **node_first, char *key,
1624 void (*destructor_function)(void *))
1626 if (node_first == NULL || *node_first == NULL)
1629 if (strEqual((*node_first)->key, key))
1631 checked_free((*node_first)->key);
1632 if (destructor_function)
1633 destructor_function((*node_first)->content);
1634 *node_first = (*node_first)->next;
1637 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1640 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1642 if (node_first == NULL)
1645 if (strEqual(node_first->key, key))
1648 return getNodeFromKey(node_first->next, key);
1651 int getNumNodes(ListNode *node_first)
1653 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1656 void dumpList(ListNode *node_first)
1658 ListNode *node = node_first;
1662 printf("['%s' (%d)]\n", node->key,
1663 ((struct ListNodeInfo *)node->content)->num_references);
1667 printf("[%d nodes]\n", getNumNodes(node_first));
1671 /* ------------------------------------------------------------------------- */
1672 /* functions for checking files and filenames */
1673 /* ------------------------------------------------------------------------- */
1675 boolean fileExists(char *filename)
1677 if (filename == NULL)
1680 return (access(filename, F_OK) == 0);
1683 boolean fileHasPrefix(char *basename, char *prefix)
1685 static char *basename_lower = NULL;
1686 int basename_length, prefix_length;
1688 checked_free(basename_lower);
1690 if (basename == NULL || prefix == NULL)
1693 basename_lower = getStringToLower(basename);
1694 basename_length = strlen(basename_lower);
1695 prefix_length = strlen(prefix);
1697 if (basename_length > prefix_length + 1 &&
1698 basename_lower[prefix_length] == '.' &&
1699 strncmp(basename_lower, prefix, prefix_length) == 0)
1705 boolean fileHasSuffix(char *basename, char *suffix)
1707 static char *basename_lower = NULL;
1708 int basename_length, suffix_length;
1710 checked_free(basename_lower);
1712 if (basename == NULL || suffix == NULL)
1715 basename_lower = getStringToLower(basename);
1716 basename_length = strlen(basename_lower);
1717 suffix_length = strlen(suffix);
1719 if (basename_length > suffix_length + 1 &&
1720 basename_lower[basename_length - suffix_length - 1] == '.' &&
1721 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1727 boolean FileIsGraphic(char *filename)
1729 char *basename = getBaseNamePtr(filename);
1731 return fileHasSuffix(basename, "pcx");
1734 boolean FileIsSound(char *filename)
1736 char *basename = getBaseNamePtr(filename);
1738 return fileHasSuffix(basename, "wav");
1741 boolean FileIsMusic(char *filename)
1743 char *basename = getBaseNamePtr(filename);
1745 if (FileIsSound(basename))
1748 #if defined(TARGET_SDL)
1749 if (fileHasPrefix(basename, "mod") ||
1750 fileHasSuffix(basename, "mod") ||
1751 fileHasSuffix(basename, "s3m") ||
1752 fileHasSuffix(basename, "it") ||
1753 fileHasSuffix(basename, "xm") ||
1754 fileHasSuffix(basename, "midi") ||
1755 fileHasSuffix(basename, "mid") ||
1756 fileHasSuffix(basename, "mp3") ||
1757 fileHasSuffix(basename, "ogg"))
1764 boolean FileIsArtworkType(char *basename, int type)
1766 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1767 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1768 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1774 /* ------------------------------------------------------------------------- */
1775 /* functions for loading artwork configuration information */
1776 /* ------------------------------------------------------------------------- */
1778 char *get_mapped_token(char *token)
1780 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1781 static char *map_token_prefix[][2] =
1783 { "char_procent", "char_percent" },
1788 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1790 int len_token_prefix = strlen(map_token_prefix[i][0]);
1792 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1793 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1799 /* This function checks if a string <s> of the format "string1, string2, ..."
1800 exactly contains a string <s_contained>. */
1802 static boolean string_has_parameter(char *s, char *s_contained)
1806 if (s == NULL || s_contained == NULL)
1809 if (strlen(s_contained) > strlen(s))
1812 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1814 char next_char = s[strlen(s_contained)];
1816 /* check if next character is delimiter or whitespace */
1817 return (next_char == ',' || next_char == '\0' ||
1818 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1821 /* check if string contains another parameter string after a comma */
1822 substring = strchr(s, ',');
1823 if (substring == NULL) /* string does not contain a comma */
1826 /* advance string pointer to next character after the comma */
1829 /* skip potential whitespaces after the comma */
1830 while (*substring == ' ' || *substring == '\t')
1833 return string_has_parameter(substring, s_contained);
1836 int get_parameter_value(char *value_raw, char *suffix, int type)
1838 char *value = getStringToLower(value_raw);
1839 int result = 0; /* probably a save default value */
1841 if (strEqual(suffix, ".direction"))
1843 result = (strEqual(value, "left") ? MV_LEFT :
1844 strEqual(value, "right") ? MV_RIGHT :
1845 strEqual(value, "up") ? MV_UP :
1846 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1848 else if (strEqual(suffix, ".align"))
1850 result = (strEqual(value, "left") ? ALIGN_LEFT :
1851 strEqual(value, "right") ? ALIGN_RIGHT :
1852 strEqual(value, "center") ? ALIGN_CENTER :
1853 strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1855 else if (strEqual(suffix, ".valign"))
1857 result = (strEqual(value, "top") ? VALIGN_TOP :
1858 strEqual(value, "bottom") ? VALIGN_BOTTOM :
1859 strEqual(value, "middle") ? VALIGN_MIDDLE :
1860 strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1862 else if (strEqual(suffix, ".anim_mode"))
1864 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1865 string_has_parameter(value, "loop") ? ANIM_LOOP :
1866 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1867 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1868 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1869 string_has_parameter(value, "random") ? ANIM_RANDOM :
1870 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1871 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1872 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1873 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1874 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1875 string_has_parameter(value, "centered") ? ANIM_CENTERED :
1878 if (string_has_parameter(value, "reverse"))
1879 result |= ANIM_REVERSE;
1881 if (string_has_parameter(value, "opaque_player"))
1882 result |= ANIM_OPAQUE_PLAYER;
1884 if (string_has_parameter(value, "static_panel"))
1885 result |= ANIM_STATIC_PANEL;
1887 else if (strEqual(suffix, ".fade_mode"))
1889 result = (string_has_parameter(value, "none") ? FADE_MODE_NONE :
1890 string_has_parameter(value, "fade") ? FADE_MODE_FADE :
1891 string_has_parameter(value, "crossfade") ? FADE_MODE_CROSSFADE :
1892 string_has_parameter(value, "melt") ? FADE_MODE_MELT :
1896 else if (strPrefix(suffix, ".font")) /* (may also be ".font_xyz") */
1898 else if (strEqualN(suffix, ".font", 5)) /* (may also be ".font_xyz") */
1901 result = gfx.get_font_from_token_function(value);
1903 else /* generic parameter of type integer or boolean */
1905 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1906 type == TYPE_INTEGER ? get_integer_from_string(value) :
1907 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1908 ARG_UNDEFINED_VALUE);
1916 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1918 static struct ScreenModeInfo screen_mode;
1919 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1920 char *screen_mode_string_copy;
1921 char *screen_mode_string_pos_w;
1922 char *screen_mode_string_pos_h;
1924 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1927 screen_mode_string_copy = getStringCopy(screen_mode_string);
1929 screen_mode_string_pos_w = screen_mode_string_copy;
1930 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1931 *screen_mode_string_pos_h++ = '\0';
1933 screen_mode.width = atoi(screen_mode_string_pos_w);
1934 screen_mode.height = atoi(screen_mode_string_pos_h);
1936 return &screen_mode;
1939 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1942 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1943 float aspect_ratio_new;
1948 *x = i * aspect_ratio + 0.000001;
1951 aspect_ratio_new = (float)*x / (float)*y;
1955 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1958 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1959 struct ListNodeInfo ***, int *);
1961 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1962 struct ConfigTypeInfo *suffix_list,
1963 char **ignore_tokens,
1964 int num_file_list_entries)
1966 struct FileInfo *file_list;
1967 int num_file_list_entries_found = 0;
1968 int num_suffix_list_entries = 0;
1972 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1974 for (i = 0; suffix_list[i].token != NULL; i++)
1975 num_suffix_list_entries++;
1977 /* always start with reliable default values */
1978 for (i = 0; i < num_file_list_entries; i++)
1980 file_list[i].token = NULL;
1982 file_list[i].default_filename = NULL;
1983 file_list[i].filename = NULL;
1985 if (num_suffix_list_entries > 0)
1987 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1989 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1990 file_list[i].parameter = checked_calloc(parameter_array_size);
1992 for (j = 0; j < num_suffix_list_entries; j++)
1994 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1995 setString(&file_list[i].parameter[j], suffix_list[j].value);
1998 file_list[i].redefined = FALSE;
1999 file_list[i].fallback_to_default = FALSE;
2000 file_list[i].default_is_cloned = FALSE;
2005 for (i = 0; config_list[i].token != NULL; i++)
2007 int len_config_token = strlen(config_list[i].token);
2008 int len_config_value = strlen(config_list[i].value);
2009 boolean is_file_entry = TRUE;
2011 for (j = 0; suffix_list[j].token != NULL; j++)
2013 int len_suffix = strlen(suffix_list[j].token);
2015 if (len_suffix < len_config_token &&
2016 strEqual(&config_list[i].token[len_config_token - len_suffix],
2017 suffix_list[j].token))
2019 setString(&file_list[list_pos].default_parameter[j],
2020 config_list[i].value);
2022 is_file_entry = FALSE;
2027 /* the following tokens are no file definitions, but other config tokens */
2028 for (j = 0; ignore_tokens[j] != NULL; j++)
2029 if (strEqual(config_list[i].token, ignore_tokens[j]))
2030 is_file_entry = FALSE;
2037 if (list_pos >= num_file_list_entries)
2040 /* simple sanity check if this is really a file definition */
2041 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2042 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2043 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2045 Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2046 config_list[i].token, config_list[i].value);
2047 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2050 file_list[list_pos].token = config_list[i].token;
2051 file_list[list_pos].default_filename = config_list[i].value;
2054 printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2058 if (strSuffix(config_list[i].token, ".clone_from"))
2059 file_list[list_pos].default_is_cloned = TRUE;
2062 num_file_list_entries_found = list_pos + 1;
2063 if (num_file_list_entries_found != num_file_list_entries)
2065 Error(ERR_INFO_LINE, "-");
2066 Error(ERR_INFO, "inconsistant config list information:");
2067 Error(ERR_INFO, "- should be: %d (according to 'src/conf_xxx.h')",
2068 num_file_list_entries);
2069 Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2070 num_file_list_entries_found);
2071 Error(ERR_EXIT, "please fix");
2075 printf("::: ---------- DONE ----------\n");
2081 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2083 int len_token = strlen(token);
2084 int len_suffix = strlen(suffix);
2086 if (start_pos < 0) /* compare suffix from end of string */
2087 start_pos += len_token;
2089 if (start_pos < 0 || start_pos + len_suffix > len_token)
2092 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2095 if (token[start_pos + len_suffix] == '\0')
2098 if (token[start_pos + len_suffix] == '.')
2104 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
2106 static void read_token_parameters(SetupFileHash *setup_file_hash,
2107 struct ConfigTypeInfo *suffix_list,
2108 struct FileInfo *file_list_entry)
2110 /* check for config token that is the base token without any suffixes */
2111 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2112 char *known_token_value = KNOWN_TOKEN_VALUE;
2115 if (filename != NULL)
2117 setString(&file_list_entry->filename, filename);
2119 /* when file definition found, set all parameters to default values */
2120 for (i = 0; suffix_list[i].token != NULL; i++)
2121 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2123 file_list_entry->redefined = TRUE;
2125 /* mark config file token as well known from default config */
2126 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2129 /* check for config tokens that can be build by base token and suffixes */
2130 for (i = 0; suffix_list[i].token != NULL; i++)
2132 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2133 char *value = getHashEntry(setup_file_hash, token);
2137 setString(&file_list_entry->parameter[i], value);
2139 /* mark config file token as well known from default config */
2140 setHashEntry(setup_file_hash, token, known_token_value);
2147 static void add_dynamic_file_list_entry(struct FileInfo **list,
2148 int *num_list_entries,
2149 SetupFileHash *extra_file_hash,
2150 struct ConfigTypeInfo *suffix_list,
2151 int num_suffix_list_entries,
2154 struct FileInfo *new_list_entry;
2155 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2157 (*num_list_entries)++;
2158 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2159 new_list_entry = &(*list)[*num_list_entries - 1];
2161 new_list_entry->token = getStringCopy(token);
2162 new_list_entry->default_filename = NULL;
2163 new_list_entry->filename = NULL;
2164 new_list_entry->parameter = checked_calloc(parameter_array_size);
2166 new_list_entry->redefined = FALSE;
2167 new_list_entry->fallback_to_default = FALSE;
2168 new_list_entry->default_is_cloned = FALSE;
2170 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2173 static void add_property_mapping(struct PropertyMapping **list,
2174 int *num_list_entries,
2175 int base_index, int ext1_index,
2176 int ext2_index, int ext3_index,
2179 struct PropertyMapping *new_list_entry;
2181 (*num_list_entries)++;
2182 *list = checked_realloc(*list,
2183 *num_list_entries * sizeof(struct PropertyMapping));
2184 new_list_entry = &(*list)[*num_list_entries - 1];
2186 new_list_entry->base_index = base_index;
2187 new_list_entry->ext1_index = ext1_index;
2188 new_list_entry->ext2_index = ext2_index;
2189 new_list_entry->ext3_index = ext3_index;
2191 new_list_entry->artwork_index = artwork_index;
2194 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2197 struct FileInfo *file_list = artwork_info->file_list;
2198 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2199 char **base_prefixes = artwork_info->base_prefixes;
2200 char **ext1_suffixes = artwork_info->ext1_suffixes;
2201 char **ext2_suffixes = artwork_info->ext2_suffixes;
2202 char **ext3_suffixes = artwork_info->ext3_suffixes;
2203 char **ignore_tokens = artwork_info->ignore_tokens;
2204 int num_file_list_entries = artwork_info->num_file_list_entries;
2205 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2206 int num_base_prefixes = artwork_info->num_base_prefixes;
2207 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2208 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2209 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2210 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2211 SetupFileHash *setup_file_hash, *valid_file_hash;
2212 SetupFileHash *extra_file_hash, *empty_file_hash;
2213 char *known_token_value = KNOWN_TOKEN_VALUE;
2216 if (filename == NULL)
2220 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2223 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2226 /* separate valid (defined) from empty (undefined) config token values */
2227 valid_file_hash = newSetupFileHash();
2228 empty_file_hash = newSetupFileHash();
2229 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2231 char *value = HASH_ITERATION_VALUE(itr);
2233 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2234 HASH_ITERATION_TOKEN(itr), value);
2236 END_HASH_ITERATION(setup_file_hash, itr)
2238 /* at this point, we do not need the setup file hash anymore -- free it */
2239 freeSetupFileHash(setup_file_hash);
2241 /* map deprecated to current tokens (using prefix match and replace) */
2242 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2244 char *token = HASH_ITERATION_TOKEN(itr);
2245 char *mapped_token = get_mapped_token(token);
2247 if (mapped_token != NULL)
2249 char *value = HASH_ITERATION_VALUE(itr);
2251 /* add mapped token */
2252 setHashEntry(valid_file_hash, mapped_token, value);
2254 /* ignore old token (by setting it to "known" keyword) */
2255 setHashEntry(valid_file_hash, token, known_token_value);
2260 END_HASH_ITERATION(valid_file_hash, itr)
2262 /* read parameters for all known config file tokens */
2263 for (i = 0; i < num_file_list_entries; i++)
2264 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2266 /* set all tokens that can be ignored here to "known" keyword */
2267 for (i = 0; i < num_ignore_tokens; i++)
2268 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2270 /* copy all unknown config file tokens to extra config hash */
2271 extra_file_hash = newSetupFileHash();
2272 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2274 char *value = HASH_ITERATION_VALUE(itr);
2276 if (!strEqual(value, known_token_value))
2277 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2279 END_HASH_ITERATION(valid_file_hash, itr)
2281 /* at this point, we do not need the valid file hash anymore -- free it */
2282 freeSetupFileHash(valid_file_hash);
2284 /* now try to determine valid, dynamically defined config tokens */
2286 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2288 struct FileInfo **dynamic_file_list =
2289 &artwork_info->dynamic_file_list;
2290 int *num_dynamic_file_list_entries =
2291 &artwork_info->num_dynamic_file_list_entries;
2292 struct PropertyMapping **property_mapping =
2293 &artwork_info->property_mapping;
2294 int *num_property_mapping_entries =
2295 &artwork_info->num_property_mapping_entries;
2296 int current_summarized_file_list_entry =
2297 artwork_info->num_file_list_entries +
2298 artwork_info->num_dynamic_file_list_entries;
2299 char *token = HASH_ITERATION_TOKEN(itr);
2300 int len_token = strlen(token);
2302 boolean base_prefix_found = FALSE;
2303 boolean parameter_suffix_found = FALSE;
2306 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2309 /* skip all parameter definitions (handled by read_token_parameters()) */
2310 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2312 int len_suffix = strlen(suffix_list[i].token);
2314 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2315 parameter_suffix_found = TRUE;
2318 if (parameter_suffix_found)
2321 /* ---------- step 0: search for matching base prefix ---------- */
2324 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2326 char *base_prefix = base_prefixes[i];
2327 int len_base_prefix = strlen(base_prefix);
2328 boolean ext1_suffix_found = FALSE;
2329 boolean ext2_suffix_found = FALSE;
2330 boolean ext3_suffix_found = FALSE;
2331 boolean exact_match = FALSE;
2332 int base_index = -1;
2333 int ext1_index = -1;
2334 int ext2_index = -1;
2335 int ext3_index = -1;
2337 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2339 if (!base_prefix_found)
2345 if (IS_PARENT_PROCESS())
2346 printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2349 if (start_pos + len_base_prefix == len_token) /* exact match */
2354 if (IS_PARENT_PROCESS())
2355 printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2358 add_dynamic_file_list_entry(dynamic_file_list,
2359 num_dynamic_file_list_entries,
2362 num_suffix_list_entries,
2364 add_property_mapping(property_mapping,
2365 num_property_mapping_entries,
2366 base_index, -1, -1, -1,
2367 current_summarized_file_list_entry);
2372 if (IS_PARENT_PROCESS())
2373 printf("---> examining token '%s': search 1st suffix ...\n", token);
2376 /* ---------- step 1: search for matching first suffix ---------- */
2378 start_pos += len_base_prefix;
2379 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2381 char *ext1_suffix = ext1_suffixes[j];
2382 int len_ext1_suffix = strlen(ext1_suffix);
2384 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2386 if (!ext1_suffix_found)
2392 if (IS_PARENT_PROCESS())
2393 printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2396 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2401 if (IS_PARENT_PROCESS())
2402 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2405 add_dynamic_file_list_entry(dynamic_file_list,
2406 num_dynamic_file_list_entries,
2409 num_suffix_list_entries,
2411 add_property_mapping(property_mapping,
2412 num_property_mapping_entries,
2413 base_index, ext1_index, -1, -1,
2414 current_summarized_file_list_entry);
2418 start_pos += len_ext1_suffix;
2425 if (IS_PARENT_PROCESS())
2426 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2429 /* ---------- step 2: search for matching second suffix ---------- */
2431 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2433 char *ext2_suffix = ext2_suffixes[k];
2434 int len_ext2_suffix = strlen(ext2_suffix);
2436 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2438 if (!ext2_suffix_found)
2444 if (IS_PARENT_PROCESS())
2445 printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2448 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2453 if (IS_PARENT_PROCESS())
2454 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2457 add_dynamic_file_list_entry(dynamic_file_list,
2458 num_dynamic_file_list_entries,
2461 num_suffix_list_entries,
2463 add_property_mapping(property_mapping,
2464 num_property_mapping_entries,
2465 base_index, ext1_index, ext2_index, -1,
2466 current_summarized_file_list_entry);
2470 start_pos += len_ext2_suffix;
2477 if (IS_PARENT_PROCESS())
2478 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2481 /* ---------- step 3: search for matching third suffix ---------- */
2483 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2485 char *ext3_suffix = ext3_suffixes[l];
2486 int len_ext3_suffix = strlen(ext3_suffix);
2488 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2490 if (!ext3_suffix_found)
2496 if (IS_PARENT_PROCESS())
2497 printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2500 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2505 if (IS_PARENT_PROCESS())
2506 printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2509 add_dynamic_file_list_entry(dynamic_file_list,
2510 num_dynamic_file_list_entries,
2513 num_suffix_list_entries,
2515 add_property_mapping(property_mapping,
2516 num_property_mapping_entries,
2517 base_index, ext1_index, ext2_index, ext3_index,
2518 current_summarized_file_list_entry);
2524 END_HASH_ITERATION(extra_file_hash, itr)
2526 if (artwork_info->num_dynamic_file_list_entries > 0)
2528 artwork_info->dynamic_artwork_list =
2529 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2530 artwork_info->sizeof_artwork_list_entry);
2533 if (options.verbose && IS_PARENT_PROCESS())
2535 SetupFileList *setup_file_list, *list;
2536 boolean dynamic_tokens_found = FALSE;
2537 boolean unknown_tokens_found = FALSE;
2538 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2540 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2541 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2543 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2545 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2546 dynamic_tokens_found = TRUE;
2548 unknown_tokens_found = TRUE;
2550 END_HASH_ITERATION(extra_file_hash, itr)
2552 if (options.debug && dynamic_tokens_found)
2554 Error(ERR_INFO_LINE, "-");
2555 Error(ERR_INFO, "dynamic token(s) found in config file:");
2556 Error(ERR_INFO, "- config file: '%s'", filename);
2558 for (list = setup_file_list; list != NULL; list = list->next)
2560 char *value = getHashEntry(extra_file_hash, list->token);
2562 if (value != NULL && strEqual(value, known_token_value))
2563 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2566 Error(ERR_INFO_LINE, "-");
2569 if (unknown_tokens_found)
2571 Error(ERR_INFO_LINE, "-");
2572 Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2573 Error(ERR_INFO, "- config file: '%s'", filename);
2575 for (list = setup_file_list; list != NULL; list = list->next)
2577 char *value = getHashEntry(extra_file_hash, list->token);
2579 if (value != NULL && !strEqual(value, known_token_value))
2580 Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2583 Error(ERR_INFO_LINE, "-");
2586 if (undefined_values_found)
2588 Error(ERR_INFO_LINE, "-");
2589 Error(ERR_INFO, "warning: undefined values found in config file:");
2590 Error(ERR_INFO, "- config file: '%s'", filename);
2592 for (list = setup_file_list; list != NULL; list = list->next)
2594 char *value = getHashEntry(empty_file_hash, list->token);
2597 Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2600 Error(ERR_INFO_LINE, "-");
2603 freeSetupFileList(setup_file_list);
2606 freeSetupFileHash(extra_file_hash);
2607 freeSetupFileHash(empty_file_hash);
2610 for (i = 0; i < num_file_list_entries; i++)
2612 printf("'%s' ", file_list[i].token);
2613 if (file_list[i].filename)
2614 printf("-> '%s'\n", file_list[i].filename);
2616 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2621 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2623 struct FileInfo *file_list = artwork_info->file_list;
2624 int num_file_list_entries = artwork_info->num_file_list_entries;
2625 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2626 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2629 DrawInitText("Loading artwork config", 120, FC_GREEN);
2630 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2632 /* always start with reliable default values */
2633 for (i = 0; i < num_file_list_entries; i++)
2635 setString(&file_list[i].filename, file_list[i].default_filename);
2637 for (j = 0; j < num_suffix_list_entries; j++)
2638 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2640 file_list[i].redefined = FALSE;
2641 file_list[i].fallback_to_default = FALSE;
2644 /* free previous dynamic artwork file array */
2645 if (artwork_info->dynamic_file_list != NULL)
2647 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2649 free(artwork_info->dynamic_file_list[i].token);
2650 free(artwork_info->dynamic_file_list[i].filename);
2651 free(artwork_info->dynamic_file_list[i].parameter);
2654 free(artwork_info->dynamic_file_list);
2655 artwork_info->dynamic_file_list = NULL;
2657 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2658 &artwork_info->num_dynamic_file_list_entries);
2661 /* free previous property mapping */
2662 if (artwork_info->property_mapping != NULL)
2664 free(artwork_info->property_mapping);
2666 artwork_info->property_mapping = NULL;
2667 artwork_info->num_property_mapping_entries = 0;
2671 if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2673 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2676 /* first look for special artwork configured in level series config */
2677 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2680 printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2681 leveldir_current->graphics_set,
2682 leveldir_current->graphics_path);
2685 if (fileExists(filename_base))
2686 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2689 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2691 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2692 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2695 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2696 struct ListNodeInfo **listnode)
2700 char *filename = (*listnode)->source_filename;
2702 if (--(*listnode)->num_references <= 0)
2703 deleteNodeFromList(&artwork_info->content_list, filename,
2704 artwork_info->free_artwork);
2710 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2711 struct ListNodeInfo **listnode,
2712 struct FileInfo *file_list_entry)
2722 char *basename = file_list_entry->filename;
2723 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2725 if (filename == NULL)
2727 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2729 basename = file_list_entry->default_filename;
2731 /* fail for cloned default artwork that has no default filename defined */
2732 if (file_list_entry->default_is_cloned &&
2733 strEqual(basename, UNDEFINED_FILENAME))
2735 int error_mode = ERR_WARN;
2737 /* we can get away without sounds and music, but not without graphics */
2738 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2739 error_mode = ERR_EXIT;
2741 Error(error_mode, "token '%s' was cloned and has no default filename",
2742 file_list_entry->token);
2747 /* dynamic artwork has no default filename / skip empty default artwork */
2748 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2751 file_list_entry->fallback_to_default = TRUE;
2753 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2755 filename = getCustomArtworkFilename(basename, artwork_info->type);
2757 if (filename == NULL)
2759 int error_mode = ERR_WARN;
2761 /* we can get away without sounds and music, but not without graphics */
2762 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2763 error_mode = ERR_EXIT;
2765 Error(error_mode, "cannot find default artwork file '%s'", basename);
2771 /* check if the old and the new artwork file are the same */
2772 if (*listnode && strEqual((*listnode)->source_filename, filename))
2774 /* The old and new artwork are the same (have the same filename and path).
2775 This usually means that this artwork does not exist in this artwork set
2776 and a fallback to the existing artwork is done. */
2779 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2785 /* delete existing artwork file entry */
2786 deleteArtworkListEntry(artwork_info, listnode);
2788 /* check if the new artwork file already exists in the list of artworks */
2789 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2792 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2795 *listnode = (struct ListNodeInfo *)node->content;
2796 (*listnode)->num_references++;
2801 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2802 DrawInitText(basename, 150, FC_YELLOW);
2804 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2807 printf("[adding new artwork '%s']\n", filename);
2810 (*listnode)->num_references = 1;
2811 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2816 int error_mode = ERR_WARN;
2818 /* we can get away without sounds and music, but not without graphics */
2819 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2820 error_mode = ERR_EXIT;
2822 Error(error_mode, "cannot load artwork file '%s'", basename);
2828 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2829 struct ListNodeInfo **listnode,
2830 struct FileInfo *file_list_entry)
2833 printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2836 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2838 deleteArtworkListEntry(artwork_info, listnode);
2842 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2845 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2847 struct FileInfo *file_list = artwork_info->file_list;
2848 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2849 int num_file_list_entries = artwork_info->num_file_list_entries;
2850 int num_dynamic_file_list_entries =
2851 artwork_info->num_dynamic_file_list_entries;
2854 for (i = 0; i < num_file_list_entries; i++)
2855 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2858 for (i = 0; i < num_dynamic_file_list_entries; i++)
2859 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2860 &dynamic_file_list[i]);
2863 dumpList(artwork_info->content_list);
2867 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2868 struct ListNodeInfo ***list,
2869 int *num_list_entries)
2876 for (i = 0; i < *num_list_entries; i++)
2877 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2881 *num_list_entries = 0;
2884 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2886 if (artwork_info == NULL)
2889 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2890 &artwork_info->num_file_list_entries);
2892 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2893 &artwork_info->num_dynamic_file_list_entries);
2897 /* ------------------------------------------------------------------------- */
2898 /* functions only needed for non-Unix (non-command-line) systems */
2899 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2900 /* (now also added for Windows, to create files in user data directory) */
2901 /* ------------------------------------------------------------------------- */
2903 char *getErrorFilename(char *basename)
2905 return getPath2(getUserGameDataDir(), basename);
2908 void openErrorFile()
2910 InitUserDataDirectory();
2912 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2913 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2914 program.error_filename);
2917 void closeErrorFile()
2919 if (program.error_file != stderr) /* do not close stream 'stderr' */
2920 fclose(program.error_file);
2923 void dumpErrorFile()
2925 FILE *error_file = fopen(program.error_filename, MODE_READ);
2927 if (error_file != NULL)
2929 while (!feof(error_file))
2930 fputc(fgetc(error_file), stderr);
2936 void NotifyUserAboutErrorFile()
2938 #if defined(PLATFORM_WIN32)
2939 char *title_text = getStringCat2(program.program_title, " Error Message");
2940 char *error_text = getStringCat2("The program was aborted due to an error; "
2941 "for details, see the following error file:"
2942 STRING_NEWLINE, program.error_filename);
2944 MessageBox(NULL, error_text, title_text, MB_OK);
2949 /* ------------------------------------------------------------------------- */
2950 /* the following is only for debugging purpose and normally not used */
2951 /* ------------------------------------------------------------------------- */
2955 #define DEBUG_NUM_TIMESTAMPS 5
2956 #define DEBUG_TIME_IN_MICROSECONDS 0
2958 #if DEBUG_TIME_IN_MICROSECONDS
2959 static double Counter_Microseconds()
2961 static struct timeval base_time = { 0, 0 };
2962 struct timeval current_time;
2965 gettimeofday(¤t_time, NULL);
2967 /* reset base time in case of wrap-around */
2968 if (current_time.tv_sec < base_time.tv_sec)
2969 base_time = current_time;
2972 ((double)(current_time.tv_sec - base_time.tv_sec)) * 1000000 +
2973 ((double)(current_time.tv_usec - base_time.tv_usec));
2975 return counter; /* return microseconds since last init */
2979 char *debug_print_timestamp_get_padding(int padding_size)
2981 static char *padding = NULL;
2982 int max_padding_size = 100;
2984 if (padding == NULL)
2986 padding = checked_calloc(max_padding_size + 1);
2987 memset(padding, ' ', max_padding_size);
2990 return &padding[MAX(0, max_padding_size - padding_size)];
2993 void debug_print_timestamp(int counter_nr, char *message)
2995 int indent_size = 8;
2996 int padding_size = 40;
2997 float timestamp_interval;
3000 Error(ERR_EXIT, "debugging: invalid negative counter");
3001 else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3002 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3004 #if DEBUG_TIME_IN_MICROSECONDS
3005 static double counter[DEBUG_NUM_TIMESTAMPS][2];
3008 counter[counter_nr][0] = Counter_Microseconds();
3010 static long counter[DEBUG_NUM_TIMESTAMPS][2];
3013 counter[counter_nr][0] = Counter();
3016 timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3017 counter[counter_nr][1] = counter[counter_nr][0];
3020 printf("%s%s%s %.3f %s\n",
3021 debug_print_timestamp_get_padding(counter_nr * indent_size),
3023 debug_print_timestamp_get_padding(padding_size - strlen(message)),
3024 timestamp_interval / 1000,
3028 void debug_print_parent_only(char *format, ...)
3030 if (!IS_PARENT_PROCESS())
3037 va_start(ap, format);
3038 vprintf(format, ap);