src/libgame/misc.c

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  https://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // misc.c
  10 // ============================================================================
  11
  12 #include <time.h>
  13 #include <sys/time.h>
  14 #include <sys/types.h>
  15 #include <sys/stat.h>
  16 #include <stdarg.h>
  17 #include <ctype.h>
  18 #include <string.h>
  19 #include <unistd.h>
  20 #include <errno.h>
  21
  22 #include "platform.h"
  23
  24 #if defined(PLATFORM_UNIX)
  25 #include <pwd.h>
  26 #include <sys/param.h>
  27 #endif
  28
  29 #include "misc.h"
  30 #include "setup.h"
  31 #include "random.h"
  32 #include "text.h"
  33 #include "image.h"
  34
  35
  36 // ============================================================================
  37 // some generic helper functions
  38 // ============================================================================
  39
  40 // ----------------------------------------------------------------------------
  41 // logging functions
  42 // ----------------------------------------------------------------------------
  43
  44 #define DUPLICATE_LOG_OUT_TO_STDOUT             TRUE
  45 #define DUPLICATE_LOG_ERR_TO_STDERR             TRUE
  46
  47
  48 #if defined(PLATFORM_ANDROID)
  49 static int android_log_prio = ANDROID_LOG_INFO;
  50 static char *android_log_buffer = NULL;
  51
  52 static void append_to_android_log_buffer(char *format, va_list ap)
  53 {
  54   char text_new[MAX_OUTPUT_LINESIZE];
  55
  56   // print text to temporary string
  57   vsnprintf(text_new, MAX_OUTPUT_LINESIZE, format, ap);
  58
  59   if (android_log_buffer == NULL)
  60   {
  61     android_log_buffer = getStringCopy(text_new);
  62   }
  63   else
  64   {
  65     char *android_log_buffer_old = android_log_buffer;
  66
  67     // append new text to existing text
  68     android_log_buffer = getStringCat2(android_log_buffer, text_new);
  69
  70     checked_free(android_log_buffer_old);
  71   }
  72 }
  73
  74 static void vprintf_log_nonewline(char *format, va_list ap)
  75 {
  76   // add log output to buffer until text with newline is printed
  77   append_to_android_log_buffer(format, ap);
  78 }
  79
  80 static void vprintf_log(char *format, va_list ap)
  81 {
  82   // add log output to buffer
  83   append_to_android_log_buffer(format, ap);
  84
  85   // __android_log_vprint(android_log_prio, program.program_title, format, ap);
  86   __android_log_write(android_log_prio, program.program_title,
  87                       android_log_buffer);
  88
  89   checked_free(android_log_buffer);
  90   android_log_buffer = NULL;
  91 }
  92
  93 #else
  94
  95 static void vprintf_log_nonewline(char *format, va_list ap)
  96 {
  97   FILE *file = program.log_file[LOG_ERR_ID];
  98
  99 #if DUPLICATE_LOG_ERR_TO_STDERR
 100   if (file != program.log_file_default[LOG_ERR_ID])
 101   {
 102     va_list ap2;
 103     va_copy(ap2, ap);
 104
 105     vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
 106
 107     va_end(ap2);
 108   }
 109 #endif
 110
 111   vfprintf(file, format, ap);
 112 }
 113
 114 static void vprintf_log(char *format, va_list ap)
 115 {
 116   FILE *file = program.log_file[LOG_ERR_ID];
 117   char *newline = STRING_NEWLINE;
 118
 119 #if DUPLICATE_LOG_ERR_TO_STDERR
 120   if (file != program.log_file_default[LOG_ERR_ID])
 121   {
 122     va_list ap2;
 123     va_copy(ap2, ap);
 124
 125     vfprintf(program.log_file_default[LOG_ERR_ID], format, ap2);
 126     fprintf(program.log_file_default[LOG_ERR_ID], "%s", newline);
 127
 128     va_end(ap2);
 129   }
 130 #endif
 131
 132   vfprintf(file, format, ap);
 133   fprintf(file, "%s", newline);
 134 }
 135 #endif
 136
 137 static void printf_log_nonewline(char *format, ...)
 138 {
 139   va_list ap;
 140
 141   va_start(ap, format);
 142   vprintf_log_nonewline(format, ap);
 143   va_end(ap);
 144 }
 145
 146 static void printf_log(char *format, ...)
 147 {
 148   va_list ap;
 149
 150   va_start(ap, format);
 151   vprintf_log(format, ap);
 152   va_end(ap);
 153 }
 154
 155 static void printf_log_line(char *line_chars, int line_length)
 156 {
 157   int i;
 158
 159   for (i = 0; i < line_length; i++)
 160     printf_log_nonewline("%s", line_chars);
 161
 162   printf_log("");
 163 }
 164
 165
 166 // ----------------------------------------------------------------------------
 167 // platform independent wrappers for printf() et al.
 168 // ----------------------------------------------------------------------------
 169
 170 void fprintf_line(FILE *file, char *line_chars, int line_length)
 171 {
 172   int i;
 173
 174   for (i = 0; i < line_length; i++)
 175     fprintf(file, "%s", line_chars);
 176
 177   fprintf(file, "\n");
 178 }
 179
 180 void fprintf_line_with_prefix(FILE *file, char *prefix, char *line_chars,
 181                               int line_length)
 182 {
 183   fprintf(file, "%s", prefix);
 184   fprintf_line(file, line_chars, line_length);
 185 }
 186
 187 void printf_line(char *line_chars, int line_length)
 188 {
 189   fprintf_line(stdout, line_chars, line_length);
 190 }
 191
 192 void printf_line_with_prefix(char *prefix, char *line_chars, int line_length)
 193 {
 194   fprintf_line_with_prefix(stdout, prefix, line_chars, line_length);
 195 }
 196
 197 static void vPrint(char *format, va_list ap)
 198 {
 199   FILE *file = program.log_file[LOG_OUT_ID];
 200
 201 #if DUPLICATE_LOG_OUT_TO_STDOUT
 202   if (file != program.log_file_default[LOG_OUT_ID])
 203   {
 204     va_list ap2;
 205     va_copy(ap2, ap);
 206
 207     vfprintf(program.log_file_default[LOG_OUT_ID], format, ap2);
 208
 209     va_end(ap2);
 210   }
 211 #endif
 212
 213   vfprintf(file, format, ap);
 214 }
 215
 216 void Print(char *format, ...)
 217 {
 218   va_list ap;
 219
 220   va_start(ap, format);
 221   vPrint(format, ap);
 222   va_end(ap);
 223 }
 224
 225 void PrintNoLog(char *format, ...)
 226 {
 227   FILE *file = program.log_file_default[LOG_OUT_ID];
 228   va_list ap;
 229
 230   va_start(ap, format);
 231   vfprintf(file, format, ap);
 232   va_end(ap);
 233
 234   fflush(file);
 235 }
 236
 237 void PrintLine(char *line_chars, int line_length)
 238 {
 239   int i;
 240
 241   for (i = 0; i < line_length; i++)
 242     Print(line_chars);
 243
 244   Print("\n");
 245 }
 246
 247 void PrintLineWithPrefix(char *prefix, char *line_chars, int line_length)
 248 {
 249   Print(prefix);
 250   PrintLine(line_chars, line_length);
 251 }
 252
 253
 254 // ----------------------------------------------------------------------------
 255 // generic logging and error handling functions
 256 // ----------------------------------------------------------------------------
 257
 258 enum log_levels
 259 {
 260   LOG_UNKNOWN = 0,
 261   LOG_DEBUG,
 262   LOG_INFO,
 263   LOG_WARN,
 264   LOG_ERROR,
 265   LOG_FATAL
 266 };
 267
 268 static char *log_tokens[] =
 269 {
 270   "UNKNOWN",
 271   "DEBUG",
 272   "INFO",
 273   "WARN",
 274   "ERROR",
 275   "FATAL"
 276 };
 277
 278 static void printf_log_prefix(int log_level, char *mode)
 279 {
 280   if (log_level < 0 || log_level > LOG_FATAL)
 281     return;
 282
 283   char *log_token = log_tokens[log_level];
 284
 285   if (log_level == LOG_DEBUG)
 286     printf_log_nonewline("[%s] [%s] ", log_token, mode);
 287   else
 288     printf_log_nonewline("[%s] ", log_token);
 289 }
 290
 291 static void vLog(int log_level, char *mode, char *format, va_list ap)
 292 {
 293   if (log_level < 0 || log_level > LOG_FATAL)
 294     return;
 295
 296   if (log_level == LOG_DEBUG)
 297   {
 298     // only show debug messages when in debug mode
 299     if (!options.debug)
 300       return;
 301
 302     // if optional debug mode specified, limit debug output accordingly
 303     if (options.debug_mode != NULL &&
 304         strstr(mode, options.debug_mode) == NULL)
 305       return;
 306   }
 307   else if (log_level == LOG_WARN)
 308   {
 309     // only show warning messages when in verbose mode
 310     if (!options.verbose)
 311       return;
 312   }
 313
 314 #if defined(PLATFORM_ANDROID)
 315   android_log_prio = (log_level == LOG_DEBUG ? ANDROID_LOG_DEBUG :
 316                       log_level == LOG_INFO  ? ANDROID_LOG_INFO :
 317                       log_level == LOG_WARN  ? ANDROID_LOG_WARN :
 318                       log_level == LOG_ERROR ? ANDROID_LOG_ERROR :
 319                       log_level == LOG_FATAL ? ANDROID_LOG_FATAL :
 320                       ANDROID_LOG_UNKNOWN);
 321 #endif
 322
 323   static boolean last_line_was_separator = FALSE;
 324   char *log_token = log_tokens[log_level];
 325
 326   if (strEqual(format, "===") ||
 327       strEqual(format, "---"))
 328   {
 329     static char *mode_last = NULL;
 330     char line_char[2] = { format[0], '\0' };
 331     int line_length = 80 - strlen(log_token) - 3;
 332
 333     if (log_level == LOG_DEBUG)
 334       line_length -= strlen(mode) + 3;
 335
 336     if (last_line_was_separator && strEqual(mode, mode_last))
 337       return;
 338
 339     printf_log_prefix(log_level, mode);
 340     printf_log_line(line_char, line_length);
 341
 342     if (!strEqual(mode, mode_last))
 343       setString(&mode_last, mode);
 344
 345     last_line_was_separator = TRUE;
 346
 347     return;
 348   }
 349
 350   last_line_was_separator = FALSE;
 351
 352   printf_log_prefix(log_level, mode);
 353
 354   vprintf_log(format, ap);
 355 }
 356
 357 static void Log(int log_level, char *mode, char *format, ...)
 358 {
 359   va_list ap;
 360
 361   va_start(ap, format);
 362   vLog(log_level, mode, format, ap);
 363   va_end(ap);
 364 }
 365
 366 void DebugContinued(char *mode, char *format, ...)
 367 {
 368   static char message[MAX_LINE_LEN] = { 0 };
 369
 370   // initialize message (optional)
 371   if (strEqual(format, ""))
 372   {
 373     message[0] = '\0';
 374
 375     return;
 376   }
 377
 378   char *message_ptr = message + strlen(message);
 379   int size_left = MAX_LINE_LEN - strlen(message);
 380   va_list ap;
 381
 382   // append message
 383   va_start(ap, format);
 384   vsnprintf(message_ptr, size_left, format, ap);
 385   va_end(ap);
 386
 387   // finalize message
 388   if (strSuffix(format, "\n"))
 389   {
 390     message[strlen(message) - 1] = '\0';
 391
 392     Debug(mode, message);
 393
 394     message[0] = '\0';
 395   }
 396 }
 397
 398 void Debug(char *mode, char *format, ...)
 399 {
 400   va_list ap;
 401
 402   va_start(ap, format);
 403   vLog(LOG_DEBUG, mode, format, ap);
 404   va_end(ap);
 405 }
 406
 407 void Info(char *format, ...)
 408 {
 409   va_list ap;
 410
 411   va_start(ap, format);
 412   vLog(LOG_INFO, NULL, format, ap);
 413   va_end(ap);
 414 }
 415
 416 void Warn(char *format, ...)
 417 {
 418   va_list ap;
 419
 420   va_start(ap, format);
 421   vLog(LOG_WARN, NULL, format, ap);
 422   va_end(ap);
 423 }
 424
 425 void Error(char *format, ...)
 426 {
 427   va_list ap;
 428
 429   va_start(ap, format);
 430   vLog(LOG_ERROR, NULL, format, ap);
 431   va_end(ap);
 432 }
 433
 434 void Fail(char *format, ...)
 435 {
 436   va_list ap;
 437
 438   va_start(ap, format);
 439   vLog(LOG_FATAL, NULL, format, ap);
 440   va_end(ap);
 441
 442   if (!network.is_server_thread)
 443   {
 444     va_start(ap, format);
 445     program.exit_message_function(format, ap);
 446     va_end(ap);
 447   }
 448
 449   Log(LOG_FATAL, NULL, "aborting");
 450
 451   // network server thread: normal exit
 452   if (network.is_server_thread)
 453     exit(1);
 454
 455   // main process: clean up stuff
 456   program.exit_function(1);
 457 }
 458
 459 void FailWithHelp(char *format, ...)
 460 {
 461   va_list ap;
 462
 463   va_start(ap, format);
 464   vLog(LOG_FATAL, NULL, format, ap);
 465   va_end(ap);
 466
 467   Log(LOG_FATAL, NULL, "try option '--help' for more information");
 468   Log(LOG_FATAL, NULL, "aborting");
 469
 470   // main process: clean up stuff
 471   program.exit_function(1);
 472 }
 473
 474
 475 // ----------------------------------------------------------------------------
 476 // string functions
 477 // ----------------------------------------------------------------------------
 478
 479 /* int2str() returns a number converted to a string;
 480    the used memory is static, but will be overwritten by later calls,
 481    so if you want to save the result, copy it to a private string buffer;
 482    there can be 10 local calls of int2str() without buffering the result --
 483    the 11th call will then destroy the result from the first call and so on. */
 484
 485 char *int2str(int number, int size)
 486 {
 487   static char shift_array[10][40];
 488   static int shift_counter = 0;
 489   char *s = shift_array[shift_counter];
 490
 491   shift_counter = (shift_counter + 1) % 10;
 492
 493   if (size > 20)
 494     size = 20;
 495
 496   if (size > 0)
 497   {
 498     sprintf(s, "                    %09d", number);
 499     return &s[strlen(s) - size];
 500   }
 501   else
 502   {
 503     sprintf(s, "%d", number);
 504     return s;
 505   }
 506 }
 507
 508
 509 // something similar to "int2str()" above, but allocates its own memory
 510 // and has a different interface; we cannot use "itoa()", because this
 511 // seems to be already defined when cross-compiling to the win32 target
 512
 513 char *i_to_a(unsigned int i)
 514 {
 515   static char *a = NULL;
 516
 517   checked_free(a);
 518
 519   if (i > 2147483647)   // yes, this is a kludge
 520     i = 2147483647;
 521
 522   a = checked_malloc(10 + 1);
 523
 524   sprintf(a, "%d", i);
 525
 526   return a;
 527 }
 528
 529
 530 // calculate base-2 logarithm of argument (rounded down to integer;
 531 // this function returns the number of the highest bit set in argument)
 532
 533 int log_2(unsigned int x)
 534 {
 535   int e = 0;
 536
 537   while ((1 << e) < x)
 538   {
 539     x -= (1 << e);      // for rounding down (rounding up: remove this line)
 540     e++;
 541   }
 542
 543   return e;
 544 }
 545
 546 boolean getTokenValueFromString(char *string, char **token, char **value)
 547 {
 548   return getTokenValueFromSetupLine(string, token, value);
 549 }
 550
 551
 552 // ----------------------------------------------------------------------------
 553 // counter functions
 554 // ----------------------------------------------------------------------------
 555
 556 // maximal allowed length of a command line option
 557 #define MAX_OPTION_LEN          256
 558
 559 static unsigned int getCurrentMS(void)
 560 {
 561   return SDL_GetTicks();
 562 }
 563
 564 static unsigned int mainCounter(int mode)
 565 {
 566   static unsigned int base_ms = 0;
 567   unsigned int current_ms;
 568
 569   // get current system milliseconds
 570   current_ms = getCurrentMS();
 571
 572   // reset base timestamp in case of counter reset or wrap-around
 573   if (mode == INIT_COUNTER || current_ms < base_ms)
 574     base_ms = current_ms;
 575
 576   // return milliseconds since last counter reset
 577   return current_ms - base_ms;
 578 }
 579
 580 void InitCounter()              // set counter back to zero
 581 {
 582   mainCounter(INIT_COUNTER);
 583 }
 584
 585 unsigned int Counter()  // get milliseconds since last call of InitCounter()
 586 {
 587   return mainCounter(READ_COUNTER);
 588 }
 589
 590 static void sleep_milliseconds(unsigned int milliseconds_delay)
 591 {
 592   SDL_Delay(milliseconds_delay);
 593 }
 594
 595 void Delay(unsigned int delay)  // Sleep specified number of milliseconds
 596 {
 597   sleep_milliseconds(delay);
 598 }
 599
 600 boolean DelayReachedExt(unsigned int *counter_var, unsigned int delay,
 601                         unsigned int actual_counter)
 602 {
 603   if (actual_counter >= *counter_var &&
 604       actual_counter < *counter_var + delay)
 605     return FALSE;
 606
 607   *counter_var = actual_counter;
 608
 609   return TRUE;
 610 }
 611
 612 boolean FrameReached(unsigned int *frame_counter_var, unsigned int frame_delay)
 613 {
 614   return DelayReachedExt(frame_counter_var, frame_delay, FrameCounter);
 615 }
 616
 617 boolean DelayReached(unsigned int *counter_var, unsigned int delay)
 618 {
 619   return DelayReachedExt(counter_var, delay, Counter());
 620 }
 621
 622 void ResetDelayCounterExt(unsigned int *counter_var,
 623                           unsigned int actual_counter)
 624 {
 625   DelayReachedExt(counter_var, 0, actual_counter);
 626 }
 627
 628 void ResetFrameCounter(unsigned int *frame_counter_var)
 629 {
 630   FrameReached(frame_counter_var, 0);
 631 }
 632
 633 void ResetDelayCounter(unsigned int *counter_var)
 634 {
 635   DelayReached(counter_var, 0);
 636 }
 637
 638 int WaitUntilDelayReached(unsigned int *counter_var, unsigned int delay)
 639 {
 640   unsigned int actual_counter;
 641   int skip_frames = 0;
 642
 643   while (1)
 644   {
 645     actual_counter = Counter();
 646
 647     if (actual_counter >= *counter_var &&
 648         actual_counter < *counter_var + delay)
 649       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 650     else
 651       break;
 652   }
 653
 654   if (*counter_var != 0 &&
 655       delay != 0 &&
 656       actual_counter >= *counter_var + delay)
 657   {
 658     int lag = actual_counter - (*counter_var + delay);
 659     int delay2 = (delay + 1) / 2;
 660
 661     if (lag >= delay2)
 662       skip_frames = (lag + delay2) / delay;
 663   }
 664
 665   *counter_var = actual_counter;
 666
 667   return skip_frames;
 668 }
 669
 670 void SkipUntilDelayReached(unsigned int *counter_var, unsigned int delay,
 671                            int *loop_var, int last_loop_value)
 672 {
 673   int skip_frames = WaitUntilDelayReached(counter_var, delay);
 674
 675 #if 0
 676 #if DEBUG
 677   if (skip_frames)
 678     Debug("internal:SkipUntilDelayReached",
 679           "%d: %d ms -> SKIP %d FRAME(S) [%d ms]",
 680           *loop_var, delay,
 681           skip_frames, skip_frames * delay);
 682   else
 683     Debug("internal:SkipUntilDelayReached",
 684           "%d: %d ms",
 685           *loop_var, delay);
 686 #endif
 687 #endif
 688
 689   if (skip_frames == 0)
 690     return;
 691
 692   // when skipping frames, make sure to never skip the last frame, as
 693   // this may be needed for animations to reach a defined end state;
 694   // furthermore, we assume that this function is called at the end
 695   // of a "for" loop, which continues by incrementing the loop variable
 696   // by one before checking the loop condition again; therefore we have
 697   // to check against the last loop value minus one here
 698
 699   last_loop_value--;
 700
 701   if (*loop_var < last_loop_value)      // never skip the last frame
 702   {
 703     *loop_var += skip_frames;
 704
 705     if (*loop_var > last_loop_value)    // never skip the last frame
 706       *loop_var = last_loop_value;
 707   }
 708 }
 709
 710
 711 // ----------------------------------------------------------------------------
 712 // random generator functions
 713 // ----------------------------------------------------------------------------
 714
 715 unsigned int init_random_number(int nr, int seed)
 716 {
 717   if (seed == NEW_RANDOMIZE)
 718   {
 719     // default random seed
 720     seed = (int)time(NULL);                     // seconds since the epoch
 721
 722 #if !defined(PLATFORM_WIN32)
 723     // add some more randomness
 724     struct timeval current_time;
 725
 726     gettimeofday(&current_time, NULL);
 727
 728     seed += (int)current_time.tv_usec;          // microseconds since the epoch
 729 #endif
 730
 731     // add some more randomness
 732     seed += (int)SDL_GetTicks();                // milliseconds since SDL init
 733
 734     // add some more randomness
 735     seed += GetSimpleRandom(1000000);
 736   }
 737
 738   srandom_linux_libc(nr, (unsigned int) seed);
 739
 740   return (unsigned int) seed;
 741 }
 742
 743 unsigned int get_random_number(int nr, int max)
 744 {
 745   return (max > 0 ? random_linux_libc(nr) % max : 0);
 746 }
 747
 748
 749 // ----------------------------------------------------------------------------
 750 // system info functions
 751 // ----------------------------------------------------------------------------
 752
 753 #if !defined(PLATFORM_ANDROID)
 754 static char *get_corrected_real_name(char *real_name)
 755 {
 756   char *real_name_new = checked_malloc(MAX_USERNAME_LEN + 1);
 757   char *from_ptr = real_name;
 758   char *to_ptr   = real_name_new;
 759
 760   // copy the name string, but not more than MAX_USERNAME_LEN characters
 761   while (*from_ptr && (int)(to_ptr - real_name_new) < MAX_USERNAME_LEN - 1)
 762   {
 763     // the name field read from "passwd" file may also contain additional
 764     // user information, separated by commas, which will be removed here
 765     if (*from_ptr == ',')
 766       break;
 767
 768     // the user's real name may contain 'german sharp s' characters,
 769     // which have no equivalent in upper case letters (used by our fonts)
 770     if (*from_ptr == CHAR_BYTE_SHARP_S)
 771     {
 772       from_ptr++;
 773       *to_ptr++ = 's';
 774       *to_ptr++ = 's';
 775     }
 776     else
 777       *to_ptr++ = *from_ptr++;
 778   }
 779
 780   *to_ptr = '\0';
 781
 782   return real_name_new;
 783 }
 784 #endif
 785
 786 #if defined(PLATFORM_UNIX)
 787 static struct passwd *getPasswdEntry(void)
 788 {
 789 #if defined(PLATFORM_EMSCRIPTEN)
 790   // currently not fully supported; force fallback to default values
 791   return NULL;
 792 #else
 793   return getpwuid(getuid());
 794 #endif
 795 }
 796
 797 char *getUnixLoginName(void)
 798 {
 799   struct passwd *pwd = getPasswdEntry();
 800
 801   if (pwd != NULL && strlen(pwd->pw_name) != 0)
 802     return pwd->pw_name;
 803
 804   return NULL;
 805 }
 806
 807 char *getUnixRealName(void)
 808 {
 809   struct passwd *pwd = getPasswdEntry();
 810
 811   if (pwd != NULL && strlen(pwd->pw_gecos) != 0)
 812     return pwd->pw_gecos;
 813
 814   return NULL;
 815 }
 816
 817 char *getUnixHomeDir(void)
 818 {
 819   struct passwd *pwd = getPasswdEntry();
 820
 821   if (pwd != NULL && strlen(pwd->pw_dir) != 0)
 822     return pwd->pw_dir;
 823
 824   return NULL;
 825 }
 826 #endif
 827
 828 char *getLoginName(void)
 829 {
 830   static char *login_name = NULL;
 831
 832 #if defined(PLATFORM_WIN32)
 833   if (login_name == NULL)
 834   {
 835     unsigned long buffer_size = MAX_USERNAME_LEN + 1;
 836
 837     login_name = checked_malloc(buffer_size);
 838
 839     if (GetUserName(login_name, &buffer_size) == 0)
 840       strcpy(login_name, ANONYMOUS_NAME);
 841   }
 842 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
 843   if (login_name == NULL)
 844   {
 845     char *name = getUnixLoginName();
 846
 847     if (name != NULL)
 848       login_name = getStringCopy(name);
 849     else
 850       login_name = ANONYMOUS_NAME;
 851   }
 852 #else
 853   login_name = ANONYMOUS_NAME;
 854 #endif
 855
 856   return login_name;
 857 }
 858
 859 char *getRealName(void)
 860 {
 861   static char *real_name = NULL;
 862
 863 #if defined(PLATFORM_WIN32)
 864   if (real_name == NULL)
 865   {
 866     static char buffer[MAX_USERNAME_LEN + 1];
 867     unsigned long buffer_size = MAX_USERNAME_LEN + 1;
 868
 869     if (GetUserName(buffer, &buffer_size) != 0)
 870       real_name = get_corrected_real_name(buffer);
 871     else
 872       real_name = ANONYMOUS_NAME;
 873   }
 874 #elif defined(PLATFORM_UNIX) && !defined(PLATFORM_ANDROID)
 875   if (real_name == NULL)
 876   {
 877     char *name = getUnixRealName();
 878
 879     if (name != NULL)
 880       real_name = get_corrected_real_name(name);
 881     else
 882       real_name = ANONYMOUS_NAME;
 883   }
 884 #else
 885   real_name = ANONYMOUS_NAME;
 886 #endif
 887
 888   return real_name;
 889 }
 890
 891 char *getFixedUserName(char *name)
 892 {
 893   // needed because player name must be a fixed length string
 894   char *name_new = checked_malloc(MAX_PLAYER_NAME_LEN + 1);
 895
 896   strncpy(name_new, name, MAX_PLAYER_NAME_LEN);
 897   name_new[MAX_PLAYER_NAME_LEN] = '\0';
 898
 899   if (strlen(name) > MAX_PLAYER_NAME_LEN)               // name has been cut
 900     if (strchr(name_new, ' '))
 901       *strchr(name_new, ' ') = '\0';
 902
 903   return name_new;
 904 }
 905
 906 char *getDefaultUserName(int nr)
 907 {
 908   static char *user_name[MAX_PLAYER_NAMES] = { NULL };
 909
 910   nr = MIN(MAX(0, nr), MAX_PLAYER_NAMES - 1);
 911
 912   if (user_name[nr] == NULL)
 913   {
 914     user_name[nr] = (nr == 0 ? getLoginName() : EMPTY_PLAYER_NAME);
 915     user_name[nr] = getFixedUserName(user_name[nr]);
 916   }
 917
 918   return user_name[nr];
 919 }
 920
 921 char *getTimestampFromEpoch(time_t epoch_seconds)
 922 {
 923   struct tm *now = localtime(&epoch_seconds);
 924   static char timestamp[20];
 925
 926   sprintf(timestamp, "%04d%02d%02d-%02d%02d%02d",
 927           now->tm_year + 1900, now->tm_mon + 1, now->tm_mday,
 928           now->tm_hour, now->tm_min, now->tm_sec);
 929
 930   return timestamp;
 931 }
 932
 933 char *getCurrentTimestamp(void)
 934 {
 935   return getTimestampFromEpoch(time(NULL));
 936 }
 937
 938 time_t getFileTimestampEpochSeconds(char *filename)
 939 {
 940   struct stat file_status;
 941
 942   if (stat(filename, &file_status) != 0)        // cannot stat file
 943     return 0;
 944
 945   return file_status.st_mtime;
 946 }
 947
 948
 949 // ----------------------------------------------------------------------------
 950 // path manipulation functions
 951 // ----------------------------------------------------------------------------
 952
 953 static char *getLastPathSeparatorPtr(char *filename)
 954 {
 955   char *last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_UNIX);
 956
 957   if (last_separator == NULL)   // also try DOS/Windows variant
 958     last_separator = strrchr(filename, CHAR_PATH_SEPARATOR_DOS);
 959
 960   return last_separator;
 961 }
 962
 963 char *getBaseNamePtr(char *filename)
 964 {
 965   char *last_separator = getLastPathSeparatorPtr(filename);
 966
 967   if (last_separator != NULL)
 968     return last_separator + 1;  // separator found: strip base path
 969   else
 970     return filename;            // no separator found: filename has no path
 971 }
 972
 973 char *getBaseName(char *filename)
 974 {
 975   return getStringCopy(getBaseNamePtr(filename));
 976 }
 977
 978 char *getBaseNameNoSuffix(char *filename)
 979 {
 980   char *basename = getStringCopy(getBaseNamePtr(filename));
 981
 982   // remove trailing suffix (separated by dot or hyphen)
 983   if (basename[0] != '.' && basename[0] != '-')
 984   {
 985     if (strchr(basename, '.') != NULL)
 986       *strchr(basename, '.') = '\0';
 987
 988     if (strchr(basename, '-') != NULL)
 989       *strchr(basename, '-') = '\0';
 990   }
 991
 992   return basename;
 993 }
 994
 995 char *getBasePath(char *filename)
 996 {
 997   char *basepath = getStringCopy(filename);
 998   char *last_separator = getLastPathSeparatorPtr(basepath);
 999
1000   // if no separator was found, use current directory
1001   if (last_separator == NULL)
1002   {
1003     free(basepath);
1004
1005     return getStringCopy(".");
1006   }
1007
1008   // separator found: strip basename
1009   *last_separator = '\0';
1010
1011   return basepath;
1012 }
1013
1014
1015 // ----------------------------------------------------------------------------
1016 // various string functions
1017 // ----------------------------------------------------------------------------
1018
1019 char *getStringCat2WithSeparator(char *s1, char *s2, char *sep)
1020 {
1021   if (s1 == NULL || s2 == NULL || sep == NULL)
1022     return NULL;
1023
1024   char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1025                                          strlen(s2) + 1);
1026
1027   sprintf(complete_string, "%s%s%s", s1, sep, s2);
1028
1029   return complete_string;
1030 }
1031
1032 char *getStringCat3WithSeparator(char *s1, char *s2, char *s3, char *sep)
1033 {
1034   if (s1 == NULL || s2 == NULL || s3 == NULL || sep == NULL)
1035     return NULL;
1036
1037   char *complete_string = checked_malloc(strlen(s1) + strlen(sep) +
1038                                          strlen(s2) + strlen(sep) +
1039                                          strlen(s3) + 1);
1040
1041   sprintf(complete_string, "%s%s%s%s%s", s1, sep, s2, sep, s3);
1042
1043   return complete_string;
1044 }
1045
1046 char *getStringCat2(char *s1, char *s2)
1047 {
1048   return getStringCat2WithSeparator(s1, s2, "");
1049 }
1050
1051 char *getStringCat3(char *s1, char *s2, char *s3)
1052 {
1053   return getStringCat3WithSeparator(s1, s2, s3, "");
1054 }
1055
1056 char *getPath2(char *path1, char *path2)
1057 {
1058 #if defined(PLATFORM_ANDROID)
1059   // workaround for reading from assets directory -- skip "." subdirs in path
1060   if (strEqual(path1, "."))
1061     return getStringCopy(path2);
1062   else if (strEqual(path2, "."))
1063     return getStringCopy(path1);
1064 #endif
1065
1066   return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1067 }
1068
1069 char *getPath3(char *path1, char *path2, char *path3)
1070 {
1071 #if defined(PLATFORM_ANDROID)
1072   // workaround for reading from assets directory -- skip "." subdirs in path
1073   if (strEqual(path1, "."))
1074     return getStringCat2WithSeparator(path2, path3, STRING_PATH_SEPARATOR);
1075   else if (strEqual(path2, "."))
1076     return getStringCat2WithSeparator(path1, path3, STRING_PATH_SEPARATOR);
1077   else if (strEqual(path3, "."))
1078     return getStringCat2WithSeparator(path1, path2, STRING_PATH_SEPARATOR);
1079 #endif
1080
1081   return getStringCat3WithSeparator(path1, path2, path3, STRING_PATH_SEPARATOR);
1082 }
1083
1084 static char *getPngOrPcxIfNotExists(char *filename)
1085 {
1086   // switch from PNG to PCX file and vice versa, if file does not exist
1087   // (backwards compatibility with PCX files used in previous versions)
1088
1089   if (!fileExists(filename) && strSuffix(filename, ".png"))
1090     strcpy(&filename[strlen(filename) - 3], "pcx");
1091   else if (!fileExists(filename) && strSuffix(filename, ".pcx"))
1092     strcpy(&filename[strlen(filename) - 3], "png");
1093
1094   return filename;
1095 }
1096
1097 char *getImg2(char *path1, char *path2)
1098 {
1099   return getPngOrPcxIfNotExists(getPath2(path1, path2));
1100 }
1101
1102 char *getImg3(char *path1, char *path2, char *path3)
1103 {
1104   return getPngOrPcxIfNotExists(getPath3(path1, path2, path3));
1105 }
1106
1107 char *getStringCopy(const char *s)
1108 {
1109   char *s_copy;
1110
1111   if (s == NULL)
1112     return NULL;
1113
1114   s_copy = checked_malloc(strlen(s) + 1);
1115   strcpy(s_copy, s);
1116
1117   return s_copy;
1118 }
1119
1120 char *getStringCopyN(const char *s, int n)
1121 {
1122   char *s_copy;
1123   int s_len = MAX(0, n);
1124
1125   if (s == NULL)
1126     return NULL;
1127
1128   s_copy = checked_malloc(s_len + 1);
1129   strncpy(s_copy, s, s_len);
1130   s_copy[s_len] = '\0';
1131
1132   return s_copy;
1133 }
1134
1135 char *getStringCopyNStatic(const char *s, int n)
1136 {
1137   static char *s_copy = NULL;
1138
1139   checked_free(s_copy);
1140
1141   s_copy = getStringCopyN(s, n);
1142
1143   return s_copy;
1144 }
1145
1146 char *getStringToLower(const char *s)
1147 {
1148   char *s_copy = checked_malloc(strlen(s) + 1);
1149   char *s_ptr = s_copy;
1150
1151   while (*s)
1152     *s_ptr++ = tolower(*s++);
1153   *s_ptr = '\0';
1154
1155   return s_copy;
1156 }
1157
1158 void setString(char **old_value, char *new_value)
1159 {
1160   checked_free(*old_value);
1161
1162   *old_value = getStringCopy(new_value);
1163 }
1164
1165 boolean strEqual(char *s1, char *s2)
1166 {
1167   return (s1 == NULL && s2 == NULL ? TRUE  :
1168           s1 == NULL && s2 != NULL ? FALSE :
1169           s1 != NULL && s2 == NULL ? FALSE :
1170           strcmp(s1, s2) == 0);
1171 }
1172
1173 boolean strEqualN(char *s1, char *s2, int n)
1174 {
1175   return (s1 == NULL && s2 == NULL ? TRUE  :
1176           s1 == NULL && s2 != NULL ? FALSE :
1177           s1 != NULL && s2 == NULL ? FALSE :
1178           strncmp(s1, s2, n) == 0);
1179 }
1180
1181 boolean strPrefix(char *s, char *prefix)
1182 {
1183   return (s == NULL && prefix == NULL ? TRUE  :
1184           s == NULL && prefix != NULL ? FALSE :
1185           s != NULL && prefix == NULL ? FALSE :
1186           strncmp(s, prefix, strlen(prefix)) == 0);
1187 }
1188
1189 boolean strSuffix(char *s, char *suffix)
1190 {
1191   return (s == NULL && suffix == NULL ? TRUE  :
1192           s == NULL && suffix != NULL ? FALSE :
1193           s != NULL && suffix == NULL ? FALSE :
1194           strlen(s) < strlen(suffix)  ? FALSE :
1195           strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1196 }
1197
1198 boolean strPrefixLower(char *s, char *prefix)
1199 {
1200   char *s_lower = getStringToLower(s);
1201   boolean match = strPrefix(s_lower, prefix);
1202
1203   free(s_lower);
1204
1205   return match;
1206 }
1207
1208 boolean strSuffixLower(char *s, char *suffix)
1209 {
1210   char *s_lower = getStringToLower(s);
1211   boolean match = strSuffix(s_lower, suffix);
1212
1213   free(s_lower);
1214
1215   return match;
1216 }
1217
1218
1219 // ----------------------------------------------------------------------------
1220 // command line option handling functions
1221 // ----------------------------------------------------------------------------
1222
1223 void GetOptions(int argc, char *argv[],
1224                 void (*print_usage_function)(void),
1225                 void (*print_version_function)(void))
1226 {
1227   char *ro_base_path = getProgramMainDataPath(argv[0], RO_BASE_PATH);
1228   char *rw_base_path = getProgramMainDataPath(argv[0], RW_BASE_PATH);
1229   char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1230   char **options_left = &argvplus[1];
1231
1232   // replace original "argv" with null-terminated array of string pointers
1233   while (argc--)
1234     argvplus[argc] = argv[argc];
1235
1236   // initialize global program options
1237   options.server_host = NULL;
1238   options.server_port = 0;
1239
1240   options.ro_base_directory = ro_base_path;
1241   options.rw_base_directory = rw_base_path;
1242   options.level_directory    = getPath2(ro_base_path, LEVELS_DIRECTORY);
1243   options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1244   options.sounds_directory   = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1245   options.music_directory    = getPath2(ro_base_path, MUSIC_DIRECTORY);
1246   options.docs_directory     = getPath2(ro_base_path, DOCS_DIRECTORY);
1247   options.conf_directory     = getPath2(ro_base_path, CONF_DIRECTORY);
1248
1249   options.execute_command = NULL;
1250   options.special_flags = NULL;
1251   options.debug_mode = NULL;
1252
1253   options.mytapes = FALSE;
1254   options.serveronly = FALSE;
1255   options.network = FALSE;
1256   options.verbose = FALSE;
1257   options.debug = FALSE;
1258
1259 #if 1
1260   options.verbose = TRUE;
1261 #else
1262 #if !defined(PLATFORM_UNIX)
1263   if (*options_left == NULL)    // no options given -- enable verbose mode
1264     options.verbose = TRUE;
1265 #endif
1266 #endif
1267
1268 #if DEBUG
1269 #if defined(PLATFORM_ANDROID)
1270   options.debug = TRUE;
1271 #endif
1272 #endif
1273
1274   while (*options_left)
1275   {
1276     char option_str[MAX_OPTION_LEN];
1277     char *option = options_left[0];
1278     char *next_option = options_left[1];
1279     char *option_arg = NULL;
1280     int option_len = strlen(option);
1281
1282     if (option_len >= MAX_OPTION_LEN)
1283       FailWithHelp("unrecognized option '%s'", option);
1284
1285     strcpy(option_str, option);                 // copy argument into buffer
1286     option = option_str;
1287
1288     if (strEqual(option, "--"))                 // stop scanning arguments
1289       break;
1290
1291     if (strPrefix(option, "--"))                // treat '--' like '-'
1292       option++;
1293
1294     option_arg = strchr(option, '=');
1295     if (option_arg == NULL)                     // no '=' in option
1296       option_arg = next_option;
1297     else
1298     {
1299       *option_arg++ = '\0';                     // cut argument from option
1300       if (*option_arg == '\0')                  // no argument after '='
1301         FailWithHelp("option '%s' has invalid argument", option_str);
1302     }
1303
1304     option_len = strlen(option);
1305
1306     if (strEqual(option, "-"))
1307     {
1308       FailWithHelp("unrecognized option '%s'", option);
1309     }
1310     else if (strncmp(option, "-help", option_len) == 0)
1311     {
1312       print_usage_function();
1313
1314       exit(0);
1315     }
1316     else if (strncmp(option, "-basepath", option_len) == 0)
1317     {
1318       if (option_arg == NULL)
1319         FailWithHelp("option '%s' requires an argument", option_str);
1320
1321       // this should be extended to separate options for ro and rw data
1322       options.ro_base_directory = ro_base_path = getStringCopy(option_arg);
1323       options.rw_base_directory = rw_base_path = getStringCopy(option_arg);
1324       if (option_arg == next_option)
1325         options_left++;
1326
1327       // adjust paths for sub-directories in base directory accordingly
1328       options.level_directory    = getPath2(ro_base_path, LEVELS_DIRECTORY);
1329       options.graphics_directory = getPath2(ro_base_path, GRAPHICS_DIRECTORY);
1330       options.sounds_directory   = getPath2(ro_base_path, SOUNDS_DIRECTORY);
1331       options.music_directory    = getPath2(ro_base_path, MUSIC_DIRECTORY);
1332       options.docs_directory     = getPath2(ro_base_path, DOCS_DIRECTORY);
1333       options.conf_directory     = getPath2(ro_base_path, CONF_DIRECTORY);
1334     }
1335     else if (strncmp(option, "-levels", option_len) == 0)
1336     {
1337       if (option_arg == NULL)
1338         FailWithHelp("option '%s' requires an argument", option_str);
1339
1340       options.level_directory = getStringCopy(option_arg);
1341       if (option_arg == next_option)
1342         options_left++;
1343     }
1344     else if (strncmp(option, "-graphics", option_len) == 0)
1345     {
1346       if (option_arg == NULL)
1347         FailWithHelp("option '%s' requires an argument", option_str);
1348
1349       options.graphics_directory = getStringCopy(option_arg);
1350       if (option_arg == next_option)
1351         options_left++;
1352     }
1353     else if (strncmp(option, "-sounds", option_len) == 0)
1354     {
1355       if (option_arg == NULL)
1356         FailWithHelp("option '%s' requires an argument", option_str);
1357
1358       options.sounds_directory = getStringCopy(option_arg);
1359       if (option_arg == next_option)
1360         options_left++;
1361     }
1362     else if (strncmp(option, "-music", option_len) == 0)
1363     {
1364       if (option_arg == NULL)
1365         FailWithHelp("option '%s' requires an argument", option_str);
1366
1367       options.music_directory = getStringCopy(option_arg);
1368       if (option_arg == next_option)
1369         options_left++;
1370     }
1371     else if (strncmp(option, "-mytapes", option_len) == 0)
1372     {
1373       options.mytapes = TRUE;
1374     }
1375     else if (strncmp(option, "-network", option_len) == 0)
1376     {
1377       options.network = TRUE;
1378     }
1379     else if (strncmp(option, "-serveronly", option_len) == 0)
1380     {
1381       options.serveronly = TRUE;
1382     }
1383     else if (strncmp(option, "-debug", option_len) == 0)
1384     {
1385       options.debug = TRUE;
1386
1387       // optionally, debug output can be limited to a specific debug mode
1388       if (option_arg != next_option)
1389         options.debug_mode = getStringCopy(option_arg);
1390     }
1391     else if (strncmp(option, "-verbose", option_len) == 0)
1392     {
1393       options.verbose = TRUE;
1394     }
1395     else if (strncmp(option, "-version", option_len) == 0 ||
1396              strncmp(option, "-V", option_len) == 0)
1397     {
1398       print_version_function();
1399
1400       exit(0);
1401     }
1402     else if (strPrefix(option, "-D"))
1403     {
1404       options.special_flags = getStringCopy(&option[2]);
1405     }
1406     else if (strncmp(option, "-execute", option_len) == 0)
1407     {
1408       if (option_arg == NULL)
1409         FailWithHelp("option '%s' requires an argument", option_str);
1410
1411       options.execute_command = getStringCopy(option_arg);
1412       if (option_arg == next_option)
1413         options_left++;
1414
1415       // when doing batch processing, always enable verbose mode (warnings)
1416       options.verbose = TRUE;
1417     }
1418 #if defined(PLATFORM_MACOSX)
1419     else if (strPrefix(option, "-psn"))
1420     {
1421       // ignore process serial number when launched via GUI on Mac OS X
1422     }
1423 #endif
1424     else if (*option == '-')
1425     {
1426       FailWithHelp("unrecognized option '%s'", option_str);
1427     }
1428     else if (options.server_host == NULL)
1429     {
1430       options.server_host = *options_left;
1431     }
1432     else if (options.server_port == 0)
1433     {
1434       options.server_port = atoi(*options_left);
1435       if (options.server_port < 1024)
1436         FailWithHelp("bad port number '%d'", options.server_port);
1437     }
1438     else
1439       FailWithHelp("too many arguments");
1440
1441     options_left++;
1442   }
1443 }
1444
1445
1446 // ----------------------------------------------------------------------------
1447 // checked memory allocation and freeing functions
1448 // ----------------------------------------------------------------------------
1449
1450 void *checked_malloc(unsigned int size)
1451 {
1452   void *ptr;
1453
1454   ptr = malloc(size);
1455
1456   if (ptr == NULL)
1457     Fail("cannot allocate %d bytes -- out of memory", size);
1458
1459   return ptr;
1460 }
1461
1462 void *checked_calloc(unsigned int size)
1463 {
1464   void *ptr;
1465
1466   ptr = calloc(1, size);
1467
1468   if (ptr == NULL)
1469     Fail("cannot allocate %d bytes -- out of memory", size);
1470
1471   return ptr;
1472 }
1473
1474 void *checked_realloc(void *ptr, unsigned int size)
1475 {
1476   ptr = realloc(ptr, size);
1477
1478   if (ptr == NULL)
1479     Fail("cannot allocate %d bytes -- out of memory", size);
1480
1481   return ptr;
1482 }
1483
1484 void checked_free(void *ptr)
1485 {
1486   if (ptr != NULL)      // this check should be done by free() anyway
1487     free(ptr);
1488 }
1489
1490 void clear_mem(void *ptr, unsigned int size)
1491 {
1492 #if defined(PLATFORM_WIN32)
1493   // for unknown reason, memset() sometimes crashes when compiled with MinGW
1494   char *cptr = (char *)ptr;
1495
1496   while (size--)
1497     *cptr++ = 0;
1498 #else
1499   memset(ptr, 0, size);
1500 #endif
1501 }
1502
1503
1504 // ----------------------------------------------------------------------------
1505 // various helper functions
1506 // ----------------------------------------------------------------------------
1507
1508 void swap_numbers(int *i1, int *i2)
1509 {
1510   int help = *i1;
1511
1512   *i1 = *i2;
1513   *i2 = help;
1514 }
1515
1516 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1517 {
1518   int help_x = *x1;
1519   int help_y = *y1;
1520
1521   *x1 = *x2;
1522   *x2 = help_x;
1523
1524   *y1 = *y2;
1525   *y2 = help_y;
1526 }
1527
1528 /* the "put" variants of the following file access functions check for the file
1529    pointer being != NULL and return the number of bytes they have or would have
1530    written; this allows for chunk writing functions to first determine the size
1531    of the (not yet written) chunk, write the correct chunk size and finally
1532    write the chunk itself */
1533
1534 int getFile8BitInteger(File *file)
1535 {
1536   return getByteFromFile(file);
1537 }
1538
1539 int putFile8BitInteger(FILE *file, int value)
1540 {
1541   if (file != NULL)
1542     fputc(value, file);
1543
1544   return 1;
1545 }
1546
1547 int getFile16BitInteger(File *file, int byte_order)
1548 {
1549   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1550     return ((getByteFromFile(file) << 8) |
1551             (getByteFromFile(file) << 0));
1552   else           // BYTE_ORDER_LITTLE_ENDIAN
1553     return ((getByteFromFile(file) << 0) |
1554             (getByteFromFile(file) << 8));
1555 }
1556
1557 int putFile16BitInteger(FILE *file, int value, int byte_order)
1558 {
1559   if (file != NULL)
1560   {
1561     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1562     {
1563       fputc((value >> 8) & 0xff, file);
1564       fputc((value >> 0) & 0xff, file);
1565     }
1566     else           // BYTE_ORDER_LITTLE_ENDIAN
1567     {
1568       fputc((value >> 0) & 0xff, file);
1569       fputc((value >> 8) & 0xff, file);
1570     }
1571   }
1572
1573   return 2;
1574 }
1575
1576 int getFile32BitInteger(File *file, int byte_order)
1577 {
1578   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1579     return ((getByteFromFile(file) << 24) |
1580             (getByteFromFile(file) << 16) |
1581             (getByteFromFile(file) <<  8) |
1582             (getByteFromFile(file) <<  0));
1583   else           // BYTE_ORDER_LITTLE_ENDIAN
1584     return ((getByteFromFile(file) <<  0) |
1585             (getByteFromFile(file) <<  8) |
1586             (getByteFromFile(file) << 16) |
1587             (getByteFromFile(file) << 24));
1588 }
1589
1590 int putFile32BitInteger(FILE *file, int value, int byte_order)
1591 {
1592   if (file != NULL)
1593   {
1594     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1595     {
1596       fputc((value >> 24) & 0xff, file);
1597       fputc((value >> 16) & 0xff, file);
1598       fputc((value >>  8) & 0xff, file);
1599       fputc((value >>  0) & 0xff, file);
1600     }
1601     else           // BYTE_ORDER_LITTLE_ENDIAN
1602     {
1603       fputc((value >>  0) & 0xff, file);
1604       fputc((value >>  8) & 0xff, file);
1605       fputc((value >> 16) & 0xff, file);
1606       fputc((value >> 24) & 0xff, file);
1607     }
1608   }
1609
1610   return 4;
1611 }
1612
1613 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1614                      int byte_order)
1615 {
1616   const int chunk_name_length = 4;
1617
1618   // read chunk name
1619   if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1620     return FALSE;
1621
1622   if (chunk_size != NULL)
1623   {
1624     // read chunk size
1625     *chunk_size = getFile32BitInteger(file, byte_order);
1626   }
1627
1628   return (checkEndOfFile(file) ? FALSE : TRUE);
1629 }
1630
1631 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1632                  int byte_order)
1633 {
1634   int num_bytes = 0;
1635
1636   // write chunk name
1637   if (file != NULL)
1638     fputs(chunk_name, file);
1639
1640   num_bytes += strlen(chunk_name);
1641
1642   if (chunk_size >= 0)
1643   {
1644     // write chunk size
1645     if (file != NULL)
1646       putFile32BitInteger(file, chunk_size, byte_order);
1647
1648     num_bytes += 4;
1649   }
1650
1651   return num_bytes;
1652 }
1653
1654 int getFileVersion(File *file)
1655 {
1656   int version_super = getByteFromFile(file);
1657   int version_major = getByteFromFile(file);
1658   int version_minor = getByteFromFile(file);
1659   int version_patch = getByteFromFile(file);
1660
1661   return VERSION_IDENT(version_super, version_major, version_minor,
1662                        version_patch);
1663 }
1664
1665 int putFileVersion(FILE *file, int version)
1666 {
1667   if (file != NULL)
1668   {
1669     int version_super = VERSION_SUPER(version);
1670     int version_major = VERSION_MAJOR(version);
1671     int version_minor = VERSION_MINOR(version);
1672     int version_patch = VERSION_PATCH(version);
1673
1674     fputc(version_super, file);
1675     fputc(version_major, file);
1676     fputc(version_minor, file);
1677     fputc(version_patch, file);
1678   }
1679
1680   return 4;
1681 }
1682
1683 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1684 {
1685   int i;
1686
1687   for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1688     buffer[i] = getByteFromFile(file);
1689 }
1690
1691 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1692 {
1693   int i;
1694
1695   for (i = 0; i < bytes; i++)
1696     fputc(buffer[i], file);
1697 }
1698
1699 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1700 {
1701   while (bytes-- && !checkEndOfFile(file))
1702     getByteFromFile(file);
1703 }
1704
1705 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1706 {
1707   while (bytes--)
1708     fputc(0, file);
1709 }
1710
1711
1712 // ----------------------------------------------------------------------------
1713 // functions to translate key identifiers between different format
1714 // ----------------------------------------------------------------------------
1715
1716 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
1717 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
1718 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
1719 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
1720
1721 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1722 {
1723   static struct
1724   {
1725     Key key;
1726     char *x11name;
1727     char *name;
1728   } translate_key[] =
1729   {
1730     // return and escape keys
1731     { KSYM_Return,      "XK_Return",            "return" },
1732     { KSYM_Escape,      "XK_Escape",            "escape" },
1733
1734     // normal cursor keys
1735     { KSYM_Left,        "XK_Left",              "cursor left" },
1736     { KSYM_Right,       "XK_Right",             "cursor right" },
1737     { KSYM_Up,          "XK_Up",                "cursor up" },
1738     { KSYM_Down,        "XK_Down",              "cursor down" },
1739
1740     // keypad cursor keys
1741 #ifdef KSYM_KP_Left
1742     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
1743     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
1744     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
1745     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
1746 #endif
1747
1748     // other keypad keys
1749 #ifdef KSYM_KP_Enter
1750     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
1751     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
1752     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
1753     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
1754     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
1755     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
1756 #endif
1757
1758     // modifier keys
1759     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
1760     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
1761     { KSYM_Control_L,   "XK_Control_L",         "left control" },
1762     { KSYM_Control_R,   "XK_Control_R",         "right control" },
1763     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
1764     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
1765     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
1766     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
1767     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, // Alt-R
1768     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   // Ctrl-R
1769
1770     // some special keys
1771     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
1772     { KSYM_Delete,      "XK_Delete",            "delete" },
1773     { KSYM_Insert,      "XK_Insert",            "insert" },
1774     { KSYM_Tab,         "XK_Tab",               "tab" },
1775     { KSYM_Home,        "XK_Home",              "home" },
1776     { KSYM_End,         "XK_End",               "end" },
1777     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
1778     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
1779
1780     { KSYM_Select,      "XK_Select",            "select" },
1781     { KSYM_Menu,        "XK_Menu",              "menu" },        // menu key
1782     { KSYM_Back,        "XK_Back",              "back" },        // back key
1783     { KSYM_PlayPause,   "XK_PlayPause",         "play/pause" },
1784 #if defined(PLATFORM_ANDROID)
1785     { KSYM_Rewind,      "XK_Rewind",            "rewind" },
1786     { KSYM_FastForward, "XK_FastForward",       "fast forward" },
1787 #endif
1788
1789     // ASCII 0x20 to 0x40 keys (except numbers)
1790     { KSYM_space,       "XK_space",             "space" },
1791     { KSYM_exclam,      "XK_exclam",            "!" },
1792     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
1793     { KSYM_numbersign,  "XK_numbersign",        "#" },
1794     { KSYM_dollar,      "XK_dollar",            "$" },
1795     { KSYM_percent,     "XK_percent",           "%" },
1796     { KSYM_ampersand,   "XK_ampersand",         "&" },
1797     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
1798     { KSYM_parenleft,   "XK_parenleft",         "(" },
1799     { KSYM_parenright,  "XK_parenright",        ")" },
1800     { KSYM_asterisk,    "XK_asterisk",          "*" },
1801     { KSYM_plus,        "XK_plus",              "+" },
1802     { KSYM_comma,       "XK_comma",             "," },
1803     { KSYM_minus,       "XK_minus",             "-" },
1804     { KSYM_period,      "XK_period",            "." },
1805     { KSYM_slash,       "XK_slash",             "/" },
1806     { KSYM_colon,       "XK_colon",             ":" },
1807     { KSYM_semicolon,   "XK_semicolon",         ";" },
1808     { KSYM_less,        "XK_less",              "<" },
1809     { KSYM_equal,       "XK_equal",             "=" },
1810     { KSYM_greater,     "XK_greater",           ">" },
1811     { KSYM_question,    "XK_question",          "?" },
1812     { KSYM_at,          "XK_at",                "@" },
1813
1814     // more ASCII keys
1815     { KSYM_bracketleft, "XK_bracketleft",       "[" },
1816     { KSYM_backslash,   "XK_backslash",         "\\" },
1817     { KSYM_bracketright,"XK_bracketright",      "]" },
1818     { KSYM_asciicircum, "XK_asciicircum",       "^" },
1819     { KSYM_underscore,  "XK_underscore",        "_" },
1820     { KSYM_grave,       "XK_grave",             "grave" },
1821     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
1822     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
1823     { KSYM_bar,         "XK_bar",               "bar" },
1824     { KSYM_braceright,  "XK_braceright",        "brace right" },
1825     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
1826
1827     // special (non-ASCII) keys
1828     { KSYM_degree,      "XK_degree",            "degree" },
1829     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "A umlaut" },
1830     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "O umlaut" },
1831     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "U umlaut" },
1832     { KSYM_adiaeresis,  "XK_adiaeresis",        "a umlaut" },
1833     { KSYM_odiaeresis,  "XK_odiaeresis",        "o umlaut" },
1834     { KSYM_udiaeresis,  "XK_udiaeresis",        "u umlaut" },
1835     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1836
1837     // special (non-ASCII) keys (UTF-8, for reverse mapping only)
1838     { KSYM_degree,      "XK_degree",            "\xc2\xb0" },
1839     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "\xc3\x84" },
1840     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "\xc3\x96" },
1841     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "\xc3\x9c" },
1842     { KSYM_adiaeresis,  "XK_adiaeresis",        "\xc3\xa4" },
1843     { KSYM_odiaeresis,  "XK_odiaeresis",        "\xc3\xb6" },
1844     { KSYM_udiaeresis,  "XK_udiaeresis",        "\xc3\xbc" },
1845     { KSYM_ssharp,      "XK_ssharp",            "\xc3\x9f" },
1846
1847     // other keys (for reverse mapping only)
1848     { KSYM_space,       "XK_space",             " " },
1849
1850     // keypad keys are not in numerical order in SDL2
1851     { KSYM_KP_0,        "XK_KP_0",              "keypad 0" },
1852     { KSYM_KP_1,        "XK_KP_1",              "keypad 1" },
1853     { KSYM_KP_2,        "XK_KP_2",              "keypad 2" },
1854     { KSYM_KP_3,        "XK_KP_3",              "keypad 3" },
1855     { KSYM_KP_4,        "XK_KP_4",              "keypad 4" },
1856     { KSYM_KP_5,        "XK_KP_5",              "keypad 5" },
1857     { KSYM_KP_6,        "XK_KP_6",              "keypad 6" },
1858     { KSYM_KP_7,        "XK_KP_7",              "keypad 7" },
1859     { KSYM_KP_8,        "XK_KP_8",              "keypad 8" },
1860     { KSYM_KP_9,        "XK_KP_9",              "keypad 9" },
1861
1862     // end-of-array identifier
1863     { 0,                NULL,                   NULL }
1864   };
1865
1866   int i;
1867
1868   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1869   {
1870     static char name_buffer[30];
1871     Key key = *keysym;
1872
1873     if (key >= KSYM_A && key <= KSYM_Z)
1874       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1875     else if (key >= KSYM_a && key <= KSYM_z)
1876       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1877     else if (key >= KSYM_0 && key <= KSYM_9)
1878       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1879     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1880       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1881     else if (key == KSYM_UNDEFINED)
1882       strcpy(name_buffer, "(undefined)");
1883     else
1884     {
1885       i = 0;
1886
1887       do
1888       {
1889         if (key == translate_key[i].key)
1890         {
1891           strcpy(name_buffer, translate_key[i].name);
1892           break;
1893         }
1894       }
1895       while (translate_key[++i].name);
1896
1897       if (!translate_key[i].name)
1898         strcpy(name_buffer, "(unknown)");
1899     }
1900
1901     *name = name_buffer;
1902   }
1903   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1904   {
1905     static char name_buffer[30];
1906     Key key = *keysym;
1907
1908     if (key >= KSYM_A && key <= KSYM_Z)
1909       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1910     else if (key >= KSYM_a && key <= KSYM_z)
1911       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1912     else if (key >= KSYM_0 && key <= KSYM_9)
1913       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1914     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1915       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1916     else if (key == KSYM_UNDEFINED)
1917       strcpy(name_buffer, "[undefined]");
1918     else
1919     {
1920       i = 0;
1921
1922       do
1923       {
1924         if (key == translate_key[i].key)
1925         {
1926           strcpy(name_buffer, translate_key[i].x11name);
1927           break;
1928         }
1929       }
1930       while (translate_key[++i].x11name);
1931
1932       if (!translate_key[i].x11name)
1933         sprintf(name_buffer, "0x%04x", (unsigned int)key);
1934     }
1935
1936     *x11name = name_buffer;
1937   }
1938   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1939   {
1940     Key key = KSYM_UNDEFINED;
1941     char *name_ptr = *name;
1942
1943     if (strlen(*name) == 1)
1944     {
1945       char c = name_ptr[0];
1946
1947       if (c >= 'A' && c <= 'Z')
1948         key = KSYM_A + (Key)(c - 'A');
1949       else if (c >= 'a' && c <= 'z')
1950         key = KSYM_a + (Key)(c - 'a');
1951       else if (c >= '0' && c <= '9')
1952         key = KSYM_0 + (Key)(c - '0');
1953     }
1954
1955     if (key == KSYM_UNDEFINED)
1956     {
1957       i = 0;
1958
1959       do
1960       {
1961         if (strEqual(translate_key[i].name, *name))
1962         {
1963           key = translate_key[i].key;
1964           break;
1965         }
1966       }
1967       while (translate_key[++i].x11name);
1968     }
1969
1970     if (key == KSYM_UNDEFINED)
1971       Warn("getKeyFromKeyName(): not completely implemented");
1972
1973     *keysym = key;
1974   }
1975   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1976   {
1977     Key key = KSYM_UNDEFINED;
1978     char *name_ptr = *x11name;
1979
1980     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1981     {
1982       char c = name_ptr[3];
1983
1984       if (c >= 'A' && c <= 'Z')
1985         key = KSYM_A + (Key)(c - 'A');
1986       else if (c >= 'a' && c <= 'z')
1987         key = KSYM_a + (Key)(c - 'a');
1988       else if (c >= '0' && c <= '9')
1989         key = KSYM_0 + (Key)(c - '0');
1990     }
1991     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1992     {
1993       char c1 = name_ptr[4];
1994       char c2 = name_ptr[5];
1995       int d = 0;
1996
1997       if ((c1 >= '0' && c1 <= '9') &&
1998           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1999         d = atoi(&name_ptr[4]);
2000
2001       if (d >= 1 && d <= KSYM_NUM_FKEYS)
2002         key = KSYM_F1 + (Key)(d - 1);
2003     }
2004     else if (strPrefix(name_ptr, "XK_"))
2005     {
2006       i = 0;
2007
2008       do
2009       {
2010         if (strEqual(name_ptr, translate_key[i].x11name))
2011         {
2012           key = translate_key[i].key;
2013           break;
2014         }
2015       }
2016       while (translate_key[++i].x11name);
2017     }
2018     else if (strPrefix(name_ptr, "0x"))
2019     {
2020       unsigned int value = 0;
2021
2022       name_ptr += 2;
2023
2024       while (name_ptr)
2025       {
2026         char c = *name_ptr++;
2027         int d = -1;
2028
2029         if (c >= '0' && c <= '9')
2030           d = (int)(c - '0');
2031         else if (c >= 'a' && c <= 'f')
2032           d = (int)(c - 'a' + 10);
2033         else if (c >= 'A' && c <= 'F')
2034           d = (int)(c - 'A' + 10);
2035
2036         if (d == -1)
2037         {
2038           value = -1;
2039           break;
2040         }
2041
2042         value = value * 16 + d;
2043       }
2044
2045       if (value != -1)
2046         key = (Key)value;
2047     }
2048
2049     *keysym = key;
2050   }
2051 }
2052
2053 char *getKeyNameFromKey(Key key)
2054 {
2055   char *name;
2056
2057   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2058   return name;
2059 }
2060
2061 char *getX11KeyNameFromKey(Key key)
2062 {
2063   char *x11name;
2064
2065   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2066   return x11name;
2067 }
2068
2069 Key getKeyFromKeyName(char *name)
2070 {
2071   Key key;
2072
2073   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2074   return key;
2075 }
2076
2077 Key getKeyFromX11KeyName(char *x11name)
2078 {
2079   Key key;
2080
2081   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2082   return key;
2083 }
2084
2085 char getCharFromKey(Key key)
2086 {
2087   static struct
2088   {
2089     Key key;
2090     byte key_char;
2091   } translate_key_char[] =
2092   {
2093     // special (non-ASCII) keys (ISO-8859-1)
2094     { KSYM_degree,      CHAR_BYTE_DEGREE        },
2095     { KSYM_Adiaeresis,  CHAR_BYTE_UMLAUT_A      },
2096     { KSYM_Odiaeresis,  CHAR_BYTE_UMLAUT_O      },
2097     { KSYM_Udiaeresis,  CHAR_BYTE_UMLAUT_U      },
2098     { KSYM_adiaeresis,  CHAR_BYTE_UMLAUT_a      },
2099     { KSYM_odiaeresis,  CHAR_BYTE_UMLAUT_o      },
2100     { KSYM_udiaeresis,  CHAR_BYTE_UMLAUT_u      },
2101     { KSYM_ssharp,      CHAR_BYTE_SHARP_S       },
2102
2103     // end-of-array identifier
2104     { 0,                0                       }
2105   };
2106
2107   char *keyname = getKeyNameFromKey(key);
2108   char c = 0;
2109
2110   if (strlen(keyname) == 1)
2111     c = keyname[0];
2112   else if (strEqual(keyname, "space"))
2113     c = ' ';
2114   else
2115   {
2116     int i = 0;
2117
2118     do
2119     {
2120       if (key == translate_key_char[i].key)
2121       {
2122         c = translate_key_char[i].key_char;
2123
2124         break;
2125       }
2126     }
2127     while (translate_key_char[++i].key_char);
2128   }
2129
2130   return c;
2131 }
2132
2133 char getValidConfigValueChar(char c)
2134 {
2135   if (c == '#' ||       // used to mark comments
2136       c == '\\')        // used to mark continued lines
2137     c = 0;
2138
2139   return c;
2140 }
2141
2142
2143 // ----------------------------------------------------------------------------
2144 // functions to translate string identifiers to integer or boolean value
2145 // ----------------------------------------------------------------------------
2146
2147 int get_integer_from_string(char *s)
2148 {
2149   static char *number_text[][3] =
2150   {
2151     { "0",      "zero",         "null",         },
2152     { "1",      "one",          "first"         },
2153     { "2",      "two",          "second"        },
2154     { "3",      "three",        "third"         },
2155     { "4",      "four",         "fourth"        },
2156     { "5",      "five",         "fifth"         },
2157     { "6",      "six",          "sixth"         },
2158     { "7",      "seven",        "seventh"       },
2159     { "8",      "eight",        "eighth"        },
2160     { "9",      "nine",         "ninth"         },
2161     { "10",     "ten",          "tenth"         },
2162     { "11",     "eleven",       "eleventh"      },
2163     { "12",     "twelve",       "twelfth"       },
2164
2165     { NULL,     NULL,           NULL            },
2166   };
2167
2168   int i, j;
2169   char *s_lower = getStringToLower(s);
2170   int result = -1;
2171
2172   for (i = 0; number_text[i][0] != NULL; i++)
2173     for (j = 0; j < 3; j++)
2174       if (strEqual(s_lower, number_text[i][j]))
2175         result = i;
2176
2177   if (result == -1)
2178   {
2179     if (strEqual(s_lower, "false") ||
2180         strEqual(s_lower, "no") ||
2181         strEqual(s_lower, "off"))
2182       result = 0;
2183     else if (strEqual(s_lower, "true") ||
2184              strEqual(s_lower, "yes") ||
2185              strEqual(s_lower, "on"))
2186       result = 1;
2187     else
2188       result = atoi(s);
2189   }
2190
2191   free(s_lower);
2192
2193   return result;
2194 }
2195
2196 boolean get_boolean_from_string(char *s)
2197 {
2198   char *s_lower = getStringToLower(s);
2199   boolean result = FALSE;
2200
2201   if (strEqual(s_lower, "true") ||
2202       strEqual(s_lower, "yes") ||
2203       strEqual(s_lower, "on") ||
2204       get_integer_from_string(s) == 1)
2205     result = TRUE;
2206
2207   free(s_lower);
2208
2209   return result;
2210 }
2211
2212 int get_switch3_from_string(char *s)
2213 {
2214   char *s_lower = getStringToLower(s);
2215   int result = FALSE;
2216
2217   if (strEqual(s_lower, "true") ||
2218       strEqual(s_lower, "yes") ||
2219       strEqual(s_lower, "on") ||
2220       get_integer_from_string(s) == 1)
2221     result = TRUE;
2222   else if (strEqual(s_lower, "auto"))
2223     result = AUTO;
2224
2225   free(s_lower);
2226
2227   return result;
2228 }
2229
2230 int get_player_nr_from_string(char *s)
2231 {
2232   static char *player_text[] =
2233   {
2234     "player_1",
2235     "player_2",
2236     "player_3",
2237     "player_4",
2238
2239     NULL
2240   };
2241
2242   char *s_lower = getStringToLower(s);
2243   int result = 0;
2244   int i;
2245
2246   for (i = 0; player_text[i] != NULL; i++)
2247     if (strEqual(s_lower, player_text[i]))
2248       result = i;
2249
2250   free(s_lower);
2251
2252   return result;
2253 }
2254
2255
2256 // ----------------------------------------------------------------------------
2257 // functions for generic lists
2258 // ----------------------------------------------------------------------------
2259
2260 ListNode *newListNode(void)
2261 {
2262   return checked_calloc(sizeof(ListNode));
2263 }
2264
2265 void addNodeToList(ListNode **node_first, char *key, void *content)
2266 {
2267   ListNode *node_new = newListNode();
2268
2269   node_new->key = getStringCopy(key);
2270   node_new->content = content;
2271   node_new->next = *node_first;
2272
2273   if (*node_first)
2274     (*node_first)->prev = node_new;
2275
2276   *node_first = node_new;
2277 }
2278
2279 void deleteNodeFromList(ListNode **node_first, char *key,
2280                         void (*destructor_function)(void *))
2281 {
2282   if (node_first == NULL || *node_first == NULL)
2283     return;
2284
2285   if (strEqual((*node_first)->key, key))
2286   {
2287     // after first recursion, (*node_first)->prev->next == *node_first,
2288     // so *node_first would be overwritten with (*node_first)->next
2289     // => use a copy of *node_first (and later of (*node_first)->next)
2290     ListNode *node = *node_first;
2291     ListNode *node_next = node->next;
2292
2293     checked_free(node->key);
2294
2295     if (destructor_function)
2296       destructor_function(node->content);
2297
2298     if (node->prev)
2299       node->prev->next = node->next;
2300
2301     if (node->next)
2302       node->next->prev = node->prev;
2303
2304     checked_free(node);
2305
2306     // after removing node, set list pointer to next valid list node
2307     // (this is important if the first node of the list was deleted)
2308     *node_first = node_next;
2309   }
2310   else
2311   {
2312     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2313   }
2314 }
2315
2316 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2317 {
2318   if (node_first == NULL)
2319     return NULL;
2320
2321   if (strEqual(node_first->key, key))
2322     return node_first;
2323   else
2324     return getNodeFromKey(node_first->next, key);
2325 }
2326
2327 int getNumNodes(ListNode *node_first)
2328 {
2329   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2330 }
2331
2332 #if 0
2333 static void dumpList(ListNode *node_first)
2334 {
2335   ListNode *node = node_first;
2336
2337   while (node)
2338   {
2339     Debug("internal:dumpList", "['%s' (%d)]", node->key,
2340           ((struct ListNodeInfo *)node->content)->num_references);
2341     node = node->next;
2342   }
2343
2344   Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2345 }
2346 #endif
2347
2348
2349 // ----------------------------------------------------------------------------
2350 // functions for file handling
2351 // ----------------------------------------------------------------------------
2352
2353 #define MAX_BUFFER_SIZE                 4096
2354
2355 File *openFile(char *filename, char *mode)
2356 {
2357   File *file = checked_calloc(sizeof(File));
2358
2359   file->file = fopen(filename, mode);
2360
2361   if (file->file != NULL)
2362   {
2363     file->filename = getStringCopy(filename);
2364
2365     return file;
2366   }
2367
2368 #if defined(PLATFORM_ANDROID)
2369   file->asset_file = SDL_RWFromFile(filename, mode);
2370
2371   if (file->asset_file != NULL)
2372   {
2373     file->file_is_asset = TRUE;
2374     file->filename = getStringCopy(filename);
2375
2376     return file;
2377   }
2378 #endif
2379
2380   checked_free(file);
2381
2382   return NULL;
2383 }
2384
2385 int closeFile(File *file)
2386 {
2387   if (file == NULL)
2388     return -1;
2389
2390   int result = 0;
2391
2392 #if defined(PLATFORM_ANDROID)
2393   if (file->asset_file)
2394     result = SDL_RWclose(file->asset_file);
2395 #endif
2396
2397   if (file->file)
2398     result = fclose(file->file);
2399
2400   checked_free(file->filename);
2401   checked_free(file);
2402
2403   return result;
2404 }
2405
2406 int checkEndOfFile(File *file)
2407 {
2408 #if defined(PLATFORM_ANDROID)
2409   if (file->file_is_asset)
2410     return file->end_of_file;
2411 #endif
2412
2413   return feof(file->file);
2414 }
2415
2416 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2417 {
2418 #if defined(PLATFORM_ANDROID)
2419   if (file->file_is_asset)
2420   {
2421     if (file->end_of_file)
2422       return 0;
2423
2424     size_t num_items_read =
2425       SDL_RWread(file->asset_file, buffer, item_size, num_items);
2426
2427     if (num_items_read < num_items)
2428       file->end_of_file = TRUE;
2429
2430     return num_items_read;
2431   }
2432 #endif
2433
2434   return fread(buffer, item_size, num_items, file->file);
2435 }
2436
2437 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2438 {
2439   return fwrite(buffer, item_size, num_items, file->file);
2440 }
2441
2442 int seekFile(File *file, long offset, int whence)
2443 {
2444 #if defined(PLATFORM_ANDROID)
2445   if (file->file_is_asset)
2446   {
2447     int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2448                       whence == SEEK_CUR ? RW_SEEK_CUR :
2449                       whence == SEEK_END ? RW_SEEK_END : 0);
2450
2451     return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2452   }
2453 #endif
2454
2455   return fseek(file->file, offset, whence);
2456 }
2457
2458 int getByteFromFile(File *file)
2459 {
2460 #if defined(PLATFORM_ANDROID)
2461   if (file->file_is_asset)
2462   {
2463     if (file->end_of_file)
2464       return EOF;
2465
2466     byte c;
2467     size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2468
2469     if (num_bytes_read < 1)
2470       file->end_of_file = TRUE;
2471
2472     return (file->end_of_file ? EOF : (int)c);
2473   }
2474 #endif
2475
2476   return fgetc(file->file);
2477 }
2478
2479 char *getStringFromFile(File *file, char *line, int size)
2480 {
2481 #if defined(PLATFORM_ANDROID)
2482   if (file->file_is_asset)
2483   {
2484     if (file->end_of_file)
2485       return NULL;
2486
2487     char *line_ptr = line;
2488     int num_bytes_read = 0;
2489
2490     while (num_bytes_read < size - 1 &&
2491            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2492            *line_ptr++ != '\n')
2493       num_bytes_read++;
2494
2495     *line_ptr = '\0';
2496
2497     if (strlen(line) == 0)
2498     {
2499       file->end_of_file = TRUE;
2500
2501       return NULL;
2502     }
2503
2504     return line;
2505   }
2506 #endif
2507
2508   return fgets(line, size, file->file);
2509 }
2510
2511 int copyFile(char *filename_from, char *filename_to)
2512 {
2513   File *file_from, *file_to;
2514
2515   if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2516   {
2517     return -1;
2518   }
2519
2520   if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2521   {
2522     closeFile(file_from);
2523
2524     return -1;
2525   }
2526
2527   while (!checkEndOfFile(file_from))
2528   {
2529     byte buffer[MAX_BUFFER_SIZE];
2530     size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2531
2532     writeFile(file_to, buffer, 1, bytes_read);
2533   }
2534
2535   closeFile(file_from);
2536   closeFile(file_to);
2537
2538   return 0;
2539 }
2540
2541
2542 // ----------------------------------------------------------------------------
2543 // functions for directory handling
2544 // ----------------------------------------------------------------------------
2545
2546 Directory *openDirectory(char *dir_name)
2547 {
2548   Directory *dir = checked_calloc(sizeof(Directory));
2549
2550   dir->dir = opendir(dir_name);
2551
2552   if (dir->dir != NULL)
2553   {
2554     dir->filename = getStringCopy(dir_name);
2555
2556     return dir;
2557   }
2558
2559 #if defined(PLATFORM_ANDROID)
2560   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2561
2562   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2563
2564   checked_free(asset_toc_filename);
2565
2566   if (dir->asset_toc_file != NULL)
2567   {
2568     dir->directory_is_asset = TRUE;
2569     dir->filename = getStringCopy(dir_name);
2570
2571     return dir;
2572   }
2573 #endif
2574
2575   checked_free(dir);
2576
2577   return NULL;
2578 }
2579
2580 int closeDirectory(Directory *dir)
2581 {
2582   if (dir == NULL)
2583     return -1;
2584
2585   int result = 0;
2586
2587 #if defined(PLATFORM_ANDROID)
2588   if (dir->asset_toc_file)
2589     result = SDL_RWclose(dir->asset_toc_file);
2590 #endif
2591
2592   if (dir->dir)
2593     result = closedir(dir->dir);
2594
2595   if (dir->dir_entry)
2596     freeDirectoryEntry(dir->dir_entry);
2597
2598   checked_free(dir->filename);
2599   checked_free(dir);
2600
2601   return result;
2602 }
2603
2604 DirectoryEntry *readDirectory(Directory *dir)
2605 {
2606   if (dir->dir_entry)
2607     freeDirectoryEntry(dir->dir_entry);
2608
2609   dir->dir_entry = NULL;
2610
2611 #if defined(PLATFORM_ANDROID)
2612   if (dir->directory_is_asset)
2613   {
2614     char line[MAX_LINE_LEN];
2615     char *line_ptr = line;
2616     int num_bytes_read = 0;
2617
2618     while (num_bytes_read < MAX_LINE_LEN - 1 &&
2619            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2620            *line_ptr != '\n')
2621     {
2622       line_ptr++;
2623       num_bytes_read++;
2624     }
2625
2626     *line_ptr = '\0';
2627
2628     if (strlen(line) == 0)
2629       return NULL;
2630
2631     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2632
2633     dir->dir_entry->is_directory = FALSE;
2634     if (line[strlen(line) - 1] == '/')
2635     {
2636       dir->dir_entry->is_directory = TRUE;
2637
2638       line[strlen(line) - 1] = '\0';
2639     }
2640
2641     dir->dir_entry->basename = getStringCopy(line);
2642     dir->dir_entry->filename = getPath2(dir->filename, line);
2643
2644     return dir->dir_entry;
2645   }
2646 #endif
2647
2648   struct dirent *dir_entry = readdir(dir->dir);
2649
2650   if (dir_entry == NULL)
2651     return NULL;
2652
2653   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2654
2655   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2656   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2657
2658   struct stat file_status;
2659
2660   dir->dir_entry->is_directory =
2661     (stat(dir->dir_entry->filename, &file_status) == 0 &&
2662      S_ISDIR(file_status.st_mode));
2663
2664   return dir->dir_entry;
2665 }
2666
2667 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2668 {
2669   if (dir_entry == NULL)
2670     return;
2671
2672   checked_free(dir_entry->basename);
2673   checked_free(dir_entry->filename);
2674   checked_free(dir_entry);
2675 }
2676
2677
2678 // ----------------------------------------------------------------------------
2679 // functions for checking files and filenames
2680 // ----------------------------------------------------------------------------
2681
2682 boolean directoryExists(char *dir_name)
2683 {
2684   if (dir_name == NULL)
2685     return FALSE;
2686
2687   struct stat file_status;
2688   boolean success = (stat(dir_name, &file_status) == 0 &&
2689                      S_ISDIR(file_status.st_mode));
2690
2691 #if defined(PLATFORM_ANDROID)
2692   if (!success)
2693   {
2694     // this might be an asset directory; check by trying to open toc file
2695     char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2696     SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2697
2698     checked_free(asset_toc_filename);
2699
2700     success = (file != NULL);
2701
2702     if (success)
2703       SDL_RWclose(file);
2704   }
2705 #endif
2706
2707   return success;
2708 }
2709
2710 boolean fileExists(char *filename)
2711 {
2712   if (filename == NULL)
2713     return FALSE;
2714
2715   boolean success = (access(filename, F_OK) == 0);
2716
2717 #if defined(PLATFORM_ANDROID)
2718   if (!success)
2719   {
2720     // this might be an asset file; check by trying to open it
2721     SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2722
2723     success = (file != NULL);
2724
2725     if (success)
2726       SDL_RWclose(file);
2727   }
2728 #endif
2729
2730   return success;
2731 }
2732
2733 #if 0
2734 static boolean fileHasPrefix(char *basename, char *prefix)
2735 {
2736   static char *basename_lower = NULL;
2737   int basename_length, prefix_length;
2738
2739   checked_free(basename_lower);
2740
2741   if (basename == NULL || prefix == NULL)
2742     return FALSE;
2743
2744   basename_lower = getStringToLower(basename);
2745   basename_length = strlen(basename_lower);
2746   prefix_length = strlen(prefix);
2747
2748   if (basename_length > prefix_length + 1 &&
2749       basename_lower[prefix_length] == '.' &&
2750       strncmp(basename_lower, prefix, prefix_length) == 0)
2751     return TRUE;
2752
2753   return FALSE;
2754 }
2755 #endif
2756
2757 static boolean fileHasSuffix(char *basename, char *suffix)
2758 {
2759   static char *basename_lower = NULL;
2760   int basename_length, suffix_length;
2761
2762   checked_free(basename_lower);
2763
2764   if (basename == NULL || suffix == NULL)
2765     return FALSE;
2766
2767   basename_lower = getStringToLower(basename);
2768   basename_length = strlen(basename_lower);
2769   suffix_length = strlen(suffix);
2770
2771   if (basename_length > suffix_length + 1 &&
2772       basename_lower[basename_length - suffix_length - 1] == '.' &&
2773       strEqual(&basename_lower[basename_length - suffix_length], suffix))
2774     return TRUE;
2775
2776   return FALSE;
2777 }
2778
2779 static boolean FileCouldBeArtwork(char *filename)
2780 {
2781   char *basename = getBaseNamePtr(filename);
2782
2783   return (!strEqual(basename, ".") &&
2784           !strEqual(basename, "..") &&
2785           !fileHasSuffix(basename, "txt") &&
2786           !fileHasSuffix(basename, "conf") &&
2787           !directoryExists(filename));
2788 }
2789
2790 boolean FileIsGraphic(char *filename)
2791 {
2792   return FileCouldBeArtwork(filename);
2793 }
2794
2795 boolean FileIsSound(char *filename)
2796 {
2797   return FileCouldBeArtwork(filename);
2798 }
2799
2800 boolean FileIsMusic(char *filename)
2801 {
2802   return FileCouldBeArtwork(filename);
2803 }
2804
2805 boolean FileIsArtworkType(char *filename, int type)
2806 {
2807   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
2808       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
2809       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
2810     return TRUE;
2811
2812   return FALSE;
2813 }
2814
2815 // ----------------------------------------------------------------------------
2816 // functions for loading artwork configuration information
2817 // ----------------------------------------------------------------------------
2818
2819 char *get_mapped_token(char *token)
2820 {
2821   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2822   static char *map_token_prefix[][2] =
2823   {
2824     { "char_procent",           "char_percent"                  },
2825     { "bd_magic_wall_filling",  "bd_magic_wall.filling"         },
2826     { "bd_magic_wall_emptying", "bd_magic_wall.emptying"        },
2827     { "bd_butterfly_left",      "bd_butterfly.left"             },
2828     { "bd_butterfly_right",     "bd_butterfly.right"            },
2829     { "bd_butterfly_up",        "bd_butterfly.up"               },
2830     { "bd_butterfly_down",      "bd_butterfly.down"             },
2831     { "bd_firefly_left",        "bd_firefly.left"               },
2832     { "bd_firefly_right",       "bd_firefly.right"              },
2833     { "bd_firefly_up",          "bd_firefly.up"                 },
2834     { "bd_firefly_down",        "bd_firefly.down"               },
2835
2836     { NULL,                                                     }
2837   };
2838   int i;
2839
2840   for (i = 0; map_token_prefix[i][0] != NULL; i++)
2841   {
2842     int len_token_prefix = strlen(map_token_prefix[i][0]);
2843
2844     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2845       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2846   }
2847
2848   // change tokens containing ".gfx" by moving the "gfx" part to the very left
2849   char *gfx_substring = ".gfx";
2850   char *gfx_prefix = "gfx.";
2851   if (strstr(token, gfx_substring) != NULL)
2852   {
2853     char *token_prefix = getStringCopy(token);
2854     char *token_gfx_pos = strstr(token_prefix, gfx_substring);
2855     char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
2856     char *mapped_token;
2857
2858     // cut off token string at ".gfx" substring position
2859     *token_gfx_pos = '\0';
2860
2861     // put together prefix "gfx." and token prefix and suffix without ".gfx"
2862     mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
2863
2864     free(token_prefix);
2865
2866     return mapped_token;
2867   }
2868
2869   return NULL;
2870 }
2871
2872 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
2873                                     char *token)
2874 {
2875   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
2876   static struct ConfigTypeInfo prefix_list[] =
2877   {
2878     { "global.anim_1"   },
2879     { "global.anim_2"   },
2880     { "global.anim_3"   },
2881     { "global.anim_4"   },
2882     { "global.anim_5"   },
2883     { "global.anim_6"   },
2884     { "global.anim_7"   },
2885     { "global.anim_8"   },
2886     { "global.anim_9"   },
2887     { "global.anim_10"  },
2888     { "global.anim_11"  },
2889     { "global.anim_12"  },
2890     { "global.anim_13"  },
2891     { "global.anim_14"  },
2892     { "global.anim_15"  },
2893     { "global.anim_16"  },
2894     { "global.anim_17"  },
2895     { "global.anim_18"  },
2896     { "global.anim_19"  },
2897     { "global.anim_20"  },
2898     { "global.anim_21"  },
2899     { "global.anim_22"  },
2900     { "global.anim_23"  },
2901     { "global.anim_24"  },
2902     { "global.anim_25"  },
2903     { "global.anim_26"  },
2904     { "global.anim_27"  },
2905     { "global.anim_28"  },
2906     { "global.anim_29"  },
2907     { "global.anim_30"  },
2908     { "global.anim_31"  },
2909     { "global.anim_32"  },
2910
2911     { NULL              }
2912   };
2913   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2914   boolean prefix_found = FALSE;
2915   int len_suffix = 0;
2916   int i;
2917
2918   // search for prefix to check if base token has to be created
2919   for (i = 0; prefix_list[i].token != NULL; i++)
2920     if (strPrefix(token, prefix_list[i].token))
2921       prefix_found = TRUE;
2922
2923   if (!prefix_found)
2924     return NULL;
2925
2926   // search for suffix (parameter) to determine base token length
2927   for (i = 0; suffix_list[i].token != NULL; i++)
2928     if (strSuffix(token, suffix_list[i].token))
2929       len_suffix = strlen(suffix_list[i].token);
2930
2931   return getStringCopyN(token, strlen(token) - len_suffix);
2932 }
2933
2934 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2935                                   struct ListNodeInfo ***, int *);
2936
2937 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2938                                            struct ConfigTypeInfo *suffix_list,
2939                                            char **ignore_tokens,
2940                                            int num_file_list_entries)
2941 {
2942   SetupFileHash *ignore_tokens_hash;
2943   struct FileInfo *file_list;
2944   int num_file_list_entries_found = 0;
2945   int num_suffix_list_entries = 0;
2946   int list_pos;
2947   int i, j;
2948
2949   // create hash from list of tokens to be ignored (for quick access)
2950   ignore_tokens_hash = newSetupFileHash();
2951   for (i = 0; ignore_tokens[i] != NULL; i++)
2952     setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
2953
2954   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2955
2956   for (i = 0; suffix_list[i].token != NULL; i++)
2957     num_suffix_list_entries++;
2958
2959   // always start with reliable default values
2960   for (i = 0; i < num_file_list_entries; i++)
2961   {
2962     file_list[i].token = NULL;
2963
2964     file_list[i].default_filename = NULL;
2965     file_list[i].filename = NULL;
2966
2967     if (num_suffix_list_entries > 0)
2968     {
2969       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2970
2971       file_list[i].default_parameter = checked_calloc(parameter_array_size);
2972       file_list[i].parameter = checked_calloc(parameter_array_size);
2973
2974       for (j = 0; j < num_suffix_list_entries; j++)
2975       {
2976         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2977         setString(&file_list[i].parameter[j], suffix_list[j].value);
2978       }
2979
2980       file_list[i].redefined = FALSE;
2981       file_list[i].fallback_to_default = FALSE;
2982       file_list[i].default_is_cloned = FALSE;
2983     }
2984   }
2985
2986   list_pos = 0;
2987
2988   for (i = 0; config_list[i].token != NULL; i++)
2989   {
2990     int len_config_token = strlen(config_list[i].token);
2991     boolean is_file_entry = TRUE;
2992
2993     for (j = 0; suffix_list[j].token != NULL; j++)
2994     {
2995       int len_suffix = strlen(suffix_list[j].token);
2996
2997       if (len_suffix < len_config_token &&
2998           strEqual(&config_list[i].token[len_config_token - len_suffix],
2999                    suffix_list[j].token))
3000       {
3001         setString(&file_list[list_pos].default_parameter[j],
3002                   config_list[i].value);
3003
3004         is_file_entry = FALSE;
3005
3006         break;
3007       }
3008     }
3009
3010     // the following tokens are no file definitions, but other config tokens
3011     if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3012       is_file_entry = FALSE;
3013
3014     if (is_file_entry)
3015     {
3016       if (i > 0)
3017         list_pos++;
3018
3019       if (list_pos >= num_file_list_entries)
3020         break;
3021
3022       file_list[list_pos].token = config_list[i].token;
3023       file_list[list_pos].default_filename = config_list[i].value;
3024     }
3025
3026     if (strSuffix(config_list[i].token, ".clone_from"))
3027       file_list[list_pos].default_is_cloned = TRUE;
3028   }
3029
3030   num_file_list_entries_found = list_pos + 1;
3031   if (num_file_list_entries_found != num_file_list_entries)
3032   {
3033     Error("---");
3034     Error("inconsistant config list information:");
3035     Error("- should be:   %d (according to 'src/conf_xxx.h')",
3036           num_file_list_entries);
3037     Error("- found to be: %d (according to 'src/conf_xxx.c')",
3038           num_file_list_entries_found);
3039
3040     Fail("please fix");
3041   }
3042
3043   freeSetupFileHash(ignore_tokens_hash);
3044
3045   return file_list;
3046 }
3047
3048 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3049 {
3050   int len_token = strlen(token);
3051   int len_suffix = strlen(suffix);
3052
3053   if (start_pos < 0)    // compare suffix from end of string
3054     start_pos += len_token;
3055
3056   if (start_pos < 0 || start_pos + len_suffix > len_token)
3057     return FALSE;
3058
3059   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3060     return FALSE;
3061
3062   if (token[start_pos + len_suffix] == '\0')
3063     return TRUE;
3064
3065   if (token[start_pos + len_suffix] == '.')
3066     return TRUE;
3067
3068   return FALSE;
3069 }
3070
3071 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
3072
3073 static void read_token_parameters(SetupFileHash *setup_file_hash,
3074                                   struct ConfigTypeInfo *suffix_list,
3075                                   struct FileInfo *file_list_entry)
3076 {
3077   // check for config token that is the base token without any suffixes
3078   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3079   char *known_token_value = KNOWN_TOKEN_VALUE;
3080   int i;
3081
3082   if (filename != NULL)
3083   {
3084     setString(&file_list_entry->filename, filename);
3085
3086     // when file definition found, set all parameters to default values
3087     for (i = 0; suffix_list[i].token != NULL; i++)
3088       setString(&file_list_entry->parameter[i], suffix_list[i].value);
3089
3090     file_list_entry->redefined = TRUE;
3091
3092     // mark config file token as well known from default config
3093     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3094   }
3095
3096   // check for config tokens that can be build by base token and suffixes
3097   for (i = 0; suffix_list[i].token != NULL; i++)
3098   {
3099     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3100     char *value = getHashEntry(setup_file_hash, token);
3101
3102     if (value != NULL)
3103     {
3104       setString(&file_list_entry->parameter[i], value);
3105
3106       // mark config file token as well known from default config
3107       setHashEntry(setup_file_hash, token, known_token_value);
3108     }
3109
3110     free(token);
3111   }
3112 }
3113
3114 static void add_dynamic_file_list_entry(struct FileInfo **list,
3115                                         int *num_list_entries,
3116                                         SetupFileHash *extra_file_hash,
3117                                         struct ConfigTypeInfo *suffix_list,
3118                                         int num_suffix_list_entries,
3119                                         char *token)
3120 {
3121   struct FileInfo *new_list_entry;
3122   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3123
3124   (*num_list_entries)++;
3125   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3126   new_list_entry = &(*list)[*num_list_entries - 1];
3127
3128   new_list_entry->token = getStringCopy(token);
3129   new_list_entry->default_filename = NULL;
3130   new_list_entry->filename = NULL;
3131   new_list_entry->parameter = checked_calloc(parameter_array_size);
3132
3133   new_list_entry->redefined = FALSE;
3134   new_list_entry->fallback_to_default = FALSE;
3135   new_list_entry->default_is_cloned = FALSE;
3136
3137   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3138 }
3139
3140 static void add_property_mapping(struct PropertyMapping **list,
3141                                  int *num_list_entries,
3142                                  int base_index, int ext1_index,
3143                                  int ext2_index, int ext3_index,
3144                                  int artwork_index)
3145 {
3146   struct PropertyMapping *new_list_entry;
3147
3148   (*num_list_entries)++;
3149   *list = checked_realloc(*list,
3150                           *num_list_entries * sizeof(struct PropertyMapping));
3151   new_list_entry = &(*list)[*num_list_entries - 1];
3152
3153   new_list_entry->base_index = base_index;
3154   new_list_entry->ext1_index = ext1_index;
3155   new_list_entry->ext2_index = ext2_index;
3156   new_list_entry->ext3_index = ext3_index;
3157
3158   new_list_entry->artwork_index = artwork_index;
3159 }
3160
3161 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3162                                           char *filename)
3163 {
3164   struct FileInfo *file_list = artwork_info->file_list;
3165   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3166   char **base_prefixes = artwork_info->base_prefixes;
3167   char **ext1_suffixes = artwork_info->ext1_suffixes;
3168   char **ext2_suffixes = artwork_info->ext2_suffixes;
3169   char **ext3_suffixes = artwork_info->ext3_suffixes;
3170   char **ignore_tokens = artwork_info->ignore_tokens;
3171   int num_file_list_entries = artwork_info->num_file_list_entries;
3172   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3173   int num_base_prefixes = artwork_info->num_base_prefixes;
3174   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3175   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3176   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3177   int num_ignore_tokens = artwork_info->num_ignore_tokens;
3178   SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3179   SetupFileHash *extra_file_hash, *empty_file_hash;
3180   char *known_token_value = KNOWN_TOKEN_VALUE;
3181   char *base_token_value = UNDEFINED_FILENAME;
3182   int i, j, k, l;
3183
3184   if (filename == NULL)
3185     return;
3186
3187   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3188     return;
3189
3190   // separate valid (defined) from empty (undefined) config token values
3191   valid_file_hash = newSetupFileHash();
3192   empty_file_hash = newSetupFileHash();
3193   BEGIN_HASH_ITERATION(setup_file_hash, itr)
3194   {
3195     char *value = HASH_ITERATION_VALUE(itr);
3196
3197     setHashEntry(*value ? valid_file_hash : empty_file_hash,
3198                  HASH_ITERATION_TOKEN(itr), value);
3199   }
3200   END_HASH_ITERATION(setup_file_hash, itr)
3201
3202   // at this point, we do not need the setup file hash anymore -- free it
3203   freeSetupFileHash(setup_file_hash);
3204
3205   // prevent changing hash while iterating over it by using a temporary copy
3206   valid_file_hash_tmp = newSetupFileHash();
3207   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3208   {
3209     setHashEntry(valid_file_hash_tmp,
3210                  HASH_ITERATION_TOKEN(itr),
3211                  HASH_ITERATION_VALUE(itr));
3212   }
3213   END_HASH_ITERATION(valid_file_hash, itr)
3214
3215   // (iterate over same temporary hash, as modifications are independent)
3216
3217   // map deprecated to current tokens (using prefix match and replace)
3218   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3219   {
3220     char *token = HASH_ITERATION_TOKEN(itr);
3221     char *mapped_token = get_mapped_token(token);
3222
3223     if (mapped_token != NULL)
3224     {
3225       char *value = HASH_ITERATION_VALUE(itr);
3226
3227       // add mapped token
3228       setHashEntry(valid_file_hash, mapped_token, value);
3229
3230       // ignore old token (by setting it to "known" keyword)
3231       setHashEntry(valid_file_hash, token, known_token_value);
3232
3233       free(mapped_token);
3234     }
3235   }
3236   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3237
3238   // add special base tokens (using prefix match and replace)
3239   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3240   {
3241     char *token = HASH_ITERATION_TOKEN(itr);
3242     char *base_token = get_special_base_token(artwork_info, token);
3243
3244     if (base_token != NULL)
3245     {
3246       // add base token only if it does not already exist
3247       if (getHashEntry(valid_file_hash, base_token) == NULL)
3248         setHashEntry(valid_file_hash, base_token, base_token_value);
3249
3250       free(base_token);
3251     }
3252   }
3253   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3254
3255   // free temporary hash used for iteration
3256   freeSetupFileHash(valid_file_hash_tmp);
3257
3258   // read parameters for all known config file tokens
3259   for (i = 0; i < num_file_list_entries; i++)
3260     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3261
3262   // set all tokens that can be ignored here to "known" keyword
3263   for (i = 0; i < num_ignore_tokens; i++)
3264     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3265
3266   // copy all unknown config file tokens to extra config hash
3267   extra_file_hash = newSetupFileHash();
3268   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3269   {
3270     char *value = HASH_ITERATION_VALUE(itr);
3271
3272     if (!strEqual(value, known_token_value))
3273       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3274   }
3275   END_HASH_ITERATION(valid_file_hash, itr)
3276
3277   // at this point, we do not need the valid file hash anymore -- free it
3278   freeSetupFileHash(valid_file_hash);
3279
3280   // now try to determine valid, dynamically defined config tokens
3281
3282   BEGIN_HASH_ITERATION(extra_file_hash, itr)
3283   {
3284     struct FileInfo **dynamic_file_list =
3285       &artwork_info->dynamic_file_list;
3286     int *num_dynamic_file_list_entries =
3287       &artwork_info->num_dynamic_file_list_entries;
3288     struct PropertyMapping **property_mapping =
3289       &artwork_info->property_mapping;
3290     int *num_property_mapping_entries =
3291       &artwork_info->num_property_mapping_entries;
3292     int current_summarized_file_list_entry =
3293       artwork_info->num_file_list_entries +
3294       artwork_info->num_dynamic_file_list_entries;
3295     char *token = HASH_ITERATION_TOKEN(itr);
3296     int len_token = strlen(token);
3297     int start_pos;
3298     boolean base_prefix_found = FALSE;
3299     boolean parameter_suffix_found = FALSE;
3300
3301     // skip all parameter definitions (handled by read_token_parameters())
3302     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3303     {
3304       int len_suffix = strlen(suffix_list[i].token);
3305
3306       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3307         parameter_suffix_found = TRUE;
3308     }
3309
3310     if (parameter_suffix_found)
3311       continue;
3312
3313     // ---------- step 0: search for matching base prefix ----------
3314
3315     start_pos = 0;
3316     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3317     {
3318       char *base_prefix = base_prefixes[i];
3319       int len_base_prefix = strlen(base_prefix);
3320       boolean ext1_suffix_found = FALSE;
3321       boolean ext2_suffix_found = FALSE;
3322       boolean ext3_suffix_found = FALSE;
3323       boolean exact_match = FALSE;
3324       int base_index = -1;
3325       int ext1_index = -1;
3326       int ext2_index = -1;
3327       int ext3_index = -1;
3328
3329       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3330
3331       if (!base_prefix_found)
3332         continue;
3333
3334       base_index = i;
3335
3336       if (start_pos + len_base_prefix == len_token)     // exact match
3337       {
3338         exact_match = TRUE;
3339
3340         add_dynamic_file_list_entry(dynamic_file_list,
3341                                     num_dynamic_file_list_entries,
3342                                     extra_file_hash,
3343                                     suffix_list,
3344                                     num_suffix_list_entries,
3345                                     token);
3346         add_property_mapping(property_mapping,
3347                              num_property_mapping_entries,
3348                              base_index, -1, -1, -1,
3349                              current_summarized_file_list_entry);
3350         continue;
3351       }
3352
3353       // ---------- step 1: search for matching first suffix ----------
3354
3355       start_pos += len_base_prefix;
3356       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3357       {
3358         char *ext1_suffix = ext1_suffixes[j];
3359         int len_ext1_suffix = strlen(ext1_suffix);
3360
3361         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3362
3363         if (!ext1_suffix_found)
3364           continue;
3365
3366         ext1_index = j;
3367
3368         if (start_pos + len_ext1_suffix == len_token)   // exact match
3369         {
3370           exact_match = TRUE;
3371
3372           add_dynamic_file_list_entry(dynamic_file_list,
3373                                       num_dynamic_file_list_entries,
3374                                       extra_file_hash,
3375                                       suffix_list,
3376                                       num_suffix_list_entries,
3377                                       token);
3378           add_property_mapping(property_mapping,
3379                                num_property_mapping_entries,
3380                                base_index, ext1_index, -1, -1,
3381                                current_summarized_file_list_entry);
3382           continue;
3383         }
3384
3385         start_pos += len_ext1_suffix;
3386       }
3387
3388       if (exact_match)
3389         break;
3390
3391       // ---------- step 2: search for matching second suffix ----------
3392
3393       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3394       {
3395         char *ext2_suffix = ext2_suffixes[k];
3396         int len_ext2_suffix = strlen(ext2_suffix);
3397
3398         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3399
3400         if (!ext2_suffix_found)
3401           continue;
3402
3403         ext2_index = k;
3404
3405         if (start_pos + len_ext2_suffix == len_token)   // exact match
3406         {
3407           exact_match = TRUE;
3408
3409           add_dynamic_file_list_entry(dynamic_file_list,
3410                                       num_dynamic_file_list_entries,
3411                                       extra_file_hash,
3412                                       suffix_list,
3413                                       num_suffix_list_entries,
3414                                       token);
3415           add_property_mapping(property_mapping,
3416                                num_property_mapping_entries,
3417                                base_index, ext1_index, ext2_index, -1,
3418                                current_summarized_file_list_entry);
3419           continue;
3420         }
3421
3422         start_pos += len_ext2_suffix;
3423       }
3424
3425       if (exact_match)
3426         break;
3427
3428       // ---------- step 3: search for matching third suffix ----------
3429
3430       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3431       {
3432         char *ext3_suffix = ext3_suffixes[l];
3433         int len_ext3_suffix = strlen(ext3_suffix);
3434
3435         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3436
3437         if (!ext3_suffix_found)
3438           continue;
3439
3440         ext3_index = l;
3441
3442         if (start_pos + len_ext3_suffix == len_token) // exact match
3443         {
3444           exact_match = TRUE;
3445
3446           add_dynamic_file_list_entry(dynamic_file_list,
3447                                       num_dynamic_file_list_entries,
3448                                       extra_file_hash,
3449                                       suffix_list,
3450                                       num_suffix_list_entries,
3451                                       token);
3452           add_property_mapping(property_mapping,
3453                                num_property_mapping_entries,
3454                                base_index, ext1_index, ext2_index, ext3_index,
3455                                current_summarized_file_list_entry);
3456           continue;
3457         }
3458       }
3459     }
3460   }
3461   END_HASH_ITERATION(extra_file_hash, itr)
3462
3463   if (artwork_info->num_dynamic_file_list_entries > 0)
3464   {
3465     artwork_info->dynamic_artwork_list =
3466       checked_calloc(artwork_info->num_dynamic_file_list_entries *
3467                      artwork_info->sizeof_artwork_list_entry);
3468   }
3469
3470   if (options.verbose && IS_PARENT_PROCESS())
3471   {
3472     SetupFileList *setup_file_list, *list;
3473     boolean dynamic_tokens_found = FALSE;
3474     boolean unknown_tokens_found = FALSE;
3475     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3476
3477     // list may be NULL for empty artwork config files
3478     setup_file_list = loadSetupFileList(filename);
3479
3480     BEGIN_HASH_ITERATION(extra_file_hash, itr)
3481     {
3482       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3483         dynamic_tokens_found = TRUE;
3484       else
3485         unknown_tokens_found = TRUE;
3486     }
3487     END_HASH_ITERATION(extra_file_hash, itr)
3488
3489     if (options.debug && dynamic_tokens_found)
3490     {
3491       Debug("config", "---");
3492       Debug("config", "dynamic token(s) found in config file:");
3493       Debug("config", "- config file: '%s'", filename);
3494
3495       for (list = setup_file_list; list != NULL; list = list->next)
3496       {
3497         char *value = getHashEntry(extra_file_hash, list->token);
3498
3499         if (value != NULL && strEqual(value, known_token_value))
3500           Debug("config", "- dynamic token: '%s'", list->token);
3501       }
3502
3503       Debug("config", "---");
3504     }
3505
3506     if (unknown_tokens_found)
3507     {
3508       Warn("---");
3509       Warn("unknown token(s) found in config file:");
3510       Warn("- config file: '%s'", filename);
3511
3512       for (list = setup_file_list; list != NULL; list = list->next)
3513       {
3514         char *value = getHashEntry(extra_file_hash, list->token);
3515
3516         if (value != NULL && !strEqual(value, known_token_value))
3517           Warn("- dynamic token: '%s'", list->token);
3518       }
3519
3520       Warn("---");
3521     }
3522
3523     if (undefined_values_found)
3524     {
3525       Warn("---");
3526       Warn("undefined values found in config file:");
3527       Warn("- config file: '%s'", filename);
3528
3529       for (list = setup_file_list; list != NULL; list = list->next)
3530       {
3531         char *value = getHashEntry(empty_file_hash, list->token);
3532
3533         if (value != NULL)
3534           Warn("- undefined value for token: '%s'", list->token);
3535       }
3536
3537       Warn("---");
3538     }
3539
3540     freeSetupFileList(setup_file_list);
3541   }
3542
3543   freeSetupFileHash(extra_file_hash);
3544   freeSetupFileHash(empty_file_hash);
3545 }
3546
3547 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3548 {
3549   struct FileInfo *file_list = artwork_info->file_list;
3550   int num_file_list_entries = artwork_info->num_file_list_entries;
3551   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3552   char *filename_base = UNDEFINED_FILENAME, *filename_local;
3553   int i, j;
3554
3555   DrawInitText("Loading artwork config", 120, FC_GREEN);
3556   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3557
3558   // always start with reliable default values
3559   for (i = 0; i < num_file_list_entries; i++)
3560   {
3561     setString(&file_list[i].filename, file_list[i].default_filename);
3562
3563     for (j = 0; j < num_suffix_list_entries; j++)
3564       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3565
3566     file_list[i].redefined = FALSE;
3567     file_list[i].fallback_to_default = FALSE;
3568   }
3569
3570   // free previous dynamic artwork file array
3571   if (artwork_info->dynamic_file_list != NULL)
3572   {
3573     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3574     {
3575       free(artwork_info->dynamic_file_list[i].token);
3576       free(artwork_info->dynamic_file_list[i].filename);
3577       free(artwork_info->dynamic_file_list[i].parameter);
3578     }
3579
3580     free(artwork_info->dynamic_file_list);
3581     artwork_info->dynamic_file_list = NULL;
3582
3583     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3584                           &artwork_info->num_dynamic_file_list_entries);
3585   }
3586
3587   // free previous property mapping
3588   if (artwork_info->property_mapping != NULL)
3589   {
3590     free(artwork_info->property_mapping);
3591
3592     artwork_info->property_mapping = NULL;
3593     artwork_info->num_property_mapping_entries = 0;
3594   }
3595
3596   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3597   {
3598     // first look for special artwork configured in level series config
3599     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3600
3601     if (fileExists(filename_base))
3602       LoadArtworkConfigFromFilename(artwork_info, filename_base);
3603   }
3604
3605   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3606
3607   if (filename_local != NULL && !strEqual(filename_base, filename_local))
3608     LoadArtworkConfigFromFilename(artwork_info, filename_local);
3609 }
3610
3611 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3612                                    struct ListNodeInfo **listnode)
3613 {
3614   if (*listnode)
3615   {
3616     char *filename = (*listnode)->source_filename;
3617
3618     if (--(*listnode)->num_references <= 0)
3619       deleteNodeFromList(&artwork_info->content_list, filename,
3620                          artwork_info->free_artwork);
3621
3622     *listnode = NULL;
3623   }
3624 }
3625
3626 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3627                                     struct ListNodeInfo **listnode,
3628                                     struct FileInfo *file_list_entry)
3629 {
3630   char *init_text[] =
3631   {
3632     "Loading graphics",
3633     "Loading sounds",
3634     "Loading music"
3635   };
3636
3637   ListNode *node;
3638   char *basename = file_list_entry->filename;
3639   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3640
3641   if (filename == NULL)
3642   {
3643     Warn("cannot find artwork file '%s'", basename);
3644
3645     basename = file_list_entry->default_filename;
3646
3647     // fail for cloned default artwork that has no default filename defined
3648     if (file_list_entry->default_is_cloned &&
3649         strEqual(basename, UNDEFINED_FILENAME))
3650     {
3651       void (*error_func)(char *, ...) = Warn;
3652
3653       // we can get away without sounds and music, but not without graphics
3654       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3655         error_func = Fail;
3656
3657       error_func("token '%s' was cloned and has no default filename",
3658                  file_list_entry->token);
3659
3660       return;
3661     }
3662
3663     // dynamic artwork has no default filename / skip empty default artwork
3664     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3665       return;
3666
3667     file_list_entry->fallback_to_default = TRUE;
3668
3669     Warn("trying default artwork file '%s'", basename);
3670
3671     filename = getCustomArtworkFilename(basename, artwork_info->type);
3672
3673     if (filename == NULL)
3674     {
3675       void (*error_func)(char *, ...) = Warn;
3676
3677       // we can get away without sounds and music, but not without graphics
3678       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3679         error_func = Fail;
3680
3681       error_func("cannot find default artwork file '%s'", basename);
3682
3683       return;
3684     }
3685   }
3686
3687   // check if the old and the new artwork file are the same
3688   if (*listnode && strEqual((*listnode)->source_filename, filename))
3689   {
3690     // The old and new artwork are the same (have the same filename and path).
3691     // This usually means that this artwork does not exist in this artwork set
3692     // and a fallback to the existing artwork is done.
3693
3694     return;
3695   }
3696
3697   // delete existing artwork file entry
3698   deleteArtworkListEntry(artwork_info, listnode);
3699
3700   // check if the new artwork file already exists in the list of artwork
3701   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3702   {
3703       *listnode = (struct ListNodeInfo *)node->content;
3704       (*listnode)->num_references++;
3705
3706       return;
3707   }
3708
3709   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3710   DrawInitText(basename, 150, FC_YELLOW);
3711
3712   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3713   {
3714     // add new artwork file entry to the list of artwork files
3715     (*listnode)->num_references = 1;
3716     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3717                   *listnode);
3718   }
3719   else
3720   {
3721     void (*error_func)(char *, ...) = Warn;
3722
3723     // we can get away without sounds and music, but not without graphics
3724     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3725       error_func = Fail;
3726
3727     error_func("cannot load artwork file '%s'", basename);
3728
3729     return;
3730   }
3731 }
3732
3733 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3734                               struct ListNodeInfo **listnode,
3735                               struct FileInfo *file_list_entry)
3736 {
3737   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3738   {
3739     deleteArtworkListEntry(artwork_info, listnode);
3740
3741     return;
3742   }
3743
3744   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3745 }
3746
3747 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3748 {
3749   struct FileInfo *file_list = artwork_info->file_list;
3750   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3751   int num_file_list_entries = artwork_info->num_file_list_entries;
3752   int num_dynamic_file_list_entries =
3753     artwork_info->num_dynamic_file_list_entries;
3754   int i;
3755
3756   print_timestamp_init("ReloadCustomArtworkList");
3757
3758   for (i = 0; i < num_file_list_entries; i++)
3759     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3760                       &file_list[i]);
3761
3762   for (i = 0; i < num_dynamic_file_list_entries; i++)
3763     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3764                       &dynamic_file_list[i]);
3765
3766   print_timestamp_done("ReloadCustomArtworkList");
3767
3768 #if 0
3769   dumpList(artwork_info->content_list);
3770 #endif
3771 }
3772
3773 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3774                                   struct ListNodeInfo ***list,
3775                                   int *num_list_entries)
3776 {
3777   int i;
3778
3779   if (*list == NULL)
3780     return;
3781
3782   for (i = 0; i < *num_list_entries; i++)
3783     deleteArtworkListEntry(artwork_info, &(*list)[i]);
3784   free(*list);
3785
3786   *list = NULL;
3787   *num_list_entries = 0;
3788 }
3789
3790 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3791 {
3792   if (artwork_info == NULL)
3793     return;
3794
3795   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3796                         &artwork_info->num_file_list_entries);
3797
3798   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3799                         &artwork_info->num_dynamic_file_list_entries);
3800 }
3801
3802
3803 // ----------------------------------------------------------------------------
3804 // functions only needed for non-Unix (non-command-line) systems
3805 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
3806 // (now also added for Windows, to create files in user data directory)
3807 // ----------------------------------------------------------------------------
3808
3809 char *getLogFilename(char *basename)
3810 {
3811   return getPath2(getMainUserGameDataDir(), basename);
3812 }
3813
3814 void OpenLogFiles(void)
3815 {
3816   int i;
3817
3818   InitMainUserDataDirectory();
3819
3820   for (i = 0; i < NUM_LOGS; i++)
3821   {
3822     if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
3823         == NULL)
3824     {
3825       program.log_file[i] = program.log_file_default[i];   // reset to default
3826
3827       Warn("cannot open file '%s' for writing: %s",
3828            program.log_filename[i], strerror(errno));
3829     }
3830
3831     // output should be unbuffered so it is not truncated in a crash
3832     setbuf(program.log_file[i], NULL);
3833   }
3834 }
3835
3836 void CloseLogFiles(void)
3837 {
3838   int i;
3839
3840   for (i = 0; i < NUM_LOGS; i++)
3841     if (program.log_file[i] != program.log_file_default[i])
3842       fclose(program.log_file[i]);
3843 }
3844
3845 void DumpLogFile(int nr)
3846 {
3847   FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
3848
3849   if (log_file == NULL)
3850     return;
3851
3852   while (!feof(log_file))
3853     fputc(fgetc(log_file), stdout);
3854
3855   fclose(log_file);
3856 }
3857
3858 void NotifyUserAboutErrorFile(void)
3859 {
3860 #if defined(PLATFORM_WIN32)
3861   char *title_text = getStringCat2(program.program_title, " Error Message");
3862   char *error_text = getStringCat2("The program was aborted due to an error; "
3863                                    "for details, see the following error file:"
3864                                    STRING_NEWLINE,
3865                                    program.log_filename[LOG_ERR_ID]);
3866
3867   MessageBox(NULL, error_text, title_text, MB_OK);
3868 #endif
3869 }
3870
3871
3872 // ----------------------------------------------------------------------------
3873 // the following is only for debugging purpose and normally not used
3874 // ----------------------------------------------------------------------------
3875
3876 #if DEBUG
3877
3878 #define DEBUG_PRINT_INIT_TIMESTAMPS             TRUE
3879 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH       10
3880
3881 #define DEBUG_NUM_TIMESTAMPS                    10
3882 #define DEBUG_TIME_IN_MICROSECONDS              0
3883
3884 #if DEBUG_TIME_IN_MICROSECONDS
3885 static double Counter_Microseconds(void)
3886 {
3887   static struct timeval base_time = { 0, 0 };
3888   struct timeval current_time;
3889   double counter;
3890
3891   gettimeofday(&current_time, NULL);
3892
3893   // reset base time in case of wrap-around
3894   if (current_time.tv_sec < base_time.tv_sec)
3895     base_time = current_time;
3896
3897   counter =
3898     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
3899     ((double)(current_time.tv_usec - base_time.tv_usec));
3900
3901   return counter;               // return microseconds since last init
3902 }
3903 #endif
3904
3905 static char *debug_print_timestamp_get_padding(int padding_size)
3906 {
3907   static char *padding = NULL;
3908   int max_padding_size = 100;
3909
3910   if (padding == NULL)
3911   {
3912     padding = checked_calloc(max_padding_size + 1);
3913     memset(padding, ' ', max_padding_size);
3914   }
3915
3916   return &padding[MAX(0, max_padding_size - padding_size)];
3917 }
3918
3919 void debug_print_timestamp(int counter_nr, char *message)
3920 {
3921   int indent_size = 8;
3922   int padding_size = 40;
3923   float timestamp_interval;
3924
3925   if (counter_nr < 0)
3926     Fail("debugging: invalid negative counter");
3927   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3928     Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3929
3930 #if DEBUG_TIME_IN_MICROSECONDS
3931   static double counter[DEBUG_NUM_TIMESTAMPS][2];
3932   char *unit = "ms";
3933
3934   counter[counter_nr][0] = Counter_Microseconds();
3935 #else
3936   static int counter[DEBUG_NUM_TIMESTAMPS][2];
3937   char *unit = "s";
3938
3939   counter[counter_nr][0] = Counter();
3940 #endif
3941
3942   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3943   counter[counter_nr][1] = counter[counter_nr][0];
3944
3945   if (message)
3946     Debug("time:init", "%s%s%s %.3f %s",
3947           debug_print_timestamp_get_padding(counter_nr * indent_size),
3948           message,
3949           debug_print_timestamp_get_padding(padding_size - strlen(message)),
3950           timestamp_interval / 1000,
3951           unit);
3952 }
3953
3954 #if 0
3955 static void debug_print_parent_only(char *format, ...)
3956 {
3957   if (!IS_PARENT_PROCESS())
3958     return;
3959
3960   if (format)
3961   {
3962     va_list ap;
3963
3964     va_start(ap, format);
3965     vprintf(format, ap);
3966     va_end(ap);
3967
3968     printf("\n");
3969   }
3970 }
3971 #endif
3972
3973 #endif  // DEBUG
3974
3975 static void print_timestamp_ext(char *message, char *mode)
3976 {
3977 #if DEBUG_PRINT_INIT_TIMESTAMPS
3978   static char *debug_message = NULL;
3979   static char *last_message = NULL;
3980   static int counter_nr = 0;
3981   int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3982
3983   checked_free(debug_message);
3984   debug_message = getStringCat3(mode, " ", message);
3985
3986   if (strEqual(mode, "INIT"))
3987   {
3988     debug_print_timestamp(counter_nr, NULL);
3989
3990     if (counter_nr + 1 < max_depth)
3991       debug_print_timestamp(counter_nr, debug_message);
3992
3993     counter_nr++;
3994
3995     debug_print_timestamp(counter_nr, NULL);
3996   }
3997   else if (strEqual(mode, "DONE"))
3998   {
3999     counter_nr--;
4000
4001     if (counter_nr + 1 < max_depth ||
4002         (counter_nr == 0 && max_depth == 1))
4003     {
4004       last_message = message;
4005
4006       if (counter_nr == 0 && max_depth == 1)
4007       {
4008         checked_free(debug_message);
4009         debug_message = getStringCat3("TIME", " ", message);
4010       }
4011
4012       debug_print_timestamp(counter_nr, debug_message);
4013     }
4014   }
4015   else if (!strEqual(mode, "TIME") ||
4016            !strEqual(message, last_message))
4017   {
4018     if (counter_nr < max_depth)
4019       debug_print_timestamp(counter_nr, debug_message);
4020   }
4021 #endif
4022 }
4023
4024 void print_timestamp_init(char *message)
4025 {
4026   print_timestamp_ext(message, "INIT");
4027 }
4028
4029 void print_timestamp_time(char *message)
4030 {
4031   print_timestamp_ext(message, "TIME");
4032 }
4033
4034 void print_timestamp_done(char *message)
4035 {
4036   print_timestamp_ext(message, "DONE");
4037 }