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