src/libgame/misc.c

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