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