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, ".class"))
1973   {
1974     result = get_hash_from_key(value);
1975   }
1976   else if (strEqual(suffix, ".style"))
1977   {
1978     result = STYLE_DEFAULT;
1979
1980     if (string_has_parameter(value, "accurate_borders"))
1981       result |= STYLE_ACCURATE_BORDERS;
1982
1983     if (string_has_parameter(value, "inner_corners"))
1984       result |= STYLE_INNER_CORNERS;
1985   }
1986   else if (strEqual(suffix, ".fade_mode"))
1987   {
1988     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
1989               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
1990               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
1991               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
1992               FADE_MODE_DEFAULT);
1993   }
1994 #if 1
1995   else if (strPrefix(suffix, ".font"))          /* (may also be ".font_xyz") */
1996 #else
1997   else if (strEqualN(suffix, ".font", 5))       /* (may also be ".font_xyz") */
1998 #endif
1999   {
2000     result = gfx.get_font_from_token_function(value);
2001   }
2002   else          /* generic parameter of type integer or boolean */
2003   {
2004     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2005               type == TYPE_INTEGER ? get_integer_from_string(value) :
2006               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2007               ARG_UNDEFINED_VALUE);
2008   }
2009
2010   free(value);
2011
2012   return result;
2013 }
2014
2015 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2016 {
2017   static struct ScreenModeInfo screen_mode;
2018   char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2019   char *screen_mode_string_copy;
2020   char *screen_mode_string_pos_w;
2021   char *screen_mode_string_pos_h;
2022
2023   if (screen_mode_string_x == NULL)     /* invalid screen mode format */
2024     return NULL;
2025
2026   screen_mode_string_copy = getStringCopy(screen_mode_string);
2027
2028   screen_mode_string_pos_w = screen_mode_string_copy;
2029   screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2030   *screen_mode_string_pos_h++ = '\0';
2031
2032   screen_mode.width  = atoi(screen_mode_string_pos_w);
2033   screen_mode.height = atoi(screen_mode_string_pos_h);
2034
2035   return &screen_mode;
2036 }
2037
2038 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2039                                        int *x, int *y)
2040 {
2041   float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2042   float aspect_ratio_new;
2043   int i = 1;
2044
2045   do
2046   {
2047     *x = i * aspect_ratio + 0.000001;
2048     *y = i;
2049
2050     aspect_ratio_new = (float)*x / (float)*y;
2051
2052     i++;
2053   }
2054   while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2055 }
2056
2057 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2058                                   struct ListNodeInfo ***, int *);
2059
2060 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2061                                            struct ConfigTypeInfo *suffix_list,
2062                                            char **ignore_tokens,
2063                                            int num_file_list_entries)
2064 {
2065   struct FileInfo *file_list;
2066   int num_file_list_entries_found = 0;
2067   int num_suffix_list_entries = 0;
2068   int list_pos;
2069   int i, j;
2070
2071   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2072
2073   for (i = 0; suffix_list[i].token != NULL; i++)
2074     num_suffix_list_entries++;
2075
2076   /* always start with reliable default values */
2077   for (i = 0; i < num_file_list_entries; i++)
2078   {
2079     file_list[i].token = NULL;
2080
2081     file_list[i].default_filename = NULL;
2082     file_list[i].filename = NULL;
2083
2084     if (num_suffix_list_entries > 0)
2085     {
2086       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2087
2088       file_list[i].default_parameter = checked_calloc(parameter_array_size);
2089       file_list[i].parameter = checked_calloc(parameter_array_size);
2090
2091       for (j = 0; j < num_suffix_list_entries; j++)
2092       {
2093         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2094         setString(&file_list[i].parameter[j], suffix_list[j].value);
2095       }
2096
2097       file_list[i].redefined = FALSE;
2098       file_list[i].fallback_to_default = FALSE;
2099       file_list[i].default_is_cloned = FALSE;
2100     }
2101   }
2102
2103   list_pos = 0;
2104   for (i = 0; config_list[i].token != NULL; i++)
2105   {
2106     int len_config_token = strlen(config_list[i].token);
2107     int len_config_value = strlen(config_list[i].value);
2108     boolean is_file_entry = TRUE;
2109
2110     for (j = 0; suffix_list[j].token != NULL; j++)
2111     {
2112       int len_suffix = strlen(suffix_list[j].token);
2113
2114       if (len_suffix < len_config_token &&
2115           strEqual(&config_list[i].token[len_config_token - len_suffix],
2116                    suffix_list[j].token))
2117       {
2118         setString(&file_list[list_pos].default_parameter[j],
2119                   config_list[i].value);
2120
2121         is_file_entry = FALSE;
2122         break;
2123       }
2124     }
2125
2126     /* the following tokens are no file definitions, but other config tokens */
2127     for (j = 0; ignore_tokens[j] != NULL; j++)
2128       if (strEqual(config_list[i].token, ignore_tokens[j]))
2129         is_file_entry = FALSE;
2130
2131     if (is_file_entry)
2132     {
2133       if (i > 0)
2134         list_pos++;
2135
2136       if (list_pos >= num_file_list_entries)
2137         break;
2138
2139       /* simple sanity check if this is really a file definition */
2140       if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2141           !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2142           !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2143       {
2144         Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2145               config_list[i].token, config_list[i].value);
2146         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2147       }
2148
2149       file_list[list_pos].token = config_list[i].token;
2150       file_list[list_pos].default_filename = config_list[i].value;
2151
2152 #if 0
2153       printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2154 #endif
2155     }
2156
2157     if (strSuffix(config_list[i].token, ".clone_from"))
2158       file_list[list_pos].default_is_cloned = TRUE;
2159   }
2160
2161   num_file_list_entries_found = list_pos + 1;
2162   if (num_file_list_entries_found != num_file_list_entries)
2163   {
2164     Error(ERR_INFO_LINE, "-");
2165     Error(ERR_INFO, "inconsistant config list information:");
2166     Error(ERR_INFO, "- should be:   %d (according to 'src/conf_xxx.h')",
2167           num_file_list_entries);
2168     Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2169           num_file_list_entries_found);
2170     Error(ERR_EXIT,   "please fix");
2171   }
2172
2173 #if 0
2174   printf("::: ---------- DONE ----------\n");
2175 #endif
2176
2177   return file_list;
2178 }
2179
2180 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2181 {
2182   int len_token = strlen(token);
2183   int len_suffix = strlen(suffix);
2184
2185   if (start_pos < 0)    /* compare suffix from end of string */
2186     start_pos += len_token;
2187
2188   if (start_pos < 0 || start_pos + len_suffix > len_token)
2189     return FALSE;
2190
2191   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2192     return FALSE;
2193
2194   if (token[start_pos + len_suffix] == '\0')
2195     return TRUE;
2196
2197   if (token[start_pos + len_suffix] == '.')
2198     return TRUE;
2199
2200   return FALSE;
2201 }
2202
2203 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
2204
2205 static void read_token_parameters(SetupFileHash *setup_file_hash,
2206                                   struct ConfigTypeInfo *suffix_list,
2207                                   struct FileInfo *file_list_entry)
2208 {
2209   /* check for config token that is the base token without any suffixes */
2210   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2211   char *known_token_value = KNOWN_TOKEN_VALUE;
2212   int i;
2213
2214   if (filename != NULL)
2215   {
2216     setString(&file_list_entry->filename, filename);
2217
2218     /* when file definition found, set all parameters to default values */
2219     for (i = 0; suffix_list[i].token != NULL; i++)
2220       setString(&file_list_entry->parameter[i], suffix_list[i].value);
2221
2222     file_list_entry->redefined = TRUE;
2223
2224     /* mark config file token as well known from default config */
2225     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2226   }
2227
2228   /* check for config tokens that can be build by base token and suffixes */
2229   for (i = 0; suffix_list[i].token != NULL; i++)
2230   {
2231     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2232     char *value = getHashEntry(setup_file_hash, token);
2233
2234     if (value != NULL)
2235     {
2236       setString(&file_list_entry->parameter[i], value);
2237
2238       /* mark config file token as well known from default config */
2239       setHashEntry(setup_file_hash, token, known_token_value);
2240     }
2241
2242     free(token);
2243   }
2244 }
2245
2246 static void add_dynamic_file_list_entry(struct FileInfo **list,
2247                                         int *num_list_entries,
2248                                         SetupFileHash *extra_file_hash,
2249                                         struct ConfigTypeInfo *suffix_list,
2250                                         int num_suffix_list_entries,
2251                                         char *token)
2252 {
2253   struct FileInfo *new_list_entry;
2254   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2255
2256   (*num_list_entries)++;
2257   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2258   new_list_entry = &(*list)[*num_list_entries - 1];
2259
2260   new_list_entry->token = getStringCopy(token);
2261   new_list_entry->default_filename = NULL;
2262   new_list_entry->filename = NULL;
2263   new_list_entry->parameter = checked_calloc(parameter_array_size);
2264
2265   new_list_entry->redefined = FALSE;
2266   new_list_entry->fallback_to_default = FALSE;
2267   new_list_entry->default_is_cloned = FALSE;
2268
2269   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2270 }
2271
2272 static void add_property_mapping(struct PropertyMapping **list,
2273                                  int *num_list_entries,
2274                                  int base_index, int ext1_index,
2275                                  int ext2_index, int ext3_index,
2276                                  int artwork_index)
2277 {
2278   struct PropertyMapping *new_list_entry;
2279
2280   (*num_list_entries)++;
2281   *list = checked_realloc(*list,
2282                           *num_list_entries * sizeof(struct PropertyMapping));
2283   new_list_entry = &(*list)[*num_list_entries - 1];
2284
2285   new_list_entry->base_index = base_index;
2286   new_list_entry->ext1_index = ext1_index;
2287   new_list_entry->ext2_index = ext2_index;
2288   new_list_entry->ext3_index = ext3_index;
2289
2290   new_list_entry->artwork_index = artwork_index;
2291 }
2292
2293 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2294                                           char *filename)
2295 {
2296   struct FileInfo *file_list = artwork_info->file_list;
2297   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2298   char **base_prefixes = artwork_info->base_prefixes;
2299   char **ext1_suffixes = artwork_info->ext1_suffixes;
2300   char **ext2_suffixes = artwork_info->ext2_suffixes;
2301   char **ext3_suffixes = artwork_info->ext3_suffixes;
2302   char **ignore_tokens = artwork_info->ignore_tokens;
2303   int num_file_list_entries = artwork_info->num_file_list_entries;
2304   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2305   int num_base_prefixes = artwork_info->num_base_prefixes;
2306   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2307   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2308   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2309   int num_ignore_tokens = artwork_info->num_ignore_tokens;
2310   SetupFileHash *setup_file_hash, *valid_file_hash;
2311   SetupFileHash *extra_file_hash, *empty_file_hash;
2312   char *known_token_value = KNOWN_TOKEN_VALUE;
2313   int i, j, k, l;
2314
2315   if (filename == NULL)
2316     return;
2317
2318 #if 0
2319   printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2320 #endif
2321
2322   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2323     return;
2324
2325   /* separate valid (defined) from empty (undefined) config token values */
2326   valid_file_hash = newSetupFileHash();
2327   empty_file_hash = newSetupFileHash();
2328   BEGIN_HASH_ITERATION(setup_file_hash, itr)
2329   {
2330     char *value = HASH_ITERATION_VALUE(itr);
2331
2332     setHashEntry(*value ? valid_file_hash : empty_file_hash,
2333                  HASH_ITERATION_TOKEN(itr), value);
2334   }
2335   END_HASH_ITERATION(setup_file_hash, itr)
2336
2337   /* at this point, we do not need the setup file hash anymore -- free it */
2338   freeSetupFileHash(setup_file_hash);
2339
2340   /* map deprecated to current tokens (using prefix match and replace) */
2341   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2342   {
2343     char *token = HASH_ITERATION_TOKEN(itr);
2344     char *mapped_token = get_mapped_token(token);
2345
2346     if (mapped_token != NULL)
2347     {
2348       char *value = HASH_ITERATION_VALUE(itr);
2349
2350       /* add mapped token */
2351       setHashEntry(valid_file_hash, mapped_token, value);
2352
2353       /* ignore old token (by setting it to "known" keyword) */
2354       setHashEntry(valid_file_hash, token, known_token_value);
2355
2356       free(mapped_token);
2357     }
2358   }
2359   END_HASH_ITERATION(valid_file_hash, itr)
2360
2361   /* read parameters for all known config file tokens */
2362   for (i = 0; i < num_file_list_entries; i++)
2363     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2364
2365   /* set all tokens that can be ignored here to "known" keyword */
2366   for (i = 0; i < num_ignore_tokens; i++)
2367     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2368
2369   /* copy all unknown config file tokens to extra config hash */
2370   extra_file_hash = newSetupFileHash();
2371   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2372   {
2373     char *value = HASH_ITERATION_VALUE(itr);
2374
2375     if (!strEqual(value, known_token_value))
2376       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2377   }
2378   END_HASH_ITERATION(valid_file_hash, itr)
2379
2380   /* at this point, we do not need the valid file hash anymore -- free it */
2381   freeSetupFileHash(valid_file_hash);
2382
2383   /* now try to determine valid, dynamically defined config tokens */
2384
2385   BEGIN_HASH_ITERATION(extra_file_hash, itr)
2386   {
2387     struct FileInfo **dynamic_file_list =
2388       &artwork_info->dynamic_file_list;
2389     int *num_dynamic_file_list_entries =
2390       &artwork_info->num_dynamic_file_list_entries;
2391     struct PropertyMapping **property_mapping =
2392       &artwork_info->property_mapping;
2393     int *num_property_mapping_entries =
2394       &artwork_info->num_property_mapping_entries;
2395     int current_summarized_file_list_entry =
2396       artwork_info->num_file_list_entries +
2397       artwork_info->num_dynamic_file_list_entries;
2398     char *token = HASH_ITERATION_TOKEN(itr);
2399     int len_token = strlen(token);
2400     int start_pos;
2401     boolean base_prefix_found = FALSE;
2402     boolean parameter_suffix_found = FALSE;
2403
2404 #if 0
2405     printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2406 #endif
2407
2408     /* skip all parameter definitions (handled by read_token_parameters()) */
2409     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2410     {
2411       int len_suffix = strlen(suffix_list[i].token);
2412
2413       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2414         parameter_suffix_found = TRUE;
2415     }
2416
2417     if (parameter_suffix_found)
2418       continue;
2419
2420     /* ---------- step 0: search for matching base prefix ---------- */
2421
2422     start_pos = 0;
2423     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2424     {
2425       char *base_prefix = base_prefixes[i];
2426       int len_base_prefix = strlen(base_prefix);
2427       boolean ext1_suffix_found = FALSE;
2428       boolean ext2_suffix_found = FALSE;
2429       boolean ext3_suffix_found = FALSE;
2430       boolean exact_match = FALSE;
2431       int base_index = -1;
2432       int ext1_index = -1;
2433       int ext2_index = -1;
2434       int ext3_index = -1;
2435
2436       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2437
2438       if (!base_prefix_found)
2439         continue;
2440
2441       base_index = i;
2442
2443 #if 0
2444       if (IS_PARENT_PROCESS())
2445         printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2446 #endif
2447
2448       if (start_pos + len_base_prefix == len_token)     /* exact match */
2449       {
2450         exact_match = TRUE;
2451
2452 #if 0
2453         if (IS_PARENT_PROCESS())
2454           printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2455 #endif
2456
2457         add_dynamic_file_list_entry(dynamic_file_list,
2458                                     num_dynamic_file_list_entries,
2459                                     extra_file_hash,
2460                                     suffix_list,
2461                                     num_suffix_list_entries,
2462                                     token);
2463         add_property_mapping(property_mapping,
2464                              num_property_mapping_entries,
2465                              base_index, -1, -1, -1,
2466                              current_summarized_file_list_entry);
2467         continue;
2468       }
2469
2470 #if 0
2471       if (IS_PARENT_PROCESS())
2472         printf("---> examining token '%s': search 1st suffix ...\n", token);
2473 #endif
2474
2475       /* ---------- step 1: search for matching first suffix ---------- */
2476
2477       start_pos += len_base_prefix;
2478       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2479       {
2480         char *ext1_suffix = ext1_suffixes[j];
2481         int len_ext1_suffix = strlen(ext1_suffix);
2482
2483         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2484
2485         if (!ext1_suffix_found)
2486           continue;
2487
2488         ext1_index = j;
2489
2490 #if 0
2491         if (IS_PARENT_PROCESS())
2492           printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2493 #endif
2494
2495         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
2496         {
2497           exact_match = TRUE;
2498
2499 #if 0
2500         if (IS_PARENT_PROCESS())
2501           printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2502 #endif
2503
2504           add_dynamic_file_list_entry(dynamic_file_list,
2505                                       num_dynamic_file_list_entries,
2506                                       extra_file_hash,
2507                                       suffix_list,
2508                                       num_suffix_list_entries,
2509                                       token);
2510           add_property_mapping(property_mapping,
2511                                num_property_mapping_entries,
2512                                base_index, ext1_index, -1, -1,
2513                                current_summarized_file_list_entry);
2514           continue;
2515         }
2516
2517         start_pos += len_ext1_suffix;
2518       }
2519
2520       if (exact_match)
2521         break;
2522
2523 #if 0
2524       if (IS_PARENT_PROCESS())
2525         printf("---> examining token '%s': search 2nd suffix ...\n", token);
2526 #endif
2527
2528       /* ---------- step 2: search for matching second suffix ---------- */
2529
2530       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2531       {
2532         char *ext2_suffix = ext2_suffixes[k];
2533         int len_ext2_suffix = strlen(ext2_suffix);
2534
2535         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2536
2537         if (!ext2_suffix_found)
2538           continue;
2539
2540         ext2_index = k;
2541
2542 #if 0
2543         if (IS_PARENT_PROCESS())
2544           printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2545 #endif
2546
2547         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
2548         {
2549           exact_match = TRUE;
2550
2551 #if 0
2552           if (IS_PARENT_PROCESS())
2553             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2554 #endif
2555
2556           add_dynamic_file_list_entry(dynamic_file_list,
2557                                       num_dynamic_file_list_entries,
2558                                       extra_file_hash,
2559                                       suffix_list,
2560                                       num_suffix_list_entries,
2561                                       token);
2562           add_property_mapping(property_mapping,
2563                                num_property_mapping_entries,
2564                                base_index, ext1_index, ext2_index, -1,
2565                                current_summarized_file_list_entry);
2566           continue;
2567         }
2568
2569         start_pos += len_ext2_suffix;
2570       }
2571
2572       if (exact_match)
2573         break;
2574
2575 #if 0
2576       if (IS_PARENT_PROCESS())
2577         printf("---> examining token '%s': search 3rd suffix ...\n",token);
2578 #endif
2579
2580       /* ---------- step 3: search for matching third suffix ---------- */
2581
2582       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2583       {
2584         char *ext3_suffix = ext3_suffixes[l];
2585         int len_ext3_suffix = strlen(ext3_suffix);
2586
2587         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2588
2589         if (!ext3_suffix_found)
2590           continue;
2591
2592         ext3_index = l;
2593
2594 #if 0
2595         if (IS_PARENT_PROCESS())
2596           printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2597 #endif
2598
2599         if (start_pos + len_ext3_suffix == len_token) /* exact match */
2600         {
2601           exact_match = TRUE;
2602
2603 #if 0
2604           if (IS_PARENT_PROCESS())
2605             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2606 #endif
2607
2608           add_dynamic_file_list_entry(dynamic_file_list,
2609                                       num_dynamic_file_list_entries,
2610                                       extra_file_hash,
2611                                       suffix_list,
2612                                       num_suffix_list_entries,
2613                                       token);
2614           add_property_mapping(property_mapping,
2615                                num_property_mapping_entries,
2616                                base_index, ext1_index, ext2_index, ext3_index,
2617                                current_summarized_file_list_entry);
2618           continue;
2619         }
2620       }
2621     }
2622   }
2623   END_HASH_ITERATION(extra_file_hash, itr)
2624
2625   if (artwork_info->num_dynamic_file_list_entries > 0)
2626   {
2627     artwork_info->dynamic_artwork_list =
2628       checked_calloc(artwork_info->num_dynamic_file_list_entries *
2629                      artwork_info->sizeof_artwork_list_entry);
2630   }
2631
2632   if (options.verbose && IS_PARENT_PROCESS())
2633   {
2634     SetupFileList *setup_file_list, *list;
2635     boolean dynamic_tokens_found = FALSE;
2636     boolean unknown_tokens_found = FALSE;
2637     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
2638
2639     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
2640       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
2641
2642     BEGIN_HASH_ITERATION(extra_file_hash, itr)
2643     {
2644       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
2645         dynamic_tokens_found = TRUE;
2646       else
2647         unknown_tokens_found = TRUE;
2648     }
2649     END_HASH_ITERATION(extra_file_hash, itr)
2650
2651     if (options.debug && dynamic_tokens_found)
2652     {
2653       Error(ERR_INFO_LINE, "-");
2654       Error(ERR_INFO, "dynamic token(s) found in config file:");
2655       Error(ERR_INFO, "- config file: '%s'", filename);
2656
2657       for (list = setup_file_list; list != NULL; list = list->next)
2658       {
2659         char *value = getHashEntry(extra_file_hash, list->token);
2660
2661         if (value != NULL && strEqual(value, known_token_value))
2662           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2663       }
2664
2665       Error(ERR_INFO_LINE, "-");
2666     }
2667
2668     if (unknown_tokens_found)
2669     {
2670       Error(ERR_INFO_LINE, "-");
2671       Error(ERR_INFO, "warning: unknown token(s) found in config file:");
2672       Error(ERR_INFO, "- config file: '%s'", filename);
2673
2674       for (list = setup_file_list; list != NULL; list = list->next)
2675       {
2676         char *value = getHashEntry(extra_file_hash, list->token);
2677
2678         if (value != NULL && !strEqual(value, known_token_value))
2679           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
2680       }
2681
2682       Error(ERR_INFO_LINE, "-");
2683     }
2684
2685     if (undefined_values_found)
2686     {
2687       Error(ERR_INFO_LINE, "-");
2688       Error(ERR_INFO, "warning: undefined values found in config file:");
2689       Error(ERR_INFO, "- config file: '%s'", filename);
2690
2691       for (list = setup_file_list; list != NULL; list = list->next)
2692       {
2693         char *value = getHashEntry(empty_file_hash, list->token);
2694
2695         if (value != NULL)
2696           Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
2697       }
2698
2699       Error(ERR_INFO_LINE, "-");
2700     }
2701
2702     freeSetupFileList(setup_file_list);
2703   }
2704
2705   freeSetupFileHash(extra_file_hash);
2706   freeSetupFileHash(empty_file_hash);
2707
2708 #if 0
2709   for (i = 0; i < num_file_list_entries; i++)
2710   {
2711     printf("'%s' ", file_list[i].token);
2712     if (file_list[i].filename)
2713       printf("-> '%s'\n", file_list[i].filename);
2714     else
2715       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
2716   }
2717 #endif
2718 }
2719
2720 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
2721 {
2722   struct FileInfo *file_list = artwork_info->file_list;
2723   int num_file_list_entries = artwork_info->num_file_list_entries;
2724   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2725   char *filename_base = UNDEFINED_FILENAME, *filename_local;
2726   int i, j;
2727
2728   DrawInitText("Loading artwork config", 120, FC_GREEN);
2729   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
2730
2731   /* always start with reliable default values */
2732   for (i = 0; i < num_file_list_entries; i++)
2733   {
2734     setString(&file_list[i].filename, file_list[i].default_filename);
2735
2736     for (j = 0; j < num_suffix_list_entries; j++)
2737       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
2738
2739     file_list[i].redefined = FALSE;
2740     file_list[i].fallback_to_default = FALSE;
2741   }
2742
2743   /* free previous dynamic artwork file array */
2744   if (artwork_info->dynamic_file_list != NULL)
2745   {
2746     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
2747     {
2748       free(artwork_info->dynamic_file_list[i].token);
2749       free(artwork_info->dynamic_file_list[i].filename);
2750       free(artwork_info->dynamic_file_list[i].parameter);
2751     }
2752
2753     free(artwork_info->dynamic_file_list);
2754     artwork_info->dynamic_file_list = NULL;
2755
2756     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2757                           &artwork_info->num_dynamic_file_list_entries);
2758   }
2759
2760   /* free previous property mapping */
2761   if (artwork_info->property_mapping != NULL)
2762   {
2763     free(artwork_info->property_mapping);
2764
2765     artwork_info->property_mapping = NULL;
2766     artwork_info->num_property_mapping_entries = 0;
2767   }
2768
2769 #if 1
2770   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
2771 #else
2772   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
2773 #endif
2774   {
2775     /* first look for special artwork configured in level series config */
2776     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
2777
2778 #if 0
2779     printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
2780            leveldir_current->graphics_set,
2781            leveldir_current->graphics_path);
2782 #endif
2783
2784     if (fileExists(filename_base))
2785       LoadArtworkConfigFromFilename(artwork_info, filename_base);
2786   }
2787
2788   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
2789
2790   if (filename_local != NULL && !strEqual(filename_base, filename_local))
2791     LoadArtworkConfigFromFilename(artwork_info, filename_local);
2792 }
2793
2794 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
2795                                    struct ListNodeInfo **listnode)
2796 {
2797   if (*listnode)
2798   {
2799     char *filename = (*listnode)->source_filename;
2800
2801     if (--(*listnode)->num_references <= 0)
2802       deleteNodeFromList(&artwork_info->content_list, filename,
2803                          artwork_info->free_artwork);
2804
2805     *listnode = NULL;
2806   }
2807 }
2808
2809 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
2810                                     struct ListNodeInfo **listnode,
2811                                     struct FileInfo *file_list_entry)
2812 {
2813   char *init_text[] =
2814   {
2815     "Loading graphics",
2816     "Loading sounds",
2817     "Loading music"
2818   };
2819
2820   ListNode *node;
2821   char *basename = file_list_entry->filename;
2822   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
2823
2824   if (filename == NULL)
2825   {
2826     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
2827
2828     basename = file_list_entry->default_filename;
2829
2830     /* fail for cloned default artwork that has no default filename defined */
2831     if (file_list_entry->default_is_cloned &&
2832         strEqual(basename, UNDEFINED_FILENAME))
2833     {
2834       int error_mode = ERR_WARN;
2835
2836       /* we can get away without sounds and music, but not without graphics */
2837       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2838         error_mode = ERR_EXIT;
2839
2840       Error(error_mode, "token '%s' was cloned and has no default filename",
2841             file_list_entry->token);
2842
2843       return;
2844     }
2845
2846     /* dynamic artwork has no default filename / skip empty default artwork */
2847     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
2848       return;
2849
2850     file_list_entry->fallback_to_default = TRUE;
2851
2852     Error(ERR_WARN, "trying default artwork file '%s'", basename);
2853
2854     filename = getCustomArtworkFilename(basename, artwork_info->type);
2855
2856     if (filename == NULL)
2857     {
2858       int error_mode = ERR_WARN;
2859
2860       /* we can get away without sounds and music, but not without graphics */
2861       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2862         error_mode = ERR_EXIT;
2863
2864       Error(error_mode, "cannot find default artwork file '%s'", basename);
2865
2866       return;
2867     }
2868   }
2869
2870   /* check if the old and the new artwork file are the same */
2871   if (*listnode && strEqual((*listnode)->source_filename, filename))
2872   {
2873     /* The old and new artwork are the same (have the same filename and path).
2874        This usually means that this artwork does not exist in this artwork set
2875        and a fallback to the existing artwork is done. */
2876
2877 #if 0
2878     printf("[artwork '%s' already exists (same list entry)]\n", filename);
2879 #endif
2880
2881     return;
2882   }
2883
2884   /* delete existing artwork file entry */
2885   deleteArtworkListEntry(artwork_info, listnode);
2886
2887   /* check if the new artwork file already exists in the list of artworks */
2888   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
2889   {
2890 #if 0
2891       printf("[artwork '%s' already exists (other list entry)]\n", filename);
2892 #endif
2893
2894       *listnode = (struct ListNodeInfo *)node->content;
2895       (*listnode)->num_references++;
2896
2897       return;
2898   }
2899
2900   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
2901   DrawInitText(basename, 150, FC_YELLOW);
2902
2903   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
2904   {
2905 #if 0
2906       printf("[adding new artwork '%s']\n", filename);
2907 #endif
2908
2909     (*listnode)->num_references = 1;
2910     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
2911                   *listnode);
2912   }
2913   else
2914   {
2915     int error_mode = ERR_WARN;
2916
2917     /* we can get away without sounds and music, but not without graphics */
2918     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
2919       error_mode = ERR_EXIT;
2920
2921     Error(error_mode, "cannot load artwork file '%s'", basename);
2922
2923     return;
2924   }
2925 }
2926
2927 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
2928                               struct ListNodeInfo **listnode,
2929                               struct FileInfo *file_list_entry)
2930 {
2931 #if 0
2932   printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
2933 #endif
2934
2935   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
2936   {
2937     deleteArtworkListEntry(artwork_info, listnode);
2938     return;
2939   }
2940
2941   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
2942 }
2943
2944 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
2945 {
2946   struct FileInfo *file_list = artwork_info->file_list;
2947   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
2948   int num_file_list_entries = artwork_info->num_file_list_entries;
2949   int num_dynamic_file_list_entries =
2950     artwork_info->num_dynamic_file_list_entries;
2951   int i;
2952
2953   for (i = 0; i < num_file_list_entries; i++)
2954     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
2955                       &file_list[i]);
2956
2957   for (i = 0; i < num_dynamic_file_list_entries; i++)
2958     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
2959                       &dynamic_file_list[i]);
2960
2961 #if 0
2962   dumpList(artwork_info->content_list);
2963 #endif
2964 }
2965
2966 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
2967                                   struct ListNodeInfo ***list,
2968                                   int *num_list_entries)
2969 {
2970   int i;
2971
2972   if (*list == NULL)
2973     return;
2974
2975   for (i = 0; i < *num_list_entries; i++)
2976     deleteArtworkListEntry(artwork_info, &(*list)[i]);
2977   free(*list);
2978
2979   *list = NULL;
2980   *num_list_entries = 0;
2981 }
2982
2983 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
2984 {
2985   if (artwork_info == NULL)
2986     return;
2987
2988   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
2989                         &artwork_info->num_file_list_entries);
2990
2991   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
2992                         &artwork_info->num_dynamic_file_list_entries);
2993 }
2994
2995
2996 /* ------------------------------------------------------------------------- */
2997 /* functions only needed for non-Unix (non-command-line) systems             */
2998 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
2999 /* (now also added for Windows, to create files in user data directory)      */
3000 /* ------------------------------------------------------------------------- */
3001
3002 char *getErrorFilename(char *basename)
3003 {
3004   return getPath2(getUserGameDataDir(), basename);
3005 }
3006
3007 void openErrorFile()
3008 {
3009   InitUserDataDirectory();
3010
3011   if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3012     fprintf_newline(stderr, "ERROR: cannot open file '%s' for writing!",
3013                     program.error_filename);
3014 }
3015
3016 void closeErrorFile()
3017 {
3018   if (program.error_file != stderr)     /* do not close stream 'stderr' */
3019     fclose(program.error_file);
3020 }
3021
3022 void dumpErrorFile()
3023 {
3024   FILE *error_file = fopen(program.error_filename, MODE_READ);
3025
3026   if (error_file != NULL)
3027   {
3028     while (!feof(error_file))
3029       fputc(fgetc(error_file), stderr);
3030
3031     fclose(error_file);
3032   }
3033 }
3034
3035 void NotifyUserAboutErrorFile()
3036 {
3037 #if defined(PLATFORM_WIN32)
3038   char *title_text = getStringCat2(program.program_title, " Error Message");
3039   char *error_text = getStringCat2("The program was aborted due to an error; "
3040                                    "for details, see the following error file:"
3041                                    STRING_NEWLINE, program.error_filename);
3042
3043   MessageBox(NULL, error_text, title_text, MB_OK);
3044 #endif
3045 }
3046
3047
3048 /* ------------------------------------------------------------------------- */
3049 /* the following is only for debugging purpose and normally not used         */
3050 /* ------------------------------------------------------------------------- */
3051
3052 #if DEBUG
3053
3054 #define DEBUG_NUM_TIMESTAMPS            5
3055 #define DEBUG_TIME_IN_MICROSECONDS      0
3056
3057 #if DEBUG_TIME_IN_MICROSECONDS
3058 static double Counter_Microseconds()
3059 {
3060   static struct timeval base_time = { 0, 0 };
3061   struct timeval current_time;
3062   double counter;
3063
3064   gettimeofday(&current_time, NULL);
3065
3066   /* reset base time in case of wrap-around */
3067   if (current_time.tv_sec < base_time.tv_sec)
3068     base_time = current_time;
3069
3070   counter =
3071     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
3072     ((double)(current_time.tv_usec - base_time.tv_usec));
3073
3074   return counter;               /* return microseconds since last init */
3075 }
3076 #endif
3077
3078 char *debug_print_timestamp_get_padding(int padding_size)
3079 {
3080   static char *padding = NULL;
3081   int max_padding_size = 100;
3082
3083   if (padding == NULL)
3084   {
3085     padding = checked_calloc(max_padding_size + 1);
3086     memset(padding, ' ', max_padding_size);
3087   }
3088
3089   return &padding[MAX(0, max_padding_size - padding_size)];
3090 }
3091
3092 void debug_print_timestamp(int counter_nr, char *message)
3093 {
3094   int indent_size = 8;
3095   int padding_size = 40;
3096   float timestamp_interval;
3097
3098   if (counter_nr < 0)
3099     Error(ERR_EXIT, "debugging: invalid negative counter");
3100   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3101     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3102
3103 #if DEBUG_TIME_IN_MICROSECONDS
3104   static double counter[DEBUG_NUM_TIMESTAMPS][2];
3105   char *unit = "ms";
3106
3107   counter[counter_nr][0] = Counter_Microseconds();
3108 #else
3109   static long counter[DEBUG_NUM_TIMESTAMPS][2];
3110   char *unit = "s";
3111
3112   counter[counter_nr][0] = Counter();
3113 #endif
3114
3115   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3116   counter[counter_nr][1] = counter[counter_nr][0];
3117
3118   if (message)
3119     printf("%s%s%s %.3f %s\n",
3120            debug_print_timestamp_get_padding(counter_nr * indent_size),
3121            message,
3122            debug_print_timestamp_get_padding(padding_size - strlen(message)),
3123            timestamp_interval / 1000,
3124            unit);
3125 }
3126
3127 void debug_print_parent_only(char *format, ...)
3128 {
3129   if (!IS_PARENT_PROCESS())
3130     return;
3131
3132   if (format)
3133   {
3134     va_list ap;
3135
3136     va_start(ap, format);
3137     vprintf(format, ap);
3138     va_end(ap);
3139
3140     printf("\n");
3141   }
3142 }
3143 #endif