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 strEqualPrefix(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 strEqualSuffix(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
 668 #if !defined(PLATFORM_UNIX)
 669   if (*options_left == NULL)    /* no options given -- enable verbose mode */
 670     options.verbose = TRUE;
 671 #endif
 672
 673   while (*options_left)
 674   {
 675     char option_str[MAX_OPTION_LEN];
 676     char *option = options_left[0];
 677     char *next_option = options_left[1];
 678     char *option_arg = NULL;
 679     int option_len = strlen(option);
 680
 681     if (option_len >= MAX_OPTION_LEN)
 682       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 683
 684     strcpy(option_str, option);                 /* copy argument into buffer */
 685     option = option_str;
 686
 687     if (strEqual(option, "--"))                 /* stop scanning arguments */
 688       break;
 689
 690     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 691       option++;
 692
 693     option_arg = strchr(option, '=');
 694     if (option_arg == NULL)                     /* no '=' in option */
 695       option_arg = next_option;
 696     else
 697     {
 698       *option_arg++ = '\0';                     /* cut argument from option */
 699       if (*option_arg == '\0')                  /* no argument after '=' */
 700         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 701     }
 702
 703     option_len = strlen(option);
 704
 705     if (strEqual(option, "-"))
 706       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 707     else if (strncmp(option, "-help", option_len) == 0)
 708     {
 709       print_usage_function();
 710
 711       exit(0);
 712     }
 713     else if (strncmp(option, "-display", option_len) == 0)
 714     {
 715       if (option_arg == NULL)
 716         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 717
 718       options.display_name = option_arg;
 719       if (option_arg == next_option)
 720         options_left++;
 721     }
 722     else if (strncmp(option, "-basepath", option_len) == 0)
 723     {
 724       if (option_arg == NULL)
 725         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 726
 727       /* this should be extended to separate options for ro and rw data */
 728       options.ro_base_directory = ro_base_path = option_arg;
 729       options.rw_base_directory = rw_base_path = option_arg;
 730       if (option_arg == next_option)
 731         options_left++;
 732
 733       /* adjust paths for sub-directories in base directory accordingly */
 734       options.level_directory    = getPath2(ro_base_path, LEVELS_DIRECTORY);
 735       options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
 736       options.sounds_directory   = getPath2(ro_base_path, SOUNDS_DIRECTORY);
 737       options.music_directory    = getPath2(ro_base_path, MUSIC_DIRECTORY);
 738       options.docs_directory     = getPath2(ro_base_path, DOCS_DIRECTORY);
 739     }
 740     else if (strncmp(option, "-levels", option_len) == 0)
 741     {
 742       if (option_arg == NULL)
 743         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 744
 745       options.level_directory = option_arg;
 746       if (option_arg == next_option)
 747         options_left++;
 748     }
 749     else if (strncmp(option, "-graphics", option_len) == 0)
 750     {
 751       if (option_arg == NULL)
 752         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 753
 754       options.graphics_directory = option_arg;
 755       if (option_arg == next_option)
 756         options_left++;
 757     }
 758     else if (strncmp(option, "-sounds", option_len) == 0)
 759     {
 760       if (option_arg == NULL)
 761         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 762
 763       options.sounds_directory = option_arg;
 764       if (option_arg == next_option)
 765         options_left++;
 766     }
 767     else if (strncmp(option, "-music", option_len) == 0)
 768     {
 769       if (option_arg == NULL)
 770         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 771
 772       options.music_directory = option_arg;
 773       if (option_arg == next_option)
 774         options_left++;
 775     }
 776     else if (strncmp(option, "-network", option_len) == 0)
 777     {
 778       options.network = TRUE;
 779     }
 780     else if (strncmp(option, "-serveronly", option_len) == 0)
 781     {
 782       options.serveronly = TRUE;
 783     }
 784     else if (strncmp(option, "-verbose", option_len) == 0)
 785     {
 786       options.verbose = TRUE;
 787     }
 788     else if (strncmp(option, "-debug", option_len) == 0)
 789     {
 790       options.debug = TRUE;
 791     }
 792     else if (strncmp(option, "-execute", option_len) == 0)
 793     {
 794       if (option_arg == NULL)
 795         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 796
 797       options.execute_command = option_arg;
 798       if (option_arg == next_option)
 799         options_left++;
 800
 801       /* when doing batch processing, always enable verbose mode (warnings) */
 802       options.verbose = TRUE;
 803     }
 804     else if (*option == '-')
 805     {
 806       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 807     }
 808     else if (options.server_host == NULL)
 809     {
 810       options.server_host = *options_left;
 811     }
 812     else if (options.server_port == 0)
 813     {
 814       options.server_port = atoi(*options_left);
 815       if (options.server_port < 1024)
 816         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 817     }
 818     else
 819       Error(ERR_EXIT_HELP, "too many arguments");
 820
 821     options_left++;
 822   }
 823 }
 824
 825
 826 /* ------------------------------------------------------------------------- */
 827 /* error handling functions                                                  */
 828 /* ------------------------------------------------------------------------- */
 829
 830 /* used by SetError() and GetError() to store internal error messages */
 831 static char internal_error[1024];       /* this is bad */
 832
 833 void SetError(char *format, ...)
 834 {
 835   va_list ap;
 836
 837   va_start(ap, format);
 838   vsprintf(internal_error, format, ap);
 839   va_end(ap);
 840 }
 841
 842 char *GetError()
 843 {
 844   return internal_error;
 845 }
 846
 847 void Error(int mode, char *format, ...)
 848 {
 849   static boolean last_line_was_separator = FALSE;
 850   char *process_name = "";
 851
 852   /* display warnings only when running in verbose mode */
 853   if (mode & ERR_WARN && !options.verbose)
 854     return;
 855
 856   if (mode == ERR_INFO_LINE)
 857   {
 858     if (!last_line_was_separator)
 859       fprintf_line(program.error_file, format, 79);
 860
 861     last_line_was_separator = TRUE;
 862
 863     return;
 864   }
 865
 866   last_line_was_separator = FALSE;
 867
 868   if (mode & ERR_SOUND_SERVER)
 869     process_name = " sound server";
 870   else if (mode & ERR_NETWORK_SERVER)
 871     process_name = " network server";
 872   else if (mode & ERR_NETWORK_CLIENT)
 873     process_name = " network client **";
 874
 875   if (format)
 876   {
 877     va_list ap;
 878
 879     fprintf(program.error_file, "%s%s: ", program.command_basename,
 880             process_name);
 881
 882     if (mode & ERR_WARN)
 883       fprintf(program.error_file, "warning: ");
 884
 885     va_start(ap, format);
 886     vfprintf_newline(program.error_file, format, ap);
 887     va_end(ap);
 888   }
 889
 890   if (mode & ERR_HELP)
 891     fprintf_newline(program.error_file,
 892                     "%s: Try option '--help' for more information.",
 893                     program.command_basename);
 894
 895   if (mode & ERR_EXIT)
 896     fprintf_newline(program.error_file, "%s%s: aborting",
 897                     program.command_basename, process_name);
 898
 899   if (mode & ERR_EXIT)
 900   {
 901     if (mode & ERR_FROM_SERVER)
 902       exit(1);                          /* child process: normal exit */
 903     else
 904       program.exit_function(1);         /* main process: clean up stuff */
 905   }
 906 }
 907
 908
 909 /* ------------------------------------------------------------------------- */
 910 /* checked memory allocation and freeing functions                           */
 911 /* ------------------------------------------------------------------------- */
 912
 913 void *checked_malloc(unsigned long size)
 914 {
 915   void *ptr;
 916
 917   ptr = malloc(size);
 918
 919   if (ptr == NULL)
 920     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 921
 922   return ptr;
 923 }
 924
 925 void *checked_calloc(unsigned long size)
 926 {
 927   void *ptr;
 928
 929   ptr = calloc(1, size);
 930
 931   if (ptr == NULL)
 932     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 933
 934   return ptr;
 935 }
 936
 937 void *checked_realloc(void *ptr, unsigned long size)
 938 {
 939   ptr = realloc(ptr, size);
 940
 941   if (ptr == NULL)
 942     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 943
 944   return ptr;
 945 }
 946
 947 void checked_free(void *ptr)
 948 {
 949   if (ptr != NULL)      /* this check should be done by free() anyway */
 950     free(ptr);
 951 }
 952
 953
 954 /* ------------------------------------------------------------------------- */
 955 /* various helper functions                                                  */
 956 /* ------------------------------------------------------------------------- */
 957
 958 inline void swap_numbers(int *i1, int *i2)
 959 {
 960   int help = *i1;
 961
 962   *i1 = *i2;
 963   *i2 = help;
 964 }
 965
 966 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
 967 {
 968   int help_x = *x1;
 969   int help_y = *y1;
 970
 971   *x1 = *x2;
 972   *x2 = help_x;
 973
 974   *y1 = *y2;
 975   *y2 = help_y;
 976 }
 977
 978 /* the "put" variants of the following file access functions check for the file
 979    pointer being != NULL and return the number of bytes they have or would have
 980    written; this allows for chunk writing functions to first determine the size
 981    of the (not yet written) chunk, write the correct chunk size and finally
 982    write the chunk itself */
 983
 984 int getFile8BitInteger(FILE *file)
 985 {
 986   return fgetc(file);
 987 }
 988
 989 int putFile8BitInteger(FILE *file, int value)
 990 {
 991   if (file != NULL)
 992     fputc(value, file);
 993
 994   return 1;
 995 }
 996
 997 int getFile16BitInteger(FILE *file, int byte_order)
 998 {
 999   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1000     return ((fgetc(file) << 8) |
1001             (fgetc(file) << 0));
1002   else           /* BYTE_ORDER_LITTLE_ENDIAN */
1003     return ((fgetc(file) << 0) |
1004             (fgetc(file) << 8));
1005 }
1006
1007 int putFile16BitInteger(FILE *file, int value, int byte_order)
1008 {
1009   if (file != NULL)
1010   {
1011     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1012     {
1013       fputc((value >> 8) & 0xff, file);
1014       fputc((value >> 0) & 0xff, file);
1015     }
1016     else           /* BYTE_ORDER_LITTLE_ENDIAN */
1017     {
1018       fputc((value >> 0) & 0xff, file);
1019       fputc((value >> 8) & 0xff, file);
1020     }
1021   }
1022
1023   return 2;
1024 }
1025
1026 int getFile32BitInteger(FILE *file, int byte_order)
1027 {
1028   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1029     return ((fgetc(file) << 24) |
1030             (fgetc(file) << 16) |
1031             (fgetc(file) <<  8) |
1032             (fgetc(file) <<  0));
1033   else           /* BYTE_ORDER_LITTLE_ENDIAN */
1034     return ((fgetc(file) <<  0) |
1035             (fgetc(file) <<  8) |
1036             (fgetc(file) << 16) |
1037             (fgetc(file) << 24));
1038 }
1039
1040 int putFile32BitInteger(FILE *file, int value, int byte_order)
1041 {
1042   if (file != NULL)
1043   {
1044     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1045     {
1046       fputc((value >> 24) & 0xff, file);
1047       fputc((value >> 16) & 0xff, file);
1048       fputc((value >>  8) & 0xff, file);
1049       fputc((value >>  0) & 0xff, file);
1050     }
1051     else           /* BYTE_ORDER_LITTLE_ENDIAN */
1052     {
1053       fputc((value >>  0) & 0xff, file);
1054       fputc((value >>  8) & 0xff, file);
1055       fputc((value >> 16) & 0xff, file);
1056       fputc((value >> 24) & 0xff, file);
1057     }
1058   }
1059
1060   return 4;
1061 }
1062
1063 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1064                      int byte_order)
1065 {
1066   const int chunk_name_length = 4;
1067
1068   /* read chunk name */
1069   fgets(chunk_name, chunk_name_length + 1, file);
1070
1071   if (chunk_size != NULL)
1072   {
1073     /* read chunk size */
1074     *chunk_size = getFile32BitInteger(file, byte_order);
1075   }
1076
1077   return (feof(file) || ferror(file) ? FALSE : TRUE);
1078 }
1079
1080 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1081                  int byte_order)
1082 {
1083   int num_bytes = 0;
1084
1085   /* write chunk name */
1086   if (file != NULL)
1087     fputs(chunk_name, file);
1088
1089   num_bytes += strlen(chunk_name);
1090
1091   if (chunk_size >= 0)
1092   {
1093     /* write chunk size */
1094     if (file != NULL)
1095       putFile32BitInteger(file, chunk_size, byte_order);
1096
1097     num_bytes += 4;
1098   }
1099
1100   return num_bytes;
1101 }
1102
1103 int getFileVersion(FILE *file)
1104 {
1105   int version_major = fgetc(file);
1106   int version_minor = fgetc(file);
1107   int version_patch = fgetc(file);
1108   int version_build = fgetc(file);
1109
1110   return VERSION_IDENT(version_major, version_minor, version_patch,
1111                        version_build);
1112 }
1113
1114 int putFileVersion(FILE *file, int version)
1115 {
1116   if (file != NULL)
1117   {
1118     int version_major = VERSION_MAJOR(version);
1119     int version_minor = VERSION_MINOR(version);
1120     int version_patch = VERSION_PATCH(version);
1121     int version_build = VERSION_BUILD(version);
1122
1123     fputc(version_major, file);
1124     fputc(version_minor, file);
1125     fputc(version_patch, file);
1126     fputc(version_build, file);
1127   }
1128
1129   return 4;
1130 }
1131
1132 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned long bytes)
1133 {
1134   int i;
1135
1136   for(i = 0; i < bytes && !feof(file); i++)
1137     buffer[i] = fgetc(file);
1138 }
1139
1140 void WriteBytesToFile(FILE *file, byte *buffer, unsigned long bytes)
1141 {
1142   int i;
1143
1144   for(i = 0; i < bytes; i++)
1145     fputc(buffer[i], file);
1146 }
1147
1148 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
1149 {
1150   while (bytes-- && !feof(file))
1151     fgetc(file);
1152 }
1153
1154 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
1155 {
1156   while (bytes--)
1157     fputc(0, file);
1158 }
1159
1160
1161 /* ------------------------------------------------------------------------- */
1162 /* functions to translate key identifiers between different format           */
1163 /* ------------------------------------------------------------------------- */
1164
1165 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
1166 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
1167 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
1168 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
1169
1170 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1171 {
1172   static struct
1173   {
1174     Key key;
1175     char *x11name;
1176     char *name;
1177   } translate_key[] =
1178   {
1179     /* normal cursor keys */
1180     { KSYM_Left,        "XK_Left",              "cursor left" },
1181     { KSYM_Right,       "XK_Right",             "cursor right" },
1182     { KSYM_Up,          "XK_Up",                "cursor up" },
1183     { KSYM_Down,        "XK_Down",              "cursor down" },
1184
1185     /* keypad cursor keys */
1186 #ifdef KSYM_KP_Left
1187     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
1188     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
1189     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
1190     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
1191 #endif
1192
1193     /* other keypad keys */
1194 #ifdef KSYM_KP_Enter
1195     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
1196     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
1197     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
1198     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
1199     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
1200     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
1201 #endif
1202
1203     /* modifier keys */
1204     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
1205     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
1206     { KSYM_Control_L,   "XK_Control_L",         "left control" },
1207     { KSYM_Control_R,   "XK_Control_R",         "right control" },
1208     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
1209     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
1210     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
1211     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
1212     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
1213     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
1214     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
1215     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
1216
1217     /* some special keys */
1218     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
1219     { KSYM_Delete,      "XK_Delete",            "delete" },
1220     { KSYM_Insert,      "XK_Insert",            "insert" },
1221     { KSYM_Tab,         "XK_Tab",               "tab" },
1222     { KSYM_Home,        "XK_Home",              "home" },
1223     { KSYM_End,         "XK_End",               "end" },
1224     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
1225     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
1226     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
1227
1228     /* ASCII 0x20 to 0x40 keys (except numbers) */
1229     { KSYM_space,       "XK_space",             "space" },
1230     { KSYM_exclam,      "XK_exclam",            "!" },
1231     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
1232     { KSYM_numbersign,  "XK_numbersign",        "#" },
1233     { KSYM_dollar,      "XK_dollar",            "$" },
1234     { KSYM_percent,     "XK_percent",           "%" },
1235     { KSYM_ampersand,   "XK_ampersand",         "&" },
1236     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
1237     { KSYM_parenleft,   "XK_parenleft",         "(" },
1238     { KSYM_parenright,  "XK_parenright",        ")" },
1239     { KSYM_asterisk,    "XK_asterisk",          "*" },
1240     { KSYM_plus,        "XK_plus",              "+" },
1241     { KSYM_comma,       "XK_comma",             "," },
1242     { KSYM_minus,       "XK_minus",             "-" },
1243     { KSYM_period,      "XK_period",            "." },
1244     { KSYM_slash,       "XK_slash",             "/" },
1245     { KSYM_colon,       "XK_colon",             ":" },
1246     { KSYM_semicolon,   "XK_semicolon",         ";" },
1247     { KSYM_less,        "XK_less",              "<" },
1248     { KSYM_equal,       "XK_equal",             "=" },
1249     { KSYM_greater,     "XK_greater",           ">" },
1250     { KSYM_question,    "XK_question",          "?" },
1251     { KSYM_at,          "XK_at",                "@" },
1252
1253     /* more ASCII keys */
1254     { KSYM_bracketleft, "XK_bracketleft",       "[" },
1255     { KSYM_backslash,   "XK_backslash",         "\\" },
1256     { KSYM_bracketright,"XK_bracketright",      "]" },
1257     { KSYM_asciicircum, "XK_asciicircum",       "^" },
1258     { KSYM_underscore,  "XK_underscore",        "_" },
1259     { KSYM_grave,       "XK_grave",             "grave" },
1260     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
1261     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
1262     { KSYM_bar,         "XK_bar",               "bar" },
1263     { KSYM_braceright,  "XK_braceright",        "brace right" },
1264     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
1265
1266     /* special (non-ASCII) keys */
1267     { KSYM_degree,      "XK_degree",            "°" },
1268     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
1269     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
1270     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
1271     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
1272     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
1273     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
1274     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1275
1276     /* end-of-array identifier */
1277     { 0,                NULL,                   NULL }
1278   };
1279
1280   int i;
1281
1282   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1283   {
1284     static char name_buffer[30];
1285     Key key = *keysym;
1286
1287     if (key >= KSYM_A && key <= KSYM_Z)
1288       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1289     else if (key >= KSYM_a && key <= KSYM_z)
1290       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1291     else if (key >= KSYM_0 && key <= KSYM_9)
1292       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1293     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1294       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1295     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1296       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1297     else if (key == KSYM_UNDEFINED)
1298       strcpy(name_buffer, "(undefined)");
1299     else
1300     {
1301       i = 0;
1302
1303       do
1304       {
1305         if (key == translate_key[i].key)
1306         {
1307           strcpy(name_buffer, translate_key[i].name);
1308           break;
1309         }
1310       }
1311       while (translate_key[++i].name);
1312
1313       if (!translate_key[i].name)
1314         strcpy(name_buffer, "(unknown)");
1315     }
1316
1317     *name = name_buffer;
1318   }
1319   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1320   {
1321     static char name_buffer[30];
1322     Key key = *keysym;
1323
1324     if (key >= KSYM_A && key <= KSYM_Z)
1325       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1326     else if (key >= KSYM_a && key <= KSYM_z)
1327       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1328     else if (key >= KSYM_0 && key <= KSYM_9)
1329       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1330     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1331       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1332     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1333       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1334     else if (key == KSYM_UNDEFINED)
1335       strcpy(name_buffer, "[undefined]");
1336     else
1337     {
1338       i = 0;
1339
1340       do
1341       {
1342         if (key == translate_key[i].key)
1343         {
1344           strcpy(name_buffer, translate_key[i].x11name);
1345           break;
1346         }
1347       }
1348       while (translate_key[++i].x11name);
1349
1350       if (!translate_key[i].x11name)
1351         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1352     }
1353
1354     *x11name = name_buffer;
1355   }
1356   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1357   {
1358     Key key = KSYM_UNDEFINED;
1359
1360     i = 0;
1361     do
1362     {
1363       if (strEqual(translate_key[i].name, *name))
1364       {
1365         key = translate_key[i].key;
1366         break;
1367       }
1368     }
1369     while (translate_key[++i].x11name);
1370
1371     if (key == KSYM_UNDEFINED)
1372       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1373
1374     *keysym = key;
1375   }
1376   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1377   {
1378     Key key = KSYM_UNDEFINED;
1379     char *name_ptr = *x11name;
1380
1381     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1382     {
1383       char c = name_ptr[3];
1384
1385       if (c >= 'A' && c <= 'Z')
1386         key = KSYM_A + (Key)(c - 'A');
1387       else if (c >= 'a' && c <= 'z')
1388         key = KSYM_a + (Key)(c - 'a');
1389       else if (c >= '0' && c <= '9')
1390         key = KSYM_0 + (Key)(c - '0');
1391     }
1392     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1393     {
1394       char c = name_ptr[6];
1395
1396       if (c >= '0' && c <= '9')
1397         key = KSYM_KP_0 + (Key)(c - '0');
1398     }
1399     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1400     {
1401       char c1 = name_ptr[4];
1402       char c2 = name_ptr[5];
1403       int d = 0;
1404
1405       if ((c1 >= '0' && c1 <= '9') &&
1406           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1407         d = atoi(&name_ptr[4]);
1408
1409       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1410         key = KSYM_F1 + (Key)(d - 1);
1411     }
1412     else if (strncmp(name_ptr, "XK_", 3) == 0)
1413     {
1414       i = 0;
1415
1416       do
1417       {
1418         if (strEqual(name_ptr, translate_key[i].x11name))
1419         {
1420           key = translate_key[i].key;
1421           break;
1422         }
1423       }
1424       while (translate_key[++i].x11name);
1425     }
1426     else if (strncmp(name_ptr, "0x", 2) == 0)
1427     {
1428       unsigned long value = 0;
1429
1430       name_ptr += 2;
1431
1432       while (name_ptr)
1433       {
1434         char c = *name_ptr++;
1435         int d = -1;
1436
1437         if (c >= '0' && c <= '9')
1438           d = (int)(c - '0');
1439         else if (c >= 'a' && c <= 'f')
1440           d = (int)(c - 'a' + 10);
1441         else if (c >= 'A' && c <= 'F')
1442           d = (int)(c - 'A' + 10);
1443
1444         if (d == -1)
1445         {
1446           value = -1;
1447           break;
1448         }
1449
1450         value = value * 16 + d;
1451       }
1452
1453       if (value != -1)
1454         key = (Key)value;
1455     }
1456
1457     *keysym = key;
1458   }
1459 }
1460
1461 char *getKeyNameFromKey(Key key)
1462 {
1463   char *name;
1464
1465   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1466   return name;
1467 }
1468
1469 char *getX11KeyNameFromKey(Key key)
1470 {
1471   char *x11name;
1472
1473   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1474   return x11name;
1475 }
1476
1477 Key getKeyFromKeyName(char *name)
1478 {
1479   Key key;
1480
1481   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1482   return key;
1483 }
1484
1485 Key getKeyFromX11KeyName(char *x11name)
1486 {
1487   Key key;
1488
1489   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1490   return key;
1491 }
1492
1493 char getCharFromKey(Key key)
1494 {
1495   char *keyname = getKeyNameFromKey(key);
1496   char c = 0;
1497
1498   if (strlen(keyname) == 1)
1499     c = keyname[0];
1500   else if (strEqual(keyname, "space"))
1501     c = ' ';
1502
1503   return c;
1504 }
1505
1506 char getValidConfigValueChar(char c)
1507 {
1508   if (c == '#' ||       /* used to mark comments */
1509       c == '\\')        /* used to mark continued lines */
1510     c = 0;
1511
1512   return c;
1513 }
1514
1515
1516 /* ------------------------------------------------------------------------- */
1517 /* functions to translate string identifiers to integer or boolean value     */
1518 /* ------------------------------------------------------------------------- */
1519
1520 int get_integer_from_string(char *s)
1521 {
1522   static char *number_text[][3] =
1523   {
1524     { "0",      "zero",         "null",         },
1525     { "1",      "one",          "first"         },
1526     { "2",      "two",          "second"        },
1527     { "3",      "three",        "third"         },
1528     { "4",      "four",         "fourth"        },
1529     { "5",      "five",         "fifth"         },
1530     { "6",      "six",          "sixth"         },
1531     { "7",      "seven",        "seventh"       },
1532     { "8",      "eight",        "eighth"        },
1533     { "9",      "nine",         "ninth"         },
1534     { "10",     "ten",          "tenth"         },
1535     { "11",     "eleven",       "eleventh"      },
1536     { "12",     "twelve",       "twelfth"       },
1537
1538     { NULL,     NULL,           NULL            },
1539   };
1540
1541   int i, j;
1542   char *s_lower = getStringToLower(s);
1543   int result = -1;
1544
1545   for (i = 0; number_text[i][0] != NULL; i++)
1546     for (j = 0; j < 3; j++)
1547       if (strEqual(s_lower, number_text[i][j]))
1548         result = i;
1549
1550   if (result == -1)
1551   {
1552     if (strEqual(s_lower, "false") ||
1553         strEqual(s_lower, "no") ||
1554         strEqual(s_lower, "off"))
1555       result = 0;
1556     else if (strEqual(s_lower, "true") ||
1557              strEqual(s_lower, "yes") ||
1558              strEqual(s_lower, "on"))
1559       result = 1;
1560     else
1561       result = atoi(s);
1562   }
1563
1564   free(s_lower);
1565
1566   return result;
1567 }
1568
1569 boolean get_boolean_from_string(char *s)
1570 {
1571   char *s_lower = getStringToLower(s);
1572   boolean result = FALSE;
1573
1574   if (strEqual(s_lower, "true") ||
1575       strEqual(s_lower, "yes") ||
1576       strEqual(s_lower, "on") ||
1577       get_integer_from_string(s) == 1)
1578     result = TRUE;
1579
1580   free(s_lower);
1581
1582   return result;
1583 }
1584
1585
1586 /* ------------------------------------------------------------------------- */
1587 /* functions for generic lists                                               */
1588 /* ------------------------------------------------------------------------- */
1589
1590 ListNode *newListNode()
1591 {
1592   return checked_calloc(sizeof(ListNode));
1593 }
1594
1595 void addNodeToList(ListNode **node_first, char *key, void *content)
1596 {
1597   ListNode *node_new = newListNode();
1598
1599   node_new->key = getStringCopy(key);
1600   node_new->content = content;
1601   node_new->next = *node_first;
1602   *node_first = node_new;
1603 }
1604
1605 void deleteNodeFromList(ListNode **node_first, char *key,
1606                         void (*destructor_function)(void *))
1607 {
1608   if (node_first == NULL || *node_first == NULL)
1609     return;
1610
1611   if (strEqual((*node_first)->key, key))
1612   {
1613     checked_free((*node_first)->key);
1614     if (destructor_function)
1615       destructor_function((*node_first)->content);
1616     *node_first = (*node_first)->next;
1617   }
1618   else
1619     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1620 }
1621
1622 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1623 {
1624   if (node_first == NULL)
1625     return NULL;
1626
1627   if (strEqual(node_first->key, key))
1628     return node_first;
1629   else
1630     return getNodeFromKey(node_first->next, key);
1631 }
1632
1633 int getNumNodes(ListNode *node_first)
1634 {
1635   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1636 }
1637
1638 void dumpList(ListNode *node_first)
1639 {
1640   ListNode *node = node_first;
1641
1642   while (node)
1643   {
1644     printf("['%s' (%d)]\n", node->key,
1645            ((struct ListNodeInfo *)node->content)->num_references);
1646     node = node->next;
1647   }
1648
1649   printf("[%d nodes]\n", getNumNodes(node_first));
1650 }
1651
1652
1653 /* ------------------------------------------------------------------------- */
1654 /* functions for checking files and filenames                                */
1655 /* ------------------------------------------------------------------------- */
1656
1657 boolean fileExists(char *filename)
1658 {
1659   if (filename == NULL)
1660     return FALSE;
1661
1662   return (access(filename, F_OK) == 0);
1663 }
1664
1665 boolean fileHasPrefix(char *basename, char *prefix)
1666 {
1667   static char *basename_lower = NULL;
1668   int basename_length, prefix_length;
1669
1670   checked_free(basename_lower);
1671
1672   if (basename == NULL || prefix == NULL)
1673     return FALSE;
1674
1675   basename_lower = getStringToLower(basename);
1676   basename_length = strlen(basename_lower);
1677   prefix_length = strlen(prefix);
1678
1679   if (basename_length > prefix_length + 1 &&
1680       basename_lower[prefix_length] == '.' &&
1681       strncmp(basename_lower, prefix, prefix_length) == 0)
1682     return TRUE;
1683
1684   return FALSE;
1685 }
1686
1687 boolean fileHasSuffix(char *basename, char *suffix)
1688 {
1689   static char *basename_lower = NULL;
1690   int basename_length, suffix_length;
1691
1692   checked_free(basename_lower);
1693
1694   if (basename == NULL || suffix == NULL)
1695     return FALSE;
1696
1697   basename_lower = getStringToLower(basename);
1698   basename_length = strlen(basename_lower);
1699   suffix_length = strlen(suffix);
1700
1701   if (basename_length > suffix_length + 1 &&
1702       basename_lower[basename_length - suffix_length - 1] == '.' &&
1703       strEqual(&basename_lower[basename_length - suffix_length], suffix))
1704     return TRUE;
1705
1706   return FALSE;
1707 }
1708
1709 boolean FileIsGraphic(char *filename)
1710 {
1711   char *basename = getBaseNamePtr(filename);
1712
1713   return fileHasSuffix(basename, "pcx");
1714 }
1715
1716 boolean FileIsSound(char *filename)
1717 {
1718   char *basename = getBaseNamePtr(filename);
1719
1720   return fileHasSuffix(basename, "wav");
1721 }
1722
1723 boolean FileIsMusic(char *filename)
1724 {
1725   char *basename = getBaseNamePtr(filename);
1726
1727   if (FileIsSound(basename))
1728     return TRUE;
1729
1730 #if defined(TARGET_SDL)
1731   if (fileHasPrefix(basename, "mod") ||
1732       fileHasSuffix(basename, "mod") ||
1733       fileHasSuffix(basename, "s3m") ||
1734       fileHasSuffix(basename, "it") ||
1735       fileHasSuffix(basename, "xm") ||
1736       fileHasSuffix(basename, "midi") ||
1737       fileHasSuffix(basename, "mid") ||
1738       fileHasSuffix(basename, "mp3") ||
1739       fileHasSuffix(basename, "ogg"))
1740     return TRUE;
1741 #endif
1742
1743   return FALSE;
1744 }
1745
1746 boolean FileIsArtworkType(char *basename, int type)
1747 {
1748   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1749       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1750       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1751     return TRUE;
1752
1753   return FALSE;
1754 }
1755
1756 /* ------------------------------------------------------------------------- */
1757 /* functions for loading artwork configuration information                   */
1758 /* ------------------------------------------------------------------------- */
1759
1760 char *get_mapped_token(char *token)
1761 {
1762   /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
1763   static char *map_token_prefix[][2] =
1764   {
1765     { "char_procent",           "char_percent"  },
1766     { NULL,                                     }
1767   };
1768   int i;
1769
1770   for (i = 0; map_token_prefix[i][0] != NULL; i++)
1771   {
1772     int len_token_prefix = strlen(map_token_prefix[i][0]);
1773
1774     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
1775       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
1776   }
1777
1778   return NULL;
1779 }
1780
1781 /* This function checks if a string <s> of the format "string1, string2, ..."
1782    exactly contains a string <s_contained>. */
1783
1784 static boolean string_has_parameter(char *s, char *s_contained)
1785 {
1786   char *substring;
1787
1788   if (s == NULL || s_contained == NULL)
1789     return FALSE;
1790
1791   if (strlen(s_contained) > strlen(s))
1792     return FALSE;
1793
1794   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
1795   {
1796     char next_char = s[strlen(s_contained)];
1797
1798     /* check if next character is delimiter or whitespace */
1799     return (next_char == ',' || next_char == '\0' ||
1800             next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
1801   }
1802
1803   /* check if string contains another parameter string after a comma */
1804   substring = strchr(s, ',');
1805   if (substring == NULL)        /* string does not contain a comma */
1806     return FALSE;
1807
1808   /* advance string pointer to next character after the comma */
1809   substring++;
1810
1811   /* skip potential whitespaces after the comma */
1812   while (*substring == ' ' || *substring == '\t')
1813     substring++;
1814
1815   return string_has_parameter(substring, s_contained);
1816 }
1817
1818 int get_parameter_value(char *value_raw, char *suffix, int type)
1819 {
1820   char *value = getStringToLower(value_raw);
1821   int result = 0;       /* probably a save default value */
1822
1823   if (strEqual(suffix, ".direction"))
1824   {
1825     result = (strEqual(value, "left")  ? MV_LEFT :
1826               strEqual(value, "right") ? MV_RIGHT :
1827               strEqual(value, "up")    ? MV_UP :
1828               strEqual(value, "down")  ? MV_DOWN : MV_NONE);
1829   }
1830   else if (strEqual(suffix, ".align"))
1831   {
1832     result = (strEqual(value, "left")   ? ALIGN_LEFT :
1833               strEqual(value, "right")  ? ALIGN_RIGHT :
1834               strEqual(value, "center") ? ALIGN_CENTER :
1835               strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
1836   }
1837   else if (strEqual(suffix, ".valign"))
1838   {
1839     result = (strEqual(value, "top")    ? VALIGN_TOP :
1840               strEqual(value, "bottom") ? VALIGN_BOTTOM :
1841               strEqual(value, "middle") ? VALIGN_MIDDLE :
1842               strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
1843   }
1844   else if (strEqual(suffix, ".anim_mode"))
1845   {
1846     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
1847               string_has_parameter(value, "loop")       ? ANIM_LOOP :
1848               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
1849               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
1850               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
1851               string_has_parameter(value, "random")     ? ANIM_RANDOM :
1852               string_has_parameter(value, "ce_value")   ? ANIM_CE_VALUE :
1853               string_has_parameter(value, "ce_score")   ? ANIM_CE_SCORE :
1854               string_has_parameter(value, "ce_delay")   ? ANIM_CE_DELAY :
1855               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
1856               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
1857               string_has_parameter(value, "centered")   ? ANIM_CENTERED :
1858               ANIM_DEFAULT);
1859
1860     if (string_has_parameter(value, "reverse"))
1861       result |= ANIM_REVERSE;
1862
1863     if (string_has_parameter(value, "opaque_player"))
1864       result |= ANIM_OPAQUE_PLAYER;
1865
1866     if (string_has_parameter(value, "static_panel"))
1867       result |= ANIM_STATIC_PANEL;
1868   }
1869   else if (strEqual(suffix, ".fade_mode"))
1870   {
1871     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
1872               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
1873               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
1874               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
1875               FADE_MODE_DEFAULT);
1876   }
1877 #if 1
1878   else if (strEqualPrefix(suffix, ".font"))     /* (may also be ".font_xyz") */
1879 #else
1880   else if (strEqualN(suffix, ".font", 5))       /* (may also be ".font_xyz") */
1881 #endif
1882   {
1883     result = gfx.get_font_from_token_function(value);
1884   }
1885   else          /* generic parameter of type integer or boolean */
1886   {
1887     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
1888               type == TYPE_INTEGER ? get_integer_from_string(value) :
1889               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1890               ARG_UNDEFINED_VALUE);
1891   }
1892
1893   free(value);
1894
1895   return result;
1896 }
1897
1898 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
1899 {
1900   static struct ScreenModeInfo screen_mode;
1901   char *screen_mode_string_x = strchr(screen_mode_string, 'x');
1902   char *screen_mode_string_copy;
1903   char *screen_mode_string_pos_w;
1904   char *screen_mode_string_pos_h;
1905
1906   if (screen_mode_string_x == NULL)     /* invalid screen mode format */
1907     return NULL;
1908
1909   screen_mode_string_copy = getStringCopy(screen_mode_string);
1910
1911   screen_mode_string_pos_w = screen_mode_string_copy;
1912   screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
1913   *screen_mode_string_pos_h++ = '\0';
1914
1915   screen_mode.width  = atoi(screen_mode_string_pos_w);
1916   screen_mode.height = atoi(screen_mode_string_pos_h);
1917
1918   return &screen_mode;
1919 }
1920
1921 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
1922                                        int *x, int *y)
1923 {
1924   float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
1925   float aspect_ratio_new;
1926   int i = 1;
1927
1928   do
1929   {
1930     *x = i * aspect_ratio + 0.000001;
1931     *y = i;
1932
1933     aspect_ratio_new = (float)*x / (float)*y;
1934
1935     i++;
1936   }
1937   while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
1938 }
1939
1940 static void FreeCustomArtworkList(struct ArtworkListInfo *,
1941                                   struct ListNodeInfo ***, int *);
1942
1943 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1944                                            struct ConfigTypeInfo *suffix_list,
1945                                            char **ignore_tokens,
1946                                            int num_file_list_entries)
1947 {
1948   struct FileInfo *file_list;
1949   int num_file_list_entries_found = 0;
1950   int num_suffix_list_entries = 0;
1951   int list_pos;
1952   int i, j;
1953
1954   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1955
1956   for (i = 0; suffix_list[i].token != NULL; i++)
1957     num_suffix_list_entries++;
1958
1959   /* always start with reliable default values */
1960   for (i = 0; i < num_file_list_entries; i++)
1961   {
1962     file_list[i].token = NULL;
1963
1964     file_list[i].default_filename = NULL;
1965     file_list[i].filename = NULL;
1966
1967     if (num_suffix_list_entries > 0)
1968     {
1969       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
1970
1971       file_list[i].default_parameter = checked_calloc(parameter_array_size);
1972       file_list[i].parameter = checked_calloc(parameter_array_size);
1973
1974       for (j = 0; j < num_suffix_list_entries; j++)
1975       {
1976         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
1977         setString(&file_list[i].parameter[j], suffix_list[j].value);
1978       }
1979
1980       file_list[i].redefined = FALSE;
1981       file_list[i].fallback_to_default = FALSE;
1982     }
1983   }
1984
1985   list_pos = 0;
1986   for (i = 0; config_list[i].token != NULL; i++)
1987   {
1988     int len_config_token = strlen(config_list[i].token);
1989     int len_config_value = strlen(config_list[i].value);
1990     boolean is_file_entry = TRUE;
1991
1992     for (j = 0; suffix_list[j].token != NULL; j++)
1993     {
1994       int len_suffix = strlen(suffix_list[j].token);
1995
1996       if (len_suffix < len_config_token &&
1997           strEqual(&config_list[i].token[len_config_token - len_suffix],
1998                    suffix_list[j].token))
1999       {
2000         setString(&file_list[list_pos].default_parameter[j],
2001                   config_list[i].value);
2002
2003         is_file_entry = FALSE;
2004         break;
2005       }
2006     }
2007
2008     /* the following tokens are no file definitions, but other config tokens */
2009     for (j = 0; ignore_tokens[j] != NULL; j++)
2010       if (strEqual(config_list[i].token, ignore_tokens[j]))
2011         is_file_entry = FALSE;
2012
2013     if (is_file_entry)
2014     {
2015       if (i > 0)
2016         list_pos++;
2017
2018       if (list_pos >= num_file_list_entries)
2019         break;
2020
2021       /* simple sanity check if this is really a file definition */
2022       if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2023           !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2024           !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2025       {
2026         Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2027               config_list[i].token, config_list[i].value);
2028         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2029       }
2030
2031       file_list[list_pos].token = config_list[i].token;
2032       file_list[list_pos].default_filename = config_list[i].value;
2033
2034 #if 0
2035       printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2036 #endif
2037     }
2038   }
2039
2040   num_file_list_entries_found = list_pos + 1;
2041   if (num_file_list_entries_found != num_file_list_entries)
2042   {
2043     Error(ERR_INFO_LINE, "-");
2044     Error(ERR_INFO, "inconsistant config list information:");
2045     Error(ERR_INFO, "- should be:   %d (according to 'src/conf_xxx.h')",
2046           num_file_list_entries);
2047     Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2048           num_file_list_entries_found);
2049     Error(ERR_EXIT,   "please fix");
2050   }
2051
2052 #if 0
2053   printf("::: ---------- DONE ----------\n");
2054 #endif
2055
2056   return file_list;
2057 }
2058
2059 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2060 {
2061   int len_token = strlen(token);
2062   int len_suffix = strlen(suffix);
2063
2064   if (start_pos < 0)    /* compare suffix from end of string */
2065     start_pos += len_token;
2066
2067   if (start_pos < 0 || start_pos + len_suffix > len_token)
2068     return FALSE;
2069
2070   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2071     return FALSE;
2072
2073   if (token[start_pos + len_suffix] == '\0')
2074     return TRUE;
2075
2076   if (token[start_pos + len_suffix] == '.')
2077     return TRUE;
2078
2079   return FALSE;
2080 }
2081
2082 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
2083
2084 static void read_token_parameters(SetupFileHash *setup_file_hash,
2085                                   struct ConfigTypeInfo *suffix_list,
2086                                   struct FileInfo *file_list_entry)
2087 {
2088   /* check for config token that is the base token without any suffixes */
2089   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2090   char *known_token_value = KNOWN_TOKEN_VALUE;
2091   int i;
2092
2093   if (filename != NULL)
2094   {
2095     setString(&file_list_entry->filename, filename);
2096
2097     /* when file definition found, set all parameters to default values */
2098     for (i = 0; suffix_list[i].token != NULL; i++)
2099       setString(&file_list_entry->parameter[i], suffix_list[i].value);
2100
2101     file_list_entry->redefined = TRUE;
2102
2103     /* mark config file token as well known from default config */
2104     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2105   }
2106
2107   /* check for config tokens that can be build by base token and suffixes */
2108   for (i = 0; suffix_list[i].token != NULL; i++)
2109   {
2110     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2111     char *value = getHashEntry(setup_file_hash, token);
2112
2113     if (value != NULL)
2114     {
2115       setString(&file_list_entry->parameter[i], value);
2116
2117       /* mark config file token as well known from default config */
2118       setHashEntry(setup_file_hash, token, known_token_value);
2119     }
2120
2121     free(token);
2122   }
2123 }
2124
2125 static void add_dynamic_file_list_entry(struct FileInfo **list,
2126                                         int *num_list_entries,
2127                                         SetupFileHash *extra_file_hash,
2128                                         struct ConfigTypeInfo *suffix_list,
2129                                         int num_suffix_list_entries,
2130                                         char *token)
2131 {
2132   struct FileInfo *new_list_entry;
2133   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2134
2135   (*num_list_entries)++;
2136   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2137   new_list_entry = &(*list)[*num_list_entries - 1];
2138
2139   new_list_entry->token = getStringCopy(token);
2140   new_list_entry->default_filename = NULL;
2141   new_list_entry->filename = NULL;
2142   new_list_entry->parameter = checked_calloc(parameter_array_size);
2143
2144   new_list_entry->redefined = FALSE;
2145   new_list_entry->fallback_to_default = FALSE;
2146
2147   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2148 }
2149
2150 static void add_property_mapping(struct PropertyMapping **list,
2151                                  int *num_list_entries,
2152                                  int base_index, int ext1_index,
2153                                  int ext2_index, int ext3_index,
2154                                  int artwork_index)
2155 {
2156   struct PropertyMapping *new_list_entry;
2157
2158   (*num_list_entries)++;
2159   *list = checked_realloc(*list,
2160                           *num_list_entries * sizeof(struct PropertyMapping));
2161   new_list_entry = &(*list)[*num_list_entries - 1];
2162
2163   new_list_entry->base_index = base_index;
2164   new_list_entry->ext1_index = ext1_index;
2165   new_list_entry->ext2_index = ext2_index;
2166   new_list_entry->ext3_index = ext3_index;
2167
2168   new_list_entry->artwork_index = artwork_index;
2169 }
2170
2171 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2172                                           char *filename)
2173 {
2174   struct FileInfo *file_list = artwork_info->file_list;
2175   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2176   char **base_prefixes = artwork_info->base_prefixes;
2177   char **ext1_suffixes = artwork_info->ext1_suffixes;
2178   char **ext2_suffixes = artwork_info->ext2_suffixes;
2179   char **ext3_suffixes = artwork_info->ext3_suffixes;
2180   char **ignore_tokens = artwork_info->ignore_tokens;
2181   int num_file_list_entries = artwork_info->num_file_list_entries;
2182   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2183   int num_base_prefixes = artwork_info->num_base_prefixes;
2184   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2185   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2186   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2187   int num_ignore_tokens = artwork_info->num_ignore_tokens;
2188   SetupFileHash *setup_file_hash, *valid_file_hash;
2189   SetupFileHash *extra_file_hash, *empty_file_hash;
2190   char *known_token_value = KNOWN_TOKEN_VALUE;
2191   int i, j, k, l;
2192
2193   if (filename == NULL)
2194     return;
2195
2196 #if 0
2197   printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2198 #endif
2199
2200   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2201     return;
2202
2203   /* separate valid (defined) from empty (undefined) config token values */
2204   valid_file_hash = newSetupFileHash();
2205   empty_file_hash = newSetupFileHash();
2206   BEGIN_HASH_ITERATION(setup_file_hash, itr)
2207   {
2208     char *value = HASH_ITERATION_VALUE(itr);
2209
2210     setHashEntry(*value ? valid_file_hash : empty_file_hash,
2211                  HASH_ITERATION_TOKEN(itr), value);
2212   }
2213   END_HASH_ITERATION(setup_file_hash, itr)
2214
2215   /* at this point, we do not need the setup file hash anymore -- free it */
2216   freeSetupFileHash(setup_file_hash);
2217
2218   /* map deprecated to current tokens (using prefix match and replace) */
2219   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2220   {
2221     char *token = HASH_ITERATION_TOKEN(itr);
2222     char *mapped_token = get_mapped_token(token);
2223
2224     if (mapped_token != NULL)
2225     {
2226       char *value = HASH_ITERATION_VALUE(itr);
2227
2228       /* add mapped token */
2229       setHashEntry(valid_file_hash, mapped_token, value);
2230
2231       /* ignore old token (by setting it to "known" keyword) */
2232       setHashEntry(valid_file_hash, token, known_token_value);
2233
2234       free(mapped_token);
2235     }
2236   }
2237   END_HASH_ITERATION(valid_file_hash, itr)
2238
2239   /* read parameters for all known config file tokens */
2240   for (i = 0; i < num_file_list_entries; i++)
2241     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2242
2243   /* set all tokens that can be ignored here to "known" keyword */
2244   for (i = 0; i < num_ignore_tokens; i++)
2245     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2246
2247   /* copy all unknown config file tokens to extra config hash */
2248   extra_file_hash = newSetupFileHash();
2249   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2250   {
2251     char *value = HASH_ITERATION_VALUE(itr);
2252
2253     if (!strEqual(value, known_token_value))
2254       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2255   }
2256   END_HASH_ITERATION(valid_file_hash, itr)
2257
2258   /* at this point, we do not need the valid file hash anymore -- free it */
2259   freeSetupFileHash(valid_file_hash);
2260
2261   /* now try to determine valid, dynamically defined config tokens */
2262
2263   BEGIN_HASH_ITERATION(extra_file_hash, itr)
2264   {
2265     struct FileInfo **dynamic_file_list =
2266       &artwork_info->dynamic_file_list;
2267     int *num_dynamic_file_list_entries =
2268       &artwork_info->num_dynamic_file_list_entries;
2269     struct PropertyMapping **property_mapping =
2270       &artwork_info->property_mapping;
2271     int *num_property_mapping_entries =
2272       &artwork_info->num_property_mapping_entries;
2273     int current_summarized_file_list_entry =
2274       artwork_info->num_file_list_entries +
2275       artwork_info->num_dynamic_file_list_entries;
2276     char *token = HASH_ITERATION_TOKEN(itr);
2277     int len_token = strlen(token);
2278     int start_pos;
2279     boolean base_prefix_found = FALSE;
2280     boolean parameter_suffix_found = FALSE;
2281
2282 #if 0
2283     printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2284 #endif
2285
2286     /* skip all parameter definitions (handled by read_token_parameters()) */
2287     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2288     {
2289       int len_suffix = strlen(suffix_list[i].token);
2290
2291       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2292         parameter_suffix_found = TRUE;
2293     }
2294
2295     if (parameter_suffix_found)
2296       continue;
2297
2298     /* ---------- step 0: search for matching base prefix ---------- */
2299
2300     start_pos = 0;
2301     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2302     {
2303       char *base_prefix = base_prefixes[i];
2304       int len_base_prefix = strlen(base_prefix);
2305       boolean ext1_suffix_found = FALSE;
2306       boolean ext2_suffix_found = FALSE;
2307       boolean ext3_suffix_found = FALSE;
2308       boolean exact_match = FALSE;
2309       int base_index = -1;
2310       int ext1_index = -1;
2311       int ext2_index = -1;
2312       int ext3_index = -1;
2313
2314       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2315
2316       if (!base_prefix_found)
2317         continue;
2318
2319       base_index = i;
2320
2321 #if 0
2322       if (IS_PARENT_PROCESS())
2323         printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2324 #endif
2325
2326       if (start_pos + len_base_prefix == len_token)     /* exact match */
2327       {
2328         exact_match = TRUE;
2329
2330 #if 0
2331         if (IS_PARENT_PROCESS())
2332           printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2333 #endif
2334
2335         add_dynamic_file_list_entry(dynamic_file_list,
2336                                     num_dynamic_file_list_entries,
2337                                     extra_file_hash,
2338                                     suffix_list,
2339                                     num_suffix_list_entries,
2340                                     token);
2341         add_property_mapping(property_mapping,
2342                              num_property_mapping_entries,
2343                              base_index, -1, -1, -1,
2344                              current_summarized_file_list_entry);
2345         continue;
2346       }
2347
2348 #if 0
2349       if (IS_PARENT_PROCESS())
2350         printf("---> examining token '%s': search 1st suffix ...\n", token);
2351 #endif
2352
2353       /* ---------- step 1: search for matching first suffix ---------- */
2354
2355       start_pos += len_base_prefix;
2356       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2357       {
2358         char *ext1_suffix = ext1_suffixes[j];
2359         int len_ext1_suffix = strlen(ext1_suffix);
2360
2361         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2362
2363         if (!ext1_suffix_found)
2364           continue;
2365
2366         ext1_index = j;
2367
2368 #if 0
2369         if (IS_PARENT_PROCESS())
2370           printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2371 #endif
2372
2373         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
2374         {
2375           exact_match = TRUE;
2376
2377 #if 0
2378         if (IS_PARENT_PROCESS())
2379           printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2380 #endif
2381
2382           add_dynamic_file_list_entry(dynamic_file_list,
2383                                       num_dynamic_file_list_entries,
2384                                       extra_file_hash,
2385                                       suffix_list,
2386                                       num_suffix_list_entries,
2387                                       token);
2388           add_property_mapping(property_mapping,
2389                                num_property_mapping_entries,
2390                                base_index, ext1_index, -1, -1,
2391                                current_summarized_file_list_entry);
2392           continue;
2393         }
2394
2395         start_pos += len_ext1_suffix;
2396       }
2397
2398       if (exact_match)
2399         break;
2400
2401 #if 0
2402       if (IS_PARENT_PROCESS())
2403         printf("---> examining token '%s': search 2nd suffix ...\n", token);
2404 #endif
2405
2406       /* ---------- step 2: search for matching second suffix ---------- */
2407
2408       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2409       {
2410         char *ext2_suffix = ext2_suffixes[k];
2411         int len_ext2_suffix = strlen(ext2_suffix);
2412
2413         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2414
2415         if (!ext2_suffix_found)
2416           continue;
2417
2418         ext2_index = k;
2419
2420 #if 0
2421         if (IS_PARENT_PROCESS())
2422           printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2423 #endif
2424
2425         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
2426         {
2427           exact_match = TRUE;
2428
2429 #if 0
2430           if (IS_PARENT_PROCESS())
2431             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2432 #endif
2433
2434           add_dynamic_file_list_entry(dynamic_file_list,
2435                                       num_dynamic_file_list_entries,
2436                                       extra_file_hash,
2437                                       suffix_list,
2438                                       num_suffix_list_entries,
2439                                       token);
2440           add_property_mapping(property_mapping,
2441                                num_property_mapping_entries,
2442                                base_index, ext1_index, ext2_index, -1,
2443                                current_summarized_file_list_entry);
2444           continue;
2445         }
2446
2447         start_pos += len_ext2_suffix;
2448       }
2449
2450       if (exact_match)
2451         break;
2452
2453 #if 0
2454       if (IS_PARENT_PROCESS())
2455         printf("---> examining token '%s': search 3rd suffix ...\n",token);
2456 #endif
2457
2458       /* ---------- step 3: search for matching third suffix ---------- */
2459
2460       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2461       {
2462         char *ext3_suffix = ext3_suffixes[l];
2463         int len_ext3_suffix = strlen(ext3_suffix);
2464
2465         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2466
2467         if (!ext3_suffix_found)
2468           continue;
2469
2470         ext3_index = l;
2471
2472 #if 0
2473         if (IS_PARENT_PROCESS())
2474           printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2475 #endif
2476
2477         if (start_pos + len_ext3_suffix == len_token) /* exact match */
2478         {
2479           exact_match = TRUE;
2480
2481 #if 0
2482           if (IS_PARENT_PROCESS())
2483             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2484 #endif
2485
2486           add_dynamic_file_list_entry(dynamic_file_list,
2487                                       num_dynamic_file_list_entries,
2488                                       extra_file_hash,
2489                                       suffix_list,
2490                                       num_suffix_list_entries,
2491                                       token);
2492           add_property_mapping(property_mapping,
2493                                num_property_mapping_entries,
2494                                base_index, ext1_index, ext2_index, ext3_index,
2495                                current_summarized_file_list_entry);
2496           continue;
2497         }
2498       }
2499     }
2500   }
2501   END_HASH_ITERATION(extra_file_hash, itr)
2502
2503   if (artwork_info->num_dynamic_file_list_entries > 0)
2504   {
2505     artwork_info->dynamic_artwork_list =
2506       checked_calloc(artwork_info->num_dynamic_file_list_entries *
2507                      artwork_info->sizeof_artwork_list_entry);
2508   }
2509
2510   if (options.verbose && IS_PARENT_PROCESS())
2511   {
2512     SetupFileList *setup_file_list, *list;
2513     boolean dynamic_tokens_found = FALSE;
2514     boolean unknown_tokens_found = FALSE;
2515     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2516
2517     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2518       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2519
2520     BEGIN_HASH_ITERATION(extra_file_hash, itr)
2521     {
2522       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2523         dynamic_tokens_found = TRUE;
2524       else
2525         unknown_tokens_found = TRUE;
2526     }
2527     END_HASH_ITERATION(extra_file_hash, itr)
2528
2529     if (options.debug && dynamic_tokens_found)
2530     {
2531       Error(ERR_INFO_LINE, "-");
2532       Error(ERR_INFO, "dynamic token(s) found in config file:");
2533       Error(ERR_INFO, "- config file: '%s'", filename);
2534
2535       for (list = setup_file_list; list != NULL; list = list->next)
2536       {
2537         char *value = getHashEntry(extra_file_hash, list->token);
2538
2539         if (value != NULL && strEqual(value, known_token_value))
2540           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2541       }
2542
2543       Error(ERR_INFO_LINE, "-");
2544     }
2545
2546     if (unknown_tokens_found)
2547     {
2548       Error(ERR_INFO_LINE, "-");
2549       Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2550       Error(ERR_INFO, "- config file: '%s'", filename);
2551
2552       for (list = setup_file_list; list != NULL; list = list->next)
2553       {
2554         char *value = getHashEntry(extra_file_hash, list->token);
2555
2556         if (value != NULL && !strEqual(value, known_token_value))
2557           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2558       }
2559
2560       Error(ERR_INFO_LINE, "-");
2561     }
2562
2563     if (undefined_values_found)
2564     {
2565       Error(ERR_INFO_LINE, "-");
2566       Error(ERR_INFO, "warning: undefined values found in config file:");
2567       Error(ERR_INFO, "- config file: '%s'", filename);
2568
2569       for (list = setup_file_list; list != NULL; list = list->next)
2570       {
2571         char *value = getHashEntry(empty_file_hash, list->token);
2572
2573         if (value != NULL)
2574           Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2575       }
2576
2577       Error(ERR_INFO_LINE, "-");
2578     }
2579
2580     freeSetupFileList(setup_file_list);
2581   }
2582
2583   freeSetupFileHash(extra_file_hash);
2584   freeSetupFileHash(empty_file_hash);
2585
2586 #if 0
2587   for (i = 0; i < num_file_list_entries; i++)
2588   {
2589     printf("'%s' ", file_list[i].token);
2590     if (file_list[i].filename)
2591       printf("-> '%s'\n", file_list[i].filename);
2592     else
2593       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2594   }
2595 #endif
2596 }
2597
2598 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2599 {
2600   struct FileInfo *file_list = artwork_info->file_list;
2601   int num_file_list_entries = artwork_info->num_file_list_entries;
2602   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2603   char *filename_base = UNDEFINED_FILENAME, *filename_local;
2604   int i, j;
2605
2606   DrawInitText("Loading artwork config", 120, FC_GREEN);
2607   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2608
2609   /* always start with reliable default values */
2610   for (i = 0; i < num_file_list_entries; i++)
2611   {
2612     setString(&file_list[i].filename, file_list[i].default_filename);
2613
2614     for (j = 0; j < num_suffix_list_entries; j++)
2615       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2616
2617     file_list[i].redefined = FALSE;
2618     file_list[i].fallback_to_default = FALSE;
2619   }
2620
2621   /* free previous dynamic artwork file array */
2622   if (artwork_info->dynamic_file_list != NULL)
2623   {
2624     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2625     {
2626       free(artwork_info->dynamic_file_list[i].token);
2627       free(artwork_info->dynamic_file_list[i].filename);
2628       free(artwork_info->dynamic_file_list[i].parameter);
2629     }
2630
2631     free(artwork_info->dynamic_file_list);
2632     artwork_info->dynamic_file_list = NULL;
2633
2634     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2635                           &artwork_info->num_dynamic_file_list_entries);
2636   }
2637
2638   /* free previous property mapping */
2639   if (artwork_info->property_mapping != NULL)
2640   {
2641     free(artwork_info->property_mapping);
2642
2643     artwork_info->property_mapping = NULL;
2644     artwork_info->num_property_mapping_entries = 0;
2645   }
2646
2647   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2648   {
2649     /* first look for special artwork configured in level series config */
2650     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2651
2652     if (fileExists(filename_base))
2653       LoadArtworkConfigFromFilename(artwork_info, filename_base);
2654   }
2655
2656   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2657
2658   if (filename_local != NULL && !strEqual(filename_base, filename_local))
2659     LoadArtworkConfigFromFilename(artwork_info, filename_local);
2660 }
2661
2662 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2663                                    struct ListNodeInfo **listnode)
2664 {
2665   if (*listnode)
2666   {
2667     char *filename = (*listnode)->source_filename;
2668
2669     if (--(*listnode)->num_references <= 0)
2670       deleteNodeFromList(&artwork_info->content_list, filename,
2671                          artwork_info->free_artwork);
2672
2673     *listnode = NULL;
2674   }
2675 }
2676
2677 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2678                                     struct ListNodeInfo **listnode,
2679                                     struct FileInfo *file_list_entry)
2680 {
2681   char *init_text[] =
2682   {
2683     "Loading graphics",
2684     "Loading sounds",
2685     "Loading music"
2686   };
2687
2688   ListNode *node;
2689   char *basename = file_list_entry->filename;
2690   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2691
2692   if (filename == NULL)
2693   {
2694     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2695
2696     basename = file_list_entry->default_filename;
2697
2698     /* dynamic artwork has no default filename / skip empty default artwork */
2699     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2700       return;
2701
2702     file_list_entry->fallback_to_default = TRUE;
2703
2704     Error(ERR_WARN, "trying default artwork file '%s'", basename);
2705
2706     filename = getCustomArtworkFilename(basename, artwork_info->type);
2707
2708     if (filename == NULL)
2709     {
2710       int error_mode = ERR_WARN;
2711
2712       /* we can get away without sounds and music, but not without graphics */
2713       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2714         error_mode = ERR_EXIT;
2715
2716       Error(error_mode, "cannot find default artwork file '%s'", basename);
2717
2718       return;
2719     }
2720   }
2721
2722   /* check if the old and the new artwork file are the same */
2723   if (*listnode && strEqual((*listnode)->source_filename, filename))
2724   {
2725     /* The old and new artwork are the same (have the same filename and path).
2726        This usually means that this artwork does not exist in this artwork set
2727        and a fallback to the existing artwork is done. */
2728
2729 #if 0
2730     printf("[artwork '%s' already exists (same list entry)]\n", filename);
2731 #endif
2732
2733     return;
2734   }
2735
2736   /* delete existing artwork file entry */
2737   deleteArtworkListEntry(artwork_info, listnode);
2738
2739   /* check if the new artwork file already exists in the list of artworks */
2740   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2741   {
2742 #if 0
2743       printf("[artwork '%s' already exists (other list entry)]\n", filename);
2744 #endif
2745
2746       *listnode = (struct ListNodeInfo *)node->content;
2747       (*listnode)->num_references++;
2748
2749       return;
2750   }
2751
2752   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2753   DrawInitText(basename, 150, FC_YELLOW);
2754
2755   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2756   {
2757 #if 0
2758       printf("[adding new artwork '%s']\n", filename);
2759 #endif
2760
2761     (*listnode)->num_references = 1;
2762     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2763                   *listnode);
2764   }
2765   else
2766   {
2767     int error_mode = ERR_WARN;
2768
2769     /* we can get away without sounds and music, but not without graphics */
2770     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2771       error_mode = ERR_EXIT;
2772
2773     Error(error_mode, "cannot load artwork file '%s'", basename);
2774     return;
2775   }
2776 }
2777
2778 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2779                               struct ListNodeInfo **listnode,
2780                               struct FileInfo *file_list_entry)
2781 {
2782 #if 0
2783   printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2784 #endif
2785
2786   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2787   {
2788     deleteArtworkListEntry(artwork_info, listnode);
2789     return;
2790   }
2791
2792   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2793 }
2794
2795 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2796 {
2797   struct FileInfo *file_list = artwork_info->file_list;
2798   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2799   int num_file_list_entries = artwork_info->num_file_list_entries;
2800   int num_dynamic_file_list_entries =
2801     artwork_info->num_dynamic_file_list_entries;
2802   int i;
2803
2804   for (i = 0; i < num_file_list_entries; i++)
2805     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2806                       &file_list[i]);
2807
2808   for (i = 0; i < num_dynamic_file_list_entries; i++)
2809     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2810                       &dynamic_file_list[i]);
2811
2812 #if 0
2813   dumpList(artwork_info->content_list);
2814 #endif
2815 }
2816
2817 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2818                                   struct ListNodeInfo ***list,
2819                                   int *num_list_entries)
2820 {
2821   int i;
2822
2823   if (*list == NULL)
2824     return;
2825
2826   for (i = 0; i < *num_list_entries; i++)
2827     deleteArtworkListEntry(artwork_info, &(*list)[i]);
2828   free(*list);
2829
2830   *list = NULL;
2831   *num_list_entries = 0;
2832 }
2833
2834 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2835 {
2836   if (artwork_info == NULL)
2837     return;
2838
2839   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2840                         &artwork_info->num_file_list_entries);
2841
2842   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2843                         &artwork_info->num_dynamic_file_list_entries);
2844 }
2845
2846
2847 /* ------------------------------------------------------------------------- */
2848 /* functions only needed for non-Unix (non-command-line) systems             */
2849 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
2850 /* (now also added for Windows, to create files in user data directory)      */
2851 /* ------------------------------------------------------------------------- */
2852
2853 char *getErrorFilename(char *basename)
2854 {
2855   return getPath2(getUserGameDataDir(), basename);
2856 }
2857
2858 void openErrorFile()
2859 {
2860   InitUserDataDirectory();
2861
2862   if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
2863     fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
2864                     program.error_filename);
2865 }
2866
2867 void closeErrorFile()
2868 {
2869   if (program.error_file != stderr)     /* do not close stream 'stderr' */
2870     fclose(program.error_file);
2871 }
2872
2873 void dumpErrorFile()
2874 {
2875   FILE *error_file = fopen(program.error_filename, MODE_READ);
2876
2877   if (error_file != NULL)
2878   {
2879     while (!feof(error_file))
2880       fputc(fgetc(error_file), stderr);
2881
2882     fclose(error_file);
2883   }
2884 }
2885
2886 void NotifyUserAboutErrorFile()
2887 {
2888 #if defined(PLATFORM_WIN32)
2889   char *title_text = getStringCat2(program.program_title, " Error Message");
2890   char *error_text = getStringCat2("The program was aborted due to an error; "
2891                                    "for details, see the following error file:"
2892                                    STRING_NEWLINE, program.error_filename);
2893
2894   MessageBox(NULL, error_text, title_text, MB_OK);
2895 #endif
2896 }
2897
2898
2899 /* ------------------------------------------------------------------------- */
2900 /* the following is only for debugging purpose and normally not used         */
2901 /* ------------------------------------------------------------------------- */
2902
2903 #if DEBUG
2904
2905 #define DEBUG_NUM_TIMESTAMPS            3
2906 #define DEBUG_TIME_IN_MICROSECONDS      0
2907
2908 #if DEBUG_TIME_IN_MICROSECONDS
2909 static double Counter_Microseconds()
2910 {
2911   static struct timeval base_time = { 0, 0 };
2912   struct timeval current_time;
2913   double counter;
2914
2915   gettimeofday(&current_time, NULL);
2916
2917   /* reset base time in case of wrap-around */
2918   if (current_time.tv_sec < base_time.tv_sec)
2919     base_time = current_time;
2920
2921   counter =
2922     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
2923     ((double)(current_time.tv_usec - base_time.tv_usec));
2924
2925   return counter;               /* return microseconds since last init */
2926 }
2927 #endif
2928
2929 void debug_print_timestamp(int counter_nr, char *message)
2930 {
2931 #if DEBUG_TIME_IN_MICROSECONDS
2932   static double counter[DEBUG_NUM_TIMESTAMPS][2];
2933
2934   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2935     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2936
2937   counter[counter_nr][0] = Counter_Microseconds();
2938
2939   if (message)
2940     printf("%s %.3f ms\n", message,
2941            (counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2942
2943   counter[counter_nr][1] = counter[counter_nr][0];
2944 #else
2945   static long counter[DEBUG_NUM_TIMESTAMPS][2];
2946
2947   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
2948     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
2949
2950   counter[counter_nr][0] = Counter();
2951
2952   if (message)
2953     printf("%s %.3f s\n", message,
2954            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
2955
2956   counter[counter_nr][1] = counter[counter_nr][0];
2957 #endif
2958 }
2959
2960 void debug_print_parent_only(char *format, ...)
2961 {
2962   if (!IS_PARENT_PROCESS())
2963     return;
2964
2965   if (format)
2966   {
2967     va_list ap;
2968
2969     va_start(ap, format);
2970     vprintf(format, ap);
2971     va_end(ap);
2972
2973     printf("\n");
2974   }
2975 }
2976 #endif