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