1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
16 #include <sys/types.h>
24 #if !defined(PLATFORM_WIN32)
26 #include <sys/param.h>
36 /* ------------------------------------------------------------------------- */
37 /* some generic helper functions */
38 /* ------------------------------------------------------------------------- */
40 void fprintf_line(FILE *stream, char *line_string, int line_length)
44 for (i = 0; i < line_length; i++)
45 fprintf(stream, "%s", line_string);
47 fprintf(stream, "\n");
50 void printf_line(char *line_string, int line_length)
52 fprintf_line(stdout, line_string, line_length);
55 void printf_line_with_prefix(char *prefix, char *line_string, int line_length)
57 fprintf(stdout, "%s", prefix);
58 fprintf_line(stdout, line_string, line_length);
62 /* int2str() returns a number converted to a string;
63 the used memory is static, but will be overwritten by later calls,
64 so if you want to save the result, copy it to a private string buffer;
65 there can be 10 local calls of int2str() without buffering the result --
66 the 11th call will then destroy the result from the first call and so on.
69 char *int2str(int number, int size)
71 static char shift_array[10][40];
72 static int shift_counter = 0;
73 char *s = shift_array[shift_counter];
75 shift_counter = (shift_counter + 1) % 10;
82 sprintf(s, " %09d", number);
83 return &s[strlen(s) - size];
87 sprintf(s, "%d", number);
93 /* something similar to "int2str()" above, but allocates its own memory
94 and has a different interface; we cannot use "itoa()", because this
95 seems to be already defined when cross-compiling to the win32 target */
97 char *i_to_a(unsigned int i)
99 static char *a = NULL;
103 if (i > 2147483647) /* yes, this is a kludge */
106 a = checked_malloc(10 + 1);
114 /* calculate base-2 logarithm of argument (rounded down to integer;
115 this function returns the number of the highest bit set in argument) */
117 int log_2(unsigned int x)
123 x -= (1 << e); /* for rounding down (rounding up: remove this line) */
131 /* ------------------------------------------------------------------------- */
132 /* counter functions */
133 /* ------------------------------------------------------------------------- */
135 #if defined(PLATFORM_MSDOS)
136 volatile unsigned long counter = 0;
138 void increment_counter()
143 END_OF_FUNCTION(increment_counter);
147 /* maximal allowed length of a command line option */
148 #define MAX_OPTION_LEN 256
151 static unsigned long mainCounter(int mode)
153 static unsigned long base_ms = 0;
154 unsigned long current_ms;
155 unsigned long counter_ms;
157 current_ms = SDL_GetTicks();
159 /* reset base time in case of counter initializing or wrap-around */
160 if (mode == INIT_COUNTER || current_ms < base_ms)
161 base_ms = current_ms;
163 counter_ms = current_ms - base_ms;
165 return counter_ms; /* return milliseconds since last init */
168 #else /* !TARGET_SDL */
170 #if defined(PLATFORM_UNIX)
171 static unsigned long mainCounter(int mode)
173 static struct timeval base_time = { 0, 0 };
174 struct timeval current_time;
175 unsigned long counter_ms;
177 gettimeofday(¤t_time, NULL);
179 /* reset base time in case of counter initializing or wrap-around */
180 if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
181 base_time = current_time;
183 counter_ms = (current_time.tv_sec - base_time.tv_sec) * 1000
184 + (current_time.tv_usec - base_time.tv_usec) / 1000;
186 return counter_ms; /* return milliseconds since last init */
188 #endif /* PLATFORM_UNIX */
189 #endif /* !TARGET_SDL */
191 void InitCounter() /* set counter back to zero */
193 #if !defined(PLATFORM_MSDOS)
194 mainCounter(INIT_COUNTER);
196 LOCK_VARIABLE(counter);
197 LOCK_FUNCTION(increment_counter);
198 install_int_ex(increment_counter, BPS_TO_TIMER(100));
202 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
204 #if !defined(PLATFORM_MSDOS)
205 return mainCounter(READ_COUNTER);
207 return (counter * 10);
211 static void sleep_milliseconds(unsigned long milliseconds_delay)
213 boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
217 /* we want to wait only a few ms -- if we assume that we have a
218 kernel timer resolution of 10 ms, we would wait far to long;
219 therefore it's better to do a short interval of busy waiting
220 to get our sleeping time more accurate */
222 unsigned long base_counter = Counter(), actual_counter = Counter();
224 while (actual_counter < base_counter + milliseconds_delay &&
225 actual_counter >= base_counter)
226 actual_counter = Counter();
230 #if defined(TARGET_SDL)
231 SDL_Delay(milliseconds_delay);
232 #elif defined(TARGET_ALLEGRO)
233 rest(milliseconds_delay);
235 struct timeval delay;
237 delay.tv_sec = milliseconds_delay / 1000;
238 delay.tv_usec = 1000 * (milliseconds_delay % 1000);
240 if (select(0, NULL, NULL, NULL, &delay) != 0)
241 Error(ERR_WARN, "sleep_milliseconds(): select() failed");
246 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
248 sleep_milliseconds(delay);
251 boolean FrameReached(unsigned long *frame_counter_var,
252 unsigned long frame_delay)
254 unsigned long actual_frame_counter = FrameCounter;
256 if (actual_frame_counter >= *frame_counter_var &&
257 actual_frame_counter < *frame_counter_var + frame_delay)
260 *frame_counter_var = actual_frame_counter;
265 boolean DelayReached(unsigned long *counter_var,
268 unsigned long actual_counter = Counter();
270 if (actual_counter >= *counter_var &&
271 actual_counter < *counter_var + delay)
274 *counter_var = actual_counter;
279 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
281 unsigned long actual_counter;
285 actual_counter = Counter();
287 if (actual_counter >= *counter_var &&
288 actual_counter < *counter_var + delay)
289 sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
294 *counter_var = actual_counter;
298 /* ------------------------------------------------------------------------- */
299 /* random generator functions */
300 /* ------------------------------------------------------------------------- */
302 unsigned int init_random_number(int nr, long seed)
304 if (seed == NEW_RANDOMIZE)
306 #if defined(TARGET_SDL)
307 seed = (long)SDL_GetTicks();
309 struct timeval current_time;
311 gettimeofday(¤t_time, NULL);
312 seed = (long)current_time.tv_usec;
316 srandom_linux_libc(nr, (unsigned int) seed);
318 return (unsigned int) seed;
321 unsigned int get_random_number(int nr, int max)
323 return (max > 0 ? random_linux_libc(nr) % max : 0);
327 /* ------------------------------------------------------------------------- */
328 /* system info functions */
329 /* ------------------------------------------------------------------------- */
331 #if !defined(PLATFORM_MSDOS)
332 static char *get_corrected_real_name(char *real_name)
334 char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
335 char *from_ptr = real_name;
336 char *to_ptr = real_name_new;
338 /* copy the name string, but not more than MAX_USERNAME_LEN characters */
339 while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
341 /* the name field read from "passwd" file may also contain additional
342 user information, separated by commas, which will be removed here */
343 if (*from_ptr == ',')
346 /* the user's real name may contain 'ß' characters (german sharp s),
347 which have no equivalent in upper case letters (used by our fonts) */
348 if (*from_ptr == 'ß')
355 *to_ptr++ = *from_ptr++;
360 return real_name_new;
366 static char *login_name = NULL;
368 #if defined(PLATFORM_WIN32)
369 if (login_name == NULL)
371 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
372 login_name = checked_malloc(buffer_size);
374 if (GetUserName(login_name, &buffer_size) == 0)
375 strcpy(login_name, ANONYMOUS_NAME);
378 if (login_name == NULL)
382 if ((pwd = getpwuid(getuid())) == NULL)
383 login_name = ANONYMOUS_NAME;
385 login_name = getStringCopy(pwd->pw_name);
394 static char *real_name = NULL;
396 #if defined(PLATFORM_WIN32)
397 if (real_name == NULL)
399 static char buffer[MAX_USERNAME_LEN + 1];
400 unsigned long buffer_size = MAX_USERNAME_LEN + 1;
402 if (GetUserName(buffer, &buffer_size) != 0)
403 real_name = get_corrected_real_name(buffer);
405 real_name = ANONYMOUS_NAME;
407 #elif defined(PLATFORM_UNIX)
408 if (real_name == NULL)
412 if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
413 real_name = get_corrected_real_name(pwd->pw_gecos);
415 real_name = ANONYMOUS_NAME;
418 real_name = ANONYMOUS_NAME;
426 static char *dir = NULL;
428 #if defined(PLATFORM_WIN32)
431 dir = checked_malloc(MAX_PATH + 1);
433 if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
436 #elif defined(PLATFORM_UNIX)
439 if ((dir = getenv("HOME")) == NULL)
443 if ((pwd = getpwuid(getuid())) != NULL)
444 dir = getStringCopy(pwd->pw_dir);
457 /* ------------------------------------------------------------------------- */
458 /* path manipulation functions */
459 /* ------------------------------------------------------------------------- */
461 static char *getLastPathSeparatorPtr(char *filename)
463 char *last_separator = strrchr(filename, '/');
465 #if !defined(PLATFORM_UNIX)
466 if (last_separator == NULL) /* also try DOS/Windows variant */
467 last_separator = strrchr(filename, '\\');
470 return last_separator;
473 static 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 *getPath2(char *path1, char *path2)
508 char *complete_path = checked_malloc(strlen(path1) + 1 +
511 sprintf(complete_path, "%s/%s", path1, path2);
513 return complete_path;
516 char *getPath3(char *path1, char *path2, char *path3)
518 char *complete_path = checked_malloc(strlen(path1) + 1 +
522 sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
524 return complete_path;
527 char *getStringCat2(char *s1, char *s2)
529 char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
531 sprintf(complete_string, "%s%s", s1, s2);
533 return complete_string;
536 char *getStringCopy(char *s)
543 s_copy = checked_malloc(strlen(s) + 1);
549 char *getStringToLower(char *s)
551 char *s_copy = checked_malloc(strlen(s) + 1);
552 char *s_ptr = s_copy;
555 *s_ptr++ = tolower(*s++);
561 void setString(char **old_value, char *new_value)
563 checked_free(*old_value);
565 *old_value = getStringCopy(new_value);
568 boolean strEqual(char *s1, char *s2)
570 return (s1 == NULL && s2 == NULL ? TRUE :
571 s1 == NULL && s2 != NULL ? FALSE :
572 s1 != NULL && s2 == NULL ? FALSE :
573 strcmp(s1, s2) == 0);
577 /* ------------------------------------------------------------------------- */
578 /* command line option handling functions */
579 /* ------------------------------------------------------------------------- */
581 void GetOptions(char *argv[], void (*print_usage_function)(void))
583 char *ro_base_path = RO_BASE_PATH;
584 char *rw_base_path = RW_BASE_PATH;
585 char **options_left = &argv[1];
587 #if !defined(PLATFORM_MACOSX)
588 /* if the program is configured to start from current directory (default),
589 determine program package directory (KDE/Konqueror does not do this by
590 itself and fails otherwise); on Mac OS X, the program binary is stored
591 in an application package directory -- do not try to use this directory
592 as the program data directory (Mac OS X handles this correctly anyway) */
594 if (strEqual(ro_base_path, "."))
595 ro_base_path = program.command_basepath;
596 if (strEqual(rw_base_path, "."))
597 rw_base_path = program.command_basepath;
600 /* initialize global program options */
601 options.display_name = NULL;
602 options.server_host = NULL;
603 options.server_port = 0;
604 options.ro_base_directory = ro_base_path;
605 options.rw_base_directory = rw_base_path;
606 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
607 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
608 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
609 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
610 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
611 options.execute_command = NULL;
612 options.serveronly = FALSE;
613 options.network = FALSE;
614 options.verbose = FALSE;
615 options.debug = FALSE;
617 #if !defined(PLATFORM_UNIX)
618 if (*options_left == NULL) /* no options given -- enable verbose mode */
619 options.verbose = TRUE;
622 while (*options_left)
624 char option_str[MAX_OPTION_LEN];
625 char *option = options_left[0];
626 char *next_option = options_left[1];
627 char *option_arg = NULL;
628 int option_len = strlen(option);
630 if (option_len >= MAX_OPTION_LEN)
631 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
633 strcpy(option_str, option); /* copy argument into buffer */
636 if (strEqual(option, "--")) /* stop scanning arguments */
639 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
642 option_arg = strchr(option, '=');
643 if (option_arg == NULL) /* no '=' in option */
644 option_arg = next_option;
647 *option_arg++ = '\0'; /* cut argument from option */
648 if (*option_arg == '\0') /* no argument after '=' */
649 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
652 option_len = strlen(option);
654 if (strEqual(option, "-"))
655 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
656 else if (strncmp(option, "-help", option_len) == 0)
658 print_usage_function();
662 else if (strncmp(option, "-display", option_len) == 0)
664 if (option_arg == NULL)
665 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
667 options.display_name = option_arg;
668 if (option_arg == next_option)
671 else if (strncmp(option, "-basepath", option_len) == 0)
673 if (option_arg == NULL)
674 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
676 /* this should be extended to separate options for ro and rw data */
677 options.ro_base_directory = ro_base_path = option_arg;
678 options.rw_base_directory = rw_base_path = option_arg;
679 if (option_arg == next_option)
682 /* adjust paths for sub-directories in base directory accordingly */
683 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
684 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
685 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
686 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
687 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
689 else if (strncmp(option, "-levels", option_len) == 0)
691 if (option_arg == NULL)
692 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
694 options.level_directory = option_arg;
695 if (option_arg == next_option)
698 else if (strncmp(option, "-graphics", option_len) == 0)
700 if (option_arg == NULL)
701 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
703 options.graphics_directory = option_arg;
704 if (option_arg == next_option)
707 else if (strncmp(option, "-sounds", option_len) == 0)
709 if (option_arg == NULL)
710 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
712 options.sounds_directory = option_arg;
713 if (option_arg == next_option)
716 else if (strncmp(option, "-music", option_len) == 0)
718 if (option_arg == NULL)
719 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
721 options.music_directory = option_arg;
722 if (option_arg == next_option)
725 else if (strncmp(option, "-network", option_len) == 0)
727 options.network = TRUE;
729 else if (strncmp(option, "-serveronly", option_len) == 0)
731 options.serveronly = TRUE;
733 else if (strncmp(option, "-verbose", option_len) == 0)
735 options.verbose = TRUE;
737 else if (strncmp(option, "-debug", option_len) == 0)
739 options.debug = TRUE;
741 else if (strncmp(option, "-execute", option_len) == 0)
743 if (option_arg == NULL)
744 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
746 options.execute_command = option_arg;
747 if (option_arg == next_option)
750 /* when doing batch processing, always enable verbose mode (warnings) */
751 options.verbose = TRUE;
753 else if (*option == '-')
755 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
757 else if (options.server_host == NULL)
759 options.server_host = *options_left;
761 else if (options.server_port == 0)
763 options.server_port = atoi(*options_left);
764 if (options.server_port < 1024)
765 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
768 Error(ERR_EXIT_HELP, "too many arguments");
775 /* ------------------------------------------------------------------------- */
776 /* error handling functions */
777 /* ------------------------------------------------------------------------- */
779 /* used by SetError() and GetError() to store internal error messages */
780 static char internal_error[1024]; /* this is bad */
782 void SetError(char *format, ...)
786 va_start(ap, format);
787 vsprintf(internal_error, format, ap);
793 return internal_error;
796 void Error(int mode, char *format, ...)
798 static boolean last_line_was_separator = FALSE;
799 char *process_name = "";
800 FILE *error = stderr;
801 char *newline = "\n";
803 /* display warnings only when running in verbose mode */
804 if (mode & ERR_WARN && !options.verbose)
807 if (mode == ERR_RETURN_LINE)
809 if (!last_line_was_separator)
810 fprintf_line(error, format, 79);
812 last_line_was_separator = TRUE;
817 last_line_was_separator = FALSE;
819 #if defined(PLATFORM_MSDOS)
822 if ((error = openErrorFile()) == NULL)
824 printf("Cannot write to error output file!%s", newline);
825 program.exit_function(1);
829 if (mode & ERR_SOUND_SERVER)
830 process_name = " sound server";
831 else if (mode & ERR_NETWORK_SERVER)
832 process_name = " network server";
833 else if (mode & ERR_NETWORK_CLIENT)
834 process_name = " network client **";
840 fprintf(error, "%s%s: ", program.command_basename, process_name);
843 fprintf(error, "warning: ");
845 va_start(ap, format);
846 vfprintf(error, format, ap);
849 fprintf(error, "%s", newline);
853 fprintf(error, "%s: Try option '--help' for more information.%s",
854 program.command_basename, newline);
857 fprintf(error, "%s%s: aborting%s",
858 program.command_basename, process_name, newline);
865 if (mode & ERR_FROM_SERVER)
866 exit(1); /* child process: normal exit */
868 program.exit_function(1); /* main process: clean up stuff */
873 /* ------------------------------------------------------------------------- */
874 /* checked memory allocation and freeing functions */
875 /* ------------------------------------------------------------------------- */
877 void *checked_malloc(unsigned long size)
884 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
889 void *checked_calloc(unsigned long size)
893 ptr = calloc(1, size);
896 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
901 void *checked_realloc(void *ptr, unsigned long size)
903 ptr = realloc(ptr, size);
906 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
911 void checked_free(void *ptr)
913 if (ptr != NULL) /* this check should be done by free() anyway */
918 /* ------------------------------------------------------------------------- */
919 /* various helper functions */
920 /* ------------------------------------------------------------------------- */
922 inline void swap_numbers(int *i1, int *i2)
930 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
942 /* the "put" variants of the following file access functions check for the file
943 pointer being != NULL and return the number of bytes they have or would have
944 written; this allows for chunk writing functions to first determine the size
945 of the (not yet written) chunk, write the correct chunk size and finally
946 write the chunk itself */
948 int getFile8BitInteger(FILE *file)
953 int putFile8BitInteger(FILE *file, int value)
961 int getFile16BitInteger(FILE *file, int byte_order)
963 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
964 return ((fgetc(file) << 8) |
966 else /* BYTE_ORDER_LITTLE_ENDIAN */
967 return ((fgetc(file) << 0) |
971 int putFile16BitInteger(FILE *file, int value, int byte_order)
975 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
977 fputc((value >> 8) & 0xff, file);
978 fputc((value >> 0) & 0xff, file);
980 else /* BYTE_ORDER_LITTLE_ENDIAN */
982 fputc((value >> 0) & 0xff, file);
983 fputc((value >> 8) & 0xff, file);
990 int getFile32BitInteger(FILE *file, int byte_order)
992 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
993 return ((fgetc(file) << 24) |
994 (fgetc(file) << 16) |
997 else /* BYTE_ORDER_LITTLE_ENDIAN */
998 return ((fgetc(file) << 0) |
1000 (fgetc(file) << 16) |
1001 (fgetc(file) << 24));
1004 int putFile32BitInteger(FILE *file, int value, int byte_order)
1008 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1010 fputc((value >> 24) & 0xff, file);
1011 fputc((value >> 16) & 0xff, file);
1012 fputc((value >> 8) & 0xff, file);
1013 fputc((value >> 0) & 0xff, file);
1015 else /* BYTE_ORDER_LITTLE_ENDIAN */
1017 fputc((value >> 0) & 0xff, file);
1018 fputc((value >> 8) & 0xff, file);
1019 fputc((value >> 16) & 0xff, file);
1020 fputc((value >> 24) & 0xff, file);
1027 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1030 const int chunk_name_length = 4;
1032 /* read chunk name */
1033 fgets(chunk_name, chunk_name_length + 1, file);
1035 if (chunk_size != NULL)
1037 /* read chunk size */
1038 *chunk_size = getFile32BitInteger(file, byte_order);
1041 return (feof(file) || ferror(file) ? FALSE : TRUE);
1044 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1049 /* write chunk name */
1051 fputs(chunk_name, file);
1053 num_bytes += strlen(chunk_name);
1055 if (chunk_size >= 0)
1057 /* write chunk size */
1059 putFile32BitInteger(file, chunk_size, byte_order);
1067 int getFileVersion(FILE *file)
1069 int version_major = fgetc(file);
1070 int version_minor = fgetc(file);
1071 int version_patch = fgetc(file);
1072 int version_build = fgetc(file);
1074 return VERSION_IDENT(version_major, version_minor, version_patch,
1078 int putFileVersion(FILE *file, int version)
1082 int version_major = VERSION_MAJOR(version);
1083 int version_minor = VERSION_MINOR(version);
1084 int version_patch = VERSION_PATCH(version);
1085 int version_build = VERSION_BUILD(version);
1087 fputc(version_major, file);
1088 fputc(version_minor, file);
1089 fputc(version_patch, file);
1090 fputc(version_build, file);
1096 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1100 for(i = 0; i < bytes && !feof(file); i++)
1101 buffer[i] = fgetc(file);
1104 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1108 for(i = 0; i < bytes; i++)
1109 fputc(buffer[i], file);
1112 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1114 while (bytes-- && !feof(file))
1118 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1125 /* ------------------------------------------------------------------------- */
1126 /* functions to translate key identifiers between different format */
1127 /* ------------------------------------------------------------------------- */
1129 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1130 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1131 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1132 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1134 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1143 /* normal cursor keys */
1144 { KSYM_Left, "XK_Left", "cursor left" },
1145 { KSYM_Right, "XK_Right", "cursor right" },
1146 { KSYM_Up, "XK_Up", "cursor up" },
1147 { KSYM_Down, "XK_Down", "cursor down" },
1149 /* keypad cursor keys */
1151 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1152 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1153 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1154 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1157 /* other keypad keys */
1158 #ifdef KSYM_KP_Enter
1159 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1160 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1161 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1162 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1163 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1164 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1168 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1169 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1170 { KSYM_Control_L, "XK_Control_L", "left control" },
1171 { KSYM_Control_R, "XK_Control_R", "right control" },
1172 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1173 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1174 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1175 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1176 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1177 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1178 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1179 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1181 /* some special keys */
1182 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1183 { KSYM_Delete, "XK_Delete", "delete" },
1184 { KSYM_Insert, "XK_Insert", "insert" },
1185 { KSYM_Tab, "XK_Tab", "tab" },
1186 { KSYM_Home, "XK_Home", "home" },
1187 { KSYM_End, "XK_End", "end" },
1188 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1189 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1190 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1192 /* ASCII 0x20 to 0x40 keys (except numbers) */
1193 { KSYM_space, "XK_space", "space" },
1194 { KSYM_exclam, "XK_exclam", "!" },
1195 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1196 { KSYM_numbersign, "XK_numbersign", "#" },
1197 { KSYM_dollar, "XK_dollar", "$" },
1198 { KSYM_percent, "XK_percent", "%" },
1199 { KSYM_ampersand, "XK_ampersand", "&" },
1200 { KSYM_apostrophe, "XK_apostrophe", "'" },
1201 { KSYM_parenleft, "XK_parenleft", "(" },
1202 { KSYM_parenright, "XK_parenright", ")" },
1203 { KSYM_asterisk, "XK_asterisk", "*" },
1204 { KSYM_plus, "XK_plus", "+" },
1205 { KSYM_comma, "XK_comma", "," },
1206 { KSYM_minus, "XK_minus", "-" },
1207 { KSYM_period, "XK_period", "." },
1208 { KSYM_slash, "XK_slash", "/" },
1209 { KSYM_colon, "XK_colon", ":" },
1210 { KSYM_semicolon, "XK_semicolon", ";" },
1211 { KSYM_less, "XK_less", "<" },
1212 { KSYM_equal, "XK_equal", "=" },
1213 { KSYM_greater, "XK_greater", ">" },
1214 { KSYM_question, "XK_question", "?" },
1215 { KSYM_at, "XK_at", "@" },
1217 /* more ASCII keys */
1218 { KSYM_bracketleft, "XK_bracketleft", "[" },
1219 { KSYM_backslash, "XK_backslash", "\\" },
1220 { KSYM_bracketright,"XK_bracketright", "]" },
1221 { KSYM_asciicircum, "XK_asciicircum", "^" },
1222 { KSYM_underscore, "XK_underscore", "_" },
1223 { KSYM_grave, "XK_grave", "grave" },
1224 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1225 { KSYM_braceleft, "XK_braceleft", "brace left" },
1226 { KSYM_bar, "XK_bar", "bar" },
1227 { KSYM_braceright, "XK_braceright", "brace right" },
1228 { KSYM_asciitilde, "XK_asciitilde", "~" },
1230 /* special (non-ASCII) keys */
1231 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1232 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1233 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1234 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1235 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1236 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1237 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1239 /* end-of-array identifier */
1245 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1247 static char name_buffer[30];
1250 if (key >= KSYM_A && key <= KSYM_Z)
1251 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1252 else if (key >= KSYM_a && key <= KSYM_z)
1253 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1254 else if (key >= KSYM_0 && key <= KSYM_9)
1255 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1256 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1257 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1259 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1260 sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1262 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1263 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1265 else if (key == KSYM_UNDEFINED)
1266 strcpy(name_buffer, "(undefined)");
1273 if (key == translate_key[i].key)
1275 strcpy(name_buffer, translate_key[i].name);
1279 while (translate_key[++i].name);
1281 if (!translate_key[i].name)
1282 strcpy(name_buffer, "(unknown)");
1285 *name = name_buffer;
1287 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1289 static char name_buffer[30];
1292 if (key >= KSYM_A && key <= KSYM_Z)
1293 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1294 else if (key >= KSYM_a && key <= KSYM_z)
1295 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1296 else if (key >= KSYM_0 && key <= KSYM_9)
1297 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1298 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1299 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1300 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1301 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1302 else if (key == KSYM_UNDEFINED)
1303 strcpy(name_buffer, "[undefined]");
1310 if (key == translate_key[i].key)
1312 strcpy(name_buffer, translate_key[i].x11name);
1316 while (translate_key[++i].x11name);
1318 if (!translate_key[i].x11name)
1319 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1322 *x11name = name_buffer;
1324 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1326 Key key = KSYM_UNDEFINED;
1331 if (strEqual(translate_key[i].name, *name))
1333 key = translate_key[i].key;
1337 while (translate_key[++i].x11name);
1339 if (key == KSYM_UNDEFINED)
1340 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1344 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1346 Key key = KSYM_UNDEFINED;
1347 char *name_ptr = *x11name;
1349 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1351 char c = name_ptr[3];
1353 if (c >= 'A' && c <= 'Z')
1354 key = KSYM_A + (Key)(c - 'A');
1355 else if (c >= 'a' && c <= 'z')
1356 key = KSYM_a + (Key)(c - 'a');
1357 else if (c >= '0' && c <= '9')
1358 key = KSYM_0 + (Key)(c - '0');
1360 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1362 char c = name_ptr[6];
1364 if (c >= '0' && c <= '9')
1365 key = KSYM_KP_0 + (Key)(c - '0');
1367 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1369 char c1 = name_ptr[4];
1370 char c2 = name_ptr[5];
1373 if ((c1 >= '0' && c1 <= '9') &&
1374 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1375 d = atoi(&name_ptr[4]);
1377 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1378 key = KSYM_F1 + (Key)(d - 1);
1380 else if (strncmp(name_ptr, "XK_", 3) == 0)
1386 if (strEqual(name_ptr, translate_key[i].x11name))
1388 key = translate_key[i].key;
1392 while (translate_key[++i].x11name);
1394 else if (strncmp(name_ptr, "0x", 2) == 0)
1396 unsigned long value = 0;
1402 char c = *name_ptr++;
1405 if (c >= '0' && c <= '9')
1407 else if (c >= 'a' && c <= 'f')
1408 d = (int)(c - 'a' + 10);
1409 else if (c >= 'A' && c <= 'F')
1410 d = (int)(c - 'A' + 10);
1418 value = value * 16 + d;
1429 char *getKeyNameFromKey(Key key)
1433 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1437 char *getX11KeyNameFromKey(Key key)
1441 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1445 Key getKeyFromKeyName(char *name)
1449 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1453 Key getKeyFromX11KeyName(char *x11name)
1457 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1461 char getCharFromKey(Key key)
1463 char *keyname = getKeyNameFromKey(key);
1466 if (strlen(keyname) == 1)
1467 letter = keyname[0];
1468 else if (strEqual(keyname, "space"))
1470 else if (strEqual(keyname, "circumflex"))
1477 /* ------------------------------------------------------------------------- */
1478 /* functions to translate string identifiers to integer or boolean value */
1479 /* ------------------------------------------------------------------------- */
1481 int get_integer_from_string(char *s)
1483 static char *number_text[][3] =
1485 { "0", "zero", "null", },
1486 { "1", "one", "first" },
1487 { "2", "two", "second" },
1488 { "3", "three", "third" },
1489 { "4", "four", "fourth" },
1490 { "5", "five", "fifth" },
1491 { "6", "six", "sixth" },
1492 { "7", "seven", "seventh" },
1493 { "8", "eight", "eighth" },
1494 { "9", "nine", "ninth" },
1495 { "10", "ten", "tenth" },
1496 { "11", "eleven", "eleventh" },
1497 { "12", "twelve", "twelfth" },
1499 { NULL, NULL, NULL },
1503 char *s_lower = getStringToLower(s);
1506 for (i = 0; number_text[i][0] != NULL; i++)
1507 for (j = 0; j < 3; j++)
1508 if (strEqual(s_lower, number_text[i][j]))
1513 if (strEqual(s_lower, "false"))
1515 else if (strEqual(s_lower, "true"))
1526 boolean get_boolean_from_string(char *s)
1528 char *s_lower = getStringToLower(s);
1529 boolean result = FALSE;
1531 if (strEqual(s_lower, "true") ||
1532 strEqual(s_lower, "yes") ||
1533 strEqual(s_lower, "on") ||
1534 get_integer_from_string(s) == 1)
1543 /* ------------------------------------------------------------------------- */
1544 /* functions for generic lists */
1545 /* ------------------------------------------------------------------------- */
1547 ListNode *newListNode()
1549 return checked_calloc(sizeof(ListNode));
1552 void addNodeToList(ListNode **node_first, char *key, void *content)
1554 ListNode *node_new = newListNode();
1556 node_new->key = getStringCopy(key);
1557 node_new->content = content;
1558 node_new->next = *node_first;
1559 *node_first = node_new;
1562 void deleteNodeFromList(ListNode **node_first, char *key,
1563 void (*destructor_function)(void *))
1565 if (node_first == NULL || *node_first == NULL)
1568 if (strEqual((*node_first)->key, key))
1570 free((*node_first)->key);
1571 if (destructor_function)
1572 destructor_function((*node_first)->content);
1573 *node_first = (*node_first)->next;
1576 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1579 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1581 if (node_first == NULL)
1584 if (strEqual(node_first->key, key))
1587 return getNodeFromKey(node_first->next, key);
1590 int getNumNodes(ListNode *node_first)
1592 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1595 void dumpList(ListNode *node_first)
1597 ListNode *node = node_first;
1601 printf("['%s' (%d)]\n", node->key,
1602 ((struct ListNodeInfo *)node->content)->num_references);
1606 printf("[%d nodes]\n", getNumNodes(node_first));
1610 /* ------------------------------------------------------------------------- */
1611 /* functions for checking files and filenames */
1612 /* ------------------------------------------------------------------------- */
1614 boolean fileExists(char *filename)
1616 if (filename == NULL)
1619 return (access(filename, F_OK) == 0);
1622 boolean fileHasPrefix(char *basename, char *prefix)
1624 static char *basename_lower = NULL;
1625 int basename_length, prefix_length;
1627 checked_free(basename_lower);
1629 if (basename == NULL || prefix == NULL)
1632 basename_lower = getStringToLower(basename);
1633 basename_length = strlen(basename_lower);
1634 prefix_length = strlen(prefix);
1636 if (basename_length > prefix_length + 1 &&
1637 basename_lower[prefix_length] == '.' &&
1638 strncmp(basename_lower, prefix, prefix_length) == 0)
1644 boolean fileHasSuffix(char *basename, char *suffix)
1646 static char *basename_lower = NULL;
1647 int basename_length, suffix_length;
1649 checked_free(basename_lower);
1651 if (basename == NULL || suffix == NULL)
1654 basename_lower = getStringToLower(basename);
1655 basename_length = strlen(basename_lower);
1656 suffix_length = strlen(suffix);
1658 if (basename_length > suffix_length + 1 &&
1659 basename_lower[basename_length - suffix_length - 1] == '.' &&
1660 strEqual(&basename_lower[basename_length - suffix_length], suffix))
1666 boolean FileIsGraphic(char *filename)
1668 char *basename = getBaseNamePtr(filename);
1670 return fileHasSuffix(basename, "pcx");
1673 boolean FileIsSound(char *filename)
1675 char *basename = getBaseNamePtr(filename);
1677 return fileHasSuffix(basename, "wav");
1680 boolean FileIsMusic(char *filename)
1682 char *basename = getBaseNamePtr(filename);
1684 if (FileIsSound(basename))
1687 #if defined(TARGET_SDL)
1688 if (fileHasPrefix(basename, "mod") ||
1689 fileHasSuffix(basename, "mod") ||
1690 fileHasSuffix(basename, "s3m") ||
1691 fileHasSuffix(basename, "it") ||
1692 fileHasSuffix(basename, "xm") ||
1693 fileHasSuffix(basename, "midi") ||
1694 fileHasSuffix(basename, "mid") ||
1695 fileHasSuffix(basename, "mp3") ||
1696 fileHasSuffix(basename, "ogg"))
1703 boolean FileIsArtworkType(char *basename, int type)
1705 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1706 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1707 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1713 /* ------------------------------------------------------------------------- */
1714 /* functions for loading artwork configuration information */
1715 /* ------------------------------------------------------------------------- */
1717 char *get_mapped_token(char *token)
1719 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1720 static char *map_token_prefix[][2] =
1722 { "char_procent", "char_percent" },
1727 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1729 int len_token_prefix = strlen(map_token_prefix[i][0]);
1731 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1732 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1738 /* This function checks if a string <s> of the format "string1, string2, ..."
1739 exactly contains a string <s_contained>. */
1741 static boolean string_has_parameter(char *s, char *s_contained)
1745 if (s == NULL || s_contained == NULL)
1748 if (strlen(s_contained) > strlen(s))
1751 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1753 char next_char = s[strlen(s_contained)];
1755 /* check if next character is delimiter or whitespace */
1756 return (next_char == ',' || next_char == '\0' ||
1757 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1760 /* check if string contains another parameter string after a comma */
1761 substring = strchr(s, ',');
1762 if (substring == NULL) /* string does not contain a comma */
1765 /* advance string pointer to next character after the comma */
1768 /* skip potential whitespaces after the comma */
1769 while (*substring == ' ' || *substring == '\t')
1772 return string_has_parameter(substring, s_contained);
1775 int get_parameter_value(char *value_raw, char *suffix, int type)
1777 char *value = getStringToLower(value_raw);
1778 int result = 0; /* probably a save default value */
1780 if (strEqual(suffix, ".direction"))
1782 result = (strEqual(value, "left") ? MV_LEFT :
1783 strEqual(value, "right") ? MV_RIGHT :
1784 strEqual(value, "up") ? MV_UP :
1785 strEqual(value, "down") ? MV_DOWN : MV_NONE);
1787 else if (strEqual(suffix, ".anim_mode"))
1789 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1790 string_has_parameter(value, "loop") ? ANIM_LOOP :
1791 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1792 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1793 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1794 string_has_parameter(value, "random") ? ANIM_RANDOM :
1795 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1796 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1797 string_has_parameter(value, "ce_delay") ? ANIM_CE_DELAY :
1798 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1799 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1802 if (string_has_parameter(value, "reverse"))
1803 result |= ANIM_REVERSE;
1805 if (string_has_parameter(value, "opaque_player"))
1806 result |= ANIM_OPAQUE_PLAYER;
1808 if (string_has_parameter(value, "static_panel"))
1809 result |= ANIM_STATIC_PANEL;
1811 else /* generic parameter of type integer or boolean */
1813 result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1814 type == TYPE_INTEGER ? get_integer_from_string(value) :
1815 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1816 ARG_UNDEFINED_VALUE);
1824 int get_auto_parameter_value(char *token, char *value_raw)
1828 if (token == NULL || value_raw == NULL)
1829 return ARG_UNDEFINED_VALUE;
1831 suffix = strrchr(token, '.');
1835 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
1838 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1839 struct ListNodeInfo ***, int *);
1841 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1842 struct ConfigTypeInfo *suffix_list,
1843 char **ignore_tokens,
1844 int num_file_list_entries)
1846 struct FileInfo *file_list;
1847 int num_file_list_entries_found = 0;
1848 int num_suffix_list_entries = 0;
1852 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1854 for (i = 0; suffix_list[i].token != NULL; i++)
1855 num_suffix_list_entries++;
1857 /* always start with reliable default values */
1858 for (i = 0; i < num_file_list_entries; i++)
1860 file_list[i].token = NULL;
1862 file_list[i].default_filename = NULL;
1863 file_list[i].filename = NULL;
1865 if (num_suffix_list_entries > 0)
1867 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1869 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1870 file_list[i].parameter = checked_calloc(parameter_array_size);
1872 for (j = 0; j < num_suffix_list_entries; j++)
1874 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1875 setString(&file_list[i].parameter[j], suffix_list[j].value);
1878 file_list[i].redefined = FALSE;
1879 file_list[i].fallback_to_default = FALSE;
1884 for (i = 0; config_list[i].token != NULL; i++)
1886 int len_config_token = strlen(config_list[i].token);
1887 int len_config_value = strlen(config_list[i].value);
1888 boolean is_file_entry = TRUE;
1890 for (j = 0; suffix_list[j].token != NULL; j++)
1892 int len_suffix = strlen(suffix_list[j].token);
1894 if (len_suffix < len_config_token &&
1895 strEqual(&config_list[i].token[len_config_token - len_suffix],
1896 suffix_list[j].token))
1898 setString(&file_list[list_pos].default_parameter[j],
1899 config_list[i].value);
1901 is_file_entry = FALSE;
1906 /* the following tokens are no file definitions, but other config tokens */
1907 for (j = 0; ignore_tokens[j] != NULL; j++)
1908 if (strEqual(config_list[i].token, ignore_tokens[j]))
1909 is_file_entry = FALSE;
1916 if (list_pos >= num_file_list_entries)
1919 /* simple sanity check if this is really a file definition */
1920 if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
1921 !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
1922 !strEqual(config_list[i].value, UNDEFINED_FILENAME))
1924 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1925 config_list[i].token, config_list[i].value);
1926 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1929 file_list[list_pos].token = config_list[i].token;
1930 file_list[list_pos].default_filename = config_list[i].value;
1934 num_file_list_entries_found = list_pos + 1;
1935 if (num_file_list_entries_found != num_file_list_entries)
1937 Error(ERR_RETURN_LINE, "-");
1938 Error(ERR_RETURN, "inconsistant config list information:");
1939 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1940 num_file_list_entries);
1941 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1942 num_file_list_entries_found);
1943 Error(ERR_EXIT, "please fix");
1949 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1951 int len_token = strlen(token);
1952 int len_suffix = strlen(suffix);
1954 if (start_pos < 0) /* compare suffix from end of string */
1955 start_pos += len_token;
1957 if (start_pos < 0 || start_pos + len_suffix > len_token)
1960 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1963 if (token[start_pos + len_suffix] == '\0')
1966 if (token[start_pos + len_suffix] == '.')
1972 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1974 static void read_token_parameters(SetupFileHash *setup_file_hash,
1975 struct ConfigTypeInfo *suffix_list,
1976 struct FileInfo *file_list_entry)
1978 /* check for config token that is the base token without any suffixes */
1979 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1980 char *known_token_value = KNOWN_TOKEN_VALUE;
1983 if (filename != NULL)
1985 setString(&file_list_entry->filename, filename);
1987 /* when file definition found, set all parameters to default values */
1988 for (i = 0; suffix_list[i].token != NULL; i++)
1989 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1991 file_list_entry->redefined = TRUE;
1993 /* mark config file token as well known from default config */
1994 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1997 /* check for config tokens that can be build by base token and suffixes */
1998 for (i = 0; suffix_list[i].token != NULL; i++)
2000 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2001 char *value = getHashEntry(setup_file_hash, token);
2005 setString(&file_list_entry->parameter[i], value);
2007 /* mark config file token as well known from default config */
2008 setHashEntry(setup_file_hash, token, known_token_value);
2015 static void add_dynamic_file_list_entry(struct FileInfo **list,
2016 int *num_list_entries,
2017 SetupFileHash *extra_file_hash,
2018 struct ConfigTypeInfo *suffix_list,
2019 int num_suffix_list_entries,
2022 struct FileInfo *new_list_entry;
2023 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2025 (*num_list_entries)++;
2026 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2027 new_list_entry = &(*list)[*num_list_entries - 1];
2029 new_list_entry->token = getStringCopy(token);
2030 new_list_entry->default_filename = NULL;
2031 new_list_entry->filename = NULL;
2032 new_list_entry->parameter = checked_calloc(parameter_array_size);
2034 new_list_entry->redefined = FALSE;
2035 new_list_entry->fallback_to_default = FALSE;
2037 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2040 static void add_property_mapping(struct PropertyMapping **list,
2041 int *num_list_entries,
2042 int base_index, int ext1_index,
2043 int ext2_index, int ext3_index,
2046 struct PropertyMapping *new_list_entry;
2048 (*num_list_entries)++;
2049 *list = checked_realloc(*list,
2050 *num_list_entries * sizeof(struct PropertyMapping));
2051 new_list_entry = &(*list)[*num_list_entries - 1];
2053 new_list_entry->base_index = base_index;
2054 new_list_entry->ext1_index = ext1_index;
2055 new_list_entry->ext2_index = ext2_index;
2056 new_list_entry->ext3_index = ext3_index;
2058 new_list_entry->artwork_index = artwork_index;
2061 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2064 struct FileInfo *file_list = artwork_info->file_list;
2065 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2066 char **base_prefixes = artwork_info->base_prefixes;
2067 char **ext1_suffixes = artwork_info->ext1_suffixes;
2068 char **ext2_suffixes = artwork_info->ext2_suffixes;
2069 char **ext3_suffixes = artwork_info->ext3_suffixes;
2070 char **ignore_tokens = artwork_info->ignore_tokens;
2071 int num_file_list_entries = artwork_info->num_file_list_entries;
2072 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2073 int num_base_prefixes = artwork_info->num_base_prefixes;
2074 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2075 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2076 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2077 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2078 SetupFileHash *setup_file_hash, *valid_file_hash;
2079 SetupFileHash *extra_file_hash, *empty_file_hash;
2080 char *known_token_value = KNOWN_TOKEN_VALUE;
2083 if (filename == NULL)
2087 printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2090 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2093 /* separate valid (defined) from empty (undefined) config token values */
2094 valid_file_hash = newSetupFileHash();
2095 empty_file_hash = newSetupFileHash();
2096 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2098 char *value = HASH_ITERATION_VALUE(itr);
2100 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2101 HASH_ITERATION_TOKEN(itr), value);
2103 END_HASH_ITERATION(setup_file_hash, itr)
2105 /* at this point, we do not need the setup file hash anymore -- free it */
2106 freeSetupFileHash(setup_file_hash);
2108 /* map deprecated to current tokens (using prefix match and replace) */
2109 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2111 char *token = HASH_ITERATION_TOKEN(itr);
2112 char *mapped_token = get_mapped_token(token);
2114 if (mapped_token != NULL)
2116 char *value = HASH_ITERATION_VALUE(itr);
2118 /* add mapped token */
2119 setHashEntry(valid_file_hash, mapped_token, value);
2121 /* ignore old token (by setting it to "known" keyword) */
2122 setHashEntry(valid_file_hash, token, known_token_value);
2127 END_HASH_ITERATION(valid_file_hash, itr)
2129 /* read parameters for all known config file tokens */
2130 for (i = 0; i < num_file_list_entries; i++)
2131 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2133 /* set all tokens that can be ignored here to "known" keyword */
2134 for (i = 0; i < num_ignore_tokens; i++)
2135 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2137 /* copy all unknown config file tokens to extra config hash */
2138 extra_file_hash = newSetupFileHash();
2139 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2141 char *value = HASH_ITERATION_VALUE(itr);
2143 if (!strEqual(value, known_token_value))
2144 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2146 END_HASH_ITERATION(valid_file_hash, itr)
2148 /* at this point, we do not need the valid file hash anymore -- free it */
2149 freeSetupFileHash(valid_file_hash);
2151 /* now try to determine valid, dynamically defined config tokens */
2153 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2155 struct FileInfo **dynamic_file_list =
2156 &artwork_info->dynamic_file_list;
2157 int *num_dynamic_file_list_entries =
2158 &artwork_info->num_dynamic_file_list_entries;
2159 struct PropertyMapping **property_mapping =
2160 &artwork_info->property_mapping;
2161 int *num_property_mapping_entries =
2162 &artwork_info->num_property_mapping_entries;
2163 int current_summarized_file_list_entry =
2164 artwork_info->num_file_list_entries +
2165 artwork_info->num_dynamic_file_list_entries;
2166 char *token = HASH_ITERATION_TOKEN(itr);
2167 int len_token = strlen(token);
2169 boolean base_prefix_found = FALSE;
2170 boolean parameter_suffix_found = FALSE;
2173 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2176 /* skip all parameter definitions (handled by read_token_parameters()) */
2177 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2179 int len_suffix = strlen(suffix_list[i].token);
2181 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2182 parameter_suffix_found = TRUE;
2185 if (parameter_suffix_found)
2188 /* ---------- step 0: search for matching base prefix ---------- */
2191 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2193 char *base_prefix = base_prefixes[i];
2194 int len_base_prefix = strlen(base_prefix);
2195 boolean ext1_suffix_found = FALSE;
2196 boolean ext2_suffix_found = FALSE;
2197 boolean ext3_suffix_found = FALSE;
2198 boolean exact_match = FALSE;
2199 int base_index = -1;
2200 int ext1_index = -1;
2201 int ext2_index = -1;
2202 int ext3_index = -1;
2204 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2206 if (!base_prefix_found)
2211 if (start_pos + len_base_prefix == len_token) /* exact match */
2215 add_dynamic_file_list_entry(dynamic_file_list,
2216 num_dynamic_file_list_entries,
2219 num_suffix_list_entries,
2221 add_property_mapping(property_mapping,
2222 num_property_mapping_entries,
2223 base_index, -1, -1, -1,
2224 current_summarized_file_list_entry);
2229 if (IS_PARENT_PROCESS())
2230 printf("---> examining token '%s': search 1st suffix ...\n", token);
2233 /* ---------- step 1: search for matching first suffix ---------- */
2235 start_pos += len_base_prefix;
2236 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2238 char *ext1_suffix = ext1_suffixes[j];
2239 int len_ext1_suffix = strlen(ext1_suffix);
2241 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2243 if (!ext1_suffix_found)
2248 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2252 add_dynamic_file_list_entry(dynamic_file_list,
2253 num_dynamic_file_list_entries,
2256 num_suffix_list_entries,
2258 add_property_mapping(property_mapping,
2259 num_property_mapping_entries,
2260 base_index, ext1_index, -1, -1,
2261 current_summarized_file_list_entry);
2265 start_pos += len_ext1_suffix;
2272 if (IS_PARENT_PROCESS())
2273 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2276 /* ---------- step 2: search for matching second suffix ---------- */
2278 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2280 char *ext2_suffix = ext2_suffixes[k];
2281 int len_ext2_suffix = strlen(ext2_suffix);
2283 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2285 if (!ext2_suffix_found)
2290 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2294 add_dynamic_file_list_entry(dynamic_file_list,
2295 num_dynamic_file_list_entries,
2298 num_suffix_list_entries,
2300 add_property_mapping(property_mapping,
2301 num_property_mapping_entries,
2302 base_index, ext1_index, ext2_index, -1,
2303 current_summarized_file_list_entry);
2307 start_pos += len_ext2_suffix;
2314 if (IS_PARENT_PROCESS())
2315 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2318 /* ---------- step 3: search for matching third suffix ---------- */
2320 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2322 char *ext3_suffix = ext3_suffixes[l];
2323 int len_ext3_suffix = strlen(ext3_suffix);
2325 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2327 if (!ext3_suffix_found)
2332 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2336 add_dynamic_file_list_entry(dynamic_file_list,
2337 num_dynamic_file_list_entries,
2340 num_suffix_list_entries,
2342 add_property_mapping(property_mapping,
2343 num_property_mapping_entries,
2344 base_index, ext1_index, ext2_index, ext3_index,
2345 current_summarized_file_list_entry);
2351 END_HASH_ITERATION(extra_file_hash, itr)
2353 if (artwork_info->num_dynamic_file_list_entries > 0)
2355 artwork_info->dynamic_artwork_list =
2356 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2357 artwork_info->sizeof_artwork_list_entry);
2360 if (options.verbose && IS_PARENT_PROCESS())
2362 SetupFileList *setup_file_list, *list;
2363 boolean dynamic_tokens_found = FALSE;
2364 boolean unknown_tokens_found = FALSE;
2365 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2367 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2368 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2370 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2372 if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2373 dynamic_tokens_found = TRUE;
2375 unknown_tokens_found = TRUE;
2377 END_HASH_ITERATION(extra_file_hash, itr)
2379 if (options.debug && dynamic_tokens_found)
2381 Error(ERR_RETURN_LINE, "-");
2382 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2383 Error(ERR_RETURN, "- config file: '%s'", filename);
2385 for (list = setup_file_list; list != NULL; list = list->next)
2387 char *value = getHashEntry(extra_file_hash, list->token);
2389 if (value != NULL && strEqual(value, known_token_value))
2390 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2393 Error(ERR_RETURN_LINE, "-");
2396 if (unknown_tokens_found)
2398 Error(ERR_RETURN_LINE, "-");
2399 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2400 Error(ERR_RETURN, "- config file: '%s'", filename);
2402 for (list = setup_file_list; list != NULL; list = list->next)
2404 char *value = getHashEntry(extra_file_hash, list->token);
2406 if (value != NULL && !strEqual(value, known_token_value))
2407 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2410 Error(ERR_RETURN_LINE, "-");
2413 if (undefined_values_found)
2415 Error(ERR_RETURN_LINE, "-");
2416 Error(ERR_RETURN, "warning: undefined values found in config file:");
2417 Error(ERR_RETURN, "- config file: '%s'", filename);
2419 for (list = setup_file_list; list != NULL; list = list->next)
2421 char *value = getHashEntry(empty_file_hash, list->token);
2424 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2427 Error(ERR_RETURN_LINE, "-");
2430 freeSetupFileList(setup_file_list);
2433 freeSetupFileHash(extra_file_hash);
2434 freeSetupFileHash(empty_file_hash);
2437 for (i = 0; i < num_file_list_entries; i++)
2439 printf("'%s' ", file_list[i].token);
2440 if (file_list[i].filename)
2441 printf("-> '%s'\n", file_list[i].filename);
2443 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2448 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2450 struct FileInfo *file_list = artwork_info->file_list;
2451 int num_file_list_entries = artwork_info->num_file_list_entries;
2452 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2453 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2456 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2457 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2459 /* always start with reliable default values */
2460 for (i = 0; i < num_file_list_entries; i++)
2462 setString(&file_list[i].filename, file_list[i].default_filename);
2464 for (j = 0; j < num_suffix_list_entries; j++)
2465 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2467 file_list[i].redefined = FALSE;
2468 file_list[i].fallback_to_default = FALSE;
2471 /* free previous dynamic artwork file array */
2472 if (artwork_info->dynamic_file_list != NULL)
2474 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2476 free(artwork_info->dynamic_file_list[i].token);
2477 free(artwork_info->dynamic_file_list[i].filename);
2478 free(artwork_info->dynamic_file_list[i].parameter);
2481 free(artwork_info->dynamic_file_list);
2482 artwork_info->dynamic_file_list = NULL;
2484 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2485 &artwork_info->num_dynamic_file_list_entries);
2488 /* free previous property mapping */
2489 if (artwork_info->property_mapping != NULL)
2491 free(artwork_info->property_mapping);
2493 artwork_info->property_mapping = NULL;
2494 artwork_info->num_property_mapping_entries = 0;
2497 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2499 /* first look for special artwork configured in level series config */
2500 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2502 if (fileExists(filename_base))
2503 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2506 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2508 if (filename_local != NULL && !strEqual(filename_base, filename_local))
2509 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2512 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2513 struct ListNodeInfo **listnode)
2517 char *filename = (*listnode)->source_filename;
2519 if (--(*listnode)->num_references <= 0)
2520 deleteNodeFromList(&artwork_info->content_list, filename,
2521 artwork_info->free_artwork);
2527 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2528 struct ListNodeInfo **listnode,
2529 struct FileInfo *file_list_entry)
2533 "Loading graphics:",
2539 char *basename = file_list_entry->filename;
2540 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2542 if (filename == NULL)
2544 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2546 basename = file_list_entry->default_filename;
2548 /* dynamic artwork has no default filename / skip empty default artwork */
2549 if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2552 file_list_entry->fallback_to_default = TRUE;
2554 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2556 filename = getCustomArtworkFilename(basename, artwork_info->type);
2558 if (filename == NULL)
2560 int error_mode = ERR_WARN;
2562 /* we can get away without sounds and music, but not without graphics */
2563 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2564 error_mode = ERR_EXIT;
2566 Error(error_mode, "cannot find default artwork file '%s'", basename);
2572 /* check if the old and the new artwork file are the same */
2573 if (*listnode && strEqual((*listnode)->source_filename, filename))
2575 /* The old and new artwork are the same (have the same filename and path).
2576 This usually means that this artwork does not exist in this artwork set
2577 and a fallback to the existing artwork is done. */
2580 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2586 /* delete existing artwork file entry */
2587 deleteArtworkListEntry(artwork_info, listnode);
2589 /* check if the new artwork file already exists in the list of artworks */
2590 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2593 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2596 *listnode = (struct ListNodeInfo *)node->content;
2597 (*listnode)->num_references++;
2602 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2603 DrawInitText(basename, 150, FC_YELLOW);
2605 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2608 printf("[adding new artwork '%s']\n", filename);
2611 (*listnode)->num_references = 1;
2612 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2617 int error_mode = ERR_WARN;
2619 /* we can get away without sounds and music, but not without graphics */
2620 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2621 error_mode = ERR_EXIT;
2623 Error(error_mode, "cannot load artwork file '%s'", basename);
2628 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2629 struct ListNodeInfo **listnode,
2630 struct FileInfo *file_list_entry)
2633 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2636 if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2638 deleteArtworkListEntry(artwork_info, listnode);
2642 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2645 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2647 struct FileInfo *file_list = artwork_info->file_list;
2648 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2649 int num_file_list_entries = artwork_info->num_file_list_entries;
2650 int num_dynamic_file_list_entries =
2651 artwork_info->num_dynamic_file_list_entries;
2654 for (i = 0; i < num_file_list_entries; i++)
2655 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2658 for (i = 0; i < num_dynamic_file_list_entries; i++)
2659 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2660 &dynamic_file_list[i]);
2663 dumpList(artwork_info->content_list);
2667 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2668 struct ListNodeInfo ***list,
2669 int *num_list_entries)
2676 for (i = 0; i < *num_list_entries; i++)
2677 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2681 *num_list_entries = 0;
2684 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2686 if (artwork_info == NULL)
2689 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2690 &artwork_info->num_file_list_entries);
2692 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2693 &artwork_info->num_dynamic_file_list_entries);
2697 /* ------------------------------------------------------------------------- */
2698 /* functions only needed for non-Unix (non-command-line) systems */
2699 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2700 /* ------------------------------------------------------------------------- */
2702 #if defined(PLATFORM_MSDOS)
2704 #define ERROR_FILENAME "stderr.txt"
2706 void initErrorFile()
2708 unlink(ERROR_FILENAME);
2711 FILE *openErrorFile()
2713 return fopen(ERROR_FILENAME, MODE_APPEND);
2716 void dumpErrorFile()
2718 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2720 if (error_file != NULL)
2722 while (!feof(error_file))
2723 fputc(fgetc(error_file), stderr);
2731 /* ------------------------------------------------------------------------- */
2732 /* the following is only for debugging purpose and normally not used */
2733 /* ------------------------------------------------------------------------- */
2735 #define DEBUG_NUM_TIMESTAMPS 3
2737 void debug_print_timestamp(int counter_nr, char *message)
2739 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2741 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2742 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2744 counter[counter_nr][0] = Counter();
2747 printf("%s %.2f seconds\n", message,
2748 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2750 counter[counter_nr][1] = Counter();
2753 void debug_print_parent_only(char *format, ...)
2755 if (!IS_PARENT_PROCESS())
2762 va_start(ap, format);
2763 vprintf(format, ap);