src/libgame/misc.c

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