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 boolean strEqual(const char *s1, const char *s2)
1427 {
1428   return (s1 == NULL && s2 == NULL ? TRUE  :
1429           s1 == NULL && s2 != NULL ? FALSE :
1430           s1 != NULL && s2 == NULL ? FALSE :
1431           strcmp(s1, s2) == 0);
1432 }
1433
1434 boolean strEqualN(const char *s1, const char *s2, int n)
1435 {
1436   return (s1 == NULL && s2 == NULL ? TRUE  :
1437           s1 == NULL && s2 != NULL ? FALSE :
1438           s1 != NULL && s2 == NULL ? FALSE :
1439           strncmp(s1, s2, n) == 0);
1440 }
1441
1442 boolean strEqualCase(const char *s1, const char *s2)
1443 {
1444   return (s1 == NULL && s2 == NULL ? TRUE  :
1445           s1 == NULL && s2 != NULL ? FALSE :
1446           s1 != NULL && s2 == NULL ? FALSE :
1447           strcasecmp(s1, s2) == 0);
1448 }
1449
1450 boolean strEqualCaseN(const char *s1, const char *s2, int n)
1451 {
1452   return (s1 == NULL && s2 == NULL ? TRUE  :
1453           s1 == NULL && s2 != NULL ? FALSE :
1454           s1 != NULL && s2 == NULL ? FALSE :
1455           strncasecmp(s1, s2, n) == 0);
1456 }
1457
1458 boolean strPrefix(const char *s, const char *prefix)
1459 {
1460   return (s == NULL && prefix == NULL ? TRUE  :
1461           s == NULL && prefix != NULL ? FALSE :
1462           s != NULL && prefix == NULL ? FALSE :
1463           strncmp(s, prefix, strlen(prefix)) == 0);
1464 }
1465
1466 boolean strSuffix(const char *s, const char *suffix)
1467 {
1468   return (s == NULL && suffix == NULL ? TRUE  :
1469           s == NULL && suffix != NULL ? FALSE :
1470           s != NULL && suffix == NULL ? FALSE :
1471           strlen(s) < strlen(suffix)  ? FALSE :
1472           strcmp(&s[strlen(s) - strlen(suffix)], suffix) == 0);
1473 }
1474
1475 boolean strPrefixLower(const char *s, const char *prefix)
1476 {
1477   char *s_lower = getStringToLower(s);
1478   boolean match = strPrefix(s_lower, prefix);
1479
1480   free(s_lower);
1481
1482   return match;
1483 }
1484
1485 boolean strSuffixLower(const char *s, const char *suffix)
1486 {
1487   char *s_lower = getStringToLower(s);
1488   boolean match = strSuffix(s_lower, suffix);
1489
1490   free(s_lower);
1491
1492   return match;
1493 }
1494
1495 boolean isURL(const char *s)
1496 {
1497   while (*s && *s >= 'a' && *s <= 'z')
1498     s++;
1499
1500   return strPrefix(s, "://");
1501 }
1502
1503
1504 // ----------------------------------------------------------------------------
1505 // command line option handling functions
1506 // ----------------------------------------------------------------------------
1507
1508 void GetOptions(int argc, char *argv[],
1509                 void (*print_usage_function)(void),
1510                 void (*print_version_function)(void))
1511 {
1512   char *base_path = getProgramMainDataPath(argv[0], BASE_PATH);
1513   char **argvplus = checked_calloc((argc + 1) * sizeof(char **));
1514   char **options_left = &argvplus[1];
1515
1516   // replace original "argv" with null-terminated array of string pointers
1517   while (argc--)
1518     argvplus[argc] = argv[argc];
1519
1520   // initialize global program options
1521   options.server_host = NULL;
1522   options.server_port = 0;
1523
1524   options.base_directory = base_path;
1525
1526   options.level_directory    = getPath2(base_path, LEVELS_DIRECTORY);
1527   options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1528   options.sounds_directory   = getPath2(base_path, SOUNDS_DIRECTORY);
1529   options.music_directory    = getPath2(base_path, MUSIC_DIRECTORY);
1530   options.docs_directory     = getPath2(base_path, DOCS_DIRECTORY);
1531   options.conf_directory     = getPath2(base_path, CONF_DIRECTORY);
1532
1533   options.execute_command = NULL;
1534   options.tape_log_filename = NULL;
1535   options.special_flags = NULL;
1536   options.debug_mode = NULL;
1537   options.player_name = NULL;
1538   options.identifier = NULL;
1539   options.level_nr = NULL;
1540
1541   options.display_nr = 0;
1542
1543   options.mytapes = FALSE;
1544   options.serveronly = FALSE;
1545   options.network = FALSE;
1546   options.verbose = FALSE;
1547   options.debug = FALSE;
1548
1549 #if 1
1550   options.verbose = TRUE;
1551 #else
1552 #if !defined(PLATFORM_UNIX)
1553   if (*options_left == NULL)    // no options given -- enable verbose mode
1554     options.verbose = TRUE;
1555 #endif
1556 #endif
1557
1558 #if DEBUG
1559 #if defined(PLATFORM_ANDROID)
1560   options.debug = TRUE;
1561 #endif
1562 #endif
1563
1564   while (*options_left)
1565   {
1566     char option_str[MAX_OPTION_LEN];
1567     char *option = options_left[0];
1568     char *next_option = options_left[1];
1569     char *option_arg = NULL;
1570     int option_len = strlen(option);
1571
1572     if (option_len >= MAX_OPTION_LEN)
1573       FailWithHelp("unrecognized option '%s'", option);
1574
1575     strcpy(option_str, option);                 // copy argument into buffer
1576     option = option_str;
1577
1578     if (strEqual(option, "--"))                 // stop scanning arguments
1579       break;
1580
1581     if (strPrefix(option, "--"))                // treat '--' like '-'
1582       option++;
1583
1584     option_arg = strchr(option, '=');
1585     if (option_arg == NULL)                     // no '=' in option
1586       option_arg = next_option;
1587     else
1588     {
1589       *option_arg++ = '\0';                     // cut argument from option
1590       if (*option_arg == '\0')                  // no argument after '='
1591         FailWithHelp("option '%s' has invalid argument", option_str);
1592     }
1593
1594     option_len = strlen(option);
1595
1596     if (strEqual(option, "-"))
1597     {
1598       FailWithHelp("unrecognized option '%s'", option);
1599     }
1600     else if (strncmp(option, "-help", option_len) == 0)
1601     {
1602       print_usage_function();
1603
1604       exit(0);
1605     }
1606     else if (strncmp(option, "-basepath", option_len) == 0)
1607     {
1608       if (option_arg == NULL)
1609         FailWithHelp("option '%s' requires an argument", option_str);
1610
1611       options.base_directory = base_path = getStringCopy(option_arg);
1612       if (option_arg == next_option)
1613         options_left++;
1614
1615       // adjust paths for sub-directories in base directory accordingly
1616       options.level_directory    = getPath2(base_path, LEVELS_DIRECTORY);
1617       options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1618       options.sounds_directory   = getPath2(base_path, SOUNDS_DIRECTORY);
1619       options.music_directory    = getPath2(base_path, MUSIC_DIRECTORY);
1620       options.docs_directory     = getPath2(base_path, DOCS_DIRECTORY);
1621       options.conf_directory     = getPath2(base_path, CONF_DIRECTORY);
1622     }
1623     else if (strncmp(option, "-levels", option_len) == 0)
1624     {
1625       if (option_arg == NULL)
1626         FailWithHelp("option '%s' requires an argument", option_str);
1627
1628       options.level_directory = getStringCopy(option_arg);
1629       if (option_arg == next_option)
1630         options_left++;
1631     }
1632     else if (strncmp(option, "-graphics", option_len) == 0)
1633     {
1634       if (option_arg == NULL)
1635         FailWithHelp("option '%s' requires an argument", option_str);
1636
1637       options.graphics_directory = getStringCopy(option_arg);
1638       if (option_arg == next_option)
1639         options_left++;
1640     }
1641     else if (strncmp(option, "-sounds", option_len) == 0)
1642     {
1643       if (option_arg == NULL)
1644         FailWithHelp("option '%s' requires an argument", option_str);
1645
1646       options.sounds_directory = getStringCopy(option_arg);
1647       if (option_arg == next_option)
1648         options_left++;
1649     }
1650     else if (strncmp(option, "-music", option_len) == 0)
1651     {
1652       if (option_arg == NULL)
1653         FailWithHelp("option '%s' requires an argument", option_str);
1654
1655       options.music_directory = getStringCopy(option_arg);
1656       if (option_arg == next_option)
1657         options_left++;
1658     }
1659     else if (strncmp(option, "-mytapes", option_len) == 0)
1660     {
1661       options.mytapes = TRUE;
1662     }
1663     else if (strncmp(option, "-network", option_len) == 0)
1664     {
1665       options.network = TRUE;
1666     }
1667     else if (strncmp(option, "-serveronly", option_len) == 0)
1668     {
1669       options.serveronly = TRUE;
1670     }
1671     else if (strncmp(option, "-debug", option_len) == 0)
1672     {
1673       options.debug = TRUE;
1674
1675       // optionally, debug output can be limited to a specific debug mode
1676       if (option_arg != next_option)
1677         options.debug_mode = getStringCopy(option_arg);
1678     }
1679     else if (strncmp(option, "-player-name", option_len) == 0)
1680     {
1681       if (option_arg == NULL)
1682         FailWithHelp("option '%s' requires an argument", option_str);
1683
1684       options.player_name = getStringCopy(option_arg);
1685       if (option_arg == next_option)
1686         options_left++;
1687     }
1688     else if (strncmp(option, "-identifier", option_len) == 0)
1689     {
1690       if (option_arg == NULL)
1691         FailWithHelp("option '%s' requires an argument", option_str);
1692
1693       options.identifier = getStringCopy(option_arg);
1694       if (option_arg == next_option)
1695         options_left++;
1696     }
1697     else if (strncmp(option, "-level-nr", option_len) == 0)
1698     {
1699       if (option_arg == NULL)
1700         FailWithHelp("option '%s' requires an argument", option_str);
1701
1702       options.level_nr = getStringCopy(option_arg);
1703       if (option_arg == next_option)
1704         options_left++;
1705     }
1706     else if (strncmp(option, "-verbose", option_len) == 0)
1707     {
1708       options.verbose = TRUE;
1709     }
1710     else if (strncmp(option, "-version", option_len) == 0 ||
1711              strncmp(option, "-V", option_len) == 0)
1712     {
1713       print_version_function();
1714
1715       exit(0);
1716     }
1717     else if (strPrefix(option, "-D"))
1718     {
1719       options.special_flags = getStringCopy(&option[2]);
1720     }
1721     else if (strncmp(option, "-execute", option_len) == 0)
1722     {
1723       if (option_arg == NULL)
1724         FailWithHelp("option '%s' requires an argument", option_str);
1725
1726       options.execute_command = getStringCopy(option_arg);
1727       if (option_arg == next_option)
1728         options_left++;
1729
1730       // when doing batch processing, always enable verbose mode (warnings)
1731       options.verbose = TRUE;
1732     }
1733     else if (strncmp(option, "-tape_logfile", option_len) == 0)
1734     {
1735       if (option_arg == NULL)
1736         FailWithHelp("option '%s' requires an argument", option_str);
1737
1738       options.tape_log_filename = getStringCopy(option_arg);
1739       if (option_arg == next_option)
1740         options_left++;
1741     }
1742     else if (strncmp(option, "-display", option_len) == 0)
1743     {
1744       if (option_arg == NULL)
1745         FailWithHelp("option '%s' requires an argument", option_str);
1746
1747       if (option_arg == next_option)
1748         options_left++;
1749
1750       int display_nr = atoi(option_arg);
1751
1752 #if 1
1753       // dirty hack: SDL_GetNumVideoDisplays() seems broken on some systems
1754       options.display_nr = display_nr;
1755 #else
1756       options.display_nr =
1757         MAX(0, MIN(display_nr, SDL_GetNumVideoDisplays() - 1));
1758
1759       if (display_nr != options.display_nr)
1760         Warn("invalid display %d -- using display %d",
1761              display_nr, options.display_nr);
1762 #endif
1763     }
1764 #if defined(PLATFORM_MAC)
1765     else if (strPrefix(option, "-psn"))
1766     {
1767       // ignore process serial number when launched via GUI on Mac OS X
1768     }
1769 #endif
1770     else if (*option == '-')
1771     {
1772       FailWithHelp("unrecognized option '%s'", option_str);
1773     }
1774     else if (options.server_host == NULL)
1775     {
1776       options.server_host = *options_left;
1777     }
1778     else if (options.server_port == 0)
1779     {
1780       options.server_port = atoi(*options_left);
1781       if (options.server_port < 1024)
1782         FailWithHelp("bad port number '%d'", options.server_port);
1783     }
1784     else
1785       FailWithHelp("too many arguments");
1786
1787     options_left++;
1788   }
1789 }
1790
1791
1792 // ----------------------------------------------------------------------------
1793 // checked memory allocation and freeing functions
1794 // ----------------------------------------------------------------------------
1795
1796 void *checked_malloc(unsigned int size)
1797 {
1798   void *ptr;
1799
1800   ptr = malloc(size);
1801
1802   if (ptr == NULL)
1803     Fail("cannot allocate %d bytes -- out of memory", size);
1804
1805   return ptr;
1806 }
1807
1808 void *checked_calloc(unsigned int size)
1809 {
1810   void *ptr;
1811
1812   ptr = calloc(1, size);
1813
1814   if (ptr == NULL)
1815     Fail("cannot allocate %d bytes -- out of memory", size);
1816
1817   return ptr;
1818 }
1819
1820 void *checked_realloc(void *ptr, unsigned int size)
1821 {
1822   ptr = realloc(ptr, size);
1823
1824   if (ptr == NULL)
1825     Fail("cannot allocate %d bytes -- out of memory", size);
1826
1827   return ptr;
1828 }
1829
1830 void checked_free(void *ptr)
1831 {
1832   if (ptr != NULL)      // this check should be done by free() anyway
1833     free(ptr);
1834 }
1835
1836 void clear_mem(void *ptr, unsigned int size)
1837 {
1838 #if defined(PLATFORM_WINDOWS)
1839   // for unknown reason, memset() sometimes crashes when compiled with MinGW
1840   char *cptr = (char *)ptr;
1841
1842   while (size--)
1843     *cptr++ = 0;
1844 #else
1845   memset(ptr, 0, size);
1846 #endif
1847 }
1848
1849
1850 // ----------------------------------------------------------------------------
1851 // various helper functions
1852 // ----------------------------------------------------------------------------
1853
1854 void swap_numbers(int *i1, int *i2)
1855 {
1856   int help = *i1;
1857
1858   *i1 = *i2;
1859   *i2 = help;
1860 }
1861
1862 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1863 {
1864   int help_x = *x1;
1865   int help_y = *y1;
1866
1867   *x1 = *x2;
1868   *x2 = help_x;
1869
1870   *y1 = *y2;
1871   *y2 = help_y;
1872 }
1873
1874 int get_number_of_bits(int bits)
1875 {
1876   /*
1877     Counting bits set, Brian Kernighan's way
1878
1879     Brian Kernighan's method goes through as many iterations as there are set
1880     bits. So if we have a 32-bit word with only the high bit set, then it will
1881     only go once through the loop.
1882
1883     Published in 1988, the C Programming Language 2nd Ed. (by Brian W. Kernighan
1884     and Dennis M. Ritchie) mentions this in exercise 2-9.
1885     First published by Peter Wegner in CACM 3 (1960), 322.
1886   */
1887
1888   int num_bits = 0;
1889
1890   while (bits)
1891   {
1892     bits &= bits - 1;   // clear the least significant bit set
1893     num_bits++;
1894   }
1895
1896   return num_bits;
1897 }
1898
1899 /* the "put" variants of the following file access functions check for the file
1900    pointer being != NULL and return the number of bytes they have or would have
1901    written; this allows for chunk writing functions to first determine the size
1902    of the (not yet written) chunk, write the correct chunk size and finally
1903    write the chunk itself */
1904
1905 int getFile8BitInteger(File *file)
1906 {
1907   return getByteFromFile(file);
1908 }
1909
1910 int putFile8BitInteger(FILE *file, int value)
1911 {
1912   if (file != NULL)
1913     fputc(value, file);
1914
1915   return 1;
1916 }
1917
1918 int getFile16BitInteger(File *file, int byte_order)
1919 {
1920   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1921     return ((getByteFromFile(file) << 8) |
1922             (getByteFromFile(file) << 0));
1923   else           // BYTE_ORDER_LITTLE_ENDIAN
1924     return ((getByteFromFile(file) << 0) |
1925             (getByteFromFile(file) << 8));
1926 }
1927
1928 int putFile16BitInteger(FILE *file, int value, int byte_order)
1929 {
1930   if (file != NULL)
1931   {
1932     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1933     {
1934       fputc((value >> 8) & 0xff, file);
1935       fputc((value >> 0) & 0xff, file);
1936     }
1937     else           // BYTE_ORDER_LITTLE_ENDIAN
1938     {
1939       fputc((value >> 0) & 0xff, file);
1940       fputc((value >> 8) & 0xff, file);
1941     }
1942   }
1943
1944   return 2;
1945 }
1946
1947 int getFile32BitInteger(File *file, int byte_order)
1948 {
1949   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1950     return ((getByteFromFile(file) << 24) |
1951             (getByteFromFile(file) << 16) |
1952             (getByteFromFile(file) <<  8) |
1953             (getByteFromFile(file) <<  0));
1954   else           // BYTE_ORDER_LITTLE_ENDIAN
1955     return ((getByteFromFile(file) <<  0) |
1956             (getByteFromFile(file) <<  8) |
1957             (getByteFromFile(file) << 16) |
1958             (getByteFromFile(file) << 24));
1959 }
1960
1961 int putFile32BitInteger(FILE *file, int value, int byte_order)
1962 {
1963   if (file != NULL)
1964   {
1965     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1966     {
1967       fputc((value >> 24) & 0xff, file);
1968       fputc((value >> 16) & 0xff, file);
1969       fputc((value >>  8) & 0xff, file);
1970       fputc((value >>  0) & 0xff, file);
1971     }
1972     else           // BYTE_ORDER_LITTLE_ENDIAN
1973     {
1974       fputc((value >>  0) & 0xff, file);
1975       fputc((value >>  8) & 0xff, file);
1976       fputc((value >> 16) & 0xff, file);
1977       fputc((value >> 24) & 0xff, file);
1978     }
1979   }
1980
1981   return 4;
1982 }
1983
1984 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1985                      int byte_order)
1986 {
1987   const int chunk_name_length = 4;
1988
1989   // read chunk name
1990   if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1991     return FALSE;
1992
1993   if (chunk_size != NULL)
1994   {
1995     // read chunk size
1996     *chunk_size = getFile32BitInteger(file, byte_order);
1997   }
1998
1999   return (checkEndOfFile(file) ? FALSE : TRUE);
2000 }
2001
2002 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
2003                  int byte_order)
2004 {
2005   int num_bytes = 0;
2006
2007   // write chunk name
2008   if (file != NULL)
2009     fputs(chunk_name, file);
2010
2011   num_bytes += strlen(chunk_name);
2012
2013   if (chunk_size >= 0)
2014   {
2015     // write chunk size
2016     if (file != NULL)
2017       putFile32BitInteger(file, chunk_size, byte_order);
2018
2019     num_bytes += 4;
2020   }
2021
2022   return num_bytes;
2023 }
2024
2025 int getFileVersion(File *file)
2026 {
2027   int version_super = getByteFromFile(file);
2028   int version_major = getByteFromFile(file);
2029   int version_minor = getByteFromFile(file);
2030   int version_patch = getByteFromFile(file);
2031
2032   return VERSION_IDENT(version_super, version_major, version_minor,
2033                        version_patch);
2034 }
2035
2036 int putFileVersion(FILE *file, int version)
2037 {
2038   if (file != NULL)
2039   {
2040     int version_super = VERSION_SUPER(version);
2041     int version_major = VERSION_MAJOR(version);
2042     int version_minor = VERSION_MINOR(version);
2043     int version_patch = VERSION_PATCH(version);
2044
2045     fputc(version_super, file);
2046     fputc(version_major, file);
2047     fputc(version_minor, file);
2048     fputc(version_patch, file);
2049   }
2050
2051   return 4;
2052 }
2053
2054 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
2055 {
2056   int i;
2057
2058   for (i = 0; i < bytes && !checkEndOfFile(file); i++)
2059     buffer[i] = getByteFromFile(file);
2060 }
2061
2062 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
2063 {
2064   int i;
2065
2066   for (i = 0; i < bytes; i++)
2067     fputc(buffer[i], file);
2068 }
2069
2070 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
2071 {
2072   while (bytes-- && !checkEndOfFile(file))
2073     getByteFromFile(file);
2074 }
2075
2076 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
2077 {
2078   while (bytes--)
2079     fputc(0, file);
2080 }
2081
2082
2083 // ----------------------------------------------------------------------------
2084 // functions to convert between ISO-8859-1 and UTF-8
2085 // ----------------------------------------------------------------------------
2086
2087 char *getUTF8FromLatin1(char *latin1)
2088 {
2089   int max_utf8_size = 2 * strlen(latin1) + 1;
2090   char *utf8 = checked_calloc(max_utf8_size);
2091   unsigned char *src = (unsigned char *)latin1;
2092   unsigned char *dst = (unsigned char *)utf8;
2093
2094   while (*src)
2095   {
2096     if (*src < 128)             // pure 7-bit ASCII
2097     {
2098       *dst++ = *src;
2099     }
2100     else if (*src >= 160)       // non-ASCII characters
2101     {
2102       *dst++ = 194 + (*src >= 192);
2103       *dst++ = 128 + (*src & 63);
2104     }
2105     else                        // undefined in ISO-8859-1
2106     {
2107       *dst++ = '?';
2108     }
2109
2110     src++;
2111   }
2112
2113   // only use the smallest possible string buffer size
2114   utf8 = checked_realloc(utf8, strlen(utf8) + 1);
2115
2116   return utf8;
2117 }
2118
2119 char *getLatin1FromUTF8(char *utf8)
2120 {
2121   int max_latin1_size = strlen(utf8) + 1;
2122   char *latin1 = checked_calloc(max_latin1_size);
2123   unsigned char *src = (unsigned char *)utf8;
2124   unsigned char *dst = (unsigned char *)latin1;
2125
2126   while (*src)
2127   {
2128     if (*src < 128)                             // pure 7-bit ASCII
2129     {
2130       *dst++ = *src++;
2131     }
2132     else if (src[0] == 194 &&
2133              src[1] >= 128 && src[1] < 192)     // non-ASCII characters
2134     {
2135       *dst++ = src[1];
2136       src += 2;
2137     }
2138     else if (src[0] == 195 &&
2139              src[1] >= 128 && src[1] < 192)     // non-ASCII characters
2140     {
2141       *dst++ = src[1] + 64;
2142       src += 2;
2143     }
2144
2145     // all other UTF-8 characters are undefined in ISO-8859-1
2146
2147     else if (src[0] >= 192 && src[0] < 224 &&
2148              src[1] >= 128 && src[1] < 192)
2149     {
2150       *dst++ = '?';
2151       src += 2;
2152     }
2153     else if (src[0] >= 224 && src[0] < 240 &&
2154              src[1] >= 128 && src[1] < 192 &&
2155              src[2] >= 128 && src[2] < 192)
2156     {
2157       *dst++ = '?';
2158       src += 3;
2159     }
2160     else if (src[0] >= 240 && src[0] < 248 &&
2161              src[1] >= 128 && src[1] < 192 &&
2162              src[2] >= 128 && src[2] < 192 &&
2163              src[3] >= 128 && src[3] < 192)
2164     {
2165       *dst++ = '?';
2166       src += 4;
2167     }
2168     else if (src[0] >= 248 && src[0] < 252 &&
2169              src[1] >= 128 && src[1] < 192 &&
2170              src[2] >= 128 && src[2] < 192 &&
2171              src[3] >= 128 && src[3] < 192 &&
2172              src[4] >= 128 && src[4] < 192)
2173     {
2174       *dst++ = '?';
2175       src += 5;
2176     }
2177     else if (src[0] >= 252 && src[0] < 254 &&
2178              src[1] >= 128 && src[1] < 192 &&
2179              src[2] >= 128 && src[2] < 192 &&
2180              src[3] >= 128 && src[3] < 192 &&
2181              src[4] >= 128 && src[4] < 192 &&
2182              src[5] >= 128 && src[5] < 192)
2183     {
2184       *dst++ = '?';
2185       src += 6;
2186     }
2187     else
2188     {
2189       *dst++ = '?';
2190       src++;
2191     }
2192   }
2193
2194   // only use the smallest possible string buffer size
2195   latin1 = checked_realloc(latin1, strlen(latin1) + 1);
2196
2197   return latin1;
2198 }
2199
2200 int getTextEncoding(char *text)
2201 {
2202   unsigned char *src = (unsigned char *)text;
2203   int encoding = TEXT_ENCODING_ASCII;   // default: assume encoding is ASCII
2204
2205   while (*src)
2206   {
2207     if (*src >= 128)
2208       encoding = TEXT_ENCODING_UTF_8;   // non-ASCII character: assume UTF-8
2209
2210     if (*src < 128)
2211     {
2212       src++;
2213     }
2214     else if (src[0] >= 192 && src[0] < 224 &&
2215              src[1] >= 128 && src[1] < 192)
2216     {
2217       src += 2;
2218     }
2219     else if (src[0] >= 224 && src[0] < 240 &&
2220              src[1] >= 128 && src[1] < 192 &&
2221              src[2] >= 128 && src[2] < 192)
2222     {
2223       src += 3;
2224     }
2225     else if (src[0] >= 240 && src[0] < 248 &&
2226              src[1] >= 128 && src[1] < 192 &&
2227              src[2] >= 128 && src[2] < 192 &&
2228              src[3] >= 128 && src[3] < 192)
2229     {
2230       src += 4;
2231     }
2232     else if (src[0] >= 248 && src[0] < 252 &&
2233              src[1] >= 128 && src[1] < 192 &&
2234              src[2] >= 128 && src[2] < 192 &&
2235              src[3] >= 128 && src[3] < 192 &&
2236              src[4] >= 128 && src[4] < 192)
2237     {
2238       src += 5;
2239     }
2240     else if (src[0] >= 252 && src[0] < 254 &&
2241              src[1] >= 128 && src[1] < 192 &&
2242              src[2] >= 128 && src[2] < 192 &&
2243              src[3] >= 128 && src[3] < 192 &&
2244              src[4] >= 128 && src[4] < 192 &&
2245              src[5] >= 128 && src[5] < 192)
2246     {
2247       src += 6;
2248     }
2249     else
2250     {
2251       return TEXT_ENCODING_UNKNOWN;     // non-UTF-8 character: unknown encoding
2252     }
2253   }
2254
2255   return encoding;
2256 }
2257
2258
2259 // ----------------------------------------------------------------------------
2260 // functions for JSON handling
2261 // ----------------------------------------------------------------------------
2262
2263 char *getEscapedJSON(char *s)
2264 {
2265   int max_json_size = 2 * strlen(s) + 1;
2266   char *json = checked_calloc(max_json_size);
2267   unsigned char *src = (unsigned char *)s;
2268   unsigned char *dst = (unsigned char *)json;
2269   char *escaped[256] =
2270   {
2271     ['\b'] = "\\b",
2272     ['\f'] = "\\f",
2273     ['\n'] = "\\n",
2274     ['\r'] = "\\r",
2275     ['\t'] = "\\t",
2276     ['\"'] = "\\\"",
2277     ['\\'] = "\\\\",
2278   };
2279
2280   while (*src)
2281   {
2282     if (escaped[*src] != NULL)
2283     {
2284       char *esc = escaped[*src++];
2285
2286       while (*esc)
2287         *dst++ = *esc++;
2288     }
2289     else
2290     {
2291       *dst++ = *src++;
2292     }
2293   }
2294
2295   // only use the smallest possible string buffer size
2296   json = checked_realloc(json, strlen(json) + 1);
2297
2298   return json;
2299 }
2300
2301
2302 // ----------------------------------------------------------------------------
2303 // functions to translate key identifiers between different format
2304 // ----------------------------------------------------------------------------
2305
2306 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
2307 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
2308 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
2309 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
2310
2311 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
2312 {
2313   static struct
2314   {
2315     Key key;
2316     char *x11name;
2317     char *name;
2318   } translate_key[] =
2319   {
2320     // return and escape keys
2321     { KSYM_Return,      "XK_Return",            "return" },
2322     { KSYM_Escape,      "XK_Escape",            "escape" },
2323
2324     // normal cursor keys
2325     { KSYM_Left,        "XK_Left",              "cursor left" },
2326     { KSYM_Right,       "XK_Right",             "cursor right" },
2327     { KSYM_Up,          "XK_Up",                "cursor up" },
2328     { KSYM_Down,        "XK_Down",              "cursor down" },
2329
2330     // keypad cursor keys
2331 #ifdef KSYM_KP_Left
2332     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
2333     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
2334     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
2335     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
2336 #endif
2337
2338     // other keypad keys
2339 #ifdef KSYM_KP_Enter
2340     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
2341     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
2342     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
2343     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
2344     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
2345     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
2346 #endif
2347
2348     // modifier keys
2349     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
2350     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
2351     { KSYM_Control_L,   "XK_Control_L",         "left control" },
2352     { KSYM_Control_R,   "XK_Control_R",         "right control" },
2353     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
2354     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
2355     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
2356     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
2357     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, // Alt-R
2358     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   // Ctrl-R
2359
2360     // some special keys
2361     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
2362     { KSYM_Delete,      "XK_Delete",            "delete" },
2363     { KSYM_Insert,      "XK_Insert",            "insert" },
2364     { KSYM_Tab,         "XK_Tab",               "tab" },
2365     { KSYM_Home,        "XK_Home",              "home" },
2366     { KSYM_End,         "XK_End",               "end" },
2367     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
2368     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
2369
2370     { KSYM_Select,      "XK_Select",            "select" },
2371     { KSYM_Menu,        "XK_Menu",              "menu" },        // menu key
2372     { KSYM_Back,        "XK_Back",              "back" },        // back key
2373     { KSYM_PlayPause,   "XK_PlayPause",         "play/pause" },
2374 #if defined(PLATFORM_ANDROID)
2375     { KSYM_Rewind,      "XK_Rewind",            "rewind" },
2376     { KSYM_FastForward, "XK_FastForward",       "fast forward" },
2377 #endif
2378
2379     // ASCII 0x20 to 0x40 keys (except numbers)
2380     { KSYM_space,       "XK_space",             "space" },
2381     { KSYM_exclam,      "XK_exclam",            "!" },
2382     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
2383     { KSYM_numbersign,  "XK_numbersign",        "#" },
2384     { KSYM_dollar,      "XK_dollar",            "$" },
2385     { KSYM_percent,     "XK_percent",           "%" },
2386     { KSYM_ampersand,   "XK_ampersand",         "&" },
2387     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
2388     { KSYM_parenleft,   "XK_parenleft",         "(" },
2389     { KSYM_parenright,  "XK_parenright",        ")" },
2390     { KSYM_asterisk,    "XK_asterisk",          "*" },
2391     { KSYM_plus,        "XK_plus",              "+" },
2392     { KSYM_comma,       "XK_comma",             "," },
2393     { KSYM_minus,       "XK_minus",             "-" },
2394     { KSYM_period,      "XK_period",            "." },
2395     { KSYM_slash,       "XK_slash",             "/" },
2396     { KSYM_colon,       "XK_colon",             ":" },
2397     { KSYM_semicolon,   "XK_semicolon",         ";" },
2398     { KSYM_less,        "XK_less",              "<" },
2399     { KSYM_equal,       "XK_equal",             "=" },
2400     { KSYM_greater,     "XK_greater",           ">" },
2401     { KSYM_question,    "XK_question",          "?" },
2402     { KSYM_at,          "XK_at",                "@" },
2403
2404     // more ASCII keys
2405     { KSYM_bracketleft, "XK_bracketleft",       "[" },
2406     { KSYM_backslash,   "XK_backslash",         "\\" },
2407     { KSYM_bracketright,"XK_bracketright",      "]" },
2408     { KSYM_asciicircum, "XK_asciicircum",       "^" },
2409     { KSYM_underscore,  "XK_underscore",        "_" },
2410     { KSYM_grave,       "XK_grave",             "grave" },
2411     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
2412     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
2413     { KSYM_bar,         "XK_bar",               "bar" },
2414     { KSYM_braceright,  "XK_braceright",        "brace right" },
2415     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
2416
2417     // special (non-ASCII) keys
2418     { KSYM_degree,      "XK_degree",            "degree" },
2419     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "A umlaut" },
2420     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "O umlaut" },
2421     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "U umlaut" },
2422     { KSYM_adiaeresis,  "XK_adiaeresis",        "a umlaut" },
2423     { KSYM_odiaeresis,  "XK_odiaeresis",        "o umlaut" },
2424     { KSYM_udiaeresis,  "XK_udiaeresis",        "u umlaut" },
2425     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
2426
2427     // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2428     { KSYM_degree,      "XK_degree",            "\xc2\xb0" },
2429     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "\xc3\x84" },
2430     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "\xc3\x96" },
2431     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "\xc3\x9c" },
2432     { KSYM_adiaeresis,  "XK_adiaeresis",        "\xc3\xa4" },
2433     { KSYM_odiaeresis,  "XK_odiaeresis",        "\xc3\xb6" },
2434     { KSYM_udiaeresis,  "XK_udiaeresis",        "\xc3\xbc" },
2435     { KSYM_ssharp,      "XK_ssharp",            "\xc3\x9f" },
2436
2437     // other keys (for reverse mapping only)
2438     { KSYM_space,       "XK_space",             " " },
2439
2440     // keypad keys are not in numerical order in SDL2
2441     { KSYM_KP_0,        "XK_KP_0",              "keypad 0" },
2442     { KSYM_KP_1,        "XK_KP_1",              "keypad 1" },
2443     { KSYM_KP_2,        "XK_KP_2",              "keypad 2" },
2444     { KSYM_KP_3,        "XK_KP_3",              "keypad 3" },
2445     { KSYM_KP_4,        "XK_KP_4",              "keypad 4" },
2446     { KSYM_KP_5,        "XK_KP_5",              "keypad 5" },
2447     { KSYM_KP_6,        "XK_KP_6",              "keypad 6" },
2448     { KSYM_KP_7,        "XK_KP_7",              "keypad 7" },
2449     { KSYM_KP_8,        "XK_KP_8",              "keypad 8" },
2450     { KSYM_KP_9,        "XK_KP_9",              "keypad 9" },
2451
2452     // end-of-array identifier
2453     { 0,                NULL,                   NULL }
2454   };
2455
2456   int i;
2457
2458   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2459   {
2460     static char name_buffer[30];
2461     Key key = *keysym;
2462
2463     if (key >= KSYM_A && key <= KSYM_Z)
2464       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2465     else if (key >= KSYM_a && key <= KSYM_z)
2466       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2467     else if (key >= KSYM_0 && key <= KSYM_9)
2468       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2469     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2470       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2471     else if (key == KSYM_UNDEFINED)
2472       strcpy(name_buffer, "(undefined)");
2473     else
2474     {
2475       i = 0;
2476
2477       do
2478       {
2479         if (key == translate_key[i].key)
2480         {
2481           strcpy(name_buffer, translate_key[i].name);
2482           break;
2483         }
2484       }
2485       while (translate_key[++i].name);
2486
2487       if (!translate_key[i].name)
2488         strcpy(name_buffer, "(unknown)");
2489     }
2490
2491     *name = name_buffer;
2492   }
2493   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2494   {
2495     static char name_buffer[30];
2496     Key key = *keysym;
2497
2498     if (key >= KSYM_A && key <= KSYM_Z)
2499       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2500     else if (key >= KSYM_a && key <= KSYM_z)
2501       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2502     else if (key >= KSYM_0 && key <= KSYM_9)
2503       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2504     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2505       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2506     else if (key == KSYM_UNDEFINED)
2507       strcpy(name_buffer, "[undefined]");
2508     else
2509     {
2510       i = 0;
2511
2512       do
2513       {
2514         if (key == translate_key[i].key)
2515         {
2516           strcpy(name_buffer, translate_key[i].x11name);
2517           break;
2518         }
2519       }
2520       while (translate_key[++i].x11name);
2521
2522       if (!translate_key[i].x11name)
2523         sprintf(name_buffer, "0x%04x", (unsigned int)key);
2524     }
2525
2526     *x11name = name_buffer;
2527   }
2528   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2529   {
2530     Key key = KSYM_UNDEFINED;
2531     char *name_ptr = *name;
2532
2533     if (strlen(*name) == 1)
2534     {
2535       char c = name_ptr[0];
2536
2537       if (c >= 'A' && c <= 'Z')
2538         key = KSYM_A + (Key)(c - 'A');
2539       else if (c >= 'a' && c <= 'z')
2540         key = KSYM_a + (Key)(c - 'a');
2541       else if (c >= '0' && c <= '9')
2542         key = KSYM_0 + (Key)(c - '0');
2543     }
2544
2545     if (key == KSYM_UNDEFINED)
2546     {
2547       i = 0;
2548
2549       do
2550       {
2551         if (strEqual(translate_key[i].name, *name))
2552         {
2553           key = translate_key[i].key;
2554           break;
2555         }
2556       }
2557       while (translate_key[++i].x11name);
2558     }
2559
2560     if (key == KSYM_UNDEFINED)
2561       Warn("getKeyFromKeyName(): not completely implemented");
2562
2563     *keysym = key;
2564   }
2565   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2566   {
2567     Key key = KSYM_UNDEFINED;
2568     char *name_ptr = *x11name;
2569
2570     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2571     {
2572       char c = name_ptr[3];
2573
2574       if (c >= 'A' && c <= 'Z')
2575         key = KSYM_A + (Key)(c - 'A');
2576       else if (c >= 'a' && c <= 'z')
2577         key = KSYM_a + (Key)(c - 'a');
2578       else if (c >= '0' && c <= '9')
2579         key = KSYM_0 + (Key)(c - '0');
2580     }
2581     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2582     {
2583       char c1 = name_ptr[4];
2584       char c2 = name_ptr[5];
2585       int d = 0;
2586
2587       if ((c1 >= '0' && c1 <= '9') &&
2588           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2589         d = atoi(&name_ptr[4]);
2590
2591       if (d >= 1 && d <= KSYM_NUM_FKEYS)
2592         key = KSYM_F1 + (Key)(d - 1);
2593     }
2594     else if (strPrefix(name_ptr, "XK_"))
2595     {
2596       i = 0;
2597
2598       do
2599       {
2600         if (strEqual(name_ptr, translate_key[i].x11name))
2601         {
2602           key = translate_key[i].key;
2603           break;
2604         }
2605       }
2606       while (translate_key[++i].x11name);
2607     }
2608     else if (strPrefix(name_ptr, "0x"))
2609     {
2610       unsigned int value = 0;
2611
2612       name_ptr += 2;
2613
2614       while (name_ptr)
2615       {
2616         char c = *name_ptr++;
2617         int d = -1;
2618
2619         if (c >= '0' && c <= '9')
2620           d = (int)(c - '0');
2621         else if (c >= 'a' && c <= 'f')
2622           d = (int)(c - 'a' + 10);
2623         else if (c >= 'A' && c <= 'F')
2624           d = (int)(c - 'A' + 10);
2625
2626         if (d == -1)
2627         {
2628           value = -1;
2629           break;
2630         }
2631
2632         value = value * 16 + d;
2633       }
2634
2635       if (value != -1)
2636         key = (Key)value;
2637     }
2638
2639     *keysym = key;
2640   }
2641 }
2642
2643 char *getKeyNameFromKey(Key key)
2644 {
2645   char *name;
2646
2647   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2648   return name;
2649 }
2650
2651 char *getX11KeyNameFromKey(Key key)
2652 {
2653   char *x11name;
2654
2655   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2656   return x11name;
2657 }
2658
2659 Key getKeyFromKeyName(char *name)
2660 {
2661   Key key;
2662
2663   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2664   return key;
2665 }
2666
2667 Key getKeyFromX11KeyName(char *x11name)
2668 {
2669   Key key;
2670
2671   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2672   return key;
2673 }
2674
2675 char getCharFromKey(Key key)
2676 {
2677   static struct
2678   {
2679     Key key;
2680     byte key_char;
2681   } translate_key_char[] =
2682   {
2683     // special (non-ASCII) keys (ISO-8859-1)
2684     { KSYM_degree,      CHAR_BYTE_DEGREE        },
2685     { KSYM_Adiaeresis,  CHAR_BYTE_UMLAUT_A      },
2686     { KSYM_Odiaeresis,  CHAR_BYTE_UMLAUT_O      },
2687     { KSYM_Udiaeresis,  CHAR_BYTE_UMLAUT_U      },
2688     { KSYM_adiaeresis,  CHAR_BYTE_UMLAUT_a      },
2689     { KSYM_odiaeresis,  CHAR_BYTE_UMLAUT_o      },
2690     { KSYM_udiaeresis,  CHAR_BYTE_UMLAUT_u      },
2691     { KSYM_ssharp,      CHAR_BYTE_SHARP_S       },
2692
2693     // end-of-array identifier
2694     { 0,                0                       }
2695   };
2696
2697   char *keyname = getKeyNameFromKey(key);
2698   char c = 0;
2699
2700   if (strlen(keyname) == 1)
2701     c = keyname[0];
2702   else if (strEqual(keyname, "space"))
2703     c = ' ';
2704   else
2705   {
2706     int i = 0;
2707
2708     do
2709     {
2710       if (key == translate_key_char[i].key)
2711       {
2712         c = translate_key_char[i].key_char;
2713
2714         break;
2715       }
2716     }
2717     while (translate_key_char[++i].key_char);
2718   }
2719
2720   return c;
2721 }
2722
2723 char getValidConfigValueChar(char c)
2724 {
2725   if (c == '#' ||       // used to mark comments
2726       c == '\\')        // used to mark continued lines
2727     c = 0;
2728
2729   return c;
2730 }
2731
2732
2733 // ----------------------------------------------------------------------------
2734 // functions to translate string identifiers to integer or boolean value
2735 // ----------------------------------------------------------------------------
2736
2737 int get_integer_from_string(char *s)
2738 {
2739   // check for the most common case first
2740   if (s[0] >= '0' && s[0] <= '9')
2741     return atoi(s);
2742
2743   char *s_lower = getStringToLower(s);
2744   int result = -1;
2745
2746   if (strEqual(s_lower, "false") ||
2747       strEqual(s_lower, "no") ||
2748       strEqual(s_lower, "off"))
2749     result = 0;
2750   else if (strEqual(s_lower, "true") ||
2751            strEqual(s_lower, "yes") ||
2752            strEqual(s_lower, "on"))
2753     result = 1;
2754   else
2755     result = atoi(s);
2756
2757   free(s_lower);
2758
2759   return result;
2760 }
2761
2762 boolean get_boolean_from_string(char *s)
2763 {
2764   char *s_lower = getStringToLower(s);
2765   boolean result = FALSE;
2766
2767   if (strEqual(s_lower, "true") ||
2768       strEqual(s_lower, "yes") ||
2769       strEqual(s_lower, "on") ||
2770       get_integer_from_string(s) == 1)
2771     result = TRUE;
2772
2773   free(s_lower);
2774
2775   return result;
2776 }
2777
2778 int get_switch3_from_string(char *s)
2779 {
2780   char *s_lower = getStringToLower(s);
2781   int result = FALSE;
2782
2783   if (strEqual(s_lower, "true") ||
2784       strEqual(s_lower, "yes") ||
2785       strEqual(s_lower, "on") ||
2786       get_integer_from_string(s) == 1)
2787     result = TRUE;
2788   else if (strEqual(s_lower, "auto"))
2789     result = AUTO;
2790
2791   free(s_lower);
2792
2793   return result;
2794 }
2795
2796 int get_player_nr_from_string(char *s)
2797 {
2798   static char *player_text[] =
2799   {
2800     "player_1",
2801     "player_2",
2802     "player_3",
2803     "player_4",
2804
2805     NULL
2806   };
2807
2808   char *s_lower = getStringToLower(s);
2809   int result = 0;
2810   int i;
2811
2812   for (i = 0; player_text[i] != NULL; i++)
2813     if (strEqual(s_lower, player_text[i]))
2814       result = i;
2815
2816   free(s_lower);
2817
2818   return result;
2819 }
2820
2821
2822 // ----------------------------------------------------------------------------
2823 // functions for generic lists
2824 // ----------------------------------------------------------------------------
2825
2826 ListNode *newListNode(void)
2827 {
2828   return checked_calloc(sizeof(ListNode));
2829 }
2830
2831 void addNodeToList(ListNode **node_first, char *key, void *content)
2832 {
2833   ListNode *node_new = newListNode();
2834
2835   node_new->key = getStringCopy(key);
2836   node_new->content = content;
2837   node_new->next = *node_first;
2838
2839   if (*node_first)
2840     (*node_first)->prev = node_new;
2841
2842   *node_first = node_new;
2843 }
2844
2845 void deleteNodeFromList(ListNode **node_first, char *key,
2846                         void (*destructor_function)(void *))
2847 {
2848   if (node_first == NULL || *node_first == NULL)
2849     return;
2850
2851   if (strEqual((*node_first)->key, key))
2852   {
2853     // after first recursion, (*node_first)->prev->next == *node_first,
2854     // so *node_first would be overwritten with (*node_first)->next
2855     // => use a copy of *node_first (and later of (*node_first)->next)
2856     ListNode *node = *node_first;
2857     ListNode *node_next = node->next;
2858
2859     checked_free(node->key);
2860
2861     if (destructor_function)
2862       destructor_function(node->content);
2863
2864     if (node->prev)
2865       node->prev->next = node->next;
2866
2867     if (node->next)
2868       node->next->prev = node->prev;
2869
2870     checked_free(node);
2871
2872     // after removing node, set list pointer to next valid list node
2873     // (this is important if the first node of the list was deleted)
2874     *node_first = node_next;
2875   }
2876   else
2877   {
2878     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2879   }
2880 }
2881
2882 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2883 {
2884   if (node_first == NULL)
2885     return NULL;
2886
2887   if (strEqual(node_first->key, key))
2888     return node_first;
2889   else
2890     return getNodeFromKey(node_first->next, key);
2891 }
2892
2893 int getNumNodes(ListNode *node_first)
2894 {
2895   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2896 }
2897
2898 #if 0
2899 static void dumpList(ListNode *node_first)
2900 {
2901   ListNode *node = node_first;
2902
2903   while (node)
2904   {
2905     Debug("internal:dumpList", "['%s' (%d)]", node->key,
2906           ((struct ListNodeInfo *)node->content)->num_references);
2907     node = node->next;
2908   }
2909
2910   Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2911 }
2912 #endif
2913
2914
2915 // ----------------------------------------------------------------------------
2916 // functions for file handling
2917 // ----------------------------------------------------------------------------
2918
2919 #define MAX_BUFFER_SIZE                 4096
2920
2921 File *openFile(char *filename, char *mode)
2922 {
2923   File *file = checked_calloc(sizeof(File));
2924
2925   file->file = fopen(filename, mode);
2926
2927   if (file->file != NULL)
2928   {
2929     file->filename = getStringCopy(filename);
2930
2931     return file;
2932   }
2933
2934 #if defined(PLATFORM_ANDROID)
2935   file->asset_file = SDL_RWFromFile(filename, mode);
2936
2937   if (file->asset_file != NULL)
2938   {
2939     file->file_is_asset = TRUE;
2940     file->filename = getStringCopy(filename);
2941
2942     return file;
2943   }
2944 #endif
2945
2946   checked_free(file);
2947
2948   return NULL;
2949 }
2950
2951 int closeFile(File *file)
2952 {
2953   if (file == NULL)
2954     return -1;
2955
2956   int result = 0;
2957
2958 #if defined(PLATFORM_ANDROID)
2959   if (file->asset_file)
2960     result = SDL_RWclose(file->asset_file);
2961 #endif
2962
2963   if (file->file)
2964     result = fclose(file->file);
2965
2966   checked_free(file->filename);
2967   checked_free(file);
2968
2969   return result;
2970 }
2971
2972 int checkEndOfFile(File *file)
2973 {
2974 #if defined(PLATFORM_ANDROID)
2975   if (file->file_is_asset)
2976     return file->end_of_file;
2977 #endif
2978
2979   return feof(file->file);
2980 }
2981
2982 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2983 {
2984 #if defined(PLATFORM_ANDROID)
2985   if (file->file_is_asset)
2986   {
2987     if (file->end_of_file)
2988       return 0;
2989
2990     size_t num_items_read =
2991       SDL_RWread(file->asset_file, buffer, item_size, num_items);
2992
2993     if (num_items_read < num_items)
2994       file->end_of_file = TRUE;
2995
2996     return num_items_read;
2997   }
2998 #endif
2999
3000   return fread(buffer, item_size, num_items, file->file);
3001 }
3002
3003 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
3004 {
3005   return fwrite(buffer, item_size, num_items, file->file);
3006 }
3007
3008 int seekFile(File *file, long offset, int whence)
3009 {
3010 #if defined(PLATFORM_ANDROID)
3011   if (file->file_is_asset)
3012   {
3013     int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
3014                       whence == SEEK_CUR ? RW_SEEK_CUR :
3015                       whence == SEEK_END ? RW_SEEK_END : 0);
3016
3017     return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
3018   }
3019 #endif
3020
3021   return fseek(file->file, offset, whence);
3022 }
3023
3024 int getByteFromFile(File *file)
3025 {
3026 #if defined(PLATFORM_ANDROID)
3027   if (file->file_is_asset)
3028   {
3029     if (file->end_of_file)
3030       return EOF;
3031
3032     byte c;
3033     size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
3034
3035     if (num_bytes_read < 1)
3036       file->end_of_file = TRUE;
3037
3038     return (file->end_of_file ? EOF : (int)c);
3039   }
3040 #endif
3041
3042   return fgetc(file->file);
3043 }
3044
3045 char *getStringFromFile(File *file, char *line, int size)
3046 {
3047 #if defined(PLATFORM_ANDROID)
3048   if (file->file_is_asset)
3049   {
3050     if (file->end_of_file)
3051       return NULL;
3052
3053     char *line_ptr = line;
3054     int num_bytes_read = 0;
3055
3056     while (num_bytes_read < size - 1 &&
3057            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
3058            *line_ptr++ != '\n')
3059       num_bytes_read++;
3060
3061     *line_ptr = '\0';
3062
3063     if (strlen(line) == 0)
3064     {
3065       file->end_of_file = TRUE;
3066
3067       return NULL;
3068     }
3069
3070     return line;
3071   }
3072 #endif
3073
3074   return fgets(line, size, file->file);
3075 }
3076
3077 int copyFile(char *filename_from, char *filename_to)
3078 {
3079   File *file_from, *file_to;
3080
3081   if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
3082   {
3083     return -1;
3084   }
3085
3086   if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
3087   {
3088     closeFile(file_from);
3089
3090     return -1;
3091   }
3092
3093   while (!checkEndOfFile(file_from))
3094   {
3095     byte buffer[MAX_BUFFER_SIZE];
3096     size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
3097
3098     writeFile(file_to, buffer, 1, bytes_read);
3099   }
3100
3101   closeFile(file_from);
3102   closeFile(file_to);
3103
3104   return 0;
3105 }
3106
3107 boolean touchFile(char *filename)
3108 {
3109   FILE *file;
3110
3111   if (!(file = fopen(filename, MODE_WRITE)))
3112   {
3113     Warn("cannot touch file '%s'", filename);
3114
3115     return FALSE;
3116   }
3117
3118   fclose(file);
3119
3120   return TRUE;
3121 }
3122
3123
3124 // ----------------------------------------------------------------------------
3125 // functions for directory handling
3126 // ----------------------------------------------------------------------------
3127
3128 Directory *openDirectory(char *dir_name)
3129 {
3130   Directory *dir = checked_calloc(sizeof(Directory));
3131
3132   dir->dir = opendir(dir_name);
3133
3134   if (dir->dir != NULL)
3135   {
3136     dir->filename = getStringCopy(dir_name);
3137
3138     return dir;
3139   }
3140
3141 #if defined(PLATFORM_ANDROID)
3142   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3143
3144   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3145
3146   checked_free(asset_toc_filename);
3147
3148   if (dir->asset_toc_file != NULL)
3149   {
3150     dir->directory_is_asset = TRUE;
3151     dir->filename = getStringCopy(dir_name);
3152
3153     return dir;
3154   }
3155 #endif
3156
3157   checked_free(dir);
3158
3159   return NULL;
3160 }
3161
3162 int closeDirectory(Directory *dir)
3163 {
3164   if (dir == NULL)
3165     return -1;
3166
3167   int result = 0;
3168
3169 #if defined(PLATFORM_ANDROID)
3170   if (dir->asset_toc_file)
3171     result = SDL_RWclose(dir->asset_toc_file);
3172 #endif
3173
3174   if (dir->dir)
3175     result = closedir(dir->dir);
3176
3177   if (dir->dir_entry)
3178     freeDirectoryEntry(dir->dir_entry);
3179
3180   checked_free(dir->filename);
3181   checked_free(dir);
3182
3183   return result;
3184 }
3185
3186 DirectoryEntry *readDirectory(Directory *dir)
3187 {
3188   if (dir->dir_entry)
3189     freeDirectoryEntry(dir->dir_entry);
3190
3191   dir->dir_entry = NULL;
3192
3193 #if defined(PLATFORM_ANDROID)
3194   if (dir->directory_is_asset)
3195   {
3196     char line[MAX_LINE_LEN];
3197     char *line_ptr = line;
3198     int num_bytes_read = 0;
3199
3200     while (num_bytes_read < MAX_LINE_LEN - 1 &&
3201            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
3202            *line_ptr != '\n')
3203     {
3204       line_ptr++;
3205       num_bytes_read++;
3206     }
3207
3208     *line_ptr = '\0';
3209
3210     if (strlen(line) == 0)
3211       return NULL;
3212
3213     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3214
3215     dir->dir_entry->is_directory = FALSE;
3216     if (line[strlen(line) - 1] == '/')
3217     {
3218       dir->dir_entry->is_directory = TRUE;
3219
3220       line[strlen(line) - 1] = '\0';
3221     }
3222
3223     dir->dir_entry->basename = getStringCopy(line);
3224     dir->dir_entry->filename = getPath2(dir->filename, line);
3225
3226     return dir->dir_entry;
3227   }
3228 #endif
3229
3230   struct dirent *dir_entry = readdir(dir->dir);
3231
3232   if (dir_entry == NULL)
3233     return NULL;
3234
3235   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
3236
3237   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
3238   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
3239
3240   struct stat file_status;
3241
3242   dir->dir_entry->is_directory =
3243     (stat(dir->dir_entry->filename, &file_status) == 0 &&
3244      S_ISDIR(file_status.st_mode));
3245
3246   return dir->dir_entry;
3247 }
3248
3249 void freeDirectoryEntry(DirectoryEntry *dir_entry)
3250 {
3251   if (dir_entry == NULL)
3252     return;
3253
3254   checked_free(dir_entry->basename);
3255   checked_free(dir_entry->filename);
3256   checked_free(dir_entry);
3257 }
3258
3259
3260 // ----------------------------------------------------------------------------
3261 // functions for checking files and filenames
3262 // ----------------------------------------------------------------------------
3263
3264 boolean directoryExists(const char *dir_name)
3265 {
3266   if (dir_name == NULL)
3267     return FALSE;
3268
3269   struct stat file_status;
3270   boolean success = (stat(dir_name, &file_status) == 0 &&
3271                      S_ISDIR(file_status.st_mode));
3272
3273 #if defined(PLATFORM_ANDROID)
3274   if (!success)
3275   {
3276     // this might be an asset directory; check by trying to open toc file
3277     char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
3278     SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
3279
3280     checked_free(asset_toc_filename);
3281
3282     success = (file != NULL);
3283
3284     if (success)
3285       SDL_RWclose(file);
3286   }
3287 #endif
3288
3289   return success;
3290 }
3291
3292 boolean fileExists(const char *filename)
3293 {
3294   if (filename == NULL)
3295     return FALSE;
3296
3297   boolean success = (access(filename, F_OK) == 0);
3298
3299 #if defined(PLATFORM_ANDROID)
3300   if (!success)
3301   {
3302     // this might be an asset file; check by trying to open it
3303     SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
3304
3305     success = (file != NULL);
3306
3307     if (success)
3308       SDL_RWclose(file);
3309   }
3310 #endif
3311
3312   return success;
3313 }
3314
3315 #if 0
3316 static boolean fileHasPrefix(const char *basename, const char *prefix)
3317 {
3318   static char *basename_lower = NULL;
3319   int basename_length, prefix_length;
3320
3321   checked_free(basename_lower);
3322
3323   if (basename == NULL || prefix == NULL)
3324     return FALSE;
3325
3326   basename_lower = getStringToLower(basename);
3327   basename_length = strlen(basename_lower);
3328   prefix_length = strlen(prefix);
3329
3330   if (basename_length > prefix_length + 1 &&
3331       basename_lower[prefix_length] == '.' &&
3332       strncmp(basename_lower, prefix, prefix_length) == 0)
3333     return TRUE;
3334
3335   return FALSE;
3336 }
3337 #endif
3338
3339 static boolean fileHasSuffix(const char *basename, const char *suffix)
3340 {
3341   static char *basename_lower = NULL;
3342   int basename_length, suffix_length;
3343
3344   checked_free(basename_lower);
3345
3346   if (basename == NULL || suffix == NULL)
3347     return FALSE;
3348
3349   basename_lower = getStringToLower(basename);
3350   basename_length = strlen(basename_lower);
3351   suffix_length = strlen(suffix);
3352
3353   if (basename_length > suffix_length + 1 &&
3354       basename_lower[basename_length - suffix_length - 1] == '.' &&
3355       strEqual(&basename_lower[basename_length - suffix_length], suffix))
3356     return TRUE;
3357
3358   return FALSE;
3359 }
3360
3361 static boolean FileCouldBeArtwork(char *filename)
3362 {
3363   char *basename = getBaseNamePtr(filename);
3364
3365   return (!strEqual(basename, ".") &&
3366           !strEqual(basename, "..") &&
3367           !fileHasSuffix(basename, "txt") &&
3368           !fileHasSuffix(basename, "conf") &&
3369           !directoryExists(filename));
3370 }
3371
3372 boolean FileIsGraphic(char *filename)
3373 {
3374   return FileCouldBeArtwork(filename);
3375 }
3376
3377 boolean FileIsSound(char *filename)
3378 {
3379   return FileCouldBeArtwork(filename);
3380 }
3381
3382 boolean FileIsMusic(char *filename)
3383 {
3384   return FileCouldBeArtwork(filename);
3385 }
3386
3387 boolean FileIsArtworkType(char *filename, int type)
3388 {
3389   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3390       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3391       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3392     return TRUE;
3393
3394   return FALSE;
3395 }
3396
3397 // ----------------------------------------------------------------------------
3398 // functions for loading artwork configuration information
3399 // ----------------------------------------------------------------------------
3400
3401 char *get_mapped_token(char *token)
3402 {
3403   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3404   static char *map_token_prefix[][2] =
3405   {
3406     { "char_procent",           "char_percent"                  },
3407     { "bd_magic_wall_filling",  "bd_magic_wall.filling"         },
3408     { "bd_magic_wall_emptying", "bd_magic_wall.emptying"        },
3409     { "bd_butterfly_left",      "bd_butterfly.left"             },
3410     { "bd_butterfly_right",     "bd_butterfly.right"            },
3411     { "bd_butterfly_up",        "bd_butterfly.up"               },
3412     { "bd_butterfly_down",      "bd_butterfly.down"             },
3413     { "bd_firefly_left",        "bd_firefly.left"               },
3414     { "bd_firefly_right",       "bd_firefly.right"              },
3415     { "bd_firefly_up",          "bd_firefly.up"                 },
3416     { "bd_firefly_down",        "bd_firefly.down"               },
3417
3418     { NULL,                                                     }
3419   };
3420   int i;
3421
3422   for (i = 0; map_token_prefix[i][0] != NULL; i++)
3423   {
3424     int len_token_prefix = strlen(map_token_prefix[i][0]);
3425
3426     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3427       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3428   }
3429
3430   // change tokens containing ".gfx" by moving the "gfx" part to the very left
3431   char *gfx_substring = ".gfx";
3432   char *gfx_prefix = "gfx.";
3433   if (strstr(token, gfx_substring) != NULL)
3434   {
3435     char *token_prefix = getStringCopy(token);
3436     char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3437     char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3438     char *mapped_token;
3439
3440     // cut off token string at ".gfx" substring position
3441     *token_gfx_pos = '\0';
3442
3443     // put together prefix "gfx." and token prefix and suffix without ".gfx"
3444     mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3445
3446     free(token_prefix);
3447
3448     return mapped_token;
3449   }
3450
3451   return NULL;
3452 }
3453
3454 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3455                                     char *token)
3456 {
3457   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3458   static struct ConfigTypeInfo prefix_list[] =
3459   {
3460     { "global.anim_1"   },
3461     { "global.anim_2"   },
3462     { "global.anim_3"   },
3463     { "global.anim_4"   },
3464     { "global.anim_5"   },
3465     { "global.anim_6"   },
3466     { "global.anim_7"   },
3467     { "global.anim_8"   },
3468     { "global.anim_9"   },
3469     { "global.anim_10"  },
3470     { "global.anim_11"  },
3471     { "global.anim_12"  },
3472     { "global.anim_13"  },
3473     { "global.anim_14"  },
3474     { "global.anim_15"  },
3475     { "global.anim_16"  },
3476     { "global.anim_17"  },
3477     { "global.anim_18"  },
3478     { "global.anim_19"  },
3479     { "global.anim_20"  },
3480     { "global.anim_21"  },
3481     { "global.anim_22"  },
3482     { "global.anim_23"  },
3483     { "global.anim_24"  },
3484     { "global.anim_25"  },
3485     { "global.anim_26"  },
3486     { "global.anim_27"  },
3487     { "global.anim_28"  },
3488     { "global.anim_29"  },
3489     { "global.anim_30"  },
3490     { "global.anim_31"  },
3491     { "global.anim_32"  },
3492
3493     { NULL              }
3494   };
3495   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3496   boolean prefix_found = FALSE;
3497   int len_suffix = 0;
3498   int i;
3499
3500   // search for prefix to check if base token has to be created
3501   for (i = 0; prefix_list[i].token != NULL; i++)
3502     if (strPrefix(token, prefix_list[i].token))
3503       prefix_found = TRUE;
3504
3505   if (!prefix_found)
3506     return NULL;
3507
3508   // search for suffix (parameter) to determine base token length
3509   for (i = 0; suffix_list[i].token != NULL; i++)
3510     if (strSuffix(token, suffix_list[i].token))
3511       len_suffix = strlen(suffix_list[i].token);
3512
3513   return getStringCopyN(token, strlen(token) - len_suffix);
3514 }
3515
3516 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3517                                   struct ListNodeInfo ***, int *);
3518
3519 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3520                                            struct ConfigTypeInfo *suffix_list,
3521                                            char **ignore_tokens,
3522                                            int num_file_list_entries)
3523 {
3524   SetupFileHash *ignore_tokens_hash;
3525   struct FileInfo *file_list;
3526   int num_file_list_entries_found = 0;
3527   int num_suffix_list_entries = 0;
3528   int list_pos;
3529   int i, j;
3530
3531   // create hash from list of tokens to be ignored (for quick access)
3532   ignore_tokens_hash = newSetupFileHash();
3533   for (i = 0; ignore_tokens[i] != NULL; i++)
3534     setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3535
3536   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3537
3538   for (i = 0; suffix_list[i].token != NULL; i++)
3539     num_suffix_list_entries++;
3540
3541   // always start with reliable default values
3542   for (i = 0; i < num_file_list_entries; i++)
3543   {
3544     file_list[i].token = NULL;
3545
3546     file_list[i].default_filename = NULL;
3547     file_list[i].filename = NULL;
3548
3549     if (num_suffix_list_entries > 0)
3550     {
3551       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3552
3553       file_list[i].default_parameter = checked_calloc(parameter_array_size);
3554       file_list[i].parameter = checked_calloc(parameter_array_size);
3555
3556       for (j = 0; j < num_suffix_list_entries; j++)
3557       {
3558         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3559         setString(&file_list[i].parameter[j], suffix_list[j].value);
3560       }
3561
3562       file_list[i].redefined = FALSE;
3563       file_list[i].fallback_to_default = FALSE;
3564       file_list[i].default_is_cloned = FALSE;
3565     }
3566   }
3567
3568   list_pos = 0;
3569
3570   for (i = 0; config_list[i].token != NULL; i++)
3571   {
3572     int len_config_token = strlen(config_list[i].token);
3573     boolean is_file_entry = TRUE;
3574
3575     for (j = 0; suffix_list[j].token != NULL; j++)
3576     {
3577       int len_suffix = strlen(suffix_list[j].token);
3578
3579       if (len_suffix < len_config_token &&
3580           strEqual(&config_list[i].token[len_config_token - len_suffix],
3581                    suffix_list[j].token))
3582       {
3583         setString(&file_list[list_pos].default_parameter[j],
3584                   config_list[i].value);
3585
3586         is_file_entry = FALSE;
3587
3588         break;
3589       }
3590     }
3591
3592     // the following tokens are no file definitions, but other config tokens
3593     if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3594       is_file_entry = FALSE;
3595
3596     if (is_file_entry)
3597     {
3598       if (i > 0)
3599         list_pos++;
3600
3601       if (list_pos >= num_file_list_entries)
3602         break;
3603
3604       file_list[list_pos].token = config_list[i].token;
3605       file_list[list_pos].default_filename = config_list[i].value;
3606     }
3607
3608     if (strSuffix(config_list[i].token, ".clone_from"))
3609       file_list[list_pos].default_is_cloned = TRUE;
3610   }
3611
3612   num_file_list_entries_found = list_pos + 1;
3613   if (num_file_list_entries_found != num_file_list_entries)
3614   {
3615     Error("---");
3616     Error("inconsistant config list information:");
3617     Error("- should be:   %d (according to 'src/conf_xxx.h')",
3618           num_file_list_entries);
3619     Error("- found to be: %d (according to 'src/conf_xxx.c')",
3620           num_file_list_entries_found);
3621
3622     Fail("please fix");
3623   }
3624
3625   freeSetupFileHash(ignore_tokens_hash);
3626
3627   return file_list;
3628 }
3629
3630 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3631 {
3632   int len_token = strlen(token);
3633   int len_suffix = strlen(suffix);
3634
3635   if (start_pos < 0)    // compare suffix from end of string
3636     start_pos += len_token;
3637
3638   if (start_pos < 0 || start_pos + len_suffix > len_token)
3639     return FALSE;
3640
3641   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3642     return FALSE;
3643
3644   if (token[start_pos + len_suffix] == '\0')
3645     return TRUE;
3646
3647   if (token[start_pos + len_suffix] == '.')
3648     return TRUE;
3649
3650   return FALSE;
3651 }
3652
3653 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
3654
3655 static void read_token_parameters(SetupFileHash *setup_file_hash,
3656                                   struct ConfigTypeInfo *suffix_list,
3657                                   struct FileInfo *file_list_entry)
3658 {
3659   // check for config token that is the base token without any suffixes
3660   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3661   char *known_token_value = KNOWN_TOKEN_VALUE;
3662   int i;
3663
3664   if (filename != NULL)
3665   {
3666     setString(&file_list_entry->filename, filename);
3667
3668     // when file definition found, set all parameters to default values
3669     for (i = 0; suffix_list[i].token != NULL; i++)
3670       setString(&file_list_entry->parameter[i], suffix_list[i].value);
3671
3672     file_list_entry->redefined = TRUE;
3673
3674     // mark config file token as well known from default config
3675     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3676   }
3677
3678   // check for config tokens that can be build by base token and suffixes
3679   for (i = 0; suffix_list[i].token != NULL; i++)
3680   {
3681     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3682     char *value = getHashEntry(setup_file_hash, token);
3683
3684     if (value != NULL)
3685     {
3686       setString(&file_list_entry->parameter[i], value);
3687
3688       // mark config file token as well known from default config
3689       setHashEntry(setup_file_hash, token, known_token_value);
3690     }
3691
3692     free(token);
3693   }
3694 }
3695
3696 static void add_dynamic_file_list_entry(struct FileInfo **list,
3697                                         int *num_list_entries,
3698                                         SetupFileHash *extra_file_hash,
3699                                         struct ConfigTypeInfo *suffix_list,
3700                                         int num_suffix_list_entries,
3701                                         char *token)
3702 {
3703   struct FileInfo *new_list_entry;
3704   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3705
3706   (*num_list_entries)++;
3707   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3708   new_list_entry = &(*list)[*num_list_entries - 1];
3709
3710   new_list_entry->token = getStringCopy(token);
3711   new_list_entry->default_filename = NULL;
3712   new_list_entry->filename = NULL;
3713   new_list_entry->parameter = checked_calloc(parameter_array_size);
3714
3715   new_list_entry->redefined = FALSE;
3716   new_list_entry->fallback_to_default = FALSE;
3717   new_list_entry->default_is_cloned = FALSE;
3718
3719   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3720 }
3721
3722 static void add_property_mapping(struct PropertyMapping **list,
3723                                  int *num_list_entries,
3724                                  int base_index, int ext1_index,
3725                                  int ext2_index, int ext3_index,
3726                                  int artwork_index)
3727 {
3728   struct PropertyMapping *new_list_entry;
3729
3730   (*num_list_entries)++;
3731   *list = checked_realloc(*list,
3732                           *num_list_entries * sizeof(struct PropertyMapping));
3733   new_list_entry = &(*list)[*num_list_entries - 1];
3734
3735   new_list_entry->base_index = base_index;
3736   new_list_entry->ext1_index = ext1_index;
3737   new_list_entry->ext2_index = ext2_index;
3738   new_list_entry->ext3_index = ext3_index;
3739
3740   new_list_entry->artwork_index = artwork_index;
3741 }
3742
3743 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3744                                           char *filename)
3745 {
3746   struct FileInfo *file_list = artwork_info->file_list;
3747   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3748   char **base_prefixes = artwork_info->base_prefixes;
3749   char **ext1_suffixes = artwork_info->ext1_suffixes;
3750   char **ext2_suffixes = artwork_info->ext2_suffixes;
3751   char **ext3_suffixes = artwork_info->ext3_suffixes;
3752   char **ignore_tokens = artwork_info->ignore_tokens;
3753   int num_file_list_entries = artwork_info->num_file_list_entries;
3754   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3755   int num_base_prefixes = artwork_info->num_base_prefixes;
3756   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3757   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3758   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3759   int num_ignore_tokens = artwork_info->num_ignore_tokens;
3760   SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3761   SetupFileHash *extra_file_hash, *empty_file_hash;
3762   char *known_token_value = KNOWN_TOKEN_VALUE;
3763   char *base_token_value = UNDEFINED_FILENAME;
3764   int i, j, k, l;
3765
3766   if (filename == NULL)
3767     return;
3768
3769   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3770     return;
3771
3772   // separate valid (defined) from empty (undefined) config token values
3773   valid_file_hash = newSetupFileHash();
3774   empty_file_hash = newSetupFileHash();
3775   BEGIN_HASH_ITERATION(setup_file_hash, itr)
3776   {
3777     char *value = HASH_ITERATION_VALUE(itr);
3778
3779     setHashEntry(*value ? valid_file_hash : empty_file_hash,
3780                  HASH_ITERATION_TOKEN(itr), value);
3781   }
3782   END_HASH_ITERATION(setup_file_hash, itr)
3783
3784   // at this point, we do not need the setup file hash anymore -- free it
3785   freeSetupFileHash(setup_file_hash);
3786
3787   // prevent changing hash while iterating over it by using a temporary copy
3788   valid_file_hash_tmp = newSetupFileHash();
3789   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3790   {
3791     setHashEntry(valid_file_hash_tmp,
3792                  HASH_ITERATION_TOKEN(itr),
3793                  HASH_ITERATION_VALUE(itr));
3794   }
3795   END_HASH_ITERATION(valid_file_hash, itr)
3796
3797   // (iterate over same temporary hash, as modifications are independent)
3798
3799   // map deprecated to current tokens (using prefix match and replace)
3800   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3801   {
3802     char *token = HASH_ITERATION_TOKEN(itr);
3803     char *mapped_token = get_mapped_token(token);
3804
3805     if (mapped_token != NULL)
3806     {
3807       char *value = HASH_ITERATION_VALUE(itr);
3808
3809       // add mapped token
3810       setHashEntry(valid_file_hash, mapped_token, value);
3811
3812       // ignore old token (by setting it to "known" keyword)
3813       setHashEntry(valid_file_hash, token, known_token_value);
3814
3815       free(mapped_token);
3816     }
3817   }
3818   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3819
3820   // add special base tokens (using prefix match and replace)
3821   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3822   {
3823     char *token = HASH_ITERATION_TOKEN(itr);
3824     char *base_token = get_special_base_token(artwork_info, token);
3825
3826     if (base_token != NULL)
3827     {
3828       // add base token only if it does not already exist
3829       if (getHashEntry(valid_file_hash, base_token) == NULL)
3830         setHashEntry(valid_file_hash, base_token, base_token_value);
3831
3832       free(base_token);
3833     }
3834   }
3835   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3836
3837   // free temporary hash used for iteration
3838   freeSetupFileHash(valid_file_hash_tmp);
3839
3840   // read parameters for all known config file tokens
3841   for (i = 0; i < num_file_list_entries; i++)
3842     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3843
3844   // set all tokens that can be ignored here to "known" keyword
3845   for (i = 0; i < num_ignore_tokens; i++)
3846     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3847
3848   // copy all unknown config file tokens to extra config hash
3849   extra_file_hash = newSetupFileHash();
3850   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3851   {
3852     char *value = HASH_ITERATION_VALUE(itr);
3853
3854     if (!strEqual(value, known_token_value))
3855       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3856   }
3857   END_HASH_ITERATION(valid_file_hash, itr)
3858
3859   // at this point, we do not need the valid file hash anymore -- free it
3860   freeSetupFileHash(valid_file_hash);
3861
3862   // now try to determine valid, dynamically defined config tokens
3863
3864   BEGIN_HASH_ITERATION(extra_file_hash, itr)
3865   {
3866     struct FileInfo **dynamic_file_list =
3867       &artwork_info->dynamic_file_list;
3868     int *num_dynamic_file_list_entries =
3869       &artwork_info->num_dynamic_file_list_entries;
3870     struct PropertyMapping **property_mapping =
3871       &artwork_info->property_mapping;
3872     int *num_property_mapping_entries =
3873       &artwork_info->num_property_mapping_entries;
3874     int current_summarized_file_list_entry =
3875       artwork_info->num_file_list_entries +
3876       artwork_info->num_dynamic_file_list_entries;
3877     char *token = HASH_ITERATION_TOKEN(itr);
3878     int len_token = strlen(token);
3879     int start_pos;
3880     boolean base_prefix_found = FALSE;
3881     boolean parameter_suffix_found = FALSE;
3882
3883     // skip all parameter definitions (handled by read_token_parameters())
3884     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3885     {
3886       int len_suffix = strlen(suffix_list[i].token);
3887
3888       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3889         parameter_suffix_found = TRUE;
3890     }
3891
3892     if (parameter_suffix_found)
3893       continue;
3894
3895     // ---------- step 0: search for matching base prefix ----------
3896
3897     start_pos = 0;
3898     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3899     {
3900       char *base_prefix = base_prefixes[i];
3901       int len_base_prefix = strlen(base_prefix);
3902       boolean ext1_suffix_found = FALSE;
3903       boolean ext2_suffix_found = FALSE;
3904       boolean ext3_suffix_found = FALSE;
3905       boolean exact_match = FALSE;
3906       int base_index = -1;
3907       int ext1_index = -1;
3908       int ext2_index = -1;
3909       int ext3_index = -1;
3910
3911       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3912
3913       if (!base_prefix_found)
3914         continue;
3915
3916       base_index = i;
3917
3918       if (start_pos + len_base_prefix == len_token)     // exact match
3919       {
3920         exact_match = TRUE;
3921
3922         add_dynamic_file_list_entry(dynamic_file_list,
3923                                     num_dynamic_file_list_entries,
3924                                     extra_file_hash,
3925                                     suffix_list,
3926                                     num_suffix_list_entries,
3927                                     token);
3928         add_property_mapping(property_mapping,
3929                              num_property_mapping_entries,
3930                              base_index, -1, -1, -1,
3931                              current_summarized_file_list_entry);
3932         continue;
3933       }
3934
3935       // ---------- step 1: search for matching first suffix ----------
3936
3937       start_pos += len_base_prefix;
3938       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3939       {
3940         char *ext1_suffix = ext1_suffixes[j];
3941         int len_ext1_suffix = strlen(ext1_suffix);
3942
3943         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3944
3945         if (!ext1_suffix_found)
3946           continue;
3947
3948         ext1_index = j;
3949
3950         if (start_pos + len_ext1_suffix == len_token)   // exact match
3951         {
3952           exact_match = TRUE;
3953
3954           add_dynamic_file_list_entry(dynamic_file_list,
3955                                       num_dynamic_file_list_entries,
3956                                       extra_file_hash,
3957                                       suffix_list,
3958                                       num_suffix_list_entries,
3959                                       token);
3960           add_property_mapping(property_mapping,
3961                                num_property_mapping_entries,
3962                                base_index, ext1_index, -1, -1,
3963                                current_summarized_file_list_entry);
3964           continue;
3965         }
3966
3967         start_pos += len_ext1_suffix;
3968       }
3969
3970       if (exact_match)
3971         break;
3972
3973       // ---------- step 2: search for matching second suffix ----------
3974
3975       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3976       {
3977         char *ext2_suffix = ext2_suffixes[k];
3978         int len_ext2_suffix = strlen(ext2_suffix);
3979
3980         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3981
3982         if (!ext2_suffix_found)
3983           continue;
3984
3985         ext2_index = k;
3986
3987         if (start_pos + len_ext2_suffix == len_token)   // exact match
3988         {
3989           exact_match = TRUE;
3990
3991           add_dynamic_file_list_entry(dynamic_file_list,
3992                                       num_dynamic_file_list_entries,
3993                                       extra_file_hash,
3994                                       suffix_list,
3995                                       num_suffix_list_entries,
3996                                       token);
3997           add_property_mapping(property_mapping,
3998                                num_property_mapping_entries,
3999                                base_index, ext1_index, ext2_index, -1,
4000                                current_summarized_file_list_entry);
4001           continue;
4002         }
4003
4004         start_pos += len_ext2_suffix;
4005       }
4006
4007       if (exact_match)
4008         break;
4009
4010       // ---------- step 3: search for matching third suffix ----------
4011
4012       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
4013       {
4014         char *ext3_suffix = ext3_suffixes[l];
4015         int len_ext3_suffix = strlen(ext3_suffix);
4016
4017         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
4018
4019         if (!ext3_suffix_found)
4020           continue;
4021
4022         ext3_index = l;
4023
4024         if (start_pos + len_ext3_suffix == len_token) // exact match
4025         {
4026           exact_match = TRUE;
4027
4028           add_dynamic_file_list_entry(dynamic_file_list,
4029                                       num_dynamic_file_list_entries,
4030                                       extra_file_hash,
4031                                       suffix_list,
4032                                       num_suffix_list_entries,
4033                                       token);
4034           add_property_mapping(property_mapping,
4035                                num_property_mapping_entries,
4036                                base_index, ext1_index, ext2_index, ext3_index,
4037                                current_summarized_file_list_entry);
4038           continue;
4039         }
4040       }
4041     }
4042   }
4043   END_HASH_ITERATION(extra_file_hash, itr)
4044
4045   if (artwork_info->num_dynamic_file_list_entries > 0)
4046   {
4047     artwork_info->dynamic_artwork_list =
4048       checked_calloc(artwork_info->num_dynamic_file_list_entries *
4049                      artwork_info->sizeof_artwork_list_entry);
4050   }
4051
4052   if (options.verbose && IS_PARENT_PROCESS())
4053   {
4054     SetupFileList *setup_file_list, *list;
4055     boolean dynamic_tokens_found = FALSE;
4056     boolean unknown_tokens_found = FALSE;
4057     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
4058
4059     // list may be NULL for empty artwork config files
4060     setup_file_list = loadSetupFileList(filename);
4061
4062     BEGIN_HASH_ITERATION(extra_file_hash, itr)
4063     {
4064       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
4065         dynamic_tokens_found = TRUE;
4066       else
4067         unknown_tokens_found = TRUE;
4068     }
4069     END_HASH_ITERATION(extra_file_hash, itr)
4070
4071     if (options.debug && dynamic_tokens_found)
4072     {
4073       Debug("config", "---");
4074       Debug("config", "dynamic token(s) found in config file:");
4075       Debug("config", "- config file: '%s'", filename);
4076
4077       for (list = setup_file_list; list != NULL; list = list->next)
4078       {
4079         char *value = getHashEntry(extra_file_hash, list->token);
4080
4081         if (value != NULL && strEqual(value, known_token_value))
4082           Debug("config", "- dynamic token: '%s'", list->token);
4083       }
4084
4085       Debug("config", "---");
4086     }
4087
4088     if (unknown_tokens_found)
4089     {
4090       Warn("---");
4091       Warn("unknown token(s) found in config file:");
4092       Warn("- config file: '%s'", filename);
4093
4094       for (list = setup_file_list; list != NULL; list = list->next)
4095       {
4096         char *value = getHashEntry(extra_file_hash, list->token);
4097
4098         if (value != NULL && !strEqual(value, known_token_value))
4099           Warn("- dynamic token: '%s'", list->token);
4100       }
4101
4102       Warn("---");
4103     }
4104
4105     if (undefined_values_found)
4106     {
4107       Warn("---");
4108       Warn("undefined values found in config file:");
4109       Warn("- config file: '%s'", filename);
4110
4111       for (list = setup_file_list; list != NULL; list = list->next)
4112       {
4113         char *value = getHashEntry(empty_file_hash, list->token);
4114
4115         if (value != NULL)
4116           Warn("- undefined value for token: '%s'", list->token);
4117       }
4118
4119       Warn("---");
4120     }
4121
4122     freeSetupFileList(setup_file_list);
4123   }
4124
4125   freeSetupFileHash(extra_file_hash);
4126   freeSetupFileHash(empty_file_hash);
4127 }
4128
4129 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
4130 {
4131   struct FileInfo *file_list = artwork_info->file_list;
4132   int num_file_list_entries = artwork_info->num_file_list_entries;
4133   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
4134   char *filename_base = UNDEFINED_FILENAME, *filename_local;
4135   int i, j;
4136
4137   DrawInitTextHead("Loading artwork config");
4138   DrawInitTextItem(ARTWORKINFO_FILENAME(artwork_info->type));
4139
4140   // always start with reliable default values
4141   for (i = 0; i < num_file_list_entries; i++)
4142   {
4143     setString(&file_list[i].filename, file_list[i].default_filename);
4144
4145     for (j = 0; j < num_suffix_list_entries; j++)
4146       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
4147
4148     file_list[i].redefined = FALSE;
4149     file_list[i].fallback_to_default = FALSE;
4150   }
4151
4152   // free previous dynamic artwork file array
4153   if (artwork_info->dynamic_file_list != NULL)
4154   {
4155     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
4156     {
4157       free(artwork_info->dynamic_file_list[i].token);
4158       free(artwork_info->dynamic_file_list[i].filename);
4159       free(artwork_info->dynamic_file_list[i].parameter);
4160     }
4161
4162     free(artwork_info->dynamic_file_list);
4163     artwork_info->dynamic_file_list = NULL;
4164
4165     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4166                           &artwork_info->num_dynamic_file_list_entries);
4167   }
4168
4169   // free previous property mapping
4170   if (artwork_info->property_mapping != NULL)
4171   {
4172     free(artwork_info->property_mapping);
4173
4174     artwork_info->property_mapping = NULL;
4175     artwork_info->num_property_mapping_entries = 0;
4176   }
4177
4178   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
4179   {
4180     // first look for special artwork configured in level series config
4181     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
4182
4183     if (fileExists(filename_base))
4184       LoadArtworkConfigFromFilename(artwork_info, filename_base);
4185   }
4186
4187   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
4188
4189   if (filename_local != NULL && !strEqual(filename_base, filename_local))
4190     LoadArtworkConfigFromFilename(artwork_info, filename_local);
4191 }
4192
4193 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
4194                                    struct ListNodeInfo **listnode)
4195 {
4196   if (*listnode)
4197   {
4198     char *filename = (*listnode)->source_filename;
4199
4200     if (--(*listnode)->num_references <= 0)
4201       deleteNodeFromList(&artwork_info->content_list, filename,
4202                          artwork_info->free_artwork);
4203
4204     *listnode = NULL;
4205   }
4206 }
4207
4208 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
4209                                     struct ListNodeInfo **listnode,
4210                                     struct FileInfo *file_list_entry)
4211 {
4212   char *init_text[] =
4213   {
4214     "Loading graphics",
4215     "Loading sounds",
4216     "Loading music"
4217   };
4218
4219   ListNode *node;
4220   char *basename = file_list_entry->filename;
4221   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
4222
4223   // mark all images from non-default graphics directory as "redefined"
4224   if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
4225       !strPrefix(filename, options.graphics_directory))
4226     file_list_entry->redefined = TRUE;
4227
4228   if (filename == NULL)
4229   {
4230     Warn("cannot find artwork file '%s'", basename);
4231
4232     basename = file_list_entry->default_filename;
4233
4234     // fail for cloned default artwork that has no default filename defined
4235     if (file_list_entry->default_is_cloned &&
4236         strEqual(basename, UNDEFINED_FILENAME))
4237     {
4238       void (*error_func)(char *, ...) = Warn;
4239
4240       // we can get away without sounds and music, but not without graphics
4241       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4242         error_func = Fail;
4243
4244       error_func("token '%s' was cloned and has no default filename",
4245                  file_list_entry->token);
4246
4247       return;
4248     }
4249
4250     // dynamic artwork has no default filename / skip empty default artwork
4251     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
4252       return;
4253
4254     file_list_entry->fallback_to_default = TRUE;
4255
4256     Warn("trying default artwork file '%s'", basename);
4257
4258     filename = getCustomArtworkFilename(basename, artwork_info->type);
4259
4260     if (filename == NULL)
4261     {
4262       void (*error_func)(char *, ...) = Warn;
4263
4264       // we can get away without sounds and music, but not without graphics
4265       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4266         error_func = Fail;
4267
4268       error_func("cannot find default artwork file '%s'", basename);
4269
4270       return;
4271     }
4272   }
4273
4274   // check if the old and the new artwork file are the same
4275   if (*listnode && strEqual((*listnode)->source_filename, filename))
4276   {
4277     // The old and new artwork are the same (have the same filename and path).
4278     // This usually means that this artwork does not exist in this artwork set
4279     // and a fallback to the existing artwork is done.
4280
4281     return;
4282   }
4283
4284   // delete existing artwork file entry
4285   deleteArtworkListEntry(artwork_info, listnode);
4286
4287   // check if the new artwork file already exists in the list of artwork
4288   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
4289   {
4290       *listnode = (struct ListNodeInfo *)node->content;
4291       (*listnode)->num_references++;
4292
4293       return;
4294   }
4295
4296   DrawInitTextHead(init_text[artwork_info->type]);
4297   DrawInitTextItem(basename);
4298
4299   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
4300   {
4301     // add new artwork file entry to the list of artwork files
4302     (*listnode)->num_references = 1;
4303     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
4304                   *listnode);
4305   }
4306   else
4307   {
4308     void (*error_func)(char *, ...) = Warn;
4309
4310     // we can get away without sounds and music, but not without graphics
4311     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
4312       error_func = Fail;
4313
4314     error_func("cannot load artwork file '%s'", basename);
4315
4316     return;
4317   }
4318 }
4319
4320 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
4321                               struct ListNodeInfo **listnode,
4322                               struct FileInfo *file_list_entry)
4323 {
4324   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
4325   {
4326     deleteArtworkListEntry(artwork_info, listnode);
4327
4328     return;
4329   }
4330
4331   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
4332 }
4333
4334 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
4335 {
4336   struct FileInfo *file_list = artwork_info->file_list;
4337   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
4338   int num_file_list_entries = artwork_info->num_file_list_entries;
4339   int num_dynamic_file_list_entries =
4340     artwork_info->num_dynamic_file_list_entries;
4341   int i;
4342
4343   print_timestamp_init("ReloadCustomArtworkList");
4344
4345   for (i = 0; i < num_file_list_entries; i++)
4346     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
4347                       &file_list[i]);
4348
4349   for (i = 0; i < num_dynamic_file_list_entries; i++)
4350     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
4351                       &dynamic_file_list[i]);
4352
4353   print_timestamp_done("ReloadCustomArtworkList");
4354
4355 #if 0
4356   dumpList(artwork_info->content_list);
4357 #endif
4358 }
4359
4360 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
4361                                   struct ListNodeInfo ***list,
4362                                   int *num_list_entries)
4363 {
4364   int i;
4365
4366   if (*list == NULL)
4367     return;
4368
4369   for (i = 0; i < *num_list_entries; i++)
4370     deleteArtworkListEntry(artwork_info, &(*list)[i]);
4371   free(*list);
4372
4373   *list = NULL;
4374   *num_list_entries = 0;
4375 }
4376
4377 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4378 {
4379   if (artwork_info == NULL)
4380     return;
4381
4382   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4383                         &artwork_info->num_file_list_entries);
4384
4385   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4386                         &artwork_info->num_dynamic_file_list_entries);
4387 }
4388
4389
4390 // ----------------------------------------------------------------------------
4391 // functions only needed for non-Unix (non-command-line) systems
4392 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4393 // (now also added for Windows, to create files in user data directory)
4394 // ----------------------------------------------------------------------------
4395
4396 char *getLogBasename(char *basename)
4397 {
4398   return getStringCat2(basename, ".log");
4399 }
4400
4401 char *getLogFilename(char *basename)
4402 {
4403   return getPath2(getMainUserGameDataDir(), basename);
4404 }
4405
4406 void OpenLogFile(void)
4407 {
4408   InitMainUserDataDirectory();
4409
4410   if ((program.log_file = fopen(program.log_filename, MODE_WRITE)) == NULL)
4411   {
4412     program.log_file = program.log_file_default;   // reset to default
4413
4414     Warn("cannot open file '%s' for writing: %s",
4415          program.log_filename, strerror(errno));
4416   }
4417
4418   // output should be unbuffered so it is not truncated in a crash
4419   setbuf(program.log_file, NULL);
4420 }
4421
4422 void CloseLogFile(void)
4423 {
4424   if (program.log_file != program.log_file_default)
4425     fclose(program.log_file);
4426 }
4427
4428 void DumpLogFile(void)
4429 {
4430   FILE *log_file = fopen(program.log_filename, MODE_READ);
4431
4432   if (log_file == NULL)
4433     return;
4434
4435   while (!feof(log_file))
4436     fputc(fgetc(log_file), stdout);
4437
4438   fclose(log_file);
4439 }
4440
4441 void NotifyUserAboutErrorFile(void)
4442 {
4443 #if defined(PLATFORM_WINDOWS)
4444   char *title_text = getStringCat2(program.program_title, " Error Message");
4445   char *error_text = getStringCat2("The program was aborted due to an error; "
4446                                    "for details, see the following error file:"
4447                                    STRING_NEWLINE,
4448                                    program.log_filename);
4449
4450   MessageBox(NULL, error_text, title_text, MB_OK);
4451 #endif
4452 }
4453
4454
4455 // ----------------------------------------------------------------------------
4456 // the following is only for debugging purpose and normally not used
4457 // ----------------------------------------------------------------------------
4458
4459 #if DEBUG
4460
4461 #define DEBUG_PRINT_INIT_TIMESTAMPS             TRUE
4462 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH       10
4463
4464 #define DEBUG_NUM_TIMESTAMPS                    10
4465 #define DEBUG_TIME_IN_MICROSECONDS              0
4466
4467 #if DEBUG_TIME_IN_MICROSECONDS
4468 static double Counter_Microseconds(void)
4469 {
4470   static struct timeval base_time = { 0, 0 };
4471   struct timeval current_time;
4472   double counter;
4473
4474   gettimeofday(&current_time, NULL);
4475
4476   // reset base time in case of wrap-around
4477   if (current_time.tv_sec < base_time.tv_sec)
4478     base_time = current_time;
4479
4480   counter =
4481     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
4482     ((double)(current_time.tv_usec - base_time.tv_usec));
4483
4484   return counter;               // return microseconds since last init
4485 }
4486 #endif
4487
4488 static char *debug_print_timestamp_get_padding(int padding_size)
4489 {
4490   static char *padding = NULL;
4491   int max_padding_size = 100;
4492
4493   if (padding == NULL)
4494   {
4495     padding = checked_calloc(max_padding_size + 1);
4496     memset(padding, ' ', max_padding_size);
4497   }
4498
4499   return &padding[MAX(0, max_padding_size - padding_size)];
4500 }
4501
4502 void debug_print_timestamp(int counter_nr, char *message)
4503 {
4504   int indent_size = 8;
4505   int padding_size = 40;
4506   float timestamp_interval;
4507
4508   if (counter_nr < 0)
4509     Fail("debugging: invalid negative counter");
4510   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4511     Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4512
4513 #if DEBUG_TIME_IN_MICROSECONDS
4514   static double counter[DEBUG_NUM_TIMESTAMPS][2];
4515   char *unit = "ms";
4516
4517   counter[counter_nr][0] = Counter_Microseconds();
4518 #else
4519   static int counter[DEBUG_NUM_TIMESTAMPS][2];
4520   char *unit = "s";
4521
4522   counter[counter_nr][0] = Counter();
4523 #endif
4524
4525   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4526   counter[counter_nr][1] = counter[counter_nr][0];
4527
4528   if (message)
4529     Debug("time:init", "%s%s%s %.3f %s",
4530           debug_print_timestamp_get_padding(counter_nr * indent_size),
4531           message,
4532           debug_print_timestamp_get_padding(padding_size - strlen(message)),
4533           timestamp_interval / 1000,
4534           unit);
4535 }
4536
4537 #if 0
4538 static void debug_print_parent_only(char *format, ...)
4539 {
4540   if (!IS_PARENT_PROCESS())
4541     return;
4542
4543   if (format)
4544   {
4545     va_list ap;
4546
4547     va_start(ap, format);
4548     vprintf(format, ap);
4549     va_end(ap);
4550
4551     printf("\n");
4552   }
4553 }
4554 #endif
4555
4556 #endif  // DEBUG
4557
4558 static void print_timestamp_ext(char *message, char *mode)
4559 {
4560 #if DEBUG_PRINT_INIT_TIMESTAMPS
4561   static char *debug_message = NULL;
4562   static char *last_message = NULL;
4563   static int counter_nr = 0;
4564   int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4565
4566   checked_free(debug_message);
4567   debug_message = getStringCat3(mode, " ", message);
4568
4569   if (strEqual(mode, "INIT"))
4570   {
4571     debug_print_timestamp(counter_nr, NULL);
4572
4573     if (counter_nr + 1 < max_depth)
4574       debug_print_timestamp(counter_nr, debug_message);
4575
4576     counter_nr++;
4577
4578     debug_print_timestamp(counter_nr, NULL);
4579   }
4580   else if (strEqual(mode, "DONE"))
4581   {
4582     counter_nr--;
4583
4584     if (counter_nr + 1 < max_depth ||
4585         (counter_nr == 0 && max_depth == 1))
4586     {
4587       last_message = message;
4588
4589       if (counter_nr == 0 && max_depth == 1)
4590       {
4591         checked_free(debug_message);
4592         debug_message = getStringCat3("TIME", " ", message);
4593       }
4594
4595       debug_print_timestamp(counter_nr, debug_message);
4596     }
4597   }
4598   else if (!strEqual(mode, "TIME") ||
4599            !strEqual(message, last_message))
4600   {
4601     if (counter_nr < max_depth)
4602       debug_print_timestamp(counter_nr, debug_message);
4603   }
4604 #endif
4605 }
4606
4607 void print_timestamp_init(char *message)
4608 {
4609   print_timestamp_ext(message, "INIT");
4610 }
4611
4612 void print_timestamp_time(char *message)
4613 {
4614   print_timestamp_ext(message, "TIME");
4615 }
4616
4617 void print_timestamp_done(char *message)
4618 {
4619   print_timestamp_ext(message, "DONE");
4620 }