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