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