src/libgame/misc.c

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