src/libgame/misc.c

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