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