src/libgame/misc.c

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