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