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