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