src/libgame/misc.c

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