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