src/libgame/misc.c

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