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