src/libgame/misc.c

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