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) */
160 /* ------------------------------------------------------------------------- */
161 /* counter functions */
162 /* ------------------------------------------------------------------------- */
164 #if defined(PLATFORM_MSDOS)
165 volatile unsigned long counter = 0;
167 void increment_counter()
172 END_OF_FUNCTION(increment_counter);
176 /* maximal allowed length of a command line option */
177 #define MAX_OPTION_LEN 256
180 static unsigned long mainCounter(int mode)
182 static unsigned long base_ms = 0;
183 unsigned long current_ms;
184 unsigned long counter_ms;
186 current_ms = SDL_GetTicks();
188 /* reset base time in case of counter initializing or wrap-around */
189 if (mode == INIT_COUNTER || current_ms < base_ms)
190 base_ms = current_ms;
192 counter_ms = current_ms - base_ms;
194 return counter_ms; /* return milliseconds since last init */
197 #else /* !TARGET_SDL */
199 #if defined(PLATFORM_UNIX)
200 static unsigned long mainCounter(int mode)
202 static struct timeval base_time = { 0, 0 };
203 struct timeval current_time;
204 unsigned long counter_ms;
206 gettimeofday(¤t_time, NULL);
208 /* reset base time in case of counter initializing or wrap-around */
209 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
210 base_time = current_time;
212 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
213 + (current_time.tv_usec - base_time.tv_usec) / 1000;
215 return counter_ms; /* return milliseconds since last init */
217 #endif /* PLATFORM_UNIX */
218 #endif /* !TARGET_SDL */
220 void InitCounter() /* set counter back to zero */
222 #if !defined(PLATFORM_MSDOS)
223 mainCounter(INIT_COUNTER);
225 LOCK_VARIABLE(counter);
226 LOCK_FUNCTION(increment_counter);
227 install_int_ex(increment_counter, BPS_TO_TIMER(100));
231 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
233 #if !defined(PLATFORM_MSDOS)
234 return mainCounter(READ_COUNTER);
236 return (counter * 10);
240 static void sleep_milliseconds(unsigned long milliseconds_delay)
242 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
246 /* we want to wait only a few ms -- if we assume that we have a
247 kernel timer resolution of 10 ms, we would wait far to long;
248 therefore it's better to do a short interval of busy waiting
249 to get our sleeping time more accurate */
251 unsigned long base_counter = Counter(), actual_counter = Counter();
253 while (actual_counter < base_counter + milliseconds_delay &&
254 actual_counter >= base_counter)
255 actual_counter = Counter();
259 #if defined(TARGET_SDL)
260 SDL_Delay(milliseconds_delay);
261 #elif defined(TARGET_ALLEGRO)
262 rest(milliseconds_delay);
264 struct timeval delay;
266 delay.tv_sec = milliseconds_delay / 1000;
267 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
269 if (select(0, NULL, NULL, NULL, &delay) != 0)
270 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
275 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
277 sleep_milliseconds(delay);
280 boolean FrameReached(unsigned long *frame_counter_var,
281 unsigned long frame_delay)
283 unsigned long actual_frame_counter = FrameCounter;
285 if (actual_frame_counter >= *frame_counter_var &&
286 actual_frame_counter < *frame_counter_var + frame_delay)
289 *frame_counter_var = actual_frame_counter;
294 boolean DelayReached(unsigned long *counter_var,
297 unsigned long actual_counter = Counter();
299 if (actual_counter >= *counter_var &&
300 actual_counter < *counter_var + delay)
303 *counter_var = actual_counter;
308 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
310 unsigned long actual_counter;
314 actual_counter = Counter();
316 if (actual_counter >= *counter_var &&
317 actual_counter < *counter_var + delay)
318 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
323 *counter_var = actual_counter;
327 /* ------------------------------------------------------------------------- */
328 /* random generator functions */
329 /* ------------------------------------------------------------------------- */
331 unsigned int init_random_number(int nr, long seed)
333 if (seed == NEW_RANDOMIZE)
335 #if defined(TARGET_SDL)
336 seed = (long)SDL_GetTicks();
338 struct timeval current_time;
340 gettimeofday(¤t_time, NULL);
341 seed = (long)current_time.tv_usec;
345 srandom_linux_libc(nr, (unsigned int) seed);
347 return (unsigned int) seed;
350 unsigned int get_random_number(int nr, int max)
352 return (max > 0 ? random_linux_libc(nr) % max : 0);
356 /* ------------------------------------------------------------------------- */
357 /* system info functions */
358 /* ------------------------------------------------------------------------- */
360 #if !defined(PLATFORM_MSDOS)
361 static char *get_corrected_real_name(char *real_name)
363 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
364 char *from_ptr = real_name;
365 char *to_ptr = real_name_new;
367 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
368 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
370 /* the name field read from "passwd" file may also contain additional
371 user information, separated by commas, which will be removed here */
372 if (*from_ptr == ',')
375 /* the user's real name may contain 'ß' characters (german sharp s),
376 which have no equivalent in upper case letters (used by our fonts) */
377 if (*from_ptr == 'ß')
384 *to_ptr++ = *from_ptr++;
389 return real_name_new;
395 static char *login_name = NULL;
397 #if defined(PLATFORM_WIN32)
398 if (login_name == NULL)
400 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
401 login_name = checked_malloc(buffer_size);
403 if (GetUserName(login_name, &buffer_size) == 0)
404 strcpy(login_name, ANONYMOUS_NAME);
407 if (login_name == NULL)
411 if ((pwd = getpwuid(getuid())) == NULL)
412 login_name = ANONYMOUS_NAME;
414 login_name = getStringCopy(pwd->pw_name);
423 static char *real_name = NULL;
425 #if defined(PLATFORM_WIN32)
426 if (real_name == NULL)
428 static char buffer[MAX_USERNAME_LEN + 1];
429 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
431 if (GetUserName(buffer, &buffer_size) != 0)
432 real_name = get_corrected_real_name(buffer);
434 real_name = ANONYMOUS_NAME;
436 #elif defined(PLATFORM_UNIX)
437 if (real_name == NULL)
441 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
442 real_name = get_corrected_real_name(pwd->pw_gecos);
444 real_name = ANONYMOUS_NAME;
447 real_name = ANONYMOUS_NAME;
454 /* ------------------------------------------------------------------------- */
455 /* path manipulation functions */
456 /* ------------------------------------------------------------------------- */
458 static char *getLastPathSeparatorPtr(char *filename)
460 char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
462 if (last_separator == NULL) /* also try DOS/Windows variant */
463 last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
465 return last_separator;
468 char *getBaseNamePtr(char *filename)
470 char *last_separator = getLastPathSeparatorPtr(filename);
472 if (last_separator != NULL)
473 return last_separator + 1; /* separator found: strip base path */
475 return filename; /* no separator found: filename has no path */
478 char *getBaseName(char *filename)
480 return getStringCopy(getBaseNamePtr(filename));
483 char *getBasePath(char *filename)
485 char *basepath = getStringCopy(filename);
486 char *last_separator = getLastPathSeparatorPtr(basepath);
488 if (last_separator != NULL)
489 *last_separator = '\0'; /* separator found: strip basename */
491 basepath = "."; /* no separator found: use current path */
497 /* ------------------------------------------------------------------------- */
498 /* various string functions */
499 /* ------------------------------------------------------------------------- */
501 char *getPath2(char *path1, char *path2)
503 char *sep = STRING_PATH_SEPARATOR;
504 char *complete_path = checked_malloc(strlen(path1) + 1 +
507 sprintf(complete_path, "%s%s%s", path1, sep, path2);
509 return complete_path;
512 char *getPath3(char *path1, char *path2, char *path3)
514 char *sep = STRING_PATH_SEPARATOR;
515 char *complete_path = checked_malloc(strlen(path1) + 1 +
519 sprintf(complete_path, "%s%s%s%s%s", path1, sep, path2, sep, path3);
521 return complete_path;
524 char *getStringCat2(char *s1, char *s2)
526 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
528 sprintf(complete_string, "%s%s", s1, s2);
530 return complete_string;
533 char *getStringCopy(char *s)
540 s_copy = checked_malloc(strlen(s) + 1);
546 char *getStringToLower(char *s)
548 char *s_copy = checked_malloc(strlen(s) + 1);
549 char *s_ptr = s_copy;
552 *s_ptr++ = tolower(*s++);
558 void setString(char **old_value, char *new_value)
560 checked_free(*old_value);
562 *old_value = getStringCopy(new_value);
565 boolean strEqual(char *s1, char *s2)
567 return (s1 == NULL && s2 == NULL ? TRUE :
568 s1 == NULL && s2 != NULL ? FALSE :
569 s1 != NULL && s2 == NULL ? FALSE :
570 strcmp(s1, s2) == 0);
574 /* ------------------------------------------------------------------------- */
575 /* command line option handling functions */
576 /* ------------------------------------------------------------------------- */
578 void GetOptions(char *argv[], void (*print_usage_function)(void))
580 char *ro_base_path = RO_BASE_PATH;
581 char *rw_base_path = RW_BASE_PATH;
582 char **options_left = &argv[1];
584 #if !defined(PLATFORM_MACOSX)
585 /* if the program is configured to start from current directory (default),
586 determine program package directory (KDE/Konqueror does not do this by
587 itself and fails otherwise); on Mac OS X, the program binary is stored
588 in an application package directory -- do not try to use this directory
589 as the program data directory (Mac OS X handles this correctly anyway) */
591 if (strEqual(ro_base_path, "."))
592 ro_base_path = program.command_basepath;
593 if (strEqual(rw_base_path, "."))
594 rw_base_path = program.command_basepath;
597 /* initialize global program options */
598 options.display_name = NULL;
599 options.server_host = NULL;
600 options.server_port = 0;
601 options.ro_base_directory = ro_base_path;
602 options.rw_base_directory = rw_base_path;
603 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
604 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
605 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
606 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
607 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
608 options.execute_command = NULL;
609 options.serveronly = FALSE;
610 options.network = FALSE;
611 options.verbose = FALSE;
612 options.debug = FALSE;
614 #if !defined(PLATFORM_UNIX)
615 if (*options_left == NULL) /* no options given -- enable verbose mode */
616 options.verbose = TRUE;
619 while (*options_left)
621 char option_str[MAX_OPTION_LEN];
622 char *option = options_left[0];
623 char *next_option = options_left[1];
624 char *option_arg = NULL;
625 int option_len = strlen(option);
627 if (option_len >= MAX_OPTION_LEN)
628 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
630 strcpy(option_str, option); /* copy argument into buffer */
633 if (strEqual(option, "--")) /* stop scanning arguments */
636 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
639 option_arg = strchr(option, '=');
640 if (option_arg == NULL) /* no '=' in option */
641 option_arg = next_option;
644 *option_arg++ = '\0'; /* cut argument from option */
645 if (*option_arg == '\0') /* no argument after '=' */
646 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
649 option_len = strlen(option);
651 if (strEqual(option, "-"))
652 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
653 else if (strncmp(option, "-help", option_len) == 0)
655 print_usage_function();
659 else if (strncmp(option, "-display", option_len) == 0)
661 if (option_arg == NULL)
662 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
664 options.display_name = option_arg;
665 if (option_arg == next_option)
668 else if (strncmp(option, "-basepath", option_len) == 0)
670 if (option_arg == NULL)
671 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
673 /* this should be extended to separate options for ro and rw data */
674 options.ro_base_directory = ro_base_path = option_arg;
675 options.rw_base_directory = rw_base_path = option_arg;
676 if (option_arg == next_option)
679 /* adjust paths for sub-directories in base directory accordingly */
680 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
681 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
682 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
683 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
684 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
686 else if (strncmp(option, "-levels", option_len) == 0)
688 if (option_arg == NULL)
689 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
691 options.level_directory = option_arg;
692 if (option_arg == next_option)
695 else if (strncmp(option, "-graphics", option_len) == 0)
697 if (option_arg == NULL)
698 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
700 options.graphics_directory = option_arg;
701 if (option_arg == next_option)
704 else if (strncmp(option, "-sounds", option_len) == 0)
706 if (option_arg == NULL)
707 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
709 options.sounds_directory = option_arg;
710 if (option_arg == next_option)
713 else if (strncmp(option, "-music", option_len) == 0)
715 if (option_arg == NULL)
716 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
718 options.music_directory = option_arg;
719 if (option_arg == next_option)
722 else if (strncmp(option, "-network", option_len) == 0)
724 options.network = TRUE;
726 else if (strncmp(option, "-serveronly", option_len) == 0)
728 options.serveronly = TRUE;
730 else if (strncmp(option, "-verbose", option_len) == 0)
732 options.verbose = TRUE;
734 else if (strncmp(option, "-debug", option_len) == 0)
736 options.debug = TRUE;
738 else if (strncmp(option, "-execute", option_len) == 0)
740 if (option_arg == NULL)
741 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
743 options.execute_command = option_arg;
744 if (option_arg == next_option)
747 /* when doing batch processing, always enable verbose mode (warnings) */
748 options.verbose = TRUE;
750 else if (*option == '-')
752 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
754 else if (options.server_host == NULL)
756 options.server_host = *options_left;
758 else if (options.server_port == 0)
760 options.server_port = atoi(*options_left);
761 if (options.server_port < 1024)
762 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
765 Error(ERR_EXIT_HELP, "too many arguments");
772 /* ------------------------------------------------------------------------- */
773 /* error handling functions */
774 /* ------------------------------------------------------------------------- */
776 /* used by SetError() and GetError() to store internal error messages */
777 static char internal_error[1024]; /* this is bad */
779 void SetError(char *format, ...)
783 va_start(ap, format);
784 vsprintf(internal_error, format, ap);
790 return internal_error;
793 void Error(int mode, char *format, ...)
795 static boolean last_line_was_separator = FALSE;
796 char *process_name = "";
798 /* display warnings only when running in verbose mode */
799 if (mode & ERR_WARN && !options.verbose)
802 if (mode == ERR_RETURN_LINE)
804 if (!last_line_was_separator)
805 fprintf_line(program.error_file, format, 79);
807 last_line_was_separator = TRUE;
812 last_line_was_separator = FALSE;
814 if (mode & ERR_SOUND_SERVER)
815 process_name = " sound server";
816 else if (mode & ERR_NETWORK_SERVER)
817 process_name = " network server";
818 else if (mode & ERR_NETWORK_CLIENT)
819 process_name = " network client **";
825 fprintf(program.error_file, "%s%s: ", program.command_basename,
829 fprintf(program.error_file, "warning: ");
831 va_start(ap, format);
832 vfprintf_newline(program.error_file, format, ap);
837 fprintf_newline(program.error_file,
838 "%s: Try option '--help' for more information.",
839 program.command_basename);
842 fprintf_newline(program.error_file, "%s%s: aborting",
843 program.command_basename, process_name);
847 if (mode & ERR_FROM_SERVER)
848 exit(1); /* child process: normal exit */
850 program.exit_function(1); /* main process: clean up stuff */
855 /* ------------------------------------------------------------------------- */
856 /* checked memory allocation and freeing functions */
857 /* ------------------------------------------------------------------------- */
859 void *checked_malloc(unsigned long size)
866 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
871 void *checked_calloc(unsigned long size)
875 ptr = calloc(1, size);
878 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
883 void *checked_realloc(void *ptr, unsigned long size)
885 ptr = realloc(ptr, size);
888 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
893 void checked_free(void *ptr)
895 if (ptr != NULL) /* this check should be done by free() anyway */
900 /* ------------------------------------------------------------------------- */
901 /* various helper functions */
902 /* ------------------------------------------------------------------------- */
904 inline void swap_numbers(int *i1, int *i2)
912 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
924 /* the "put" variants of the following file access functions check for the file
925 pointer being != NULL and return the number of bytes they have or would have
926 written; this allows for chunk writing functions to first determine the size
927 of the (not yet written) chunk, write the correct chunk size and finally
928 write the chunk itself */
930 int getFile8BitInteger(FILE *file)
935 int putFile8BitInteger(FILE *file, int value)
943 int getFile16BitInteger(FILE *file, int byte_order)
945 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
946 return ((fgetc(file) << 8) |
948 else /* BYTE_ORDER_LITTLE_ENDIAN */
949 return ((fgetc(file) << 0) |
953 int putFile16BitInteger(FILE *file, int value, int byte_order)
957 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
959 fputc((value >> 8) & 0xff, file);
960 fputc((value >> 0) & 0xff, file);
962 else /* BYTE_ORDER_LITTLE_ENDIAN */
964 fputc((value >> 0) & 0xff, file);
965 fputc((value >> 8) & 0xff, file);
972 int getFile32BitInteger(FILE *file, int byte_order)
974 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
975 return ((fgetc(file) << 24) |
976 (fgetc(file) << 16) |
979 else /* BYTE_ORDER_LITTLE_ENDIAN */
980 return ((fgetc(file) << 0) |
982 (fgetc(file) << 16) |
983 (fgetc(file) << 24));
986 int putFile32BitInteger(FILE *file, int value, int byte_order)
990 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
992 fputc((value >> 24) & 0xff, file);
993 fputc((value >> 16) & 0xff, file);
994 fputc((value >> 8) & 0xff, file);
995 fputc((value >> 0) & 0xff, file);
997 else /* BYTE_ORDER_LITTLE_ENDIAN */
999 fputc((value >> 0) & 0xff, file);
1000 fputc((value >> 8) & 0xff, file);
1001 fputc((value >> 16) & 0xff, file);
1002 fputc((value >> 24) & 0xff, file);
1009 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1012 const int chunk_name_length = 4;
1014 /* read chunk name */
1015 fgets(chunk_name, chunk_name_length + 1, file);
1017 if (chunk_size != NULL)
1019 /* read chunk size */
1020 *chunk_size = getFile32BitInteger(file, byte_order);
1023 return (feof(file) || ferror(file) ? FALSE : TRUE);
1026 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1031 /* write chunk name */
1033 fputs(chunk_name, file);
1035 num_bytes += strlen(chunk_name);
1037 if (chunk_size >= 0)
1039 /* write chunk size */
1041 putFile32BitInteger(file, chunk_size, byte_order);
1049 int getFileVersion(FILE *file)
1051 int version_major = fgetc(file);
1052 int version_minor = fgetc(file);
1053 int version_patch = fgetc(file);
1054 int version_build = fgetc(file);
1056 return VERSION_IDENT(version_major, version_minor, version_patch,
1060 int putFileVersion(FILE *file, int version)
1064 int version_major = VERSION_MAJOR(version);
1065 int version_minor = VERSION_MINOR(version);
1066 int version_patch = VERSION_PATCH(version);
1067 int version_build = VERSION_BUILD(version);
1069 fputc(version_major, file);
1070 fputc(version_minor, file);
1071 fputc(version_patch, file);
1072 fputc(version_build, file);
1078 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1082 for(i = 0; i < bytes && !feof(file); i++)
1083 buffer[i] = fgetc(file);
1086 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1090 for(i = 0; i < bytes; i++)
1091 fputc(buffer[i], file);
1094 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1096 while (bytes-- && !feof(file))
1100 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1107 /* ------------------------------------------------------------------------- */
1108 /* functions to translate key identifiers between different format */
1109 /* ------------------------------------------------------------------------- */
1111 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1112 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1113 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1114 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1116 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1125 /* normal cursor keys */
1126 { KSYM_Left, "XK_Left", "cursor left" },
1127 { KSYM_Right, "XK_Right", "cursor right" },
1128 { KSYM_Up, "XK_Up", "cursor up" },
1129 { KSYM_Down, "XK_Down", "cursor down" },
1131 /* keypad cursor keys */
1133 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1134 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1135 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1136 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1139 /* other keypad keys */
1140 #ifdef KSYM_KP_Enter
1141 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1142 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1143 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1144 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1145 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1146 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1150 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1151 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1152 { KSYM_Control_L, "XK_Control_L", "left control" },
1153 { KSYM_Control_R, "XK_Control_R", "right control" },
1154 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1155 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1156 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1157 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1158 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1159 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1160 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1161 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1163 /* some special keys */
1164 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1165 { KSYM_Delete, "XK_Delete", "delete" },
1166 { KSYM_Insert, "XK_Insert", "insert" },
1167 { KSYM_Tab, "XK_Tab", "tab" },
1168 { KSYM_Home, "XK_Home", "home" },
1169 { KSYM_End, "XK_End", "end" },
1170 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1171 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1172 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1174 /* ASCII 0x20 to 0x40 keys (except numbers) */
1175 { KSYM_space, "XK_space", "space" },
1176 { KSYM_exclam, "XK_exclam", "!" },
1177 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1178 { KSYM_numbersign, "XK_numbersign", "#" },
1179 { KSYM_dollar, "XK_dollar", "$" },
1180 { KSYM_percent, "XK_percent", "%" },
1181 { KSYM_ampersand, "XK_ampersand", "&" },
1182 { KSYM_apostrophe, "XK_apostrophe", "'" },
1183 { KSYM_parenleft, "XK_parenleft", "(" },
1184 { KSYM_parenright, "XK_parenright", ")" },
1185 { KSYM_asterisk, "XK_asterisk", "*" },
1186 { KSYM_plus, "XK_plus", "+" },
1187 { KSYM_comma, "XK_comma", "," },
1188 { KSYM_minus, "XK_minus", "-" },
1189 { KSYM_period, "XK_period", "." },
1190 { KSYM_slash, "XK_slash", "/" },
1191 { KSYM_colon, "XK_colon", ":" },
1192 { KSYM_semicolon, "XK_semicolon", ";" },
1193 { KSYM_less, "XK_less", "<" },
1194 { KSYM_equal, "XK_equal", "=" },
1195 { KSYM_greater, "XK_greater", ">" },
1196 { KSYM_question, "XK_question", "?" },
1197 { KSYM_at, "XK_at", "@" },
1199 /* more ASCII keys */
1200 { KSYM_bracketleft, "XK_bracketleft", "[" },
1201 { KSYM_backslash, "XK_backslash", "\\" },
1202 { KSYM_bracketright,"XK_bracketright", "]" },
1203 { KSYM_asciicircum, "XK_asciicircum", "^" },
1204 { KSYM_underscore, "XK_underscore", "_" },
1205 { KSYM_grave, "XK_grave", "grave" },
1206 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1207 { KSYM_braceleft, "XK_braceleft", "brace left" },
1208 { KSYM_bar, "XK_bar", "bar" },
1209 { KSYM_braceright, "XK_braceright", "brace right" },
1210 { KSYM_asciitilde, "XK_asciitilde", "~" },
1212 /* special (non-ASCII) keys */
1213 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1214 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1215 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1216 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1217 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1218 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1219 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1221 /* end-of-array identifier */
1227 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1229 static char name_buffer[30];
1232 if (key >= KSYM_A && key <= KSYM_Z)
1233 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1234 else if (key >= KSYM_a && key <= KSYM_z)
1235 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1236 else if (key >= KSYM_0 && key <= KSYM_9)
1237 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1238 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1239 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1240 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1241 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1242 else if (key == KSYM_UNDEFINED)
1243 strcpy(name_buffer, "(undefined)");
1250 if (key == translate_key[i].key)
1252 strcpy(name_buffer, translate_key[i].name);
1256 while (translate_key[++i].name);
1258 if (!translate_key[i].name)
1259 strcpy(name_buffer, "(unknown)");
1262 *name = name_buffer;
1264 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1266 static char name_buffer[30];
1269 if (key >= KSYM_A && key <= KSYM_Z)
1270 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1271 else if (key >= KSYM_a && key <= KSYM_z)
1272 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1273 else if (key >= KSYM_0 && key <= KSYM_9)
1274 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1275 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1276 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1277 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1278 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1279 else if (key == KSYM_UNDEFINED)
1280 strcpy(name_buffer, "[undefined]");
1287 if (key == translate_key[i].key)
1289 strcpy(name_buffer, translate_key[i].x11name);
1293 while (translate_key[++i].x11name);
1295 if (!translate_key[i].x11name)
1296 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1299 *x11name = name_buffer;
1301 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1303 Key key = KSYM_UNDEFINED;
1308 if (strEqual(translate_key[i].name, *name))
1310 key = translate_key[i].key;
1314 while (translate_key[++i].x11name);
1316 if (key == KSYM_UNDEFINED)
1317 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1321 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1323 Key key = KSYM_UNDEFINED;
1324 char *name_ptr = *x11name;
1326 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1328 char c = name_ptr[3];
1330 if (c >= 'A' && c <= 'Z')
1331 key = KSYM_A + (Key)(c - 'A');
1332 else if (c >= 'a' && c <= 'z')
1333 key = KSYM_a + (Key)(c - 'a');
1334 else if (c >= '0' && c <= '9')
1335 key = KSYM_0 + (Key)(c - '0');
1337 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1339 char c = name_ptr[6];
1341 if (c >= '0' && c <= '9')
1342 key = KSYM_KP_0 + (Key)(c - '0');
1344 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1346 char c1 = name_ptr[4];
1347 char c2 = name_ptr[5];
1350 if ((c1 >= '0' && c1 <= '9') &&
1351 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1352 d = atoi(&name_ptr[4]);
1354 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1355 key = KSYM_F1 + (Key)(d - 1);
1357 else if (strncmp(name_ptr, "XK_", 3) == 0)
1363 if (strEqual(name_ptr, translate_key[i].x11name))
1365 key = translate_key[i].key;
1369 while (translate_key[++i].x11name);
1371 else if (strncmp(name_ptr, "0x", 2) == 0)
1373 unsigned long value = 0;
1379 char c = *name_ptr++;
1382 if (c >= '0' && c <= '9')
1384 else if (c >= 'a' && c <= 'f')
1385 d = (int)(c - 'a' + 10);
1386 else if (c >= 'A' && c <= 'F')
1387 d = (int)(c - 'A' + 10);
1395 value = value * 16 + d;
1406 char *getKeyNameFromKey(Key key)
1410 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1414 char *getX11KeyNameFromKey(Key key)
1418 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1422 Key getKeyFromKeyName(char *name)
1426 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1430 Key getKeyFromX11KeyName(char *x11name)
1434 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1438 char getCharFromKey(Key key)
1440 char *keyname = getKeyNameFromKey(key);
1443 if (strlen(keyname) == 1)
1444 letter = keyname[0];
1445 else if (strEqual(keyname, "space"))
1447 else if (strEqual(keyname, "circumflex"))
1454 /* ------------------------------------------------------------------------- */
1455 /* functions to translate string identifiers to integer or boolean value */
1456 /* ------------------------------------------------------------------------- */
1458 int get_integer_from_string(char *s)
1460 static char *number_text[][3] =
1462 { "0", "zero", "null", },
1463 { "1", "one", "first" },
1464 { "2", "two", "second" },
1465 { "3", "three", "third" },
1466 { "4", "four", "fourth" },
1467 { "5", "five", "fifth" },
1468 { "6", "six", "sixth" },
1469 { "7", "seven", "seventh" },
1470 { "8", "eight", "eighth" },
1471 { "9", "nine", "ninth" },
1472 { "10", "ten", "tenth" },
1473 { "11", "eleven", "eleventh" },
1474 { "12", "twelve", "twelfth" },
1476 { NULL, NULL, NULL },
1480 char *s_lower = getStringToLower(s);
1483 for (i = 0; number_text[i][0] != NULL; i++)
1484 for (j = 0; j < 3; j++)
1485 if (strEqual(s_lower, number_text[i][j]))
1490 if (strEqual(s_lower, "false"))
1492 else if (strEqual(s_lower, "true"))
1503 boolean get_boolean_from_string(char *s)
1505 char *s_lower = getStringToLower(s);
1506 boolean result = FALSE;
1508 if (strEqual(s_lower, "true") ||
1509 strEqual(s_lower, "yes") ||
1510 strEqual(s_lower, "on") ||
1511 get_integer_from_string(s) == 1)
1520 /* ------------------------------------------------------------------------- */
1521 /* functions for generic lists */
1522 /* ------------------------------------------------------------------------- */
1524 ListNode *newListNode()
1526 return checked_calloc(sizeof(ListNode));
1529 void addNodeToList(ListNode **node_first, char *key, void *content)
1531 ListNode *node_new = newListNode();
1533 node_new->key = getStringCopy(key);
1534 node_new->content = content;
1535 node_new->next = *node_first;
1536 *node_first = node_new;
1539 void deleteNodeFromList(ListNode **node_first, char *key,
1540 void (*destructor_function)(void *))
1542 if (node_first == NULL || *node_first == NULL)
1545 if (strEqual((*node_first)->key, key))
1547 free((*node_first)->key);
1548 if (destructor_function)
1549 destructor_function((*node_first)->content);
1550 *node_first = (*node_first)->next;
1553 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1556 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1558 if (node_first == NULL)
1561 if (strEqual(node_first->key, key))
1564 return getNodeFromKey(node_first->next, key);
1567 int getNumNodes(ListNode *node_first)
1569 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1572 void dumpList(ListNode *node_first)
1574 ListNode *node = node_first;
1578 printf("['%s' (%d)]\n", node->key,
1579 ((struct ListNodeInfo *)node->content)->num_references);
1583 printf("[%d nodes]\n", getNumNodes(node_first));
1587 /* ------------------------------------------------------------------------- */
1588 /* functions for checking files and filenames */
1589 /* ------------------------------------------------------------------------- */
1591 boolean fileExists(char *filename)
1593 if (filename == NULL)
1596 return (access(filename, F_OK) == 0);
1599 boolean fileHasPrefix(char *basename, char *prefix)
1601 static char *basename_lower = NULL;
1602 int basename_length, prefix_length;
1604 checked_free(basename_lower);
1606 if (basename == NULL || prefix == NULL)
1609 basename_lower = getStringToLower(basename);
1610 basename_length = strlen(basename_lower);
1611 prefix_length = strlen(prefix);
1613 if (basename_length > prefix_length + 1 &&
1614 basename_lower[prefix_length] == '.' &&
1615 strncmp(basename_lower, prefix, prefix_length) == 0)
1621 boolean fileHasSuffix(char *basename, char *suffix)
1623 static char *basename_lower = NULL;
1624 int basename_length, suffix_length;
1626 checked_free(basename_lower);
1628 if (basename == NULL || suffix == NULL)
1631 basename_lower = getStringToLower(basename);
1632 basename_length = strlen(basename_lower);
1633 suffix_length = strlen(suffix);
1635 if (basename_length > suffix_length + 1 &&
1636 basename_lower[basename_length - suffix_length - 1] == '.' &&
1637 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1643 boolean FileIsGraphic(char *filename)
1645 char *basename = getBaseNamePtr(filename);
1647 return fileHasSuffix(basename, "pcx");
1650 boolean FileIsSound(char *filename)
1652 char *basename = getBaseNamePtr(filename);
1654 return fileHasSuffix(basename, "wav");
1657 boolean FileIsMusic(char *filename)
1659 char *basename = getBaseNamePtr(filename);
1661 if (FileIsSound(basename))
1664 #if defined(TARGET_SDL)
1665 if (fileHasPrefix(basename, "mod") ||
1666 fileHasSuffix(basename, "mod") ||
1667 fileHasSuffix(basename, "s3m") ||
1668 fileHasSuffix(basename, "it") ||
1669 fileHasSuffix(basename, "xm") ||
1670 fileHasSuffix(basename, "midi") ||
1671 fileHasSuffix(basename, "mid") ||
1672 fileHasSuffix(basename, "mp3") ||
1673 fileHasSuffix(basename, "ogg"))
1680 boolean FileIsArtworkType(char *basename, int type)
1682 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1683 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1684 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1690 /* ------------------------------------------------------------------------- */
1691 /* functions for loading artwork configuration information */
1692 /* ------------------------------------------------------------------------- */
1694 char *get_mapped_token(char *token)
1696 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1697 static char *map_token_prefix[][2] =
1699 { "char_procent", "char_percent" },
1704 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1706 int len_token_prefix = strlen(map_token_prefix[i][0]);
1708 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1709 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1715 /* This function checks if a string <s> of the format "string1, string2, ..."
1716 exactly contains a string <s_contained>. */
1718 static boolean string_has_parameter(char *s, char *s_contained)
1722 if (s == NULL || s_contained == NULL)
1725 if (strlen(s_contained) > strlen(s))
1728 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1730 char next_char = s[strlen(s_contained)];
1732 /* check if next character is delimiter or whitespace */
1733 return (next_char == ',' || next_char == '\0' ||
1734 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1737 /* check if string contains another parameter string after a comma */
1738 substring = strchr(s, ',');
1739 if (substring == NULL) /* string does not contain a comma */
1742 /* advance string pointer to next character after the comma */
1745 /* skip potential whitespaces after the comma */
1746 while (*substring == ' ' || *substring == '\t')
1749 return string_has_parameter(substring, s_contained);
1752 int get_parameter_value(char *value_raw, char *suffix, int type)
1754 char *value = getStringToLower(value_raw);
1755 int result = 0; /* probably a save default value */
1757 if (strEqual(suffix, ".direction"))
1759 result = (strEqual(value, "left") ? MV_LEFT :
1760 strEqual(value, "right") ? MV_RIGHT :
1761 strEqual(value, "up") ? MV_UP :
1762 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1764 else if (strEqual(suffix, ".anim_mode"))
1766 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1767 string_has_parameter(value, "loop") ? ANIM_LOOP :
1768 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1769 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1770 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1771 string_has_parameter(value, "random") ? ANIM_RANDOM :
1772 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1773 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1774 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1775 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1776 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1779 if (string_has_parameter(value, "reverse"))
1780 result |= ANIM_REVERSE;
1782 if (string_has_parameter(value, "opaque_player"))
1783 result |= ANIM_OPAQUE_PLAYER;
1785 if (string_has_parameter(value, "static_panel"))
1786 result |= ANIM_STATIC_PANEL;
1788 else /* generic parameter of type integer or boolean */
1790 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1791 type == TYPE_INTEGER ? get_integer_from_string(value) :
1792 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1793 ARG_UNDEFINED_VALUE);
1801 int get_auto_parameter_value(char *token, char *value_raw)
1805 if (token == NULL || value_raw == NULL)
1806 return ARG_UNDEFINED_VALUE;
1808 suffix = strrchr(token, '.');
1812 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
1815 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1817 static struct ScreenModeInfo screen_mode;
1818 char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1819 char *screen_mode_string_copy;
1820 char *screen_mode_string_pos_w;
1821 char *screen_mode_string_pos_h;
1823 if (screen_mode_string_x == NULL) /* invalid screen mode format */
1826 screen_mode_string_copy = getStringCopy(screen_mode_string);
1828 screen_mode_string_pos_w = screen_mode_string_copy;
1829 screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1830 *screen_mode_string_pos_h++ = '\0';
1832 screen_mode.width = atoi(screen_mode_string_pos_w);
1833 screen_mode.height = atoi(screen_mode_string_pos_h);
1835 return &screen_mode;
1838 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1841 float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1842 float aspect_ratio_new;
1847 *x = i * aspect_ratio + 0.000001;
1850 aspect_ratio_new = (float)*x / (float)*y;
1854 while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1857 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1858 struct ListNodeInfo ***, int *);
1860 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1861 struct ConfigTypeInfo *suffix_list,
1862 char **ignore_tokens,
1863 int num_file_list_entries)
1865 struct FileInfo *file_list;
1866 int num_file_list_entries_found = 0;
1867 int num_suffix_list_entries = 0;
1871 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1873 for (i = 0; suffix_list[i].token != NULL; i++)
1874 num_suffix_list_entries++;
1876 /* always start with reliable default values */
1877 for (i = 0; i < num_file_list_entries; i++)
1879 file_list[i].token = NULL;
1881 file_list[i].default_filename = NULL;
1882 file_list[i].filename = NULL;
1884 if (num_suffix_list_entries > 0)
1886 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1888 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1889 file_list[i].parameter = checked_calloc(parameter_array_size);
1891 for (j = 0; j < num_suffix_list_entries; j++)
1893 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1894 setString(&file_list[i].parameter[j], suffix_list[j].value);
1897 file_list[i].redefined = FALSE;
1898 file_list[i].fallback_to_default = FALSE;
1903 for (i = 0; config_list[i].token != NULL; i++)
1905 int len_config_token = strlen(config_list[i].token);
1906 int len_config_value = strlen(config_list[i].value);
1907 boolean is_file_entry = TRUE;
1909 for (j = 0; suffix_list[j].token != NULL; j++)
1911 int len_suffix = strlen(suffix_list[j].token);
1913 if (len_suffix < len_config_token &&
1914 strEqual(&config_list[i].token[len_config_token - len_suffix],
1915 suffix_list[j].token))
1917 setString(&file_list[list_pos].default_parameter[j],
1918 config_list[i].value);
1920 is_file_entry = FALSE;
1925 /* the following tokens are no file definitions, but other config tokens */
1926 for (j = 0; ignore_tokens[j] != NULL; j++)
1927 if (strEqual(config_list[i].token, ignore_tokens[j]))
1928 is_file_entry = FALSE;
1935 if (list_pos >= num_file_list_entries)
1938 /* simple sanity check if this is really a file definition */
1939 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
1940 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
1941 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
1943 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1944 config_list[i].token, config_list[i].value);
1945 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1948 file_list[list_pos].token = config_list[i].token;
1949 file_list[list_pos].default_filename = config_list[i].value;
1953 num_file_list_entries_found = list_pos + 1;
1954 if (num_file_list_entries_found != num_file_list_entries)
1956 Error(ERR_RETURN_LINE, "-");
1957 Error(ERR_RETURN, "inconsistant config list information:");
1958 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1959 num_file_list_entries);
1960 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1961 num_file_list_entries_found);
1962 Error(ERR_EXIT, "please fix");
1968 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1970 int len_token = strlen(token);
1971 int len_suffix = strlen(suffix);
1973 if (start_pos < 0) /* compare suffix from end of string */
1974 start_pos += len_token;
1976 if (start_pos < 0 || start_pos + len_suffix > len_token)
1979 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1982 if (token[start_pos + len_suffix] == '\0')
1985 if (token[start_pos + len_suffix] == '.')
1991 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1993 static void read_token_parameters(SetupFileHash *setup_file_hash,
1994 struct ConfigTypeInfo *suffix_list,
1995 struct FileInfo *file_list_entry)
1997 /* check for config token that is the base token without any suffixes */
1998 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1999 char *known_token_value = KNOWN_TOKEN_VALUE;
2002 if (filename != NULL)
2004 setString(&file_list_entry->filename, filename);
2006 /* when file definition found, set all parameters to default values */
2007 for (i = 0; suffix_list[i].token != NULL; i++)
2008 setString(&file_list_entry->parameter[i], suffix_list[i].value);
2010 file_list_entry->redefined = TRUE;
2012 /* mark config file token as well known from default config */
2013 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2016 /* check for config tokens that can be build by base token and suffixes */
2017 for (i = 0; suffix_list[i].token != NULL; i++)
2019 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2020 char *value = getHashEntry(setup_file_hash, token);
2024 setString(&file_list_entry->parameter[i], value);
2026 /* mark config file token as well known from default config */
2027 setHashEntry(setup_file_hash, token, known_token_value);
2034 static void add_dynamic_file_list_entry(struct FileInfo **list,
2035 int *num_list_entries,
2036 SetupFileHash *extra_file_hash,
2037 struct ConfigTypeInfo *suffix_list,
2038 int num_suffix_list_entries,
2041 struct FileInfo *new_list_entry;
2042 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2044 (*num_list_entries)++;
2045 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2046 new_list_entry = &(*list)[*num_list_entries - 1];
2048 new_list_entry->token = getStringCopy(token);
2049 new_list_entry->default_filename = NULL;
2050 new_list_entry->filename = NULL;
2051 new_list_entry->parameter = checked_calloc(parameter_array_size);
2053 new_list_entry->redefined = FALSE;
2054 new_list_entry->fallback_to_default = FALSE;
2056 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2059 static void add_property_mapping(struct PropertyMapping **list,
2060 int *num_list_entries,
2061 int base_index, int ext1_index,
2062 int ext2_index, int ext3_index,
2065 struct PropertyMapping *new_list_entry;
2067 (*num_list_entries)++;
2068 *list = checked_realloc(*list,
2069 *num_list_entries * sizeof(struct PropertyMapping));
2070 new_list_entry = &(*list)[*num_list_entries - 1];
2072 new_list_entry->base_index = base_index;
2073 new_list_entry->ext1_index = ext1_index;
2074 new_list_entry->ext2_index = ext2_index;
2075 new_list_entry->ext3_index = ext3_index;
2077 new_list_entry->artwork_index = artwork_index;
2080 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2083 struct FileInfo *file_list = artwork_info->file_list;
2084 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2085 char **base_prefixes = artwork_info->base_prefixes;
2086 char **ext1_suffixes = artwork_info->ext1_suffixes;
2087 char **ext2_suffixes = artwork_info->ext2_suffixes;
2088 char **ext3_suffixes = artwork_info->ext3_suffixes;
2089 char **ignore_tokens = artwork_info->ignore_tokens;
2090 int num_file_list_entries = artwork_info->num_file_list_entries;
2091 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2092 int num_base_prefixes = artwork_info->num_base_prefixes;
2093 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2094 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2095 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2096 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2097 SetupFileHash *setup_file_hash, *valid_file_hash;
2098 SetupFileHash *extra_file_hash, *empty_file_hash;
2099 char *known_token_value = KNOWN_TOKEN_VALUE;
2102 if (filename == NULL)
2106 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2109 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2112 /* separate valid (defined) from empty (undefined) config token values */
2113 valid_file_hash = newSetupFileHash();
2114 empty_file_hash = newSetupFileHash();
2115 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2117 char *value = HASH_ITERATION_VALUE(itr);
2119 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2120 HASH_ITERATION_TOKEN(itr), value);
2122 END_HASH_ITERATION(setup_file_hash, itr)
2124 /* at this point, we do not need the setup file hash anymore -- free it */
2125 freeSetupFileHash(setup_file_hash);
2127 /* map deprecated to current tokens (using prefix match and replace) */
2128 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2130 char *token = HASH_ITERATION_TOKEN(itr);
2131 char *mapped_token = get_mapped_token(token);
2133 if (mapped_token != NULL)
2135 char *value = HASH_ITERATION_VALUE(itr);
2137 /* add mapped token */
2138 setHashEntry(valid_file_hash, mapped_token, value);
2140 /* ignore old token (by setting it to "known" keyword) */
2141 setHashEntry(valid_file_hash, token, known_token_value);
2146 END_HASH_ITERATION(valid_file_hash, itr)
2148 /* read parameters for all known config file tokens */
2149 for (i = 0; i < num_file_list_entries; i++)
2150 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2152 /* set all tokens that can be ignored here to "known" keyword */
2153 for (i = 0; i < num_ignore_tokens; i++)
2154 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2156 /* copy all unknown config file tokens to extra config hash */
2157 extra_file_hash = newSetupFileHash();
2158 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2160 char *value = HASH_ITERATION_VALUE(itr);
2162 if (!strEqual(value, known_token_value))
2163 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2165 END_HASH_ITERATION(valid_file_hash, itr)
2167 /* at this point, we do not need the valid file hash anymore -- free it */
2168 freeSetupFileHash(valid_file_hash);
2170 /* now try to determine valid, dynamically defined config tokens */
2172 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2174 struct FileInfo **dynamic_file_list =
2175 &artwork_info->dynamic_file_list;
2176 int *num_dynamic_file_list_entries =
2177 &artwork_info->num_dynamic_file_list_entries;
2178 struct PropertyMapping **property_mapping =
2179 &artwork_info->property_mapping;
2180 int *num_property_mapping_entries =
2181 &artwork_info->num_property_mapping_entries;
2182 int current_summarized_file_list_entry =
2183 artwork_info->num_file_list_entries +
2184 artwork_info->num_dynamic_file_list_entries;
2185 char *token = HASH_ITERATION_TOKEN(itr);
2186 int len_token = strlen(token);
2188 boolean base_prefix_found = FALSE;
2189 boolean parameter_suffix_found = FALSE;
2192 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2195 /* skip all parameter definitions (handled by read_token_parameters()) */
2196 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2198 int len_suffix = strlen(suffix_list[i].token);
2200 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2201 parameter_suffix_found = TRUE;
2204 if (parameter_suffix_found)
2207 /* ---------- step 0: search for matching base prefix ---------- */
2210 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2212 char *base_prefix = base_prefixes[i];
2213 int len_base_prefix = strlen(base_prefix);
2214 boolean ext1_suffix_found = FALSE;
2215 boolean ext2_suffix_found = FALSE;
2216 boolean ext3_suffix_found = FALSE;
2217 boolean exact_match = FALSE;
2218 int base_index = -1;
2219 int ext1_index = -1;
2220 int ext2_index = -1;
2221 int ext3_index = -1;
2223 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2225 if (!base_prefix_found)
2230 if (start_pos + len_base_prefix == len_token) /* exact match */
2234 add_dynamic_file_list_entry(dynamic_file_list,
2235 num_dynamic_file_list_entries,
2238 num_suffix_list_entries,
2240 add_property_mapping(property_mapping,
2241 num_property_mapping_entries,
2242 base_index, -1, -1, -1,
2243 current_summarized_file_list_entry);
2248 if (IS_PARENT_PROCESS())
2249 printf("---> examining token '%s': search 1st suffix ...\n", token);
2252 /* ---------- step 1: search for matching first suffix ---------- */
2254 start_pos += len_base_prefix;
2255 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2257 char *ext1_suffix = ext1_suffixes[j];
2258 int len_ext1_suffix = strlen(ext1_suffix);
2260 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2262 if (!ext1_suffix_found)
2267 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2271 add_dynamic_file_list_entry(dynamic_file_list,
2272 num_dynamic_file_list_entries,
2275 num_suffix_list_entries,
2277 add_property_mapping(property_mapping,
2278 num_property_mapping_entries,
2279 base_index, ext1_index, -1, -1,
2280 current_summarized_file_list_entry);
2284 start_pos += len_ext1_suffix;
2291 if (IS_PARENT_PROCESS())
2292 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2295 /* ---------- step 2: search for matching second suffix ---------- */
2297 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2299 char *ext2_suffix = ext2_suffixes[k];
2300 int len_ext2_suffix = strlen(ext2_suffix);
2302 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2304 if (!ext2_suffix_found)
2309 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2313 add_dynamic_file_list_entry(dynamic_file_list,
2314 num_dynamic_file_list_entries,
2317 num_suffix_list_entries,
2319 add_property_mapping(property_mapping,
2320 num_property_mapping_entries,
2321 base_index, ext1_index, ext2_index, -1,
2322 current_summarized_file_list_entry);
2326 start_pos += len_ext2_suffix;
2333 if (IS_PARENT_PROCESS())
2334 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2337 /* ---------- step 3: search for matching third suffix ---------- */
2339 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2341 char *ext3_suffix = ext3_suffixes[l];
2342 int len_ext3_suffix = strlen(ext3_suffix);
2344 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2346 if (!ext3_suffix_found)
2351 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2355 add_dynamic_file_list_entry(dynamic_file_list,
2356 num_dynamic_file_list_entries,
2359 num_suffix_list_entries,
2361 add_property_mapping(property_mapping,
2362 num_property_mapping_entries,
2363 base_index, ext1_index, ext2_index, ext3_index,
2364 current_summarized_file_list_entry);
2370 END_HASH_ITERATION(extra_file_hash, itr)
2372 if (artwork_info->num_dynamic_file_list_entries > 0)
2374 artwork_info->dynamic_artwork_list =
2375 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2376 artwork_info->sizeof_artwork_list_entry);
2379 if (options.verbose && IS_PARENT_PROCESS())
2381 SetupFileList *setup_file_list, *list;
2382 boolean dynamic_tokens_found = FALSE;
2383 boolean unknown_tokens_found = FALSE;
2384 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2386 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2387 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2389 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2391 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2392 dynamic_tokens_found = TRUE;
2394 unknown_tokens_found = TRUE;
2396 END_HASH_ITERATION(extra_file_hash, itr)
2398 if (options.debug && dynamic_tokens_found)
2400 Error(ERR_RETURN_LINE, "-");
2401 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2402 Error(ERR_RETURN, "- config file: '%s'", filename);
2404 for (list = setup_file_list; list != NULL; list = list->next)
2406 char *value = getHashEntry(extra_file_hash, list->token);
2408 if (value != NULL && strEqual(value, known_token_value))
2409 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2412 Error(ERR_RETURN_LINE, "-");
2415 if (unknown_tokens_found)
2417 Error(ERR_RETURN_LINE, "-");
2418 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2419 Error(ERR_RETURN, "- config file: '%s'", filename);
2421 for (list = setup_file_list; list != NULL; list = list->next)
2423 char *value = getHashEntry(extra_file_hash, list->token);
2425 if (value != NULL && !strEqual(value, known_token_value))
2426 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2429 Error(ERR_RETURN_LINE, "-");
2432 if (undefined_values_found)
2434 Error(ERR_RETURN_LINE, "-");
2435 Error(ERR_RETURN, "warning: undefined values found in config file:");
2436 Error(ERR_RETURN, "- config file: '%s'", filename);
2438 for (list = setup_file_list; list != NULL; list = list->next)
2440 char *value = getHashEntry(empty_file_hash, list->token);
2443 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2446 Error(ERR_RETURN_LINE, "-");
2449 freeSetupFileList(setup_file_list);
2452 freeSetupFileHash(extra_file_hash);
2453 freeSetupFileHash(empty_file_hash);
2456 for (i = 0; i < num_file_list_entries; i++)
2458 printf("'%s' ", file_list[i].token);
2459 if (file_list[i].filename)
2460 printf("-> '%s'\n", file_list[i].filename);
2462 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2467 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2469 struct FileInfo *file_list = artwork_info->file_list;
2470 int num_file_list_entries = artwork_info->num_file_list_entries;
2471 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2472 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2475 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2476 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2478 /* always start with reliable default values */
2479 for (i = 0; i < num_file_list_entries; i++)
2481 setString(&file_list[i].filename, file_list[i].default_filename);
2483 for (j = 0; j < num_suffix_list_entries; j++)
2484 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2486 file_list[i].redefined = FALSE;
2487 file_list[i].fallback_to_default = FALSE;
2490 /* free previous dynamic artwork file array */
2491 if (artwork_info->dynamic_file_list != NULL)
2493 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2495 free(artwork_info->dynamic_file_list[i].token);
2496 free(artwork_info->dynamic_file_list[i].filename);
2497 free(artwork_info->dynamic_file_list[i].parameter);
2500 free(artwork_info->dynamic_file_list);
2501 artwork_info->dynamic_file_list = NULL;
2503 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2504 &artwork_info->num_dynamic_file_list_entries);
2507 /* free previous property mapping */
2508 if (artwork_info->property_mapping != NULL)
2510 free(artwork_info->property_mapping);
2512 artwork_info->property_mapping = NULL;
2513 artwork_info->num_property_mapping_entries = 0;
2516 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2518 /* first look for special artwork configured in level series config */
2519 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2521 if (fileExists(filename_base))
2522 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2525 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2527 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2528 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2531 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2532 struct ListNodeInfo **listnode)
2536 char *filename = (*listnode)->source_filename;
2538 if (--(*listnode)->num_references <= 0)
2539 deleteNodeFromList(&artwork_info->content_list, filename,
2540 artwork_info->free_artwork);
2546 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2547 struct ListNodeInfo **listnode,
2548 struct FileInfo *file_list_entry)
2552 "Loading graphics:",
2558 char *basename = file_list_entry->filename;
2559 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2561 if (filename == NULL)
2563 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2565 basename = file_list_entry->default_filename;
2567 /* dynamic artwork has no default filename / skip empty default artwork */
2568 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2571 file_list_entry->fallback_to_default = TRUE;
2573 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2575 filename = getCustomArtworkFilename(basename, artwork_info->type);
2577 if (filename == NULL)
2579 int error_mode = ERR_WARN;
2581 /* we can get away without sounds and music, but not without graphics */
2582 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2583 error_mode = ERR_EXIT;
2585 Error(error_mode, "cannot find default artwork file '%s'", basename);
2591 /* check if the old and the new artwork file are the same */
2592 if (*listnode && strEqual((*listnode)->source_filename, filename))
2594 /* The old and new artwork are the same (have the same filename and path).
2595 This usually means that this artwork does not exist in this artwork set
2596 and a fallback to the existing artwork is done. */
2599 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2605 /* delete existing artwork file entry */
2606 deleteArtworkListEntry(artwork_info, listnode);
2608 /* check if the new artwork file already exists in the list of artworks */
2609 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2612 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2615 *listnode = (struct ListNodeInfo *)node->content;
2616 (*listnode)->num_references++;
2621 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2622 DrawInitText(basename, 150, FC_YELLOW);
2624 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2627 printf("[adding new artwork '%s']\n", filename);
2630 (*listnode)->num_references = 1;
2631 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2636 int error_mode = ERR_WARN;
2638 /* we can get away without sounds and music, but not without graphics */
2639 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2640 error_mode = ERR_EXIT;
2642 Error(error_mode, "cannot load artwork file '%s'", basename);
2647 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2648 struct ListNodeInfo **listnode,
2649 struct FileInfo *file_list_entry)
2652 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2655 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2657 deleteArtworkListEntry(artwork_info, listnode);
2661 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2664 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2666 struct FileInfo *file_list = artwork_info->file_list;
2667 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2668 int num_file_list_entries = artwork_info->num_file_list_entries;
2669 int num_dynamic_file_list_entries =
2670 artwork_info->num_dynamic_file_list_entries;
2673 for (i = 0; i < num_file_list_entries; i++)
2674 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2677 for (i = 0; i < num_dynamic_file_list_entries; i++)
2678 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2679 &dynamic_file_list[i]);
2682 dumpList(artwork_info->content_list);
2686 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2687 struct ListNodeInfo ***list,
2688 int *num_list_entries)
2695 for (i = 0; i < *num_list_entries; i++)
2696 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2700 *num_list_entries = 0;
2703 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2705 if (artwork_info == NULL)
2708 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2709 &artwork_info->num_file_list_entries);
2711 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2712 &artwork_info->num_dynamic_file_list_entries);
2716 /* ------------------------------------------------------------------------- */
2717 /* functions only needed for non-Unix (non-command-line) systems */
2718 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2719 /* (now also added for Windows, to create files in user data directory) */
2720 /* ------------------------------------------------------------------------- */
2722 char *getErrorFilename(char *basename)
2724 return getPath2(getUserGameDataDir(), basename);
2727 void openErrorFile()
2729 InitUserDataDirectory();
2731 if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2732 fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2733 program.error_filename);
2736 void closeErrorFile()
2738 if (program.error_file != stderr) /* do not close stream 'stderr' */
2739 fclose(program.error_file);
2742 void dumpErrorFile()
2744 FILE *error_file = fopen(program.error_filename, MODE_READ);
2746 if (error_file != NULL)
2748 while (!feof(error_file))
2749 fputc(fgetc(error_file), stderr);
2755 void NotifyUserAboutErrorFile()
2757 #if defined(PLATFORM_WIN32)
2758 char *title_text = getStringCat2(program.program_title, " Error Message");
2759 char *error_text = getStringCat2("The program was aborted due to an error; "
2760 "for details, see the following error file:"
2761 STRING_NEWLINE, program.error_filename);
2763 MessageBox(NULL, error_text, title_text, MB_OK);
2768 /* ------------------------------------------------------------------------- */
2769 /* the following is only for debugging purpose and normally not used */
2770 /* ------------------------------------------------------------------------- */
2772 #define DEBUG_NUM_TIMESTAMPS 3
2774 void debug_print_timestamp(int counter_nr, char *message)
2776 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2778 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2779 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2781 counter[counter_nr][0] = Counter();
2784 printf("%s %.2f seconds\n", message,
2785 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2787 counter[counter_nr][1] = Counter();
2790 void debug_print_parent_only(char *format, ...)
2792 if (!IS_PARENT_PROCESS())
2799 va_start(ap, format);
2800 vprintf(format, ap);