src/libgame/misc.c

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