src/libgame/misc.c

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