src/libgame/misc.c

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