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