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