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