src/libgame/misc.c

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