src/libgame/misc.c

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