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