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