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);
569 /* ------------------------------------------------------------------------- */
570 /* command line option handling functions */
571 /* ------------------------------------------------------------------------- */
573 void GetOptions(char *argv[], void (*print_usage_function)(void))
575 char *ro_base_path = RO_BASE_PATH;
576 char *rw_base_path = RW_BASE_PATH;
577 char **options_left = &argv[1];
579 #if !defined(PLATFORM_MACOSX)
580 /* if the program is configured to start from current directory (default),
581 determine program package directory (KDE/Konqueror does not do this by
582 itself and fails otherwise); on Mac OS X, the program binary is stored
583 in an application package directory -- do not try to use this directory
584 as the program data directory (Mac OS X handles this correctly anyway) */
586 if (strcmp(ro_base_path, ".") == 0)
587 ro_base_path = program.command_basepath;
588 if (strcmp(rw_base_path, ".") == 0)
589 rw_base_path = program.command_basepath;
592 /* initialize global program options */
593 options.display_name = NULL;
594 options.server_host = NULL;
595 options.server_port = 0;
596 options.ro_base_directory = ro_base_path;
597 options.rw_base_directory = rw_base_path;
598 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
599 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
600 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
601 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
602 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
603 options.execute_command = NULL;
604 options.serveronly = FALSE;
605 options.network = FALSE;
606 options.verbose = FALSE;
607 options.debug = FALSE;
609 #if !defined(PLATFORM_UNIX)
610 if (*options_left == NULL) /* no options given -- enable verbose mode */
611 options.verbose = TRUE;
614 while (*options_left)
616 char option_str[MAX_OPTION_LEN];
617 char *option = options_left[0];
618 char *next_option = options_left[1];
619 char *option_arg = NULL;
620 int option_len = strlen(option);
622 if (option_len >= MAX_OPTION_LEN)
623 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
625 strcpy(option_str, option); /* copy argument into buffer */
628 if (strcmp(option, "--") == 0) /* stop scanning arguments */
631 if (strncmp(option, "--", 2) == 0) /* treat '--' like '-' */
634 option_arg = strchr(option, '=');
635 if (option_arg == NULL) /* no '=' in option */
636 option_arg = next_option;
639 *option_arg++ = '\0'; /* cut argument from option */
640 if (*option_arg == '\0') /* no argument after '=' */
641 Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
644 option_len = strlen(option);
646 if (strcmp(option, "-") == 0)
647 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
648 else if (strncmp(option, "-help", option_len) == 0)
650 print_usage_function();
654 else if (strncmp(option, "-display", option_len) == 0)
656 if (option_arg == NULL)
657 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
659 options.display_name = option_arg;
660 if (option_arg == next_option)
663 else if (strncmp(option, "-basepath", option_len) == 0)
665 if (option_arg == NULL)
666 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
668 /* this should be extended to separate options for ro and rw data */
669 options.ro_base_directory = ro_base_path = option_arg;
670 options.rw_base_directory = rw_base_path = option_arg;
671 if (option_arg == next_option)
674 /* adjust paths for sub-directories in base directory accordingly */
675 options.level_directory = getPath2(ro_base_path, LEVELS_DIRECTORY);
676 options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
677 options.sounds_directory = getPath2(ro_base_path, SOUNDS_DIRECTORY);
678 options.music_directory = getPath2(ro_base_path, MUSIC_DIRECTORY);
679 options.docs_directory = getPath2(ro_base_path, DOCS_DIRECTORY);
681 else if (strncmp(option, "-levels", option_len) == 0)
683 if (option_arg == NULL)
684 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
686 options.level_directory = option_arg;
687 if (option_arg == next_option)
690 else if (strncmp(option, "-graphics", option_len) == 0)
692 if (option_arg == NULL)
693 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
695 options.graphics_directory = option_arg;
696 if (option_arg == next_option)
699 else if (strncmp(option, "-sounds", option_len) == 0)
701 if (option_arg == NULL)
702 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
704 options.sounds_directory = option_arg;
705 if (option_arg == next_option)
708 else if (strncmp(option, "-music", option_len) == 0)
710 if (option_arg == NULL)
711 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
713 options.music_directory = option_arg;
714 if (option_arg == next_option)
717 else if (strncmp(option, "-network", option_len) == 0)
719 options.network = TRUE;
721 else if (strncmp(option, "-serveronly", option_len) == 0)
723 options.serveronly = TRUE;
725 else if (strncmp(option, "-verbose", option_len) == 0)
727 options.verbose = TRUE;
729 else if (strncmp(option, "-debug", option_len) == 0)
731 options.debug = TRUE;
733 else if (strncmp(option, "-execute", option_len) == 0)
735 if (option_arg == NULL)
736 Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
738 options.execute_command = option_arg;
739 if (option_arg == next_option)
742 /* when doing batch processing, always enable verbose mode (warnings) */
743 options.verbose = TRUE;
745 else if (*option == '-')
747 Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
749 else if (options.server_host == NULL)
751 options.server_host = *options_left;
753 else if (options.server_port == 0)
755 options.server_port = atoi(*options_left);
756 if (options.server_port < 1024)
757 Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
760 Error(ERR_EXIT_HELP, "too many arguments");
767 /* ------------------------------------------------------------------------- */
768 /* error handling functions */
769 /* ------------------------------------------------------------------------- */
771 /* used by SetError() and GetError() to store internal error messages */
772 static char internal_error[1024]; /* this is bad */
774 void SetError(char *format, ...)
778 va_start(ap, format);
779 vsprintf(internal_error, format, ap);
785 return internal_error;
788 void Error(int mode, char *format, ...)
790 static boolean last_line_was_separator = FALSE;
791 char *process_name = "";
792 FILE *error = stderr;
793 char *newline = "\n";
795 /* display warnings only when running in verbose mode */
796 if (mode & ERR_WARN && !options.verbose)
799 if (mode == ERR_RETURN_LINE)
801 if (!last_line_was_separator)
802 fprintf_line(error, format, 79);
804 last_line_was_separator = TRUE;
809 last_line_was_separator = FALSE;
811 #if defined(PLATFORM_MSDOS)
814 if ((error = openErrorFile()) == NULL)
816 printf("Cannot write to error output file!%s", newline);
817 program.exit_function(1);
821 if (mode & ERR_SOUND_SERVER)
822 process_name = " sound server";
823 else if (mode & ERR_NETWORK_SERVER)
824 process_name = " network server";
825 else if (mode & ERR_NETWORK_CLIENT)
826 process_name = " network client **";
832 fprintf(error, "%s%s: ", program.command_basename, process_name);
835 fprintf(error, "warning: ");
837 va_start(ap, format);
838 vfprintf(error, format, ap);
841 fprintf(error, "%s", newline);
845 fprintf(error, "%s: Try option '--help' for more information.%s",
846 program.command_basename, newline);
849 fprintf(error, "%s%s: aborting%s",
850 program.command_basename, process_name, newline);
857 if (mode & ERR_FROM_SERVER)
858 exit(1); /* child process: normal exit */
860 program.exit_function(1); /* main process: clean up stuff */
865 /* ------------------------------------------------------------------------- */
866 /* checked memory allocation and freeing functions */
867 /* ------------------------------------------------------------------------- */
869 void *checked_malloc(unsigned long size)
876 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
881 void *checked_calloc(unsigned long size)
885 ptr = calloc(1, size);
888 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
893 void *checked_realloc(void *ptr, unsigned long size)
895 ptr = realloc(ptr, size);
898 Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
903 void checked_free(void *ptr)
905 if (ptr != NULL) /* this check should be done by free() anyway */
910 /* ------------------------------------------------------------------------- */
911 /* various helper functions */
912 /* ------------------------------------------------------------------------- */
914 inline void swap_numbers(int *i1, int *i2)
922 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
934 /* the "put" variants of the following file access functions check for the file
935 pointer being != NULL and return the number of bytes they have or would have
936 written; this allows for chunk writing functions to first determine the size
937 of the (not yet written) chunk, write the correct chunk size and finally
938 write the chunk itself */
940 int getFile8BitInteger(FILE *file)
945 int putFile8BitInteger(FILE *file, int value)
953 int getFile16BitInteger(FILE *file, int byte_order)
955 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
956 return ((fgetc(file) << 8) |
958 else /* BYTE_ORDER_LITTLE_ENDIAN */
959 return ((fgetc(file) << 0) |
963 int putFile16BitInteger(FILE *file, int value, int byte_order)
967 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
969 fputc((value >> 8) & 0xff, file);
970 fputc((value >> 0) & 0xff, file);
972 else /* BYTE_ORDER_LITTLE_ENDIAN */
974 fputc((value >> 0) & 0xff, file);
975 fputc((value >> 8) & 0xff, file);
982 int getFile32BitInteger(FILE *file, int byte_order)
984 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
985 return ((fgetc(file) << 24) |
986 (fgetc(file) << 16) |
989 else /* BYTE_ORDER_LITTLE_ENDIAN */
990 return ((fgetc(file) << 0) |
992 (fgetc(file) << 16) |
993 (fgetc(file) << 24));
996 int putFile32BitInteger(FILE *file, int value, int byte_order)
1000 if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1002 fputc((value >> 24) & 0xff, file);
1003 fputc((value >> 16) & 0xff, file);
1004 fputc((value >> 8) & 0xff, file);
1005 fputc((value >> 0) & 0xff, file);
1007 else /* BYTE_ORDER_LITTLE_ENDIAN */
1009 fputc((value >> 0) & 0xff, file);
1010 fputc((value >> 8) & 0xff, file);
1011 fputc((value >> 16) & 0xff, file);
1012 fputc((value >> 24) & 0xff, file);
1019 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1022 const int chunk_name_length = 4;
1024 /* read chunk name */
1025 fgets(chunk_name, chunk_name_length + 1, file);
1027 if (chunk_size != NULL)
1029 /* read chunk size */
1030 *chunk_size = getFile32BitInteger(file, byte_order);
1033 return (feof(file) || ferror(file) ? FALSE : TRUE);
1036 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1039 /* write chunk name */
1040 fputs(chunk_name, file);
1042 if (chunk_size >= 0)
1044 /* write chunk size */
1045 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 void putFileVersion(FILE *file, int version)
1062 int version_major = VERSION_MAJOR(version);
1063 int version_minor = VERSION_MINOR(version);
1064 int version_patch = VERSION_PATCH(version);
1065 int version_build = VERSION_BUILD(version);
1067 fputc(version_major, file);
1068 fputc(version_minor, file);
1069 fputc(version_patch, file);
1070 fputc(version_build, file);
1073 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1077 for(i = 0; i < bytes && !feof(file); i++)
1078 buffer[i] = fgetc(file);
1081 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1085 for(i = 0; i < bytes; i++)
1086 fputc(buffer[i], file);
1089 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1091 while (bytes-- && !feof(file))
1095 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1102 /* ------------------------------------------------------------------------- */
1103 /* functions to translate key identifiers between different format */
1104 /* ------------------------------------------------------------------------- */
1106 #define TRANSLATE_KEYSYM_TO_KEYNAME 0
1107 #define TRANSLATE_KEYSYM_TO_X11KEYNAME 1
1108 #define TRANSLATE_KEYNAME_TO_KEYSYM 2
1109 #define TRANSLATE_X11KEYNAME_TO_KEYSYM 3
1111 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1120 /* normal cursor keys */
1121 { KSYM_Left, "XK_Left", "cursor left" },
1122 { KSYM_Right, "XK_Right", "cursor right" },
1123 { KSYM_Up, "XK_Up", "cursor up" },
1124 { KSYM_Down, "XK_Down", "cursor down" },
1126 /* keypad cursor keys */
1128 { KSYM_KP_Left, "XK_KP_Left", "keypad left" },
1129 { KSYM_KP_Right, "XK_KP_Right", "keypad right" },
1130 { KSYM_KP_Up, "XK_KP_Up", "keypad up" },
1131 { KSYM_KP_Down, "XK_KP_Down", "keypad down" },
1134 /* other keypad keys */
1135 #ifdef KSYM_KP_Enter
1136 { KSYM_KP_Enter, "XK_KP_Enter", "keypad enter" },
1137 { KSYM_KP_Add, "XK_KP_Add", "keypad +" },
1138 { KSYM_KP_Subtract, "XK_KP_Subtract", "keypad -" },
1139 { KSYM_KP_Multiply, "XK_KP_Multiply", "keypad mltply" },
1140 { KSYM_KP_Divide, "XK_KP_Divide", "keypad /" },
1141 { KSYM_KP_Separator,"XK_KP_Separator", "keypad ," },
1145 { KSYM_Shift_L, "XK_Shift_L", "left shift" },
1146 { KSYM_Shift_R, "XK_Shift_R", "right shift" },
1147 { KSYM_Control_L, "XK_Control_L", "left control" },
1148 { KSYM_Control_R, "XK_Control_R", "right control" },
1149 { KSYM_Meta_L, "XK_Meta_L", "left meta" },
1150 { KSYM_Meta_R, "XK_Meta_R", "right meta" },
1151 { KSYM_Alt_L, "XK_Alt_L", "left alt" },
1152 { KSYM_Alt_R, "XK_Alt_R", "right alt" },
1153 { KSYM_Super_L, "XK_Super_L", "left super" }, /* Win-L */
1154 { KSYM_Super_R, "XK_Super_R", "right super" }, /* Win-R */
1155 { KSYM_Mode_switch, "XK_Mode_switch", "mode switch" }, /* Alt-R */
1156 { KSYM_Multi_key, "XK_Multi_key", "multi key" }, /* Ctrl-R */
1158 /* some special keys */
1159 { KSYM_BackSpace, "XK_BackSpace", "backspace" },
1160 { KSYM_Delete, "XK_Delete", "delete" },
1161 { KSYM_Insert, "XK_Insert", "insert" },
1162 { KSYM_Tab, "XK_Tab", "tab" },
1163 { KSYM_Home, "XK_Home", "home" },
1164 { KSYM_End, "XK_End", "end" },
1165 { KSYM_Page_Up, "XK_Page_Up", "page up" },
1166 { KSYM_Page_Down, "XK_Page_Down", "page down" },
1167 { KSYM_Menu, "XK_Menu", "menu" }, /* Win-Menu */
1169 /* ASCII 0x20 to 0x40 keys (except numbers) */
1170 { KSYM_space, "XK_space", "space" },
1171 { KSYM_exclam, "XK_exclam", "!" },
1172 { KSYM_quotedbl, "XK_quotedbl", "\"" },
1173 { KSYM_numbersign, "XK_numbersign", "#" },
1174 { KSYM_dollar, "XK_dollar", "$" },
1175 { KSYM_percent, "XK_percent", "%" },
1176 { KSYM_ampersand, "XK_ampersand", "&" },
1177 { KSYM_apostrophe, "XK_apostrophe", "'" },
1178 { KSYM_parenleft, "XK_parenleft", "(" },
1179 { KSYM_parenright, "XK_parenright", ")" },
1180 { KSYM_asterisk, "XK_asterisk", "*" },
1181 { KSYM_plus, "XK_plus", "+" },
1182 { KSYM_comma, "XK_comma", "," },
1183 { KSYM_minus, "XK_minus", "-" },
1184 { KSYM_period, "XK_period", "." },
1185 { KSYM_slash, "XK_slash", "/" },
1186 { KSYM_colon, "XK_colon", ":" },
1187 { KSYM_semicolon, "XK_semicolon", ";" },
1188 { KSYM_less, "XK_less", "<" },
1189 { KSYM_equal, "XK_equal", "=" },
1190 { KSYM_greater, "XK_greater", ">" },
1191 { KSYM_question, "XK_question", "?" },
1192 { KSYM_at, "XK_at", "@" },
1194 /* more ASCII keys */
1195 { KSYM_bracketleft, "XK_bracketleft", "[" },
1196 { KSYM_backslash, "XK_backslash", "backslash" },
1197 { KSYM_bracketright,"XK_bracketright", "]" },
1198 { KSYM_asciicircum, "XK_asciicircum", "circumflex" },
1199 { KSYM_underscore, "XK_underscore", "_" },
1200 { KSYM_grave, "XK_grave", "grave" },
1201 { KSYM_quoteleft, "XK_quoteleft", "quote left" },
1202 { KSYM_braceleft, "XK_braceleft", "brace left" },
1203 { KSYM_bar, "XK_bar", "bar" },
1204 { KSYM_braceright, "XK_braceright", "brace right" },
1205 { KSYM_asciitilde, "XK_asciitilde", "ascii tilde" },
1207 /* special (non-ASCII) keys */
1208 { KSYM_Adiaeresis, "XK_Adiaeresis", "Ä" },
1209 { KSYM_Odiaeresis, "XK_Odiaeresis", "Ö" },
1210 { KSYM_Udiaeresis, "XK_Udiaeresis", "Ü" },
1211 { KSYM_adiaeresis, "XK_adiaeresis", "ä" },
1212 { KSYM_odiaeresis, "XK_odiaeresis", "ö" },
1213 { KSYM_udiaeresis, "XK_udiaeresis", "ü" },
1214 { KSYM_ssharp, "XK_ssharp", "sharp s" },
1216 /* end-of-array identifier */
1222 if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1224 static char name_buffer[30];
1227 if (key >= KSYM_A && key <= KSYM_Z)
1228 sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1229 else if (key >= KSYM_a && key <= KSYM_z)
1230 sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1231 else if (key >= KSYM_0 && key <= KSYM_9)
1232 sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1233 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1234 sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1235 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1236 sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1237 else if (key == KSYM_UNDEFINED)
1238 strcpy(name_buffer, "(undefined)");
1245 if (key == translate_key[i].key)
1247 strcpy(name_buffer, translate_key[i].name);
1251 while (translate_key[++i].name);
1253 if (!translate_key[i].name)
1254 strcpy(name_buffer, "(unknown)");
1257 *name = name_buffer;
1259 else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1261 static char name_buffer[30];
1264 if (key >= KSYM_A && key <= KSYM_Z)
1265 sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1266 else if (key >= KSYM_a && key <= KSYM_z)
1267 sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1268 else if (key >= KSYM_0 && key <= KSYM_9)
1269 sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1270 else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1271 sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1272 else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1273 sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1274 else if (key == KSYM_UNDEFINED)
1275 strcpy(name_buffer, "[undefined]");
1282 if (key == translate_key[i].key)
1284 strcpy(name_buffer, translate_key[i].x11name);
1288 while (translate_key[++i].x11name);
1290 if (!translate_key[i].x11name)
1291 sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1294 *x11name = name_buffer;
1296 else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1298 Key key = KSYM_UNDEFINED;
1303 if (strcmp(translate_key[i].name, *name) == 0)
1305 key = translate_key[i].key;
1309 while (translate_key[++i].x11name);
1311 if (key == KSYM_UNDEFINED)
1312 Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1316 else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1318 Key key = KSYM_UNDEFINED;
1319 char *name_ptr = *x11name;
1321 if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1323 char c = name_ptr[3];
1325 if (c >= 'A' && c <= 'Z')
1326 key = KSYM_A + (Key)(c - 'A');
1327 else if (c >= 'a' && c <= 'z')
1328 key = KSYM_a + (Key)(c - 'a');
1329 else if (c >= '0' && c <= '9')
1330 key = KSYM_0 + (Key)(c - '0');
1332 else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1334 char c = name_ptr[6];
1336 if (c >= '0' && c <= '9')
1337 key = KSYM_KP_0 + (Key)(c - '0');
1339 else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1341 char c1 = name_ptr[4];
1342 char c2 = name_ptr[5];
1345 if ((c1 >= '0' && c1 <= '9') &&
1346 ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1347 d = atoi(&name_ptr[4]);
1349 if (d >= 1 && d <= KSYM_NUM_FKEYS)
1350 key = KSYM_F1 + (Key)(d - 1);
1352 else if (strncmp(name_ptr, "XK_", 3) == 0)
1358 if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1360 key = translate_key[i].key;
1364 while (translate_key[++i].x11name);
1366 else if (strncmp(name_ptr, "0x", 2) == 0)
1368 unsigned long value = 0;
1374 char c = *name_ptr++;
1377 if (c >= '0' && c <= '9')
1379 else if (c >= 'a' && c <= 'f')
1380 d = (int)(c - 'a' + 10);
1381 else if (c >= 'A' && c <= 'F')
1382 d = (int)(c - 'A' + 10);
1390 value = value * 16 + d;
1401 char *getKeyNameFromKey(Key key)
1405 translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1409 char *getX11KeyNameFromKey(Key key)
1413 translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1417 Key getKeyFromKeyName(char *name)
1421 translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1425 Key getKeyFromX11KeyName(char *x11name)
1429 translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1433 char getCharFromKey(Key key)
1435 char *keyname = getKeyNameFromKey(key);
1438 if (strlen(keyname) == 1)
1439 letter = keyname[0];
1440 else if (strcmp(keyname, "space") == 0)
1442 else if (strcmp(keyname, "circumflex") == 0)
1449 /* ------------------------------------------------------------------------- */
1450 /* functions to translate string identifiers to integer or boolean value */
1451 /* ------------------------------------------------------------------------- */
1453 int get_integer_from_string(char *s)
1455 static char *number_text[][3] =
1457 { "0", "zero", "null", },
1458 { "1", "one", "first" },
1459 { "2", "two", "second" },
1460 { "3", "three", "third" },
1461 { "4", "four", "fourth" },
1462 { "5", "five", "fifth" },
1463 { "6", "six", "sixth" },
1464 { "7", "seven", "seventh" },
1465 { "8", "eight", "eighth" },
1466 { "9", "nine", "ninth" },
1467 { "10", "ten", "tenth" },
1468 { "11", "eleven", "eleventh" },
1469 { "12", "twelve", "twelfth" },
1471 { NULL, NULL, NULL },
1475 char *s_lower = getStringToLower(s);
1478 for (i = 0; number_text[i][0] != NULL; i++)
1479 for (j = 0; j < 3; j++)
1480 if (strcmp(s_lower, number_text[i][j]) == 0)
1485 if (strcmp(s_lower, "false") == 0)
1487 else if (strcmp(s_lower, "true") == 0)
1498 boolean get_boolean_from_string(char *s)
1500 char *s_lower = getStringToLower(s);
1501 boolean result = FALSE;
1503 if (strcmp(s_lower, "true") == 0 ||
1504 strcmp(s_lower, "yes") == 0 ||
1505 strcmp(s_lower, "on") == 0 ||
1506 get_integer_from_string(s) == 1)
1515 /* ------------------------------------------------------------------------- */
1516 /* functions for generic lists */
1517 /* ------------------------------------------------------------------------- */
1519 ListNode *newListNode()
1521 return checked_calloc(sizeof(ListNode));
1524 void addNodeToList(ListNode **node_first, char *key, void *content)
1526 ListNode *node_new = newListNode();
1528 node_new->key = getStringCopy(key);
1529 node_new->content = content;
1530 node_new->next = *node_first;
1531 *node_first = node_new;
1534 void deleteNodeFromList(ListNode **node_first, char *key,
1535 void (*destructor_function)(void *))
1537 if (node_first == NULL || *node_first == NULL)
1540 if (strcmp((*node_first)->key, key) == 0)
1542 free((*node_first)->key);
1543 if (destructor_function)
1544 destructor_function((*node_first)->content);
1545 *node_first = (*node_first)->next;
1548 deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1551 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1553 if (node_first == NULL)
1556 if (strcmp(node_first->key, key) == 0)
1559 return getNodeFromKey(node_first->next, key);
1562 int getNumNodes(ListNode *node_first)
1564 return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1567 void dumpList(ListNode *node_first)
1569 ListNode *node = node_first;
1573 printf("['%s' (%d)]\n", node->key,
1574 ((struct ListNodeInfo *)node->content)->num_references);
1578 printf("[%d nodes]\n", getNumNodes(node_first));
1582 /* ------------------------------------------------------------------------- */
1583 /* functions for checking files and filenames */
1584 /* ------------------------------------------------------------------------- */
1586 boolean fileExists(char *filename)
1588 if (filename == NULL)
1591 return (access(filename, F_OK) == 0);
1594 boolean fileHasPrefix(char *basename, char *prefix)
1596 static char *basename_lower = NULL;
1597 int basename_length, prefix_length;
1599 checked_free(basename_lower);
1601 if (basename == NULL || prefix == NULL)
1604 basename_lower = getStringToLower(basename);
1605 basename_length = strlen(basename_lower);
1606 prefix_length = strlen(prefix);
1608 if (basename_length > prefix_length + 1 &&
1609 basename_lower[prefix_length] == '.' &&
1610 strncmp(basename_lower, prefix, prefix_length) == 0)
1616 boolean fileHasSuffix(char *basename, char *suffix)
1618 static char *basename_lower = NULL;
1619 int basename_length, suffix_length;
1621 checked_free(basename_lower);
1623 if (basename == NULL || suffix == NULL)
1626 basename_lower = getStringToLower(basename);
1627 basename_length = strlen(basename_lower);
1628 suffix_length = strlen(suffix);
1630 if (basename_length > suffix_length + 1 &&
1631 basename_lower[basename_length - suffix_length - 1] == '.' &&
1632 strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0)
1638 boolean FileIsGraphic(char *filename)
1640 char *basename = getBaseNamePtr(filename);
1642 return fileHasSuffix(basename, "pcx");
1645 boolean FileIsSound(char *filename)
1647 char *basename = getBaseNamePtr(filename);
1649 return fileHasSuffix(basename, "wav");
1652 boolean FileIsMusic(char *filename)
1654 char *basename = getBaseNamePtr(filename);
1656 if (FileIsSound(basename))
1659 #if defined(TARGET_SDL)
1660 if (fileHasPrefix(basename, "mod") ||
1661 fileHasSuffix(basename, "mod") ||
1662 fileHasSuffix(basename, "s3m") ||
1663 fileHasSuffix(basename, "it") ||
1664 fileHasSuffix(basename, "xm") ||
1665 fileHasSuffix(basename, "midi") ||
1666 fileHasSuffix(basename, "mid") ||
1667 fileHasSuffix(basename, "mp3") ||
1668 fileHasSuffix(basename, "ogg"))
1675 boolean FileIsArtworkType(char *basename, int type)
1677 if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1678 (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1679 (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1685 /* ------------------------------------------------------------------------- */
1686 /* functions for loading artwork configuration information */
1687 /* ------------------------------------------------------------------------- */
1689 char *get_mapped_token(char *token)
1691 /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1692 static char *map_token_prefix[][2] =
1694 { "char_procent", "char_percent" },
1699 for (i = 0; map_token_prefix[i][0] != NULL; i++)
1701 int len_token_prefix = strlen(map_token_prefix[i][0]);
1703 if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1704 return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1710 /* This function checks if a string <s> of the format "string1, string2, ..."
1711 exactly contains a string <s_contained>. */
1713 static boolean string_has_parameter(char *s, char *s_contained)
1717 if (s == NULL || s_contained == NULL)
1720 if (strlen(s_contained) > strlen(s))
1723 if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1725 char next_char = s[strlen(s_contained)];
1727 /* check if next character is delimiter or whitespace */
1728 return (next_char == ',' || next_char == '\0' ||
1729 next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1732 /* check if string contains another parameter string after a comma */
1733 substring = strchr(s, ',');
1734 if (substring == NULL) /* string does not contain a comma */
1737 /* advance string pointer to next character after the comma */
1740 /* skip potential whitespaces after the comma */
1741 while (*substring == ' ' || *substring == '\t')
1744 return string_has_parameter(substring, s_contained);
1747 int get_parameter_value(char *value_raw, char *suffix, int type)
1749 char *value = getStringToLower(value_raw);
1750 int result = 0; /* probably a save default value */
1752 if (strcmp(suffix, ".direction") == 0)
1754 result = (strcmp(value, "left") == 0 ? MV_LEFT :
1755 strcmp(value, "right") == 0 ? MV_RIGHT :
1756 strcmp(value, "up") == 0 ? MV_UP :
1757 strcmp(value, "down") == 0 ? MV_DOWN : MV_NONE);
1759 else if (strcmp(suffix, ".anim_mode") == 0)
1761 result = (string_has_parameter(value, "none") ? ANIM_NONE :
1762 string_has_parameter(value, "loop") ? ANIM_LOOP :
1763 string_has_parameter(value, "linear") ? ANIM_LINEAR :
1764 string_has_parameter(value, "pingpong") ? ANIM_PINGPONG :
1765 string_has_parameter(value, "pingpong2") ? ANIM_PINGPONG2 :
1766 string_has_parameter(value, "random") ? ANIM_RANDOM :
1767 string_has_parameter(value, "ce_value") ? ANIM_CE_VALUE :
1768 string_has_parameter(value, "ce_score") ? ANIM_CE_SCORE :
1769 string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1770 string_has_parameter(value, "vertical") ? ANIM_VERTICAL :
1773 if (string_has_parameter(value, "reverse"))
1774 result |= ANIM_REVERSE;
1776 if (string_has_parameter(value, "static_panel"))
1777 result |= ANIM_STATIC_PANEL;
1779 else /* generic parameter of type integer or boolean */
1781 result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1782 type == TYPE_INTEGER ? get_integer_from_string(value) :
1783 type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1784 ARG_UNDEFINED_VALUE);
1792 int get_auto_parameter_value(char *token, char *value_raw)
1796 if (token == NULL || value_raw == NULL)
1797 return ARG_UNDEFINED_VALUE;
1799 suffix = strrchr(token, '.');
1803 return get_parameter_value(value_raw, suffix, TYPE_INTEGER);
1806 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1807 struct ListNodeInfo ***, int *);
1809 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1810 struct ConfigTypeInfo *suffix_list,
1811 char **ignore_tokens,
1812 int num_file_list_entries)
1814 struct FileInfo *file_list;
1815 int num_file_list_entries_found = 0;
1816 int num_suffix_list_entries = 0;
1820 file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1822 for (i = 0; suffix_list[i].token != NULL; i++)
1823 num_suffix_list_entries++;
1825 /* always start with reliable default values */
1826 for (i = 0; i < num_file_list_entries; i++)
1828 file_list[i].token = NULL;
1830 file_list[i].default_filename = NULL;
1831 file_list[i].filename = NULL;
1833 if (num_suffix_list_entries > 0)
1835 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1837 file_list[i].default_parameter = checked_calloc(parameter_array_size);
1838 file_list[i].parameter = checked_calloc(parameter_array_size);
1840 for (j = 0; j < num_suffix_list_entries; j++)
1842 setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1843 setString(&file_list[i].parameter[j], suffix_list[j].value);
1846 file_list[i].redefined = FALSE;
1847 file_list[i].fallback_to_default = FALSE;
1852 for (i = 0; config_list[i].token != NULL; i++)
1854 int len_config_token = strlen(config_list[i].token);
1855 int len_config_value = strlen(config_list[i].value);
1856 boolean is_file_entry = TRUE;
1858 for (j = 0; suffix_list[j].token != NULL; j++)
1860 int len_suffix = strlen(suffix_list[j].token);
1862 if (len_suffix < len_config_token &&
1863 strcmp(&config_list[i].token[len_config_token - len_suffix],
1864 suffix_list[j].token) == 0)
1866 setString(&file_list[list_pos].default_parameter[j],
1867 config_list[i].value);
1869 is_file_entry = FALSE;
1874 /* the following tokens are no file definitions, but other config tokens */
1875 for (j = 0; ignore_tokens[j] != NULL; j++)
1876 if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1877 is_file_entry = FALSE;
1884 if (list_pos >= num_file_list_entries)
1887 /* simple sanity check if this is really a file definition */
1888 if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1889 strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1890 strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1892 Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1893 config_list[i].token, config_list[i].value);
1894 Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1897 file_list[list_pos].token = config_list[i].token;
1898 file_list[list_pos].default_filename = config_list[i].value;
1902 num_file_list_entries_found = list_pos + 1;
1903 if (num_file_list_entries_found != num_file_list_entries)
1905 Error(ERR_RETURN_LINE, "-");
1906 Error(ERR_RETURN, "inconsistant config list information:");
1907 Error(ERR_RETURN, "- should be: %d (according to 'src/conf_gfx.h')",
1908 num_file_list_entries);
1909 Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1910 num_file_list_entries_found);
1911 Error(ERR_EXIT, "please fix");
1917 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1919 int len_token = strlen(token);
1920 int len_suffix = strlen(suffix);
1922 if (start_pos < 0) /* compare suffix from end of string */
1923 start_pos += len_token;
1925 if (start_pos < 0 || start_pos + len_suffix > len_token)
1928 if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1931 if (token[start_pos + len_suffix] == '\0')
1934 if (token[start_pos + len_suffix] == '.')
1940 #define KNOWN_TOKEN_VALUE "[KNOWN_TOKEN_VALUE]"
1942 static void read_token_parameters(SetupFileHash *setup_file_hash,
1943 struct ConfigTypeInfo *suffix_list,
1944 struct FileInfo *file_list_entry)
1946 /* check for config token that is the base token without any suffixes */
1947 char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1948 char *known_token_value = KNOWN_TOKEN_VALUE;
1951 if (filename != NULL)
1953 setString(&file_list_entry->filename, filename);
1955 /* when file definition found, set all parameters to default values */
1956 for (i = 0; suffix_list[i].token != NULL; i++)
1957 setString(&file_list_entry->parameter[i], suffix_list[i].value);
1959 file_list_entry->redefined = TRUE;
1961 /* mark config file token as well known from default config */
1962 setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1965 /* check for config tokens that can be build by base token and suffixes */
1966 for (i = 0; suffix_list[i].token != NULL; i++)
1968 char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1969 char *value = getHashEntry(setup_file_hash, token);
1973 setString(&file_list_entry->parameter[i], value);
1975 /* mark config file token as well known from default config */
1976 setHashEntry(setup_file_hash, token, known_token_value);
1983 static void add_dynamic_file_list_entry(struct FileInfo **list,
1984 int *num_list_entries,
1985 SetupFileHash *extra_file_hash,
1986 struct ConfigTypeInfo *suffix_list,
1987 int num_suffix_list_entries,
1990 struct FileInfo *new_list_entry;
1991 int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1993 (*num_list_entries)++;
1994 *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1995 new_list_entry = &(*list)[*num_list_entries - 1];
1997 new_list_entry->token = getStringCopy(token);
1998 new_list_entry->default_filename = NULL;
1999 new_list_entry->filename = NULL;
2000 new_list_entry->parameter = checked_calloc(parameter_array_size);
2002 new_list_entry->redefined = FALSE;
2003 new_list_entry->fallback_to_default = FALSE;
2005 read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2008 static void add_property_mapping(struct PropertyMapping **list,
2009 int *num_list_entries,
2010 int base_index, int ext1_index,
2011 int ext2_index, int ext3_index,
2014 struct PropertyMapping *new_list_entry;
2016 (*num_list_entries)++;
2017 *list = checked_realloc(*list,
2018 *num_list_entries * sizeof(struct PropertyMapping));
2019 new_list_entry = &(*list)[*num_list_entries - 1];
2021 new_list_entry->base_index = base_index;
2022 new_list_entry->ext1_index = ext1_index;
2023 new_list_entry->ext2_index = ext2_index;
2024 new_list_entry->ext3_index = ext3_index;
2026 new_list_entry->artwork_index = artwork_index;
2029 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2032 struct FileInfo *file_list = artwork_info->file_list;
2033 struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2034 char **base_prefixes = artwork_info->base_prefixes;
2035 char **ext1_suffixes = artwork_info->ext1_suffixes;
2036 char **ext2_suffixes = artwork_info->ext2_suffixes;
2037 char **ext3_suffixes = artwork_info->ext3_suffixes;
2038 char **ignore_tokens = artwork_info->ignore_tokens;
2039 int num_file_list_entries = artwork_info->num_file_list_entries;
2040 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2041 int num_base_prefixes = artwork_info->num_base_prefixes;
2042 int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2043 int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2044 int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2045 int num_ignore_tokens = artwork_info->num_ignore_tokens;
2046 SetupFileHash *setup_file_hash, *valid_file_hash;
2047 SetupFileHash *extra_file_hash, *empty_file_hash;
2048 char *known_token_value = KNOWN_TOKEN_VALUE;
2051 if (filename == NULL)
2054 if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2057 /* separate valid (defined) from empty (undefined) config token values */
2058 valid_file_hash = newSetupFileHash();
2059 empty_file_hash = newSetupFileHash();
2060 BEGIN_HASH_ITERATION(setup_file_hash, itr)
2062 char *value = HASH_ITERATION_VALUE(itr);
2064 setHashEntry(*value ? valid_file_hash : empty_file_hash,
2065 HASH_ITERATION_TOKEN(itr), value);
2067 END_HASH_ITERATION(setup_file_hash, itr)
2069 /* at this point, we do not need the setup file hash anymore -- free it */
2070 freeSetupFileHash(setup_file_hash);
2072 /* map deprecated to current tokens (using prefix match and replace) */
2073 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2075 char *token = HASH_ITERATION_TOKEN(itr);
2076 char *mapped_token = get_mapped_token(token);
2078 if (mapped_token != NULL)
2080 char *value = HASH_ITERATION_VALUE(itr);
2082 /* add mapped token */
2083 setHashEntry(valid_file_hash, mapped_token, value);
2085 /* ignore old token (by setting it to "known" keyword) */
2086 setHashEntry(valid_file_hash, token, known_token_value);
2091 END_HASH_ITERATION(valid_file_hash, itr)
2093 /* read parameters for all known config file tokens */
2094 for (i = 0; i < num_file_list_entries; i++)
2095 read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2097 /* set all tokens that can be ignored here to "known" keyword */
2098 for (i = 0; i < num_ignore_tokens; i++)
2099 setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2101 /* copy all unknown config file tokens to extra config hash */
2102 extra_file_hash = newSetupFileHash();
2103 BEGIN_HASH_ITERATION(valid_file_hash, itr)
2105 char *value = HASH_ITERATION_VALUE(itr);
2107 if (strcmp(value, known_token_value) != 0)
2108 setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2110 END_HASH_ITERATION(valid_file_hash, itr)
2112 /* at this point, we do not need the valid file hash anymore -- free it */
2113 freeSetupFileHash(valid_file_hash);
2115 /* now try to determine valid, dynamically defined config tokens */
2117 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2119 struct FileInfo **dynamic_file_list =
2120 &artwork_info->dynamic_file_list;
2121 int *num_dynamic_file_list_entries =
2122 &artwork_info->num_dynamic_file_list_entries;
2123 struct PropertyMapping **property_mapping =
2124 &artwork_info->property_mapping;
2125 int *num_property_mapping_entries =
2126 &artwork_info->num_property_mapping_entries;
2127 int current_summarized_file_list_entry =
2128 artwork_info->num_file_list_entries +
2129 artwork_info->num_dynamic_file_list_entries;
2130 char *token = HASH_ITERATION_TOKEN(itr);
2131 int len_token = strlen(token);
2133 boolean base_prefix_found = FALSE;
2134 boolean parameter_suffix_found = FALSE;
2137 printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2140 /* skip all parameter definitions (handled by read_token_parameters()) */
2141 for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2143 int len_suffix = strlen(suffix_list[i].token);
2145 if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2146 parameter_suffix_found = TRUE;
2149 if (parameter_suffix_found)
2152 /* ---------- step 0: search for matching base prefix ---------- */
2155 for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2157 char *base_prefix = base_prefixes[i];
2158 int len_base_prefix = strlen(base_prefix);
2159 boolean ext1_suffix_found = FALSE;
2160 boolean ext2_suffix_found = FALSE;
2161 boolean ext3_suffix_found = FALSE;
2162 boolean exact_match = FALSE;
2163 int base_index = -1;
2164 int ext1_index = -1;
2165 int ext2_index = -1;
2166 int ext3_index = -1;
2168 base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2170 if (!base_prefix_found)
2175 if (start_pos + len_base_prefix == len_token) /* exact match */
2179 add_dynamic_file_list_entry(dynamic_file_list,
2180 num_dynamic_file_list_entries,
2183 num_suffix_list_entries,
2185 add_property_mapping(property_mapping,
2186 num_property_mapping_entries,
2187 base_index, -1, -1, -1,
2188 current_summarized_file_list_entry);
2193 if (IS_PARENT_PROCESS())
2194 printf("---> examining token '%s': search 1st suffix ...\n", token);
2197 /* ---------- step 1: search for matching first suffix ---------- */
2199 start_pos += len_base_prefix;
2200 for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2202 char *ext1_suffix = ext1_suffixes[j];
2203 int len_ext1_suffix = strlen(ext1_suffix);
2205 ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2207 if (!ext1_suffix_found)
2212 if (start_pos + len_ext1_suffix == len_token) /* exact match */
2216 add_dynamic_file_list_entry(dynamic_file_list,
2217 num_dynamic_file_list_entries,
2220 num_suffix_list_entries,
2222 add_property_mapping(property_mapping,
2223 num_property_mapping_entries,
2224 base_index, ext1_index, -1, -1,
2225 current_summarized_file_list_entry);
2229 start_pos += len_ext1_suffix;
2236 if (IS_PARENT_PROCESS())
2237 printf("---> examining token '%s': search 2nd suffix ...\n", token);
2240 /* ---------- step 2: search for matching second suffix ---------- */
2242 for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2244 char *ext2_suffix = ext2_suffixes[k];
2245 int len_ext2_suffix = strlen(ext2_suffix);
2247 ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2249 if (!ext2_suffix_found)
2254 if (start_pos + len_ext2_suffix == len_token) /* exact match */
2258 add_dynamic_file_list_entry(dynamic_file_list,
2259 num_dynamic_file_list_entries,
2262 num_suffix_list_entries,
2264 add_property_mapping(property_mapping,
2265 num_property_mapping_entries,
2266 base_index, ext1_index, ext2_index, -1,
2267 current_summarized_file_list_entry);
2271 start_pos += len_ext2_suffix;
2278 if (IS_PARENT_PROCESS())
2279 printf("---> examining token '%s': search 3rd suffix ...\n",token);
2282 /* ---------- step 3: search for matching third suffix ---------- */
2284 for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2286 char *ext3_suffix = ext3_suffixes[l];
2287 int len_ext3_suffix = strlen(ext3_suffix);
2289 ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2291 if (!ext3_suffix_found)
2296 if (start_pos + len_ext3_suffix == len_token) /* exact match */
2300 add_dynamic_file_list_entry(dynamic_file_list,
2301 num_dynamic_file_list_entries,
2304 num_suffix_list_entries,
2306 add_property_mapping(property_mapping,
2307 num_property_mapping_entries,
2308 base_index, ext1_index, ext2_index, ext3_index,
2309 current_summarized_file_list_entry);
2315 END_HASH_ITERATION(extra_file_hash, itr)
2317 if (artwork_info->num_dynamic_file_list_entries > 0)
2319 artwork_info->dynamic_artwork_list =
2320 checked_calloc(artwork_info->num_dynamic_file_list_entries *
2321 artwork_info->sizeof_artwork_list_entry);
2324 if (options.verbose && IS_PARENT_PROCESS())
2326 SetupFileList *setup_file_list, *list;
2327 boolean dynamic_tokens_found = FALSE;
2328 boolean unknown_tokens_found = FALSE;
2329 boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2331 if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2332 Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2334 BEGIN_HASH_ITERATION(extra_file_hash, itr)
2336 if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2337 dynamic_tokens_found = TRUE;
2339 unknown_tokens_found = TRUE;
2341 END_HASH_ITERATION(extra_file_hash, itr)
2343 if (options.debug && dynamic_tokens_found)
2345 Error(ERR_RETURN_LINE, "-");
2346 Error(ERR_RETURN, "dynamic token(s) found in config file:");
2347 Error(ERR_RETURN, "- config file: '%s'", filename);
2349 for (list = setup_file_list; list != NULL; list = list->next)
2351 char *value = getHashEntry(extra_file_hash, list->token);
2353 if (value != NULL && strcmp(value, known_token_value) == 0)
2354 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2357 Error(ERR_RETURN_LINE, "-");
2360 if (unknown_tokens_found)
2362 Error(ERR_RETURN_LINE, "-");
2363 Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2364 Error(ERR_RETURN, "- config file: '%s'", filename);
2366 for (list = setup_file_list; list != NULL; list = list->next)
2368 char *value = getHashEntry(extra_file_hash, list->token);
2370 if (value != NULL && strcmp(value, known_token_value) != 0)
2371 Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2374 Error(ERR_RETURN_LINE, "-");
2377 if (undefined_values_found)
2379 Error(ERR_RETURN_LINE, "-");
2380 Error(ERR_RETURN, "warning: undefined values found in config file:");
2381 Error(ERR_RETURN, "- config file: '%s'", filename);
2383 for (list = setup_file_list; list != NULL; list = list->next)
2385 char *value = getHashEntry(empty_file_hash, list->token);
2388 Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2391 Error(ERR_RETURN_LINE, "-");
2394 freeSetupFileList(setup_file_list);
2397 freeSetupFileHash(extra_file_hash);
2398 freeSetupFileHash(empty_file_hash);
2401 for (i = 0; i < num_file_list_entries; i++)
2403 printf("'%s' ", file_list[i].token);
2404 if (file_list[i].filename)
2405 printf("-> '%s'\n", file_list[i].filename);
2407 printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2412 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2414 struct FileInfo *file_list = artwork_info->file_list;
2415 int num_file_list_entries = artwork_info->num_file_list_entries;
2416 int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2417 char *filename_base = UNDEFINED_FILENAME, *filename_local;
2421 printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2424 DrawInitText("Loading artwork config:", 120, FC_GREEN);
2425 DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2427 /* always start with reliable default values */
2428 for (i = 0; i < num_file_list_entries; i++)
2430 setString(&file_list[i].filename, file_list[i].default_filename);
2432 for (j = 0; j < num_suffix_list_entries; j++)
2433 setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2435 file_list[i].redefined = FALSE;
2436 file_list[i].fallback_to_default = FALSE;
2439 /* free previous dynamic artwork file array */
2440 if (artwork_info->dynamic_file_list != NULL)
2442 for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2444 free(artwork_info->dynamic_file_list[i].token);
2445 free(artwork_info->dynamic_file_list[i].filename);
2446 free(artwork_info->dynamic_file_list[i].parameter);
2449 free(artwork_info->dynamic_file_list);
2450 artwork_info->dynamic_file_list = NULL;
2452 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2453 &artwork_info->num_dynamic_file_list_entries);
2456 /* free previous property mapping */
2457 if (artwork_info->property_mapping != NULL)
2459 free(artwork_info->property_mapping);
2461 artwork_info->property_mapping = NULL;
2462 artwork_info->num_property_mapping_entries = 0;
2465 if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2467 /* first look for special artwork configured in level series config */
2468 filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2470 if (fileExists(filename_base))
2471 LoadArtworkConfigFromFilename(artwork_info, filename_base);
2474 filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2476 if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2477 LoadArtworkConfigFromFilename(artwork_info, filename_local);
2480 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2481 struct ListNodeInfo **listnode)
2485 char *filename = (*listnode)->source_filename;
2487 if (--(*listnode)->num_references <= 0)
2488 deleteNodeFromList(&artwork_info->content_list, filename,
2489 artwork_info->free_artwork);
2495 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2496 struct ListNodeInfo **listnode,
2497 struct FileInfo *file_list_entry)
2501 "Loading graphics:",
2507 char *basename = file_list_entry->filename;
2508 char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2510 if (filename == NULL)
2512 Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2514 basename = file_list_entry->default_filename;
2516 /* dynamic artwork has no default filename / skip empty default artwork */
2517 if (basename == NULL || strcmp(basename, UNDEFINED_FILENAME) == 0)
2520 file_list_entry->fallback_to_default = TRUE;
2522 Error(ERR_WARN, "trying default artwork file '%s'", basename);
2524 filename = getCustomArtworkFilename(basename, artwork_info->type);
2526 if (filename == NULL)
2528 int error_mode = ERR_WARN;
2530 /* we can get away without sounds and music, but not without graphics */
2531 if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2532 error_mode = ERR_EXIT;
2534 Error(error_mode, "cannot find default artwork file '%s'", basename);
2540 /* check if the old and the new artwork file are the same */
2541 if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2543 /* The old and new artwork are the same (have the same filename and path).
2544 This usually means that this artwork does not exist in this artwork set
2545 and a fallback to the existing artwork is done. */
2548 printf("[artwork '%s' already exists (same list entry)]\n", filename);
2554 /* delete existing artwork file entry */
2555 deleteArtworkListEntry(artwork_info, listnode);
2557 /* check if the new artwork file already exists in the list of artworks */
2558 if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2561 printf("[artwork '%s' already exists (other list entry)]\n", filename);
2564 *listnode = (struct ListNodeInfo *)node->content;
2565 (*listnode)->num_references++;
2570 DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2571 DrawInitText(basename, 150, FC_YELLOW);
2573 if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2576 printf("[adding new artwork '%s']\n", filename);
2579 (*listnode)->num_references = 1;
2580 addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2585 int error_mode = ERR_WARN;
2587 /* we can get away without sounds and music, but not without graphics */
2588 if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2589 error_mode = ERR_EXIT;
2591 Error(error_mode, "cannot load artwork file '%s'", basename);
2596 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2597 struct ListNodeInfo **listnode,
2598 struct FileInfo *file_list_entry)
2601 printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2604 if (strcmp(file_list_entry->filename, UNDEFINED_FILENAME) == 0)
2606 deleteArtworkListEntry(artwork_info, listnode);
2610 replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2613 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2615 struct FileInfo *file_list = artwork_info->file_list;
2616 struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2617 int num_file_list_entries = artwork_info->num_file_list_entries;
2618 int num_dynamic_file_list_entries =
2619 artwork_info->num_dynamic_file_list_entries;
2622 for (i = 0; i < num_file_list_entries; i++)
2623 LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2626 for (i = 0; i < num_dynamic_file_list_entries; i++)
2627 LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2628 &dynamic_file_list[i]);
2631 dumpList(artwork_info->content_list);
2635 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2636 struct ListNodeInfo ***list,
2637 int *num_list_entries)
2644 for (i = 0; i < *num_list_entries; i++)
2645 deleteArtworkListEntry(artwork_info, &(*list)[i]);
2649 *num_list_entries = 0;
2652 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2654 if (artwork_info == NULL)
2657 FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2658 &artwork_info->num_file_list_entries);
2660 FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2661 &artwork_info->num_dynamic_file_list_entries);
2665 /* ------------------------------------------------------------------------- */
2666 /* functions only needed for non-Unix (non-command-line) systems */
2667 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt") */
2668 /* ------------------------------------------------------------------------- */
2670 #if defined(PLATFORM_MSDOS)
2672 #define ERROR_FILENAME "stderr.txt"
2674 void initErrorFile()
2676 unlink(ERROR_FILENAME);
2679 FILE *openErrorFile()
2681 return fopen(ERROR_FILENAME, MODE_APPEND);
2684 void dumpErrorFile()
2686 FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2688 if (error_file != NULL)
2690 while (!feof(error_file))
2691 fputc(fgetc(error_file), stderr);
2699 /* ------------------------------------------------------------------------- */
2700 /* the following is only for debugging purpose and normally not used */
2701 /* ------------------------------------------------------------------------- */
2703 #define DEBUG_NUM_TIMESTAMPS 3
2705 void debug_print_timestamp(int counter_nr, char *message)
2707 static long counter[DEBUG_NUM_TIMESTAMPS][2];
2709 if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2710 Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2712 counter[counter_nr][0] = Counter();
2715 printf("%s %.2f seconds\n", message,
2716 (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2718 counter[counter_nr][1] = Counter();
2721 void debug_print_parent_only(char *format, ...)
2723 if (!IS_PARENT_PROCESS())
2730 va_start(ap, format);
2731 vprintf(format, ap);