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