rnd-20050608-1-src
[rocksndiamonds.git] / src / libgame / misc.c
1 /***********************************************************
2 * Artsoft Retro-Game Library                               *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * misc.c                                                   *
12 ***********************************************************/
13
14 #include <time.h>
15 #include <sys/time.h>
16 #include <sys/types.h>
17 #include <stdarg.h>
18 #include <ctype.h>
19 #include <string.h>
20 #include <unistd.h>
21
22 #include "platform.h"
23
24 #if !defined(PLATFORM_WIN32)
25 #include <pwd.h>
26 #include <sys/param.h>
27 #endif
28
29 #include "misc.h"
30 #include "setup.h"
31 #include "random.h"
32 #include "text.h"
33 #include "image.h"
34
35
36 /* ------------------------------------------------------------------------- */
37 /* some generic helper functions                                             */
38 /* ------------------------------------------------------------------------- */
39
40 void fprintf_line(FILE *stream, char *line_string, int line_length)
41 {
42   int i;
43
44   for (i = 0; i < line_length; i++)
45     fprintf(stream, "%s", line_string);
46
47   fprintf(stream, "\n");
48 }
49
50 void printf_line(char *line_string, int line_length)
51 {
52   fprintf_line(stdout, line_string, line_length);
53 }
54
55
56 /* int2str() returns a number converted to a string;
57    the used memory is static, but will be overwritten by later calls,
58    so if you want to save the result, copy it to a private string buffer;
59    there can be 10 local calls of int2str() without buffering the result --
60    the 11th call will then destroy the result from the first call and so on.
61 */
62
63 char *int2str(int number, int size)
64 {
65   static char shift_array[10][40];
66   static int shift_counter = 0;
67   char *s = shift_array[shift_counter];
68
69   shift_counter = (shift_counter + 1) % 10;
70
71   if (size > 20)
72     size = 20;
73
74   if (size)
75   {
76     sprintf(s, "                    %09d", number);
77     return &s[strlen(s) - size];
78   }
79   else
80   {
81     sprintf(s, "%d", number);
82     return s;
83   }
84 }
85
86
87 /* something similar to "int2str()" above, but allocates its own memory
88    and has a different interface; we cannot use "itoa()", because this
89    seems to be already defined when cross-compiling to the win32 target */
90
91 char *i_to_a(unsigned int i)
92 {
93   static char *a = NULL;
94
95   checked_free(a);
96
97   if (i > 2147483647)   /* yes, this is a kludge */
98     i = 2147483647;
99
100   a = checked_malloc(10 + 1);
101
102   sprintf(a, "%d", i);
103
104   return a;
105 }
106
107
108 /* calculate base-2 logarithm of argument (rounded down to integer;
109    this function returns the number of the highest bit set in argument) */
110
111 int log_2(unsigned int x)
112 {
113   int e = 0;
114
115   while ((1 << e) < x)
116   {
117     x -= (1 << e);      /* for rounding down (rounding up: remove this line) */
118     e++;
119   }
120
121   return e;
122 }
123
124
125 /* ------------------------------------------------------------------------- */
126 /* counter functions                                                         */
127 /* ------------------------------------------------------------------------- */
128
129 #if defined(PLATFORM_MSDOS)
130 volatile unsigned long counter = 0;
131
132 void increment_counter()
133 {
134   counter++;
135 }
136
137 END_OF_FUNCTION(increment_counter);
138 #endif
139
140
141 /* maximal allowed length of a command line option */
142 #define MAX_OPTION_LEN          256
143
144 #ifdef TARGET_SDL
145 static unsigned long mainCounter(int mode)
146 {
147   static unsigned long base_ms = 0;
148   unsigned long current_ms;
149   unsigned long counter_ms;
150
151   current_ms = SDL_GetTicks();
152
153   /* reset base time in case of counter initializing or wrap-around */
154   if (mode == INIT_COUNTER || current_ms < base_ms)
155     base_ms = current_ms;
156
157   counter_ms = current_ms - base_ms;
158
159   return counter_ms;            /* return milliseconds since last init */
160 }
161
162 #else /* !TARGET_SDL */
163
164 #if defined(PLATFORM_UNIX)
165 static unsigned long mainCounter(int mode)
166 {
167   static struct timeval base_time = { 0, 0 };
168   struct timeval current_time;
169   unsigned long counter_ms;
170
171   gettimeofday(&current_time, NULL);
172
173   /* reset base time in case of counter initializing or wrap-around */
174   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
175     base_time = current_time;
176
177   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
178              + (current_time.tv_usec - base_time.tv_usec) / 1000;
179
180   return counter_ms;            /* return milliseconds since last init */
181 }
182 #endif /* PLATFORM_UNIX */
183 #endif /* !TARGET_SDL */
184
185 void InitCounter()              /* set counter back to zero */
186 {
187 #if !defined(PLATFORM_MSDOS)
188   mainCounter(INIT_COUNTER);
189 #else
190   LOCK_VARIABLE(counter);
191   LOCK_FUNCTION(increment_counter);
192   install_int_ex(increment_counter, BPS_TO_TIMER(100));
193 #endif
194 }
195
196 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
197 {
198 #if !defined(PLATFORM_MSDOS)
199   return mainCounter(READ_COUNTER);
200 #else
201   return (counter * 10);
202 #endif
203 }
204
205 static void sleep_milliseconds(unsigned long milliseconds_delay)
206 {
207   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
208
209 #if 0
210 #if defined(PLATFORM_MSDOS)
211   /* don't use select() to perform waiting operations under DOS
212      environment; always use a busy loop for waiting instead */
213   do_busy_waiting = TRUE;
214 #endif
215 #endif
216
217   if (do_busy_waiting)
218   {
219     /* we want to wait only a few ms -- if we assume that we have a
220        kernel timer resolution of 10 ms, we would wait far to long;
221        therefore it's better to do a short interval of busy waiting
222        to get our sleeping time more accurate */
223
224     unsigned long base_counter = Counter(), actual_counter = Counter();
225
226     while (actual_counter < base_counter + milliseconds_delay &&
227            actual_counter >= base_counter)
228       actual_counter = Counter();
229   }
230   else
231   {
232 #if defined(TARGET_SDL)
233     SDL_Delay(milliseconds_delay);
234 #elif defined(TARGET_ALLEGRO)
235     rest(milliseconds_delay);
236 #else
237     struct timeval delay;
238
239     delay.tv_sec  = milliseconds_delay / 1000;
240     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
241
242     if (select(0, NULL, NULL, NULL, &delay) != 0)
243       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
244 #endif
245   }
246 }
247
248 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
249 {
250   sleep_milliseconds(delay);
251 }
252
253 boolean FrameReached(unsigned long *frame_counter_var,
254                      unsigned long frame_delay)
255 {
256   unsigned long actual_frame_counter = FrameCounter;
257
258   if (actual_frame_counter >= *frame_counter_var &&
259       actual_frame_counter < *frame_counter_var + frame_delay)
260     return FALSE;
261
262   *frame_counter_var = actual_frame_counter;
263
264   return TRUE;
265 }
266
267 boolean DelayReached(unsigned long *counter_var,
268                      unsigned long delay)
269 {
270   unsigned long actual_counter = Counter();
271
272   if (actual_counter >= *counter_var &&
273       actual_counter < *counter_var + delay)
274     return FALSE;
275
276   *counter_var = actual_counter;
277
278   return TRUE;
279 }
280
281 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
282 {
283   unsigned long actual_counter;
284
285   while (1)
286   {
287     actual_counter = Counter();
288
289     if (actual_counter >= *counter_var &&
290         actual_counter < *counter_var + delay)
291       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
292     else
293       break;
294   }
295
296   *counter_var = actual_counter;
297 }
298
299
300 /* ------------------------------------------------------------------------- */
301 /* random generator functions                                                */
302 /* ------------------------------------------------------------------------- */
303
304 unsigned int init_random_number(int nr, long seed)
305 {
306   if (seed == NEW_RANDOMIZE)
307   {
308 #if defined(TARGET_SDL)
309     seed = (long)SDL_GetTicks();
310 #else
311     struct timeval current_time;
312
313     gettimeofday(&current_time, NULL);
314     seed = (long)current_time.tv_usec;
315 #endif
316   }
317
318   srandom_linux_libc(nr, (unsigned int) seed);
319
320   return (unsigned int) seed;
321 }
322
323 unsigned int get_random_number(int nr, int max)
324 {
325   return (max > 0 ? random_linux_libc(nr) % max : 0);
326 }
327
328
329 /* ------------------------------------------------------------------------- */
330 /* system info functions                                                     */
331 /* ------------------------------------------------------------------------- */
332
333 #if !defined(PLATFORM_MSDOS)
334 static char *get_corrected_real_name(char *real_name)
335 {
336   char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
337   char *from_ptr = real_name;
338   char *to_ptr   = real_name_new;
339
340   /* copy the name string, but not more than MAX_USERNAME_LEN characters */
341   while (*from_ptr && (long)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
342   {
343     /* the name field read from "passwd" file may also contain additional
344        user information, separated by commas, which will be removed here */
345     if (*from_ptr == ',')
346       break;
347
348     /* the user's real name may contain 'ß' characters (german sharp s),
349        which have no equivalent in upper case letters (used by our fonts) */
350     if (*from_ptr == 'ß')
351     {
352       from_ptr++;
353       *to_ptr++ = 's';
354       *to_ptr++ = 's';
355     }
356     else
357       *to_ptr++ = *from_ptr++;
358   }
359
360   *to_ptr = '\0';
361
362   return real_name_new;
363 }
364 #endif
365
366 char *getLoginName()
367 {
368   static char *login_name = NULL;
369
370 #if defined(PLATFORM_WIN32)
371   if (login_name == NULL)
372   {
373     unsigned long buffer_size = MAX_USERNAME_LEN + 1;
374     login_name = checked_malloc(buffer_size);
375
376     if (GetUserName(login_name, &buffer_size) == 0)
377       strcpy(login_name, ANONYMOUS_NAME);
378   }
379 #else
380   if (login_name == NULL)
381   {
382     struct passwd *pwd;
383
384     if ((pwd = getpwuid(getuid())) == NULL)
385       login_name = ANONYMOUS_NAME;
386     else
387       login_name = getStringCopy(pwd->pw_name);
388   }
389 #endif
390
391   return login_name;
392 }
393
394 char *getRealName()
395 {
396   static char *real_name = NULL;
397
398 #if defined(PLATFORM_WIN32)
399   if (real_name == NULL)
400   {
401     static char buffer[MAX_USERNAME_LEN + 1];
402     unsigned long buffer_size = MAX_USERNAME_LEN + 1;
403
404     if (GetUserName(buffer, &buffer_size) != 0)
405       real_name = get_corrected_real_name(buffer);
406     else
407       real_name = ANONYMOUS_NAME;
408   }
409 #elif defined(PLATFORM_UNIX)
410   if (real_name == NULL)
411   {
412     struct passwd *pwd;
413
414     if ((pwd = getpwuid(getuid())) != NULL && strlen(pwd->pw_gecos) != 0)
415       real_name = get_corrected_real_name(pwd->pw_gecos);
416     else
417       real_name = ANONYMOUS_NAME;
418   }
419 #else
420   real_name = ANONYMOUS_NAME;
421 #endif
422
423   return real_name;
424 }
425
426 char *getHomeDir()
427 {
428   static char *dir = NULL;
429
430 #if defined(PLATFORM_WIN32)
431   if (dir == NULL)
432   {
433     dir = checked_malloc(MAX_PATH + 1);
434
435     if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_PERSONAL, NULL, 0, dir)))
436       strcpy(dir, ".");
437   }
438 #elif defined(PLATFORM_UNIX)
439   if (dir == NULL)
440   {
441     if ((dir = getenv("HOME")) == NULL)
442     {
443       struct passwd *pwd;
444
445       if ((pwd = getpwuid(getuid())) != NULL)
446         dir = getStringCopy(pwd->pw_dir);
447       else
448         dir = ".";
449     }
450   }
451 #else
452   dir = ".";
453 #endif
454
455   return dir;
456 }
457
458
459 /* ------------------------------------------------------------------------- */
460 /* various string functions                                                  */
461 /* ------------------------------------------------------------------------- */
462
463 char *getPath2(char *path1, char *path2)
464 {
465   char *complete_path = checked_malloc(strlen(path1) + 1 +
466                                        strlen(path2) + 1);
467
468   sprintf(complete_path, "%s/%s", path1, path2);
469
470   return complete_path;
471 }
472
473 char *getPath3(char *path1, char *path2, char *path3)
474 {
475   char *complete_path = checked_malloc(strlen(path1) + 1 +
476                                        strlen(path2) + 1 +
477                                        strlen(path3) + 1);
478
479   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
480
481   return complete_path;
482 }
483
484 char *getStringCat2(char *s1, char *s2)
485 {
486   char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
487
488   sprintf(complete_string, "%s%s", s1, s2);
489
490   return complete_string;
491 }
492
493 char *getStringCopy(char *s)
494 {
495   char *s_copy;
496
497   if (s == NULL)
498     return NULL;
499
500   s_copy = checked_malloc(strlen(s) + 1);
501   strcpy(s_copy, s);
502
503   return s_copy;
504 }
505
506 char *getStringToLower(char *s)
507 {
508   char *s_copy = checked_malloc(strlen(s) + 1);
509   char *s_ptr = s_copy;
510
511   while (*s)
512     *s_ptr++ = tolower(*s++);
513   *s_ptr = '\0';
514
515   return s_copy;
516 }
517
518 void setString(char **old_value, char *new_value)
519 {
520   checked_free(*old_value);
521
522   *old_value = getStringCopy(new_value);
523 }
524
525
526 /* ------------------------------------------------------------------------- */
527 /* command line option handling functions                                    */
528 /* ------------------------------------------------------------------------- */
529
530 void GetOptions(char *argv[], void (*print_usage_function)(void))
531 {
532   char **options_left = &argv[1];
533
534   /* initialize global program options */
535   options.display_name = NULL;
536   options.server_host = NULL;
537   options.server_port = 0;
538   options.ro_base_directory = RO_BASE_PATH;
539   options.rw_base_directory = RW_BASE_PATH;
540   options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
541   options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
542   options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
543   options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
544   options.docs_directory = RO_BASE_PATH "/" DOCS_DIRECTORY;
545   options.execute_command = NULL;
546   options.serveronly = FALSE;
547   options.network = FALSE;
548   options.verbose = FALSE;
549   options.debug = FALSE;
550
551 #if !defined(PLATFORM_UNIX)
552   if (*options_left == NULL)    /* no options given -- enable verbose mode */
553     options.verbose = TRUE;
554 #endif
555
556   while (*options_left)
557   {
558     char option_str[MAX_OPTION_LEN];
559     char *option = options_left[0];
560     char *next_option = options_left[1];
561     char *option_arg = NULL;
562     int option_len = strlen(option);
563
564     if (option_len >= MAX_OPTION_LEN)
565       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
566
567     strcpy(option_str, option);                 /* copy argument into buffer */
568     option = option_str;
569
570     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
571       break;
572
573     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
574       option++;
575
576     option_arg = strchr(option, '=');
577     if (option_arg == NULL)                     /* no '=' in option */
578       option_arg = next_option;
579     else
580     {
581       *option_arg++ = '\0';                     /* cut argument from option */
582       if (*option_arg == '\0')                  /* no argument after '=' */
583         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
584     }
585
586     option_len = strlen(option);
587
588     if (strcmp(option, "-") == 0)
589       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
590     else if (strncmp(option, "-help", option_len) == 0)
591     {
592       print_usage_function();
593
594       exit(0);
595     }
596     else if (strncmp(option, "-display", option_len) == 0)
597     {
598       if (option_arg == NULL)
599         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
600
601       options.display_name = option_arg;
602       if (option_arg == next_option)
603         options_left++;
604     }
605     else if (strncmp(option, "-basepath", option_len) == 0)
606     {
607       if (option_arg == NULL)
608         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
609
610       /* this should be extended to separate options for ro and rw data */
611       options.ro_base_directory = option_arg;
612       options.rw_base_directory = option_arg;
613       if (option_arg == next_option)
614         options_left++;
615
616       /* adjust paths for sub-directories in base directory accordingly */
617       options.level_directory =
618         getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
619       options.graphics_directory =
620         getPath2(options.ro_base_directory, GRAPHICS_DIRECTORY);
621       options.sounds_directory =
622         getPath2(options.ro_base_directory, SOUNDS_DIRECTORY);
623       options.music_directory =
624         getPath2(options.ro_base_directory, MUSIC_DIRECTORY);
625       options.docs_directory =
626         getPath2(options.ro_base_directory, DOCS_DIRECTORY);
627     }
628     else if (strncmp(option, "-levels", option_len) == 0)
629     {
630       if (option_arg == NULL)
631         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
632
633       options.level_directory = option_arg;
634       if (option_arg == next_option)
635         options_left++;
636     }
637     else if (strncmp(option, "-graphics", option_len) == 0)
638     {
639       if (option_arg == NULL)
640         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
641
642       options.graphics_directory = option_arg;
643       if (option_arg == next_option)
644         options_left++;
645     }
646     else if (strncmp(option, "-sounds", option_len) == 0)
647     {
648       if (option_arg == NULL)
649         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
650
651       options.sounds_directory = option_arg;
652       if (option_arg == next_option)
653         options_left++;
654     }
655     else if (strncmp(option, "-music", option_len) == 0)
656     {
657       if (option_arg == NULL)
658         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
659
660       options.music_directory = option_arg;
661       if (option_arg == next_option)
662         options_left++;
663     }
664     else if (strncmp(option, "-network", option_len) == 0)
665     {
666       options.network = TRUE;
667     }
668     else if (strncmp(option, "-serveronly", option_len) == 0)
669     {
670       options.serveronly = TRUE;
671     }
672     else if (strncmp(option, "-verbose", option_len) == 0)
673     {
674       options.verbose = TRUE;
675     }
676     else if (strncmp(option, "-debug", option_len) == 0)
677     {
678       options.debug = TRUE;
679     }
680     else if (strncmp(option, "-execute", option_len) == 0)
681     {
682       if (option_arg == NULL)
683         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
684
685       options.execute_command = option_arg;
686       if (option_arg == next_option)
687         options_left++;
688
689 #if 1
690       /* when doing batch processing, always enable verbose mode (warnings) */
691       options.verbose = TRUE;
692 #endif
693     }
694     else if (*option == '-')
695     {
696       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
697     }
698     else if (options.server_host == NULL)
699     {
700       options.server_host = *options_left;
701     }
702     else if (options.server_port == 0)
703     {
704       options.server_port = atoi(*options_left);
705       if (options.server_port < 1024)
706         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
707     }
708     else
709       Error(ERR_EXIT_HELP, "too many arguments");
710
711     options_left++;
712   }
713 }
714
715
716 /* ------------------------------------------------------------------------- */
717 /* error handling functions                                                  */
718 /* ------------------------------------------------------------------------- */
719
720 /* used by SetError() and GetError() to store internal error messages */
721 static char internal_error[1024];       /* this is bad */
722
723 void SetError(char *format, ...)
724 {
725   va_list ap;
726
727   va_start(ap, format);
728   vsprintf(internal_error, format, ap);
729   va_end(ap);
730 }
731
732 char *GetError()
733 {
734   return internal_error;
735 }
736
737 void Error(int mode, char *format, ...)
738 {
739   static boolean last_line_was_separator = FALSE;
740   char *process_name = "";
741   FILE *error = stderr;
742   char *newline = "\n";
743
744   /* display warnings only when running in verbose mode */
745   if (mode & ERR_WARN && !options.verbose)
746     return;
747
748   if (mode == ERR_RETURN_LINE)
749   {
750     if (!last_line_was_separator)
751       fprintf_line(error, format, 79);
752
753     last_line_was_separator = TRUE;
754
755     return;
756   }
757
758   last_line_was_separator = FALSE;
759
760 #if defined(PLATFORM_MSDOS)
761   newline = "\r\n";
762
763   if ((error = openErrorFile()) == NULL)
764   {
765     printf("Cannot write to error output file!%s", newline);
766     program.exit_function(1);
767   }
768 #endif
769
770   if (mode & ERR_SOUND_SERVER)
771     process_name = " sound server";
772   else if (mode & ERR_NETWORK_SERVER)
773     process_name = " network server";
774   else if (mode & ERR_NETWORK_CLIENT)
775     process_name = " network client **";
776
777   if (format)
778   {
779     va_list ap;
780
781     fprintf(error, "%s%s: ", program.command_basename, process_name);
782
783     if (mode & ERR_WARN)
784       fprintf(error, "warning: ");
785
786     va_start(ap, format);
787     vfprintf(error, format, ap);
788     va_end(ap);
789   
790     fprintf(error, "%s", newline);
791   }
792   
793   if (mode & ERR_HELP)
794     fprintf(error, "%s: Try option '--help' for more information.%s",
795             program.command_basename, newline);
796
797   if (mode & ERR_EXIT)
798     fprintf(error, "%s%s: aborting%s",
799             program.command_basename, process_name, newline);
800
801   if (error != stderr)
802     fclose(error);
803
804   if (mode & ERR_EXIT)
805   {
806     if (mode & ERR_FROM_SERVER)
807       exit(1);                          /* child process: normal exit */
808     else
809       program.exit_function(1);         /* main process: clean up stuff */
810   }
811 }
812
813
814 /* ------------------------------------------------------------------------- */
815 /* checked memory allocation and freeing functions                           */
816 /* ------------------------------------------------------------------------- */
817
818 void *checked_malloc(unsigned long size)
819 {
820   void *ptr;
821
822   ptr = malloc(size);
823
824   if (ptr == NULL)
825     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
826
827   return ptr;
828 }
829
830 void *checked_calloc(unsigned long size)
831 {
832   void *ptr;
833
834   ptr = calloc(1, size);
835
836   if (ptr == NULL)
837     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
838
839   return ptr;
840 }
841
842 void *checked_realloc(void *ptr, unsigned long size)
843 {
844   ptr = realloc(ptr, size);
845
846   if (ptr == NULL)
847     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
848
849   return ptr;
850 }
851
852 void checked_free(void *ptr)
853 {
854   if (ptr != NULL)      /* this check should be done by free() anyway */
855     free(ptr);
856 }
857
858
859 /* ------------------------------------------------------------------------- */
860 /* various helper functions                                                  */
861 /* ------------------------------------------------------------------------- */
862
863 inline void swap_numbers(int *i1, int *i2)
864 {
865   int help = *i1;
866
867   *i1 = *i2;
868   *i2 = help;
869 }
870
871 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
872 {
873   int help_x = *x1;
874   int help_y = *y1;
875
876   *x1 = *x2;
877   *x2 = help_x;
878
879   *y1 = *y2;
880   *y2 = help_y;
881 }
882
883 int getFile16BitInteger(FILE *file, int byte_order)
884 {
885   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
886     return ((fgetc(file) << 8) |
887             (fgetc(file) << 0));
888   else           /* BYTE_ORDER_LITTLE_ENDIAN */
889     return ((fgetc(file) << 0) |
890             (fgetc(file) << 8));
891 }
892
893 void putFile16BitInteger(FILE *file, int value, int byte_order)
894 {
895   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
896   {
897     fputc((value >> 8) & 0xff, file);
898     fputc((value >> 0) & 0xff, file);
899   }
900   else           /* BYTE_ORDER_LITTLE_ENDIAN */
901   {
902     fputc((value >> 0) & 0xff, file);
903     fputc((value >> 8) & 0xff, file);
904   }
905 }
906
907 int getFile32BitInteger(FILE *file, int byte_order)
908 {
909   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
910     return ((fgetc(file) << 24) |
911             (fgetc(file) << 16) |
912             (fgetc(file) <<  8) |
913             (fgetc(file) <<  0));
914   else           /* BYTE_ORDER_LITTLE_ENDIAN */
915     return ((fgetc(file) <<  0) |
916             (fgetc(file) <<  8) |
917             (fgetc(file) << 16) |
918             (fgetc(file) << 24));
919 }
920
921 void putFile32BitInteger(FILE *file, int value, int byte_order)
922 {
923   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
924   {
925     fputc((value >> 24) & 0xff, file);
926     fputc((value >> 16) & 0xff, file);
927     fputc((value >>  8) & 0xff, file);
928     fputc((value >>  0) & 0xff, file);
929   }
930   else           /* BYTE_ORDER_LITTLE_ENDIAN */
931   {
932     fputc((value >>  0) & 0xff, file);
933     fputc((value >>  8) & 0xff, file);
934     fputc((value >> 16) & 0xff, file);
935     fputc((value >> 24) & 0xff, file);
936   }
937 }
938
939 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
940                      int byte_order)
941 {
942   const int chunk_name_length = 4;
943
944   /* read chunk name */
945   fgets(chunk_name, chunk_name_length + 1, file);
946
947   if (chunk_size != NULL)
948   {
949     /* read chunk size */
950     *chunk_size = getFile32BitInteger(file, byte_order);
951   }
952
953   return (feof(file) || ferror(file) ? FALSE : TRUE);
954 }
955
956 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
957                   int byte_order)
958 {
959   /* write chunk name */
960   fputs(chunk_name, file);
961
962   if (chunk_size >= 0)
963   {
964     /* write chunk size */
965     putFile32BitInteger(file, chunk_size, byte_order);
966   }
967 }
968
969 int getFileVersion(FILE *file)
970 {
971   int version_major = fgetc(file);
972   int version_minor = fgetc(file);
973   int version_patch = fgetc(file);
974   int version_build = fgetc(file);
975
976   return VERSION_IDENT(version_major, version_minor, version_patch,
977                        version_build);
978 }
979
980 void putFileVersion(FILE *file, int version)
981 {
982   int version_major = VERSION_MAJOR(version);
983   int version_minor = VERSION_MINOR(version);
984   int version_patch = VERSION_PATCH(version);
985   int version_build = VERSION_BUILD(version);
986
987   fputc(version_major, file);
988   fputc(version_minor, file);
989   fputc(version_patch, file);
990   fputc(version_build, file);
991 }
992
993 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
994 {
995   while (bytes-- && !feof(file))
996     fgetc(file);
997 }
998
999 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1000 {
1001   while (bytes--)
1002     fputc(0, file);
1003 }
1004
1005
1006 /* ------------------------------------------------------------------------- */
1007 /* functions to translate key identifiers between different format           */
1008 /* ------------------------------------------------------------------------- */
1009
1010 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
1011 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
1012 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
1013 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
1014
1015 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1016 {
1017   static struct
1018   {
1019     Key key;
1020     char *x11name;
1021     char *name;
1022   } translate_key[] =
1023   {
1024     /* normal cursor keys */
1025     { KSYM_Left,        "XK_Left",              "cursor left" },
1026     { KSYM_Right,       "XK_Right",             "cursor right" },
1027     { KSYM_Up,          "XK_Up",                "cursor up" },
1028     { KSYM_Down,        "XK_Down",              "cursor down" },
1029
1030     /* keypad cursor keys */
1031 #ifdef KSYM_KP_Left
1032     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
1033     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
1034     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
1035     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
1036 #endif
1037
1038     /* other keypad keys */
1039 #ifdef KSYM_KP_Enter
1040     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
1041     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
1042     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
1043     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
1044     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
1045     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
1046 #endif
1047
1048     /* modifier keys */
1049     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
1050     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
1051     { KSYM_Control_L,   "XK_Control_L",         "left control" },
1052     { KSYM_Control_R,   "XK_Control_R",         "right control" },
1053     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
1054     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
1055     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
1056     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
1057     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
1058     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
1059     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
1060     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
1061
1062     /* some special keys */
1063     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
1064     { KSYM_Delete,      "XK_Delete",            "delete" },
1065     { KSYM_Insert,      "XK_Insert",            "insert" },
1066     { KSYM_Tab,         "XK_Tab",               "tab" },
1067     { KSYM_Home,        "XK_Home",              "home" },
1068     { KSYM_End,         "XK_End",               "end" },
1069     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
1070     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
1071     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
1072
1073     /* ASCII 0x20 to 0x40 keys (except numbers) */
1074     { KSYM_space,       "XK_space",             "space" },
1075     { KSYM_exclam,      "XK_exclam",            "!" },
1076     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
1077     { KSYM_numbersign,  "XK_numbersign",        "#" },
1078     { KSYM_dollar,      "XK_dollar",            "$" },
1079     { KSYM_percent,     "XK_percent",           "%" },
1080     { KSYM_ampersand,   "XK_ampersand",         "&" },
1081     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
1082     { KSYM_parenleft,   "XK_parenleft",         "(" },
1083     { KSYM_parenright,  "XK_parenright",        ")" },
1084     { KSYM_asterisk,    "XK_asterisk",          "*" },
1085     { KSYM_plus,        "XK_plus",              "+" },
1086     { KSYM_comma,       "XK_comma",             "," },
1087     { KSYM_minus,       "XK_minus",             "-" },
1088     { KSYM_period,      "XK_period",            "." },
1089     { KSYM_slash,       "XK_slash",             "/" },
1090     { KSYM_colon,       "XK_colon",             ":" },
1091     { KSYM_semicolon,   "XK_semicolon",         ";" },
1092     { KSYM_less,        "XK_less",              "<" },
1093     { KSYM_equal,       "XK_equal",             "=" },
1094     { KSYM_greater,     "XK_greater",           ">" },
1095     { KSYM_question,    "XK_question",          "?" },
1096     { KSYM_at,          "XK_at",                "@" },
1097
1098     /* more ASCII keys */
1099     { KSYM_bracketleft, "XK_bracketleft",       "[" },
1100     { KSYM_backslash,   "XK_backslash",         "backslash" },
1101     { KSYM_bracketright,"XK_bracketright",      "]" },
1102     { KSYM_asciicircum, "XK_asciicircum",       "circumflex" },
1103     { KSYM_underscore,  "XK_underscore",        "_" },
1104     { KSYM_grave,       "XK_grave",             "grave" },
1105     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
1106     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
1107     { KSYM_bar,         "XK_bar",               "bar" },
1108     { KSYM_braceright,  "XK_braceright",        "brace right" },
1109     { KSYM_asciitilde,  "XK_asciitilde",        "ascii tilde" },
1110
1111     /* special (non-ASCII) keys */
1112     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
1113     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
1114     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ãœ" },
1115     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
1116     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
1117     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
1118     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1119
1120     /* end-of-array identifier */
1121     { 0,                NULL,                   NULL }
1122   };
1123
1124   int i;
1125
1126   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1127   {
1128     static char name_buffer[30];
1129     Key key = *keysym;
1130
1131     if (key >= KSYM_A && key <= KSYM_Z)
1132       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1133     else if (key >= KSYM_a && key <= KSYM_z)
1134       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1135     else if (key >= KSYM_0 && key <= KSYM_9)
1136       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1137     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1138       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1139     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1140       sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1141     else if (key == KSYM_UNDEFINED)
1142       strcpy(name_buffer, "(undefined)");
1143     else
1144     {
1145       i = 0;
1146
1147       do
1148       {
1149         if (key == translate_key[i].key)
1150         {
1151           strcpy(name_buffer, translate_key[i].name);
1152           break;
1153         }
1154       }
1155       while (translate_key[++i].name);
1156
1157       if (!translate_key[i].name)
1158         strcpy(name_buffer, "(unknown)");
1159     }
1160
1161     *name = name_buffer;
1162   }
1163   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1164   {
1165     static char name_buffer[30];
1166     Key key = *keysym;
1167
1168     if (key >= KSYM_A && key <= KSYM_Z)
1169       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1170     else if (key >= KSYM_a && key <= KSYM_z)
1171       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1172     else if (key >= KSYM_0 && key <= KSYM_9)
1173       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1174     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1175       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1176     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1177       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1178     else if (key == KSYM_UNDEFINED)
1179       strcpy(name_buffer, "[undefined]");
1180     else
1181     {
1182       i = 0;
1183
1184       do
1185       {
1186         if (key == translate_key[i].key)
1187         {
1188           strcpy(name_buffer, translate_key[i].x11name);
1189           break;
1190         }
1191       }
1192       while (translate_key[++i].x11name);
1193
1194       if (!translate_key[i].x11name)
1195         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1196     }
1197
1198     *x11name = name_buffer;
1199   }
1200   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1201   {
1202     Key key = KSYM_UNDEFINED;
1203
1204     i = 0;
1205     do
1206     {
1207       if (strcmp(translate_key[i].name, *name) == 0)
1208       {
1209         key = translate_key[i].key;
1210         break;
1211       }
1212     }
1213     while (translate_key[++i].x11name);
1214
1215     if (key == KSYM_UNDEFINED)
1216       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1217
1218     *keysym = key;
1219   }
1220   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1221   {
1222     Key key = KSYM_UNDEFINED;
1223     char *name_ptr = *x11name;
1224
1225     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1226     {
1227       char c = name_ptr[3];
1228
1229       if (c >= 'A' && c <= 'Z')
1230         key = KSYM_A + (Key)(c - 'A');
1231       else if (c >= 'a' && c <= 'z')
1232         key = KSYM_a + (Key)(c - 'a');
1233       else if (c >= '0' && c <= '9')
1234         key = KSYM_0 + (Key)(c - '0');
1235     }
1236     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1237     {
1238       char c = name_ptr[6];
1239
1240       if (c >= '0' && c <= '9')
1241         key = KSYM_KP_0 + (Key)(c - '0');
1242     }
1243     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1244     {
1245       char c1 = name_ptr[4];
1246       char c2 = name_ptr[5];
1247       int d = 0;
1248
1249       if ((c1 >= '0' && c1 <= '9') &&
1250           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1251         d = atoi(&name_ptr[4]);
1252
1253       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1254         key = KSYM_F1 + (Key)(d - 1);
1255     }
1256     else if (strncmp(name_ptr, "XK_", 3) == 0)
1257     {
1258       i = 0;
1259
1260       do
1261       {
1262         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1263         {
1264           key = translate_key[i].key;
1265           break;
1266         }
1267       }
1268       while (translate_key[++i].x11name);
1269     }
1270     else if (strncmp(name_ptr, "0x", 2) == 0)
1271     {
1272       unsigned long value = 0;
1273
1274       name_ptr += 2;
1275
1276       while (name_ptr)
1277       {
1278         char c = *name_ptr++;
1279         int d = -1;
1280
1281         if (c >= '0' && c <= '9')
1282           d = (int)(c - '0');
1283         else if (c >= 'a' && c <= 'f')
1284           d = (int)(c - 'a' + 10);
1285         else if (c >= 'A' && c <= 'F')
1286           d = (int)(c - 'A' + 10);
1287
1288         if (d == -1)
1289         {
1290           value = -1;
1291           break;
1292         }
1293
1294         value = value * 16 + d;
1295       }
1296
1297       if (value != -1)
1298         key = (Key)value;
1299     }
1300
1301     *keysym = key;
1302   }
1303 }
1304
1305 char *getKeyNameFromKey(Key key)
1306 {
1307   char *name;
1308
1309   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1310   return name;
1311 }
1312
1313 char *getX11KeyNameFromKey(Key key)
1314 {
1315   char *x11name;
1316
1317   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1318   return x11name;
1319 }
1320
1321 Key getKeyFromKeyName(char *name)
1322 {
1323   Key key;
1324
1325   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1326   return key;
1327 }
1328
1329 Key getKeyFromX11KeyName(char *x11name)
1330 {
1331   Key key;
1332
1333   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1334   return key;
1335 }
1336
1337 char getCharFromKey(Key key)
1338 {
1339   char *keyname = getKeyNameFromKey(key);
1340   char letter = 0;
1341
1342   if (strlen(keyname) == 1)
1343     letter = keyname[0];
1344   else if (strcmp(keyname, "space") == 0)
1345     letter = ' ';
1346   else if (strcmp(keyname, "circumflex") == 0)
1347     letter = '^';
1348
1349   return letter;
1350 }
1351
1352
1353 /* ------------------------------------------------------------------------- */
1354 /* functions to translate string identifiers to integer or boolean value     */
1355 /* ------------------------------------------------------------------------- */
1356
1357 int get_integer_from_string(char *s)
1358 {
1359   static char *number_text[][3] =
1360   {
1361     { "0",      "zero",         "null",         },
1362     { "1",      "one",          "first"         },
1363     { "2",      "two",          "second"        },
1364     { "3",      "three",        "third"         },
1365     { "4",      "four",         "fourth"        },
1366     { "5",      "five",         "fifth"         },
1367     { "6",      "six",          "sixth"         },
1368     { "7",      "seven",        "seventh"       },
1369     { "8",      "eight",        "eighth"        },
1370     { "9",      "nine",         "ninth"         },
1371     { "10",     "ten",          "tenth"         },
1372     { "11",     "eleven",       "eleventh"      },
1373     { "12",     "twelve",       "twelfth"       },
1374
1375     { NULL,     NULL,           NULL            },
1376   };
1377
1378   int i, j;
1379   char *s_lower = getStringToLower(s);
1380   int result = -1;
1381
1382   for (i = 0; number_text[i][0] != NULL; i++)
1383     for (j = 0; j < 3; j++)
1384       if (strcmp(s_lower, number_text[i][j]) == 0)
1385         result = i;
1386
1387   if (result == -1)
1388   {
1389     if (strcmp(s_lower, "false") == 0)
1390       result = 0;
1391     else if (strcmp(s_lower, "true") == 0)
1392       result = 1;
1393     else
1394       result = atoi(s);
1395   }
1396
1397   free(s_lower);
1398
1399   return result;
1400 }
1401
1402 boolean get_boolean_from_string(char *s)
1403 {
1404   char *s_lower = getStringToLower(s);
1405   boolean result = FALSE;
1406
1407   if (strcmp(s_lower, "true") == 0 ||
1408       strcmp(s_lower, "yes") == 0 ||
1409       strcmp(s_lower, "on") == 0 ||
1410       get_integer_from_string(s) == 1)
1411     result = TRUE;
1412
1413   free(s_lower);
1414
1415   return result;
1416 }
1417
1418
1419 /* ------------------------------------------------------------------------- */
1420 /* functions for generic lists                                               */
1421 /* ------------------------------------------------------------------------- */
1422
1423 ListNode *newListNode()
1424 {
1425   return checked_calloc(sizeof(ListNode));
1426 }
1427
1428 void addNodeToList(ListNode **node_first, char *key, void *content)
1429 {
1430   ListNode *node_new = newListNode();
1431
1432 #if 0
1433   printf("LIST: adding node with key '%s'\n", key);
1434 #endif
1435
1436   node_new->key = getStringCopy(key);
1437   node_new->content = content;
1438   node_new->next = *node_first;
1439   *node_first = node_new;
1440 }
1441
1442 void deleteNodeFromList(ListNode **node_first, char *key,
1443                         void (*destructor_function)(void *))
1444 {
1445   if (node_first == NULL || *node_first == NULL)
1446     return;
1447
1448 #if 0
1449   printf("[CHECKING LIST KEY '%s' == '%s']\n",
1450          (*node_first)->key, key);
1451 #endif
1452
1453   if (strcmp((*node_first)->key, key) == 0)
1454   {
1455 #if 0
1456     printf("[DELETING LIST ENTRY]\n");
1457 #endif
1458
1459     free((*node_first)->key);
1460     if (destructor_function)
1461       destructor_function((*node_first)->content);
1462     *node_first = (*node_first)->next;
1463   }
1464   else
1465     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1466 }
1467
1468 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1469 {
1470   if (node_first == NULL)
1471     return NULL;
1472
1473   if (strcmp(node_first->key, key) == 0)
1474     return node_first;
1475   else
1476     return getNodeFromKey(node_first->next, key);
1477 }
1478
1479 int getNumNodes(ListNode *node_first)
1480 {
1481   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1482 }
1483
1484 void dumpList(ListNode *node_first)
1485 {
1486   ListNode *node = node_first;
1487
1488   while (node)
1489   {
1490     printf("['%s' (%d)]\n", node->key,
1491            ((struct ListNodeInfo *)node->content)->num_references);
1492     node = node->next;
1493   }
1494
1495   printf("[%d nodes]\n", getNumNodes(node_first));
1496 }
1497
1498
1499 /* ------------------------------------------------------------------------- */
1500 /* functions for checking files and filenames                                */
1501 /* ------------------------------------------------------------------------- */
1502
1503 boolean fileExists(char *filename)
1504 {
1505   if (filename == NULL)
1506     return FALSE;
1507
1508 #if 0
1509   printf("checking file '%s'\n", filename);
1510 #endif
1511
1512   return (access(filename, F_OK) == 0);
1513 }
1514
1515 boolean fileHasPrefix(char *basename, char *prefix)
1516 {
1517   static char *basename_lower = NULL;
1518   int basename_length, prefix_length;
1519
1520   checked_free(basename_lower);
1521
1522   if (basename == NULL || prefix == NULL)
1523     return FALSE;
1524
1525   basename_lower = getStringToLower(basename);
1526   basename_length = strlen(basename_lower);
1527   prefix_length = strlen(prefix);
1528
1529   if (basename_length > prefix_length + 1 &&
1530       basename_lower[prefix_length] == '.' &&
1531       strncmp(basename_lower, prefix, prefix_length) == 0)
1532     return TRUE;
1533
1534   return FALSE;
1535 }
1536
1537 boolean fileHasSuffix(char *basename, char *suffix)
1538 {
1539   static char *basename_lower = NULL;
1540   int basename_length, suffix_length;
1541
1542   checked_free(basename_lower);
1543
1544   if (basename == NULL || suffix == NULL)
1545     return FALSE;
1546
1547   basename_lower = getStringToLower(basename);
1548   basename_length = strlen(basename_lower);
1549   suffix_length = strlen(suffix);
1550
1551   if (basename_length > suffix_length + 1 &&
1552       basename_lower[basename_length - suffix_length - 1] == '.' &&
1553       strcmp(&basename_lower[basename_length - suffix_length], suffix) == 0)
1554     return TRUE;
1555
1556   return FALSE;
1557 }
1558
1559 boolean FileIsGraphic(char *filename)
1560 {
1561   char *basename = strrchr(filename, '/');
1562
1563   basename = (basename != NULL ? basename + 1 : filename);
1564
1565   return fileHasSuffix(basename, "pcx");
1566 }
1567
1568 boolean FileIsSound(char *filename)
1569 {
1570   char *basename = strrchr(filename, '/');
1571
1572   basename = (basename != NULL ? basename + 1 : filename);
1573
1574   return fileHasSuffix(basename, "wav");
1575 }
1576
1577 boolean FileIsMusic(char *filename)
1578 {
1579   char *basename = strrchr(filename, '/');
1580
1581   basename = (basename != NULL ? basename + 1 : filename);
1582
1583   if (FileIsSound(basename))
1584     return TRUE;
1585
1586 #if defined(TARGET_SDL)
1587   if (fileHasPrefix(basename, "mod") ||
1588       fileHasSuffix(basename, "mod") ||
1589       fileHasSuffix(basename, "s3m") ||
1590       fileHasSuffix(basename, "it") ||
1591       fileHasSuffix(basename, "xm") ||
1592       fileHasSuffix(basename, "midi") ||
1593       fileHasSuffix(basename, "mid") ||
1594       fileHasSuffix(basename, "mp3") ||
1595       fileHasSuffix(basename, "ogg"))
1596     return TRUE;
1597 #endif
1598
1599   return FALSE;
1600 }
1601
1602 boolean FileIsArtworkType(char *basename, int type)
1603 {
1604   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1605       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1606       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1607     return TRUE;
1608
1609   return FALSE;
1610 }
1611
1612 /* ------------------------------------------------------------------------- */
1613 /* functions for loading artwork configuration information                   */
1614 /* ------------------------------------------------------------------------- */
1615
1616 char *get_mapped_token(char *token)
1617 {
1618   /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1619   static char *map_token_prefix[][2] =
1620   {
1621     { "char_procent",           "char_percent"  },
1622     { NULL,                                     }
1623   };
1624   int i;
1625
1626   for (i = 0; map_token_prefix[i][0] != NULL; i++)
1627   {
1628     int len_token_prefix = strlen(map_token_prefix[i][0]);
1629
1630     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1631       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1632   }
1633
1634   return NULL;
1635 }
1636
1637 /* This function checks if a string <s> of the format "string1, string2, ..."
1638    exactly contains a string <s_contained>. */
1639
1640 static boolean string_has_parameter(char *s, char *s_contained)
1641 {
1642   char *substring;
1643
1644   if (s == NULL || s_contained == NULL)
1645     return FALSE;
1646
1647   if (strlen(s_contained) > strlen(s))
1648     return FALSE;
1649
1650   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1651   {
1652     char next_char = s[strlen(s_contained)];
1653
1654     /* check if next character is delimiter or whitespace */
1655     return (next_char == ',' || next_char == '\0' ||
1656             next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1657   }
1658
1659   /* check if string contains another parameter string after a comma */
1660   substring = strchr(s, ',');
1661   if (substring == NULL)        /* string does not contain a comma */
1662     return FALSE;
1663
1664   /* advance string pointer to next character after the comma */
1665   substring++;
1666
1667   /* skip potential whitespaces after the comma */
1668   while (*substring == ' ' || *substring == '\t')
1669     substring++;
1670
1671   return string_has_parameter(substring, s_contained);
1672 }
1673
1674 int get_parameter_value(char *suffix, char *value_raw, int type)
1675 {
1676   char *value = getStringToLower(value_raw);
1677   int result = 0;       /* probably a save default value */
1678
1679   if (strcmp(suffix, ".direction") == 0)
1680   {
1681     result = (strcmp(value, "left")  == 0 ? MV_LEFT :
1682               strcmp(value, "right") == 0 ? MV_RIGHT :
1683               strcmp(value, "up")    == 0 ? MV_UP :
1684               strcmp(value, "down")  == 0 ? MV_DOWN : MV_NO_MOVING);
1685   }
1686   else if (strcmp(suffix, ".anim_mode") == 0)
1687   {
1688     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
1689               string_has_parameter(value, "loop")       ? ANIM_LOOP :
1690               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
1691               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
1692               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
1693               string_has_parameter(value, "random")     ? ANIM_RANDOM :
1694               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1695               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
1696               ANIM_DEFAULT);
1697
1698     if (string_has_parameter(value, "reverse"))
1699       result |= ANIM_REVERSE;
1700   }
1701   else          /* generic parameter of type integer or boolean */
1702   {
1703     result = (strcmp(value, ARG_UNDEFINED) == 0 ? ARG_UNDEFINED_VALUE :
1704               type == TYPE_INTEGER ? get_integer_from_string(value) :
1705               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1706               ARG_UNDEFINED_VALUE);
1707   }
1708
1709   free(value);
1710
1711   return result;
1712 }
1713
1714 int get_auto_parameter_value(char *token, char *value_raw)
1715 {
1716   char *suffix;
1717
1718   if (token == NULL || value_raw == NULL)
1719     return ARG_UNDEFINED_VALUE;
1720
1721   suffix = strrchr(token, '.');
1722   if (suffix == NULL)
1723     suffix = token;
1724
1725   return get_parameter_value(suffix, value_raw, TYPE_INTEGER);
1726 }
1727
1728 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1729                                   struct ListNodeInfo ***, int *);
1730
1731 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1732                                            struct ConfigTypeInfo *suffix_list,
1733                                            char **ignore_tokens,
1734                                            int num_file_list_entries)
1735 {
1736   struct FileInfo *file_list;
1737   int num_file_list_entries_found = 0;
1738   int num_suffix_list_entries = 0;
1739   int list_pos;
1740   int i, j;
1741
1742   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1743
1744   for (i = 0; suffix_list[i].token != NULL; i++)
1745     num_suffix_list_entries++;
1746
1747   /* always start with reliable default values */
1748   for (i = 0; i < num_file_list_entries; i++)
1749   {
1750     file_list[i].token = NULL;
1751
1752     file_list[i].default_filename = NULL;
1753     file_list[i].filename = NULL;
1754
1755     if (num_suffix_list_entries > 0)
1756     {
1757       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1758
1759       file_list[i].default_parameter = checked_calloc(parameter_array_size);
1760       file_list[i].parameter = checked_calloc(parameter_array_size);
1761
1762       for (j = 0; j < num_suffix_list_entries; j++)
1763       {
1764         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1765         setString(&file_list[i].parameter[j], suffix_list[j].value);
1766       }
1767
1768       file_list[i].redefined = FALSE;
1769       file_list[i].fallback_to_default = FALSE;
1770     }
1771   }
1772
1773   list_pos = 0;
1774   for (i = 0; config_list[i].token != NULL; i++)
1775   {
1776     int len_config_token = strlen(config_list[i].token);
1777     int len_config_value = strlen(config_list[i].value);
1778     boolean is_file_entry = TRUE;
1779
1780     for (j = 0; suffix_list[j].token != NULL; j++)
1781     {
1782       int len_suffix = strlen(suffix_list[j].token);
1783
1784       if (len_suffix < len_config_token &&
1785           strcmp(&config_list[i].token[len_config_token - len_suffix],
1786                  suffix_list[j].token) == 0)
1787       {
1788         setString(&file_list[list_pos].default_parameter[j],
1789                   config_list[i].value);
1790
1791         is_file_entry = FALSE;
1792         break;
1793       }
1794     }
1795
1796     /* the following tokens are no file definitions, but other config tokens */
1797     for (j = 0; ignore_tokens[j] != NULL; j++)
1798       if (strcmp(config_list[i].token, ignore_tokens[j]) == 0)
1799         is_file_entry = FALSE;
1800
1801     if (is_file_entry)
1802     {
1803       if (i > 0)
1804         list_pos++;
1805
1806       if (list_pos >= num_file_list_entries)
1807         break;
1808
1809       /* simple sanity check if this is really a file definition */
1810       if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1811           strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1812           strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1813       {
1814         Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1815               config_list[i].token, config_list[i].value);
1816         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1817       }
1818
1819       file_list[list_pos].token = config_list[i].token;
1820       file_list[list_pos].default_filename = config_list[i].value;
1821     }
1822   }
1823
1824   num_file_list_entries_found = list_pos + 1;
1825   if (num_file_list_entries_found != num_file_list_entries)
1826   {
1827     Error(ERR_RETURN_LINE, "-");
1828     Error(ERR_RETURN, "inconsistant config list information:");
1829     Error(ERR_RETURN, "- should be:   %d (according to 'src/conf_gfx.h')",
1830           num_file_list_entries);
1831     Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1832           num_file_list_entries_found);
1833     Error(ERR_EXIT,   "please fix");
1834   }
1835
1836   return file_list;
1837 }
1838
1839 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
1840 {
1841   int len_token = strlen(token);
1842   int len_suffix = strlen(suffix);
1843
1844 #if 0
1845   if (IS_PARENT_PROCESS())
1846     printf(":::::::::: check '%s' for '%s' ::::::::::\n", token, suffix);
1847 #endif
1848
1849   if (start_pos < 0)    /* compare suffix from end of string */
1850     start_pos += len_token;
1851
1852   if (start_pos < 0 || start_pos + len_suffix > len_token)
1853     return FALSE;
1854
1855   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
1856     return FALSE;
1857
1858   if (token[start_pos + len_suffix] == '\0')
1859     return TRUE;
1860
1861   if (token[start_pos + len_suffix] == '.')
1862     return TRUE;
1863
1864   return FALSE;
1865 }
1866
1867 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
1868
1869 static void read_token_parameters(SetupFileHash *setup_file_hash,
1870                                   struct ConfigTypeInfo *suffix_list,
1871                                   struct FileInfo *file_list_entry)
1872 {
1873   /* check for config token that is the base token without any suffixes */
1874   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
1875   char *known_token_value = KNOWN_TOKEN_VALUE;
1876   int i;
1877
1878   if (filename != NULL)
1879   {
1880     setString(&file_list_entry->filename, filename);
1881
1882     /* when file definition found, set all parameters to default values */
1883     for (i = 0; suffix_list[i].token != NULL; i++)
1884       setString(&file_list_entry->parameter[i], suffix_list[i].value);
1885
1886     file_list_entry->redefined = TRUE;
1887
1888     /* mark config file token as well known from default config */
1889     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
1890   }
1891 #if 0
1892   else
1893   {
1894     if (strcmp(file_list_entry->filename,
1895                file_list_entry->default_filename) != 0)
1896       printf("___ resetting '%s' to default\n", file_list_entry->token);
1897
1898     setString(&file_list_entry->filename, file_list_entry->default_filename);
1899   }
1900 #endif
1901
1902   /* check for config tokens that can be build by base token and suffixes */
1903   for (i = 0; suffix_list[i].token != NULL; i++)
1904   {
1905     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
1906     char *value = getHashEntry(setup_file_hash, token);
1907
1908     if (value != NULL)
1909     {
1910       setString(&file_list_entry->parameter[i], value);
1911
1912       /* mark config file token as well known from default config */
1913       setHashEntry(setup_file_hash, token, known_token_value);
1914     }
1915
1916     free(token);
1917   }
1918 }
1919
1920 static void add_dynamic_file_list_entry(struct FileInfo **list,
1921                                         int *num_list_entries,
1922                                         SetupFileHash *extra_file_hash,
1923                                         struct ConfigTypeInfo *suffix_list,
1924                                         int num_suffix_list_entries,
1925                                         char *token)
1926 {
1927   struct FileInfo *new_list_entry;
1928   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1929
1930 #if 0
1931   if (IS_PARENT_PROCESS())
1932     printf("===> found dynamic definition '%s'\n", token);
1933 #endif
1934
1935   (*num_list_entries)++;
1936   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
1937   new_list_entry = &(*list)[*num_list_entries - 1];
1938
1939   new_list_entry->token = getStringCopy(token);
1940   new_list_entry->default_filename = NULL;
1941   new_list_entry->filename = NULL;
1942   new_list_entry->parameter = checked_calloc(parameter_array_size);
1943
1944   new_list_entry->redefined = FALSE;
1945   new_list_entry->fallback_to_default = FALSE;
1946
1947   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
1948 }
1949
1950 static void add_property_mapping(struct PropertyMapping **list,
1951                                  int *num_list_entries,
1952                                  int base_index, int ext1_index,
1953                                  int ext2_index, int ext3_index,
1954                                  int artwork_index)
1955 {
1956   struct PropertyMapping *new_list_entry;
1957
1958   (*num_list_entries)++;
1959   *list = checked_realloc(*list,
1960                           *num_list_entries * sizeof(struct PropertyMapping));
1961   new_list_entry = &(*list)[*num_list_entries - 1];
1962
1963   new_list_entry->base_index = base_index;
1964   new_list_entry->ext1_index = ext1_index;
1965   new_list_entry->ext2_index = ext2_index;
1966   new_list_entry->ext3_index = ext3_index;
1967
1968   new_list_entry->artwork_index = artwork_index;
1969 }
1970
1971 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
1972                                           char *filename)
1973 {
1974   struct FileInfo *file_list = artwork_info->file_list;
1975   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
1976   char **base_prefixes = artwork_info->base_prefixes;
1977   char **ext1_suffixes = artwork_info->ext1_suffixes;
1978   char **ext2_suffixes = artwork_info->ext2_suffixes;
1979   char **ext3_suffixes = artwork_info->ext3_suffixes;
1980   char **ignore_tokens = artwork_info->ignore_tokens;
1981   int num_file_list_entries = artwork_info->num_file_list_entries;
1982   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1983   int num_base_prefixes = artwork_info->num_base_prefixes;
1984   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
1985   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
1986   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
1987   int num_ignore_tokens = artwork_info->num_ignore_tokens;
1988   SetupFileHash *setup_file_hash, *valid_file_hash;
1989   SetupFileHash *extra_file_hash, *empty_file_hash;
1990   char *known_token_value = KNOWN_TOKEN_VALUE;
1991   int i, j, k, l;
1992
1993   if (filename == NULL)
1994     return;
1995
1996 #if 0
1997   printf("::: LoadArtworkConfigFromFilename: '%s'\n", filename);
1998 #endif
1999
2000   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2001     return;
2002
2003   /* separate valid (defined) from empty (undefined) config token values */
2004   valid_file_hash = newSetupFileHash();
2005   empty_file_hash = newSetupFileHash();
2006   BEGIN_HASH_ITERATION(setup_file_hash, itr)
2007   {
2008     char *value = HASH_ITERATION_VALUE(itr);
2009
2010     setHashEntry(*value ? valid_file_hash : empty_file_hash,
2011                  HASH_ITERATION_TOKEN(itr), value);
2012   }
2013   END_HASH_ITERATION(setup_file_hash, itr)
2014
2015   /* at this point, we do not need the setup file hash anymore -- free it */
2016   freeSetupFileHash(setup_file_hash);
2017
2018 #if 1
2019   /* map deprecated to current tokens (using prefix match and replace) */
2020   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2021   {
2022     char *token = HASH_ITERATION_TOKEN(itr);
2023     char *mapped_token = get_mapped_token(token);
2024
2025     if (mapped_token != NULL)
2026     {
2027       char *value = HASH_ITERATION_VALUE(itr);
2028
2029       /* add mapped token */
2030       setHashEntry(valid_file_hash, mapped_token, value);
2031
2032       /* ignore old token (by setting it to "known" keyword) */
2033       setHashEntry(valid_file_hash, token, known_token_value);
2034
2035       free(mapped_token);
2036     }
2037   }
2038   END_HASH_ITERATION(valid_file_hash, itr)
2039 #endif
2040
2041   /* read parameters for all known config file tokens */
2042   for (i = 0; i < num_file_list_entries; i++)
2043     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2044
2045   /* set all tokens that can be ignored here to "known" keyword */
2046   for (i = 0; i < num_ignore_tokens; i++)
2047     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2048
2049   /* copy all unknown config file tokens to extra config hash */
2050   extra_file_hash = newSetupFileHash();
2051   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2052   {
2053     char *value = HASH_ITERATION_VALUE(itr);
2054
2055     if (strcmp(value, known_token_value) != 0)
2056       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2057   }
2058   END_HASH_ITERATION(valid_file_hash, itr)
2059
2060   /* at this point, we do not need the valid file hash anymore -- free it */
2061   freeSetupFileHash(valid_file_hash);
2062
2063   /* now try to determine valid, dynamically defined config tokens */
2064
2065   BEGIN_HASH_ITERATION(extra_file_hash, itr)
2066   {
2067     struct FileInfo **dynamic_file_list =
2068       &artwork_info->dynamic_file_list;
2069     int *num_dynamic_file_list_entries =
2070       &artwork_info->num_dynamic_file_list_entries;
2071     struct PropertyMapping **property_mapping =
2072       &artwork_info->property_mapping;
2073     int *num_property_mapping_entries =
2074       &artwork_info->num_property_mapping_entries;
2075     int current_summarized_file_list_entry =
2076       artwork_info->num_file_list_entries +
2077       artwork_info->num_dynamic_file_list_entries;
2078     char *token = HASH_ITERATION_TOKEN(itr);
2079     int len_token = strlen(token);
2080     int start_pos;
2081     boolean base_prefix_found = FALSE;
2082     boolean parameter_suffix_found = FALSE;
2083
2084     /* skip all parameter definitions (handled by read_token_parameters()) */
2085     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2086     {
2087       int len_suffix = strlen(suffix_list[i].token);
2088
2089       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2090         parameter_suffix_found = TRUE;
2091     }
2092
2093 #if 0
2094     if (IS_PARENT_PROCESS())
2095     {
2096       if (parameter_suffix_found)
2097         printf("---> skipping token '%s' (parameter token)\n", token);
2098       else
2099         printf("---> examining token '%s': search prefix ...\n", token);
2100     }
2101 #endif
2102
2103     if (parameter_suffix_found)
2104       continue;
2105
2106     /* ---------- step 0: search for matching base prefix ---------- */
2107
2108     start_pos = 0;
2109     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2110     {
2111       char *base_prefix = base_prefixes[i];
2112       int len_base_prefix = strlen(base_prefix);
2113       boolean ext1_suffix_found = FALSE;
2114       boolean ext2_suffix_found = FALSE;
2115       boolean ext3_suffix_found = FALSE;
2116       boolean exact_match = FALSE;
2117       int base_index = -1;
2118       int ext1_index = -1;
2119       int ext2_index = -1;
2120       int ext3_index = -1;
2121
2122       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2123
2124       if (!base_prefix_found)
2125         continue;
2126
2127       base_index = i;
2128
2129       if (start_pos + len_base_prefix == len_token)     /* exact match */
2130       {
2131         exact_match = TRUE;
2132
2133         add_dynamic_file_list_entry(dynamic_file_list,
2134                                     num_dynamic_file_list_entries,
2135                                     extra_file_hash,
2136                                     suffix_list,
2137                                     num_suffix_list_entries,
2138                                     token);
2139         add_property_mapping(property_mapping,
2140                              num_property_mapping_entries,
2141                              base_index, -1, -1, -1,
2142                              current_summarized_file_list_entry);
2143         continue;
2144       }
2145
2146 #if 0
2147       if (IS_PARENT_PROCESS())
2148         printf("---> examining token '%s': search 1st suffix ...\n", token);
2149 #endif
2150
2151       /* ---------- step 1: search for matching first suffix ---------- */
2152
2153       start_pos += len_base_prefix;
2154       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2155       {
2156         char *ext1_suffix = ext1_suffixes[j];
2157         int len_ext1_suffix = strlen(ext1_suffix);
2158
2159         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2160
2161         if (!ext1_suffix_found)
2162           continue;
2163
2164         ext1_index = j;
2165
2166         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
2167         {
2168           exact_match = TRUE;
2169
2170           add_dynamic_file_list_entry(dynamic_file_list,
2171                                       num_dynamic_file_list_entries,
2172                                       extra_file_hash,
2173                                       suffix_list,
2174                                       num_suffix_list_entries,
2175                                       token);
2176           add_property_mapping(property_mapping,
2177                                num_property_mapping_entries,
2178                                base_index, ext1_index, -1, -1,
2179                                current_summarized_file_list_entry);
2180           continue;
2181         }
2182
2183         start_pos += len_ext1_suffix;
2184       }
2185
2186       if (exact_match)
2187         break;
2188
2189 #if 0
2190       if (IS_PARENT_PROCESS())
2191         printf("---> examining token '%s': search 2nd suffix ...\n", token);
2192 #endif
2193
2194       /* ---------- step 2: search for matching second suffix ---------- */
2195
2196       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2197       {
2198         char *ext2_suffix = ext2_suffixes[k];
2199         int len_ext2_suffix = strlen(ext2_suffix);
2200
2201         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2202
2203         if (!ext2_suffix_found)
2204           continue;
2205
2206         ext2_index = k;
2207
2208         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
2209         {
2210           exact_match = TRUE;
2211
2212           add_dynamic_file_list_entry(dynamic_file_list,
2213                                       num_dynamic_file_list_entries,
2214                                       extra_file_hash,
2215                                       suffix_list,
2216                                       num_suffix_list_entries,
2217                                       token);
2218           add_property_mapping(property_mapping,
2219                                num_property_mapping_entries,
2220                                base_index, ext1_index, ext2_index, -1,
2221                                current_summarized_file_list_entry);
2222           continue;
2223         }
2224
2225         start_pos += len_ext2_suffix;
2226       }
2227
2228       if (exact_match)
2229         break;
2230
2231 #if 0
2232       if (IS_PARENT_PROCESS())
2233         printf("---> examining token '%s': search 3rd suffix ...\n",token);
2234 #endif
2235
2236       /* ---------- step 3: search for matching third suffix ---------- */
2237
2238       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2239       {
2240         char *ext3_suffix = ext3_suffixes[l];
2241         int len_ext3_suffix = strlen(ext3_suffix);
2242
2243         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2244
2245         if (!ext3_suffix_found)
2246           continue;
2247
2248         ext3_index = l;
2249
2250         if (start_pos + len_ext3_suffix == len_token) /* exact match */
2251         {
2252           exact_match = TRUE;
2253
2254           add_dynamic_file_list_entry(dynamic_file_list,
2255                                       num_dynamic_file_list_entries,
2256                                       extra_file_hash,
2257                                       suffix_list,
2258                                       num_suffix_list_entries,
2259                                       token);
2260           add_property_mapping(property_mapping,
2261                                num_property_mapping_entries,
2262                                base_index, ext1_index, ext2_index, ext3_index,
2263                                current_summarized_file_list_entry);
2264           continue;
2265         }
2266       }
2267     }
2268   }
2269   END_HASH_ITERATION(extra_file_hash, itr)
2270
2271   if (artwork_info->num_dynamic_file_list_entries > 0)
2272   {
2273     artwork_info->dynamic_artwork_list =
2274       checked_calloc(artwork_info->num_dynamic_file_list_entries *
2275                      artwork_info->sizeof_artwork_list_entry);
2276   }
2277
2278   if (options.verbose && IS_PARENT_PROCESS())
2279   {
2280     SetupFileList *setup_file_list, *list;
2281     boolean dynamic_tokens_found = FALSE;
2282     boolean unknown_tokens_found = FALSE;
2283     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2284
2285     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2286       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2287
2288     BEGIN_HASH_ITERATION(extra_file_hash, itr)
2289     {
2290       if (strcmp(HASH_ITERATION_VALUE(itr), known_token_value) == 0)
2291         dynamic_tokens_found = TRUE;
2292       else
2293         unknown_tokens_found = TRUE;
2294     }
2295     END_HASH_ITERATION(extra_file_hash, itr)
2296
2297     if (options.debug && dynamic_tokens_found)
2298     {
2299       Error(ERR_RETURN_LINE, "-");
2300       Error(ERR_RETURN, "dynamic token(s) found in config file:");
2301       Error(ERR_RETURN, "- config file: '%s'", filename);
2302
2303       for (list = setup_file_list; list != NULL; list = list->next)
2304       {
2305         char *value = getHashEntry(extra_file_hash, list->token);
2306
2307         if (value != NULL && strcmp(value, known_token_value) == 0)
2308           Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2309       }
2310
2311       Error(ERR_RETURN_LINE, "-");
2312     }
2313
2314     if (unknown_tokens_found)
2315     {
2316       Error(ERR_RETURN_LINE, "-");
2317       Error(ERR_RETURN, "warning: unknown token(s) found in config file:");
2318       Error(ERR_RETURN, "- config file: '%s'", filename);
2319
2320       for (list = setup_file_list; list != NULL; list = list->next)
2321       {
2322         char *value = getHashEntry(extra_file_hash, list->token);
2323
2324         if (value != NULL && strcmp(value, known_token_value) != 0)
2325           Error(ERR_RETURN, "- dynamic token: '%s'", list->token);
2326       }
2327
2328       Error(ERR_RETURN_LINE, "-");
2329     }
2330
2331     if (undefined_values_found)
2332     {
2333       Error(ERR_RETURN_LINE, "-");
2334       Error(ERR_RETURN, "warning: undefined values found in config file:");
2335       Error(ERR_RETURN, "- config file: '%s'", filename);
2336
2337       for (list = setup_file_list; list != NULL; list = list->next)
2338       {
2339         char *value = getHashEntry(empty_file_hash, list->token);
2340
2341         if (value != NULL)
2342           Error(ERR_RETURN, "- undefined value for token: '%s'", list->token);
2343       }
2344
2345       Error(ERR_RETURN_LINE, "-");
2346     }
2347
2348     freeSetupFileList(setup_file_list);
2349   }
2350
2351   freeSetupFileHash(extra_file_hash);
2352   freeSetupFileHash(empty_file_hash);
2353
2354 #if 0
2355   for (i = 0; i < num_file_list_entries; i++)
2356   {
2357     printf("'%s' ", file_list[i].token);
2358     if (file_list[i].filename)
2359       printf("-> '%s'\n", file_list[i].filename);
2360     else
2361       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2362   }
2363 #endif
2364 }
2365
2366 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2367 {
2368   struct FileInfo *file_list = artwork_info->file_list;
2369   int num_file_list_entries = artwork_info->num_file_list_entries;
2370   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2371   char *filename_base = UNDEFINED_FILENAME, *filename_local;
2372   int i, j;
2373
2374 #if 0
2375   printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
2376 #endif
2377
2378   DrawInitText("Loading artwork config:", 120, FC_GREEN);
2379   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2380
2381   /* always start with reliable default values */
2382   for (i = 0; i < num_file_list_entries; i++)
2383   {
2384     setString(&file_list[i].filename, file_list[i].default_filename);
2385
2386     for (j = 0; j < num_suffix_list_entries; j++)
2387       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2388
2389     file_list[i].redefined = FALSE;
2390     file_list[i].fallback_to_default = FALSE;
2391   }
2392
2393   /* free previous dynamic artwork file array */
2394   if (artwork_info->dynamic_file_list != NULL)
2395   {
2396     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2397     {
2398       free(artwork_info->dynamic_file_list[i].token);
2399       free(artwork_info->dynamic_file_list[i].filename);
2400       free(artwork_info->dynamic_file_list[i].parameter);
2401     }
2402
2403     free(artwork_info->dynamic_file_list);
2404     artwork_info->dynamic_file_list = NULL;
2405
2406     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2407                           &artwork_info->num_dynamic_file_list_entries);
2408   }
2409
2410   /* free previous property mapping */
2411   if (artwork_info->property_mapping != NULL)
2412   {
2413     free(artwork_info->property_mapping);
2414
2415     artwork_info->property_mapping = NULL;
2416     artwork_info->num_property_mapping_entries = 0;
2417   }
2418
2419   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2420   {
2421     /* first look for special artwork configured in level series config */
2422     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2423
2424     if (fileExists(filename_base))
2425       LoadArtworkConfigFromFilename(artwork_info, filename_base);
2426   }
2427
2428   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2429
2430   if (filename_local != NULL && strcmp(filename_base, filename_local) != 0)
2431     LoadArtworkConfigFromFilename(artwork_info, filename_local);
2432 }
2433
2434 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2435                                    struct ListNodeInfo **listnode)
2436 {
2437   if (*listnode)
2438   {
2439     char *filename = (*listnode)->source_filename;
2440
2441 #if 0
2442     printf("[decrementing reference counter of artwork '%s']\n", filename);
2443 #endif
2444
2445     if (--(*listnode)->num_references <= 0)
2446     {
2447 #if 0
2448       printf("[deleting artwork '%s']\n", filename);
2449 #endif
2450
2451       deleteNodeFromList(&artwork_info->content_list, filename,
2452                          artwork_info->free_artwork);
2453     }
2454
2455     *listnode = NULL;
2456   }
2457 }
2458
2459 #if 1
2460 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2461                                     struct ListNodeInfo **listnode,
2462                                     struct FileInfo *file_list_entry)
2463 {
2464   char *init_text[] =
2465   {
2466     "Loading graphics:",
2467     "Loading sounds:",
2468     "Loading music:"
2469   };
2470
2471   ListNode *node;
2472   char *basename = file_list_entry->filename;
2473   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2474
2475 #if 0
2476   if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2477     printf("::: replaceArtworkListEntry: '%s' => '%s'\n",
2478            basename, filename);
2479 #endif
2480
2481   if (filename == NULL)
2482   {
2483     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2484
2485     basename = file_list_entry->default_filename;
2486
2487     /* dynamic artwork has no default filename / skip empty default artwork */
2488     if (basename == NULL || strcmp(basename, UNDEFINED_FILENAME) == 0)
2489       return;
2490
2491     file_list_entry->fallback_to_default = TRUE;
2492
2493     Error(ERR_WARN, "trying default artwork file '%s'", basename);
2494
2495     filename = getCustomArtworkFilename(basename, artwork_info->type);
2496
2497     if (filename == NULL)
2498     {
2499       int error_mode = ERR_WARN;
2500
2501       /* we can get away without sounds and music, but not without graphics */
2502       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2503         error_mode = ERR_EXIT;
2504
2505       Error(error_mode, "cannot find default artwork file '%s'", basename);
2506
2507       return;
2508     }
2509   }
2510
2511   /* check if the old and the new artwork file are the same */
2512   if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2513   {
2514     /* The old and new artwork are the same (have the same filename and path).
2515        This usually means that this artwork does not exist in this artwork set
2516        and a fallback to the existing artwork is done. */
2517
2518 #if 0
2519     printf("[artwork '%s' already exists (same list entry)]\n", filename);
2520 #endif
2521
2522     return;
2523   }
2524
2525   /* delete existing artwork file entry */
2526   deleteArtworkListEntry(artwork_info, listnode);
2527
2528   /* check if the new artwork file already exists in the list of artworks */
2529   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2530   {
2531 #if 0
2532       printf("[artwork '%s' already exists (other list entry)]\n", filename);
2533 #endif
2534
2535       *listnode = (struct ListNodeInfo *)node->content;
2536       (*listnode)->num_references++;
2537
2538       return;
2539   }
2540
2541 #if 0
2542   if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2543     printf("::: replaceArtworkListEntry: LOAD IT'\n");
2544 #endif
2545
2546 #if 0
2547   printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2548 #endif
2549
2550   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2551   DrawInitText(basename, 150, FC_YELLOW);
2552
2553   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2554   {
2555 #if 0
2556       printf("[adding new artwork '%s']\n", filename);
2557 #endif
2558
2559     (*listnode)->num_references = 1;
2560     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2561                   *listnode);
2562   }
2563   else
2564   {
2565     int error_mode = ERR_WARN;
2566
2567 #if 1
2568     /* we can get away without sounds and music, but not without graphics */
2569     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2570       error_mode = ERR_EXIT;
2571 #endif
2572
2573     Error(error_mode, "cannot load artwork file '%s'", basename);
2574     return;
2575   }
2576 }
2577
2578 #else
2579
2580 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2581                                     struct ListNodeInfo **listnode,
2582                                     char *basename)
2583 {
2584   char *init_text[] =
2585   {
2586     "Loading graphics:",
2587     "Loading sounds:",
2588     "Loading music:"
2589   };
2590
2591   ListNode *node;
2592   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2593
2594   if (filename == NULL)
2595   {
2596     int error_mode = ERR_WARN;
2597
2598 #if 1
2599     /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2600     /* before failing, try fallback to default artwork */
2601 #else
2602     /* we can get away without sounds and music, but not without graphics */
2603     if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2604       error_mode = ERR_EXIT;
2605 #endif
2606
2607     Error(error_mode, "cannot find artwork file '%s'", basename);
2608     return;
2609   }
2610
2611   /* check if the old and the new artwork file are the same */
2612   if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
2613   {
2614     /* The old and new artwork are the same (have the same filename and path).
2615        This usually means that this artwork does not exist in this artwork set
2616        and a fallback to the existing artwork is done. */
2617
2618 #if 0
2619     printf("[artwork '%s' already exists (same list entry)]\n", filename);
2620 #endif
2621
2622     return;
2623   }
2624
2625   /* delete existing artwork file entry */
2626   deleteArtworkListEntry(artwork_info, listnode);
2627
2628   /* check if the new artwork file already exists in the list of artworks */
2629   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2630   {
2631 #if 0
2632       printf("[artwork '%s' already exists (other list entry)]\n", filename);
2633 #endif
2634
2635       *listnode = (struct ListNodeInfo *)node->content;
2636       (*listnode)->num_references++;
2637
2638       return;
2639   }
2640
2641 #if 0
2642   printf("::: %s: '%s'\n", init_text[artwork_info->type], basename);
2643 #endif
2644
2645   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2646   DrawInitText(basename, 150, FC_YELLOW);
2647
2648   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2649   {
2650 #if 0
2651       printf("[adding new artwork '%s']\n", filename);
2652 #endif
2653
2654     (*listnode)->num_references = 1;
2655     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2656                   *listnode);
2657   }
2658   else
2659   {
2660     int error_mode = ERR_WARN;
2661
2662 #if 1
2663     /* we can get away without sounds and music, but not without graphics */
2664     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2665       error_mode = ERR_EXIT;
2666 #endif
2667
2668     Error(error_mode, "cannot load artwork file '%s'", basename);
2669     return;
2670   }
2671 }
2672 #endif
2673
2674 #if 1
2675 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2676                               struct ListNodeInfo **listnode,
2677                               struct FileInfo *file_list_entry)
2678 {
2679 #if 0
2680   printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2681 #endif
2682
2683 #if 0
2684   if (strcmp(file_list_entry->token, "background.DOOR") == 0)
2685     printf("::: -> '%s' -> '%s'\n",
2686            file_list_entry->token, file_list_entry->filename);
2687 #endif
2688
2689   if (strcmp(file_list_entry->filename, UNDEFINED_FILENAME) == 0)
2690   {
2691     deleteArtworkListEntry(artwork_info, listnode);
2692     return;
2693   }
2694
2695   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2696 }
2697
2698 #else
2699
2700 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2701                               struct ListNodeInfo **listnode,
2702                               char *basename)
2703 {
2704 #if 0
2705   printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
2706 #endif
2707
2708   if (strcmp(basename, UNDEFINED_FILENAME) == 0)
2709   {
2710     deleteArtworkListEntry(artwork_info, listnode);
2711     return;
2712   }
2713
2714   replaceArtworkListEntry(artwork_info, listnode, basename);
2715 }
2716 #endif
2717
2718 #if 1
2719 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2720                               struct ListNodeInfo **listnode,
2721                               struct FileInfo *file_list_entry)
2722 {
2723 #if 0
2724   if (artwork_info->artwork_list == NULL ||
2725       list_pos >= artwork_info->num_file_list_entries)
2726     return;
2727 #endif
2728
2729 #if 0
2730   printf("loading artwork '%s' ...  [%d]\n",
2731          file_list_entry->filename, getNumNodes(artwork_info->content_list));
2732 #endif
2733
2734 #if 1
2735   LoadCustomArtwork(artwork_info, listnode, file_list_entry);
2736 #else
2737   LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2738                     basename);
2739 #endif
2740
2741 #if 0
2742   printf("loading artwork '%s' done [%d]\n",
2743          basename, getNumNodes(artwork_info->content_list));
2744 #endif
2745 }
2746
2747 #else
2748
2749 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
2750                               struct ListNodeInfo **listnode,
2751                               char *basename, int list_pos)
2752 {
2753 #if 0
2754   if (artwork_info->artwork_list == NULL ||
2755       list_pos >= artwork_info->num_file_list_entries)
2756     return;
2757 #endif
2758
2759 #if 0
2760   printf("loading artwork '%s' ...  [%d]\n",
2761          basename, getNumNodes(artwork_info->content_list));
2762 #endif
2763
2764 #if 1
2765   LoadCustomArtwork(artwork_info, listnode, basename);
2766 #else
2767   LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
2768                     basename);
2769 #endif
2770
2771 #if 0
2772   printf("loading artwork '%s' done [%d]\n",
2773          basename, getNumNodes(artwork_info->content_list));
2774 #endif
2775 }
2776 #endif
2777
2778 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2779 {
2780   struct FileInfo *file_list = artwork_info->file_list;
2781   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2782   int num_file_list_entries = artwork_info->num_file_list_entries;
2783   int num_dynamic_file_list_entries =
2784     artwork_info->num_dynamic_file_list_entries;
2785   int i;
2786
2787 #if 0
2788   printf("DEBUG: reloading %d static artwork files ...\n",
2789          num_file_list_entries);
2790 #endif
2791
2792   for (i = 0; i < num_file_list_entries; i++)
2793   {
2794 #if 0
2795     if (strcmp(file_list[i].token, "background.DOOR") == 0)
2796       printf("::: '%s' -> '%s'\n", file_list[i].token, file_list[i].filename);
2797 #endif
2798
2799 #if 1
2800     LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2801                       &file_list[i]);
2802 #else
2803     LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2804                       file_list[i].filename, i);
2805 #endif
2806
2807 #if 0
2808     if (strcmp(file_list[i].token, "background.DOOR") == 0)
2809     {
2810       Bitmap *bitmap = getBitmapFromImageID(i);
2811
2812       printf("::: BITMAP: %08lx\n", bitmap);
2813
2814 #if 0
2815       BlitBitmap(bitmap, window, 0, 0, 100, 280, 0, 0);
2816 #endif
2817     }
2818 #endif
2819
2820 #if 0
2821     /* !!! NEW ARTWORK FALLBACK CODE !!! NEARLY UNTESTED !!! */
2822     if (artwork_info->artwork_list[i] == NULL &&
2823         strcmp(file_list[i].filename, UNDEFINED_FILENAME) != 0 &&
2824         strcmp(file_list[i].default_filename, file_list[i].filename) != 0 &&
2825         strcmp(file_list[i].default_filename, UNDEFINED_FILENAME) != 0)
2826     {
2827       Error(ERR_WARN, "trying default artwork file '%s'",
2828             file_list[i].default_filename);
2829
2830       LoadArtworkToList(artwork_info, &artwork_info->artwork_list[i],
2831                         file_list[i].default_filename, i);
2832
2833       /* even the fallback to default artwork was not successful -- fail now */
2834       if (artwork_info->artwork_list[i] == NULL &&
2835           artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2836         Error(ERR_EXIT, "cannot find artwork file '%s' or default file '%s'",
2837               file_list[i].filename, file_list[i].default_filename);
2838
2839       file_list[i].fallback_to_default = TRUE;
2840     }
2841 #endif
2842   }
2843
2844 #if 0
2845   printf("DEBUG: reloading %d dynamic artwork files ...\n",
2846          num_dynamic_file_list_entries);
2847 #endif
2848
2849   for (i = 0; i < num_dynamic_file_list_entries; i++)
2850   {
2851 #if 1
2852     LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2853                       &dynamic_file_list[i]);
2854 #else
2855     LoadArtworkToList(artwork_info, &artwork_info->dynamic_artwork_list[i],
2856                       dynamic_file_list[i].filename, i);
2857 #endif
2858
2859 #if 0
2860     printf("::: '%s', '0x%08x'\n",
2861            dynamic_file_list[i].filename,
2862            dynamic_file_list[i].default_filename);
2863 #endif
2864
2865     /* dynamic artwork does not have default filename! */
2866   }
2867
2868 #if 0
2869   dumpList(artwork_info->content_list);
2870 #endif
2871 }
2872
2873 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2874                                   struct ListNodeInfo ***list,
2875                                   int *num_list_entries)
2876 {
2877   int i;
2878
2879   if (*list == NULL)
2880     return;
2881
2882   for (i = 0; i < *num_list_entries; i++)
2883     deleteArtworkListEntry(artwork_info, &(*list)[i]);
2884   free(*list);
2885
2886   *list = NULL;
2887   *num_list_entries = 0;
2888 }
2889
2890 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2891 {
2892   if (artwork_info == NULL)
2893     return;
2894
2895 #if 0
2896   printf("%s: FREEING ARTWORK ...\n",
2897          IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2898 #endif
2899
2900   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2901                         &artwork_info->num_file_list_entries);
2902
2903   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2904                         &artwork_info->num_dynamic_file_list_entries);
2905
2906 #if 0
2907   printf("%s: FREEING ARTWORK -- DONE\n",
2908          IS_CHILD_PROCESS() ? "CHILD" : "PARENT");
2909 #endif
2910 }
2911
2912
2913 /* ------------------------------------------------------------------------- */
2914 /* functions only needed for non-Unix (non-command-line) systems             */
2915 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
2916 /* ------------------------------------------------------------------------- */
2917
2918 #if defined(PLATFORM_MSDOS)
2919
2920 #define ERROR_FILENAME          "stderr.txt"
2921
2922 void initErrorFile()
2923 {
2924   unlink(ERROR_FILENAME);
2925 }
2926
2927 FILE *openErrorFile()
2928 {
2929   return fopen(ERROR_FILENAME, MODE_APPEND);
2930 }
2931
2932 void dumpErrorFile()
2933 {
2934   FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
2935
2936   if (error_file != NULL)
2937   {
2938     while (!feof(error_file))
2939       fputc(fgetc(error_file), stderr);
2940
2941     fclose(error_file);
2942   }
2943 }
2944 #endif
2945
2946
2947 /* ------------------------------------------------------------------------- */
2948 /* the following is only for debugging purpose and normally not used         */
2949 /* ------------------------------------------------------------------------- */
2950
2951 #define DEBUG_NUM_TIMESTAMPS    3
2952
2953 void debug_print_timestamp(int counter_nr, char *message)
2954 {
2955   static long counter[DEBUG_NUM_TIMESTAMPS][2];
2956
2957   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2958     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2959
2960   counter[counter_nr][0] = Counter();
2961
2962   if (message)
2963     printf("%s %.2f seconds\n", message,
2964            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2965
2966   counter[counter_nr][1] = Counter();
2967 }
2968
2969 void debug_print_parent_only(char *format, ...)
2970 {
2971   if (!IS_PARENT_PROCESS())
2972     return;
2973
2974   if (format)
2975   {
2976     va_list ap;
2977
2978     va_start(ap, format);
2979     vprintf(format, ap);
2980     va_end(ap);
2981
2982     printf("\n");
2983   }
2984 }