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