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