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