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 (ISO-Latin-1) */
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     /* special (non-ASCII) keys (UTF-8, for reverse mapping only) */
1659     { KSYM_degree,      "XK_degree",            "\xc2\xb0" },
1660     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "\xc3\x84" },
1661     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "\xc3\x96" },
1662     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "\xc3\x9c" },
1663     { KSYM_adiaeresis,  "XK_adiaeresis",        "\xc3\xa4" },
1664     { KSYM_odiaeresis,  "XK_odiaeresis",        "\xc3\xb6" },
1665     { KSYM_udiaeresis,  "XK_udiaeresis",        "\xc3\xbc" },
1666     { KSYM_ssharp,      "XK_ssharp",            "\xc3\x9f" },
1667
1668     /* other keys (for reverse mapping only) */
1669     { KSYM_space,       "XK_space",             " " },
1670 #endif
1671
1672 #if defined(TARGET_SDL2)
1673     /* keypad keys are not in numerical order in SDL2 */
1674     { KSYM_KP_0,        "XK_KP_0",              "keypad 0" },
1675     { KSYM_KP_1,        "XK_KP_1",              "keypad 1" },
1676     { KSYM_KP_2,        "XK_KP_2",              "keypad 2" },
1677     { KSYM_KP_3,        "XK_KP_3",              "keypad 3" },
1678     { KSYM_KP_4,        "XK_KP_4",              "keypad 4" },
1679     { KSYM_KP_5,        "XK_KP_5",              "keypad 5" },
1680     { KSYM_KP_6,        "XK_KP_6",              "keypad 6" },
1681     { KSYM_KP_7,        "XK_KP_7",              "keypad 7" },
1682     { KSYM_KP_8,        "XK_KP_8",              "keypad 8" },
1683     { KSYM_KP_9,        "XK_KP_9",              "keypad 9" },
1684 #endif
1685
1686     /* end-of-array identifier */
1687     { 0,                NULL,                   NULL }
1688   };
1689
1690   int i;
1691
1692   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1693   {
1694     static char name_buffer[30];
1695     Key key = *keysym;
1696
1697     if (key >= KSYM_A && key <= KSYM_Z)
1698       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1699     else if (key >= KSYM_a && key <= KSYM_z)
1700       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1701     else if (key >= KSYM_0 && key <= KSYM_9)
1702       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1703 #if !defined(TARGET_SDL2)
1704     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1705       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1706 #endif
1707     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1708       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1709     else if (key == KSYM_UNDEFINED)
1710       strcpy(name_buffer, "(undefined)");
1711     else
1712     {
1713       i = 0;
1714
1715       do
1716       {
1717         if (key == translate_key[i].key)
1718         {
1719           strcpy(name_buffer, translate_key[i].name);
1720           break;
1721         }
1722       }
1723       while (translate_key[++i].name);
1724
1725       if (!translate_key[i].name)
1726         strcpy(name_buffer, "(unknown)");
1727     }
1728
1729     *name = name_buffer;
1730   }
1731   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1732   {
1733     static char name_buffer[30];
1734     Key key = *keysym;
1735
1736     if (key >= KSYM_A && key <= KSYM_Z)
1737       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1738     else if (key >= KSYM_a && key <= KSYM_z)
1739       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1740     else if (key >= KSYM_0 && key <= KSYM_9)
1741       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1742 #if !defined(TARGET_SDL2)
1743     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1744       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1745 #endif
1746     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1747       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1748     else if (key == KSYM_UNDEFINED)
1749       strcpy(name_buffer, "[undefined]");
1750     else
1751     {
1752       i = 0;
1753
1754       do
1755       {
1756         if (key == translate_key[i].key)
1757         {
1758           strcpy(name_buffer, translate_key[i].x11name);
1759           break;
1760         }
1761       }
1762       while (translate_key[++i].x11name);
1763
1764       if (!translate_key[i].x11name)
1765         sprintf(name_buffer, "0x%04x", (unsigned int)key);
1766     }
1767
1768     *x11name = name_buffer;
1769   }
1770   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1771   {
1772     Key key = KSYM_UNDEFINED;
1773     char *name_ptr = *name;
1774
1775     if (strlen(*name) == 1)
1776     {
1777       char c = name_ptr[0];
1778
1779       if (c >= 'A' && c <= 'Z')
1780         key = KSYM_A + (Key)(c - 'A');
1781       else if (c >= 'a' && c <= 'z')
1782         key = KSYM_a + (Key)(c - 'a');
1783       else if (c >= '0' && c <= '9')
1784         key = KSYM_0 + (Key)(c - '0');
1785     }
1786
1787     if (key == KSYM_UNDEFINED)
1788     {
1789       i = 0;
1790
1791       do
1792       {
1793         if (strEqual(translate_key[i].name, *name))
1794         {
1795           key = translate_key[i].key;
1796           break;
1797         }
1798       }
1799       while (translate_key[++i].x11name);
1800     }
1801
1802     if (key == KSYM_UNDEFINED)
1803       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1804
1805     *keysym = key;
1806   }
1807   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1808   {
1809     Key key = KSYM_UNDEFINED;
1810     char *name_ptr = *x11name;
1811
1812     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1813     {
1814       char c = name_ptr[3];
1815
1816       if (c >= 'A' && c <= 'Z')
1817         key = KSYM_A + (Key)(c - 'A');
1818       else if (c >= 'a' && c <= 'z')
1819         key = KSYM_a + (Key)(c - 'a');
1820       else if (c >= '0' && c <= '9')
1821         key = KSYM_0 + (Key)(c - '0');
1822     }
1823 #if !defined(TARGET_SDL2)
1824     else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1825     {
1826       char c = name_ptr[6];
1827
1828       if (c >= '0' && c <= '9')
1829         key = KSYM_KP_0 + (Key)(c - '0');
1830     }
1831 #endif
1832     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1833     {
1834       char c1 = name_ptr[4];
1835       char c2 = name_ptr[5];
1836       int d = 0;
1837
1838       if ((c1 >= '0' && c1 <= '9') &&
1839           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1840         d = atoi(&name_ptr[4]);
1841
1842       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1843         key = KSYM_F1 + (Key)(d - 1);
1844     }
1845     else if (strPrefix(name_ptr, "XK_"))
1846     {
1847       i = 0;
1848
1849       do
1850       {
1851         if (strEqual(name_ptr, translate_key[i].x11name))
1852         {
1853           key = translate_key[i].key;
1854           break;
1855         }
1856       }
1857       while (translate_key[++i].x11name);
1858     }
1859     else if (strPrefix(name_ptr, "0x"))
1860     {
1861       unsigned int value = 0;
1862
1863       name_ptr += 2;
1864
1865       while (name_ptr)
1866       {
1867         char c = *name_ptr++;
1868         int d = -1;
1869
1870         if (c >= '0' && c <= '9')
1871           d = (int)(c - '0');
1872         else if (c >= 'a' && c <= 'f')
1873           d = (int)(c - 'a' + 10);
1874         else if (c >= 'A' && c <= 'F')
1875           d = (int)(c - 'A' + 10);
1876
1877         if (d == -1)
1878         {
1879           value = -1;
1880           break;
1881         }
1882
1883         value = value * 16 + d;
1884       }
1885
1886       if (value != -1)
1887         key = (Key)value;
1888     }
1889
1890     *keysym = key;
1891   }
1892 }
1893
1894 char *getKeyNameFromKey(Key key)
1895 {
1896   char *name;
1897
1898   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1899   return name;
1900 }
1901
1902 char *getX11KeyNameFromKey(Key key)
1903 {
1904   char *x11name;
1905
1906   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1907   return x11name;
1908 }
1909
1910 Key getKeyFromKeyName(char *name)
1911 {
1912   Key key;
1913
1914   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1915   return key;
1916 }
1917
1918 Key getKeyFromX11KeyName(char *x11name)
1919 {
1920   Key key;
1921
1922   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1923   return key;
1924 }
1925
1926 char getCharFromKey(Key key)
1927 {
1928   char *keyname = getKeyNameFromKey(key);
1929   char c = 0;
1930
1931   if (strlen(keyname) == 1)
1932     c = keyname[0];
1933   else if (strEqual(keyname, "space"))
1934     c = ' ';
1935
1936   return c;
1937 }
1938
1939 char getValidConfigValueChar(char c)
1940 {
1941   if (c == '#' ||       /* used to mark comments */
1942       c == '\\')        /* used to mark continued lines */
1943     c = 0;
1944
1945   return c;
1946 }
1947
1948
1949 /* ------------------------------------------------------------------------- */
1950 /* functions to translate string identifiers to integer or boolean value     */
1951 /* ------------------------------------------------------------------------- */
1952
1953 int get_integer_from_string(char *s)
1954 {
1955   static char *number_text[][3] =
1956   {
1957     { "0",      "zero",         "null",         },
1958     { "1",      "one",          "first"         },
1959     { "2",      "two",          "second"        },
1960     { "3",      "three",        "third"         },
1961     { "4",      "four",         "fourth"        },
1962     { "5",      "five",         "fifth"         },
1963     { "6",      "six",          "sixth"         },
1964     { "7",      "seven",        "seventh"       },
1965     { "8",      "eight",        "eighth"        },
1966     { "9",      "nine",         "ninth"         },
1967     { "10",     "ten",          "tenth"         },
1968     { "11",     "eleven",       "eleventh"      },
1969     { "12",     "twelve",       "twelfth"       },
1970
1971     { NULL,     NULL,           NULL            },
1972   };
1973
1974   int i, j;
1975   char *s_lower = getStringToLower(s);
1976   int result = -1;
1977
1978   for (i = 0; number_text[i][0] != NULL; i++)
1979     for (j = 0; j < 3; j++)
1980       if (strEqual(s_lower, number_text[i][j]))
1981         result = i;
1982
1983   if (result == -1)
1984   {
1985     if (strEqual(s_lower, "false") ||
1986         strEqual(s_lower, "no") ||
1987         strEqual(s_lower, "off"))
1988       result = 0;
1989     else if (strEqual(s_lower, "true") ||
1990              strEqual(s_lower, "yes") ||
1991              strEqual(s_lower, "on"))
1992       result = 1;
1993     else
1994       result = atoi(s);
1995   }
1996
1997   free(s_lower);
1998
1999   return result;
2000 }
2001
2002 boolean get_boolean_from_string(char *s)
2003 {
2004   char *s_lower = getStringToLower(s);
2005   boolean result = FALSE;
2006
2007   if (strEqual(s_lower, "true") ||
2008       strEqual(s_lower, "yes") ||
2009       strEqual(s_lower, "on") ||
2010       get_integer_from_string(s) == 1)
2011     result = TRUE;
2012
2013   free(s_lower);
2014
2015   return result;
2016 }
2017
2018 int get_switch3_from_string(char *s)
2019 {
2020   char *s_lower = getStringToLower(s);
2021   int result = FALSE;
2022
2023   if (strEqual(s_lower, "true") ||
2024       strEqual(s_lower, "yes") ||
2025       strEqual(s_lower, "on") ||
2026       get_integer_from_string(s) == 1)
2027     result = TRUE;
2028   else if (strEqual(s_lower, "auto"))
2029     result = AUTO;
2030
2031   free(s_lower);
2032
2033   return result;
2034 }
2035
2036
2037 /* ------------------------------------------------------------------------- */
2038 /* functions for generic lists                                               */
2039 /* ------------------------------------------------------------------------- */
2040
2041 ListNode *newListNode()
2042 {
2043   return checked_calloc(sizeof(ListNode));
2044 }
2045
2046 void addNodeToList(ListNode **node_first, char *key, void *content)
2047 {
2048   ListNode *node_new = newListNode();
2049
2050   node_new->key = getStringCopy(key);
2051   node_new->content = content;
2052   node_new->next = *node_first;
2053   *node_first = node_new;
2054 }
2055
2056 void deleteNodeFromList(ListNode **node_first, char *key,
2057                         void (*destructor_function)(void *))
2058 {
2059   if (node_first == NULL || *node_first == NULL)
2060     return;
2061
2062   if (strEqual((*node_first)->key, key))
2063   {
2064     checked_free((*node_first)->key);
2065     if (destructor_function)
2066       destructor_function((*node_first)->content);
2067     *node_first = (*node_first)->next;
2068   }
2069   else
2070     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2071 }
2072
2073 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2074 {
2075   if (node_first == NULL)
2076     return NULL;
2077
2078   if (strEqual(node_first->key, key))
2079     return node_first;
2080   else
2081     return getNodeFromKey(node_first->next, key);
2082 }
2083
2084 int getNumNodes(ListNode *node_first)
2085 {
2086   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2087 }
2088
2089 void dumpList(ListNode *node_first)
2090 {
2091   ListNode *node = node_first;
2092
2093   while (node)
2094   {
2095     printf("['%s' (%d)]\n", node->key,
2096            ((struct ListNodeInfo *)node->content)->num_references);
2097     node = node->next;
2098   }
2099
2100   printf("[%d nodes]\n", getNumNodes(node_first));
2101 }
2102
2103
2104 /* ------------------------------------------------------------------------- */
2105 /* functions for file handling                                               */
2106 /* ------------------------------------------------------------------------- */
2107
2108 File *openFile(char *filename, char *mode)
2109 {
2110   File *file = checked_calloc(sizeof(File));
2111
2112   file->file = fopen(filename, mode);
2113
2114   if (file->file != NULL)
2115   {
2116     file->filename = getStringCopy(filename);
2117
2118     return file;
2119   }
2120
2121 #if defined(PLATFORM_ANDROID)
2122   file->asset_file = SDL_RWFromFile(filename, mode);
2123
2124   if (file->asset_file != NULL)
2125   {
2126     file->file_is_asset = TRUE;
2127     file->filename = getStringCopy(filename);
2128
2129     return file;
2130   }
2131 #endif
2132
2133   checked_free(file);
2134
2135   return NULL;
2136 }
2137
2138 int closeFile(File *file)
2139 {
2140   if (file == NULL)
2141     return -1;
2142
2143   int result = 0;
2144
2145 #if defined(PLATFORM_ANDROID)
2146   if (file->asset_file)
2147     result = SDL_RWclose(file->asset_file);
2148 #endif
2149
2150   if (file->file)
2151     result = fclose(file->file);
2152
2153   checked_free(file->filename);
2154   checked_free(file);
2155
2156   return result;
2157 }
2158
2159 int checkEndOfFile(File *file)
2160 {
2161 #if defined(PLATFORM_ANDROID)
2162   if (file->file_is_asset)
2163     return file->end_of_file;
2164 #endif
2165
2166   return feof(file->file);
2167 }
2168
2169 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2170 {
2171 #if defined(PLATFORM_ANDROID)
2172   if (file->file_is_asset)
2173   {
2174     if (file->end_of_file)
2175       return 0;
2176
2177     size_t num_items_read =
2178       SDL_RWread(file->asset_file, buffer, item_size, num_items);
2179
2180     if (num_items_read < num_items)
2181       file->end_of_file = TRUE;
2182
2183     return num_items_read;
2184   }
2185 #endif
2186
2187   return fread(buffer, item_size, num_items, file->file);
2188 }
2189
2190 int seekFile(File *file, long offset, int whence)
2191 {
2192 #if defined(PLATFORM_ANDROID)
2193   if (file->file_is_asset)
2194   {
2195     int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2196                       whence == SEEK_CUR ? RW_SEEK_CUR :
2197                       whence == SEEK_END ? RW_SEEK_END : 0);
2198
2199     return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2200   }
2201 #endif
2202
2203   return fseek(file->file, offset, whence);
2204 }
2205
2206 int getByteFromFile(File *file)
2207 {
2208 #if defined(PLATFORM_ANDROID)
2209   if (file->file_is_asset)
2210   {
2211     if (file->end_of_file)
2212       return EOF;
2213
2214     byte c;
2215     size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2216
2217     if (num_bytes_read < 1)
2218       file->end_of_file = TRUE;
2219
2220     return (file->end_of_file ? EOF : (int)c);
2221   }
2222 #endif
2223
2224   return fgetc(file->file);
2225 }
2226
2227 char *getStringFromFile(File *file, char *line, int size)
2228 {
2229 #if defined(PLATFORM_ANDROID)
2230   if (file->file_is_asset)
2231   {
2232     if (file->end_of_file)
2233       return NULL;
2234
2235     char *line_ptr = line;
2236     int num_bytes_read = 0;
2237
2238     while (num_bytes_read < size - 1 &&
2239            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2240            *line_ptr++ != '\n')
2241       num_bytes_read++;
2242
2243     *line_ptr = '\0';
2244
2245     if (strlen(line) == 0)
2246     {
2247       file->end_of_file = TRUE;
2248
2249       return NULL;
2250     }
2251
2252     return line;
2253   }
2254 #endif
2255
2256   return fgets(line, size, file->file);
2257 }
2258
2259
2260 /* ------------------------------------------------------------------------- */
2261 /* functions for directory handling                                          */
2262 /* ------------------------------------------------------------------------- */
2263
2264 Directory *openDirectory(char *dir_name)
2265 {
2266   Directory *dir = checked_calloc(sizeof(Directory));
2267
2268   dir->dir = opendir(dir_name);
2269
2270   if (dir->dir != NULL)
2271   {
2272     dir->filename = getStringCopy(dir_name);
2273
2274     return dir;
2275   }
2276
2277 #if defined(PLATFORM_ANDROID)
2278   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2279
2280   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2281
2282   checked_free(asset_toc_filename);
2283
2284   if (dir->asset_toc_file != NULL)
2285   {
2286     dir->directory_is_asset = TRUE;
2287     dir->filename = getStringCopy(dir_name);
2288
2289     return dir;
2290   }
2291 #endif
2292
2293   checked_free(dir);
2294
2295   return NULL;
2296 }
2297
2298 int closeDirectory(Directory *dir)
2299 {
2300   if (dir == NULL)
2301     return -1;
2302
2303   int result = 0;
2304
2305 #if defined(PLATFORM_ANDROID)
2306   if (dir->asset_toc_file)
2307     result = SDL_RWclose(dir->asset_toc_file);
2308 #endif
2309
2310   if (dir->dir)
2311     result = closedir(dir->dir);
2312
2313   if (dir->dir_entry)
2314     freeDirectoryEntry(dir->dir_entry);
2315
2316   checked_free(dir->filename);
2317   checked_free(dir);
2318
2319   return result;
2320 }
2321
2322 DirectoryEntry *readDirectory(Directory *dir)
2323 {
2324   if (dir->dir_entry)
2325     freeDirectoryEntry(dir->dir_entry);
2326
2327   dir->dir_entry = NULL;
2328
2329 #if defined(PLATFORM_ANDROID)
2330   if (dir->directory_is_asset)
2331   {
2332     char line[MAX_LINE_LEN];
2333     char *line_ptr = line;
2334     int num_bytes_read = 0;
2335
2336     while (num_bytes_read < MAX_LINE_LEN - 1 &&
2337            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2338            *line_ptr != '\n')
2339     {
2340       line_ptr++;
2341       num_bytes_read++;
2342     }
2343
2344     *line_ptr = '\0';
2345
2346     if (strlen(line) == 0)
2347       return NULL;
2348
2349     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2350
2351     dir->dir_entry->is_directory = FALSE;
2352     if (line[strlen(line) - 1] == '/')
2353     {
2354       dir->dir_entry->is_directory = TRUE;
2355
2356       line[strlen(line) - 1] = '\0';
2357     }
2358
2359     dir->dir_entry->basename = getStringCopy(line);
2360     dir->dir_entry->filename = getPath2(dir->filename, line);
2361
2362     return dir->dir_entry;
2363   }
2364 #endif
2365
2366   struct dirent *dir_entry = readdir(dir->dir);
2367
2368   if (dir_entry == NULL)
2369     return NULL;
2370
2371   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2372
2373   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2374   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2375
2376   struct stat file_status;
2377
2378   dir->dir_entry->is_directory =
2379     (stat(dir->dir_entry->filename, &file_status) == 0 &&
2380      (file_status.st_mode & S_IFMT) == S_IFDIR);
2381
2382 #if 0
2383   Error(ERR_INFO, "::: '%s' is directory: %d",
2384         dir->dir_entry->basename,
2385         dir->dir_entry->is_directory);
2386 #endif
2387
2388   return dir->dir_entry;
2389 }
2390
2391 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2392 {
2393   if (dir_entry == NULL)
2394     return;
2395
2396   checked_free(dir_entry->basename);
2397   checked_free(dir_entry->filename);
2398   checked_free(dir_entry);
2399 }
2400
2401
2402 /* ------------------------------------------------------------------------- */
2403 /* functions for checking files and filenames                                */
2404 /* ------------------------------------------------------------------------- */
2405
2406 boolean directoryExists(char *dir_name)
2407 {
2408   if (dir_name == NULL)
2409     return FALSE;
2410
2411   boolean success = (access(dir_name, F_OK) == 0);
2412
2413 #if defined(PLATFORM_ANDROID)
2414   if (!success)
2415   {
2416     // this might be an asset directory; check by trying to open toc file
2417     char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2418     SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2419
2420     checked_free(asset_toc_filename);
2421
2422     success = (file != NULL);
2423
2424     if (success)
2425       SDL_RWclose(file);
2426   }
2427 #endif
2428
2429   return success;
2430 }
2431
2432 boolean fileExists(char *filename)
2433 {
2434   if (filename == NULL)
2435     return FALSE;
2436
2437   boolean success = (access(filename, F_OK) == 0);
2438
2439 #if defined(PLATFORM_ANDROID)
2440   if (!success)
2441   {
2442     // this might be an asset file; check by trying to open it
2443     SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2444
2445     success = (file != NULL);
2446
2447     if (success)
2448       SDL_RWclose(file);
2449   }
2450 #endif
2451
2452   return success;
2453 }
2454
2455 boolean fileHasPrefix(char *basename, char *prefix)
2456 {
2457   static char *basename_lower = NULL;
2458   int basename_length, prefix_length;
2459
2460   checked_free(basename_lower);
2461
2462   if (basename == NULL || prefix == NULL)
2463     return FALSE;
2464
2465   basename_lower = getStringToLower(basename);
2466   basename_length = strlen(basename_lower);
2467   prefix_length = strlen(prefix);
2468
2469   if (basename_length > prefix_length + 1 &&
2470       basename_lower[prefix_length] == '.' &&
2471       strncmp(basename_lower, prefix, prefix_length) == 0)
2472     return TRUE;
2473
2474   return FALSE;
2475 }
2476
2477 boolean fileHasSuffix(char *basename, char *suffix)
2478 {
2479   static char *basename_lower = NULL;
2480   int basename_length, suffix_length;
2481
2482   checked_free(basename_lower);
2483
2484   if (basename == NULL || suffix == NULL)
2485     return FALSE;
2486
2487   basename_lower = getStringToLower(basename);
2488   basename_length = strlen(basename_lower);
2489   suffix_length = strlen(suffix);
2490
2491   if (basename_length > suffix_length + 1 &&
2492       basename_lower[basename_length - suffix_length - 1] == '.' &&
2493       strEqual(&basename_lower[basename_length - suffix_length], suffix))
2494     return TRUE;
2495
2496   return FALSE;
2497 }
2498
2499 #if defined(TARGET_SDL)
2500 static boolean FileCouldBeArtwork(char *basename)
2501 {
2502   return (!strEqual(basename, ".") &&
2503           !strEqual(basename, "..") &&
2504           !fileHasSuffix(basename, "txt") &&
2505           !fileHasSuffix(basename, "conf"));
2506 }
2507 #endif
2508
2509 boolean FileIsGraphic(char *filename)
2510 {
2511   char *basename = getBaseNamePtr(filename);
2512
2513 #if defined(TARGET_SDL)
2514   return FileCouldBeArtwork(basename);
2515 #else
2516   return fileHasSuffix(basename, "pcx");
2517 #endif
2518 }
2519
2520 boolean FileIsSound(char *filename)
2521 {
2522   char *basename = getBaseNamePtr(filename);
2523
2524 #if defined(TARGET_SDL)
2525   return FileCouldBeArtwork(basename);
2526 #else
2527   return fileHasSuffix(basename, "wav");
2528 #endif
2529 }
2530
2531 boolean FileIsMusic(char *filename)
2532 {
2533   char *basename = getBaseNamePtr(filename);
2534
2535 #if defined(TARGET_SDL)
2536   return FileCouldBeArtwork(basename);
2537 #else
2538   if (FileIsSound(basename))
2539     return TRUE;
2540
2541 #if 0
2542 #if defined(TARGET_SDL)
2543   if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2544       fileHasSuffix(basename, "mod") ||
2545       fileHasSuffix(basename, "s3m") ||
2546       fileHasSuffix(basename, "it") ||
2547       fileHasSuffix(basename, "xm") ||
2548       fileHasSuffix(basename, "midi") ||
2549       fileHasSuffix(basename, "mid") ||
2550       fileHasSuffix(basename, "mp3") ||
2551       fileHasSuffix(basename, "ogg"))
2552     return TRUE;
2553 #endif
2554 #endif
2555
2556   return FALSE;
2557 #endif
2558 }
2559
2560 boolean FileIsArtworkType(char *basename, int type)
2561 {
2562   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2563       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2564       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2565     return TRUE;
2566
2567   return FALSE;
2568 }
2569
2570 /* ------------------------------------------------------------------------- */
2571 /* functions for loading artwork configuration information                   */
2572 /* ------------------------------------------------------------------------- */
2573
2574 char *get_mapped_token(char *token)
2575 {
2576   /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2577   static char *map_token_prefix[][2] =
2578   {
2579     { "char_procent",           "char_percent"  },
2580     { NULL,                                     }
2581   };
2582   int i;
2583
2584   for (i = 0; map_token_prefix[i][0] != NULL; i++)
2585   {
2586     int len_token_prefix = strlen(map_token_prefix[i][0]);
2587
2588     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2589       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2590   }
2591
2592   return NULL;
2593 }
2594
2595 /* This function checks if a string <s> of the format "string1, string2, ..."
2596    exactly contains a string <s_contained>. */
2597
2598 static boolean string_has_parameter(char *s, char *s_contained)
2599 {
2600   char *substring;
2601
2602   if (s == NULL || s_contained == NULL)
2603     return FALSE;
2604
2605   if (strlen(s_contained) > strlen(s))
2606     return FALSE;
2607
2608   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2609   {
2610     char next_char = s[strlen(s_contained)];
2611
2612     /* check if next character is delimiter or whitespace */
2613     return (next_char == ',' || next_char == '\0' ||
2614             next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2615   }
2616
2617   /* check if string contains another parameter string after a comma */
2618   substring = strchr(s, ',');
2619   if (substring == NULL)        /* string does not contain a comma */
2620     return FALSE;
2621
2622   /* advance string pointer to next character after the comma */
2623   substring++;
2624
2625   /* skip potential whitespaces after the comma */
2626   while (*substring == ' ' || *substring == '\t')
2627     substring++;
2628
2629   return string_has_parameter(substring, s_contained);
2630 }
2631
2632 int get_parameter_value(char *value_raw, char *suffix, int type)
2633 {
2634   char *value = getStringToLower(value_raw);
2635   int result = 0;       /* probably a save default value */
2636
2637   if (strEqual(suffix, ".direction"))
2638   {
2639     result = (strEqual(value, "left")  ? MV_LEFT :
2640               strEqual(value, "right") ? MV_RIGHT :
2641               strEqual(value, "up")    ? MV_UP :
2642               strEqual(value, "down")  ? MV_DOWN : MV_NONE);
2643   }
2644   else if (strEqual(suffix, ".align"))
2645   {
2646     result = (strEqual(value, "left")   ? ALIGN_LEFT :
2647               strEqual(value, "right")  ? ALIGN_RIGHT :
2648               strEqual(value, "center") ? ALIGN_CENTER :
2649               strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2650   }
2651   else if (strEqual(suffix, ".valign"))
2652   {
2653     result = (strEqual(value, "top")    ? VALIGN_TOP :
2654               strEqual(value, "bottom") ? VALIGN_BOTTOM :
2655               strEqual(value, "middle") ? VALIGN_MIDDLE :
2656               strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2657   }
2658   else if (strEqual(suffix, ".anim_mode"))
2659   {
2660     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
2661               string_has_parameter(value, "loop")       ? ANIM_LOOP :
2662               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
2663               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
2664               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
2665               string_has_parameter(value, "random")     ? ANIM_RANDOM :
2666               string_has_parameter(value, "ce_value")   ? ANIM_CE_VALUE :
2667               string_has_parameter(value, "ce_score")   ? ANIM_CE_SCORE :
2668               string_has_parameter(value, "ce_delay")   ? ANIM_CE_DELAY :
2669               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2670               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
2671               string_has_parameter(value, "centered")   ? ANIM_CENTERED :
2672               ANIM_DEFAULT);
2673
2674     if (string_has_parameter(value, "reverse"))
2675       result |= ANIM_REVERSE;
2676
2677     if (string_has_parameter(value, "opaque_player"))
2678       result |= ANIM_OPAQUE_PLAYER;
2679
2680     if (string_has_parameter(value, "static_panel"))
2681       result |= ANIM_STATIC_PANEL;
2682   }
2683   else if (strEqual(suffix, ".class"))
2684   {
2685     result = get_hash_from_key(value);
2686   }
2687   else if (strEqual(suffix, ".style"))
2688   {
2689     result = STYLE_DEFAULT;
2690
2691     if (string_has_parameter(value, "accurate_borders"))
2692       result |= STYLE_ACCURATE_BORDERS;
2693
2694     if (string_has_parameter(value, "inner_corners"))
2695       result |= STYLE_INNER_CORNERS;
2696   }
2697   else if (strEqual(suffix, ".fade_mode"))
2698   {
2699     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
2700               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
2701               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
2702               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
2703               FADE_MODE_DEFAULT);
2704   }
2705 #if 1
2706   else if (strPrefix(suffix, ".font"))          /* (may also be ".font_xyz") */
2707 #else
2708   else if (strEqualN(suffix, ".font", 5))       /* (may also be ".font_xyz") */
2709 #endif
2710   {
2711     result = gfx.get_font_from_token_function(value);
2712   }
2713   else          /* generic parameter of type integer or boolean */
2714   {
2715     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2716               type == TYPE_INTEGER ? get_integer_from_string(value) :
2717               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2718               ARG_UNDEFINED_VALUE);
2719   }
2720
2721   free(value);
2722
2723   return result;
2724 }
2725
2726 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2727 {
2728   static struct ScreenModeInfo screen_mode;
2729   char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2730   char *screen_mode_string_copy;
2731   char *screen_mode_string_pos_w;
2732   char *screen_mode_string_pos_h;
2733
2734   if (screen_mode_string_x == NULL)     /* invalid screen mode format */
2735     return NULL;
2736
2737   screen_mode_string_copy = getStringCopy(screen_mode_string);
2738
2739   screen_mode_string_pos_w = screen_mode_string_copy;
2740   screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2741   *screen_mode_string_pos_h++ = '\0';
2742
2743   screen_mode.width  = atoi(screen_mode_string_pos_w);
2744   screen_mode.height = atoi(screen_mode_string_pos_h);
2745
2746   return &screen_mode;
2747 }
2748
2749 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2750                                        int *x, int *y)
2751 {
2752   float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2753   float aspect_ratio_new;
2754   int i = 1;
2755
2756   do
2757   {
2758     *x = i * aspect_ratio + 0.000001;
2759     *y = i;
2760
2761     aspect_ratio_new = (float)*x / (float)*y;
2762
2763     i++;
2764   }
2765   while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2766 }
2767
2768 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2769                                   struct ListNodeInfo ***, int *);
2770
2771 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2772                                            struct ConfigTypeInfo *suffix_list,
2773                                            char **ignore_tokens,
2774                                            int num_file_list_entries)
2775 {
2776   struct FileInfo *file_list;
2777   int num_file_list_entries_found = 0;
2778   int num_suffix_list_entries = 0;
2779   int list_pos;
2780   int i, j;
2781
2782   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2783
2784   for (i = 0; suffix_list[i].token != NULL; i++)
2785     num_suffix_list_entries++;
2786
2787   /* always start with reliable default values */
2788   for (i = 0; i < num_file_list_entries; i++)
2789   {
2790     file_list[i].token = NULL;
2791
2792     file_list[i].default_filename = NULL;
2793     file_list[i].filename = NULL;
2794
2795     if (num_suffix_list_entries > 0)
2796     {
2797       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2798
2799       file_list[i].default_parameter = checked_calloc(parameter_array_size);
2800       file_list[i].parameter = checked_calloc(parameter_array_size);
2801
2802       for (j = 0; j < num_suffix_list_entries; j++)
2803       {
2804         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2805         setString(&file_list[i].parameter[j], suffix_list[j].value);
2806       }
2807
2808       file_list[i].redefined = FALSE;
2809       file_list[i].fallback_to_default = FALSE;
2810       file_list[i].default_is_cloned = FALSE;
2811     }
2812   }
2813
2814   list_pos = 0;
2815
2816   for (i = 0; config_list[i].token != NULL; i++)
2817   {
2818     int len_config_token = strlen(config_list[i].token);
2819 #if 0
2820     int len_config_value = strlen(config_list[i].value);
2821 #endif
2822     boolean is_file_entry = TRUE;
2823
2824     for (j = 0; suffix_list[j].token != NULL; j++)
2825     {
2826       int len_suffix = strlen(suffix_list[j].token);
2827
2828       if (len_suffix < len_config_token &&
2829           strEqual(&config_list[i].token[len_config_token - len_suffix],
2830                    suffix_list[j].token))
2831       {
2832         setString(&file_list[list_pos].default_parameter[j],
2833                   config_list[i].value);
2834
2835         is_file_entry = FALSE;
2836
2837         break;
2838       }
2839     }
2840
2841     /* the following tokens are no file definitions, but other config tokens */
2842     for (j = 0; ignore_tokens[j] != NULL; j++)
2843       if (strEqual(config_list[i].token, ignore_tokens[j]))
2844         is_file_entry = FALSE;
2845
2846     if (is_file_entry)
2847     {
2848       if (i > 0)
2849         list_pos++;
2850
2851       if (list_pos >= num_file_list_entries)
2852         break;
2853
2854 #if 0
2855       /* simple sanity check if this is really a file definition */
2856       if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2857           !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2858           !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2859       {
2860         Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2861               config_list[i].token, config_list[i].value);
2862         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2863       }
2864 #endif
2865
2866       file_list[list_pos].token = config_list[i].token;
2867       file_list[list_pos].default_filename = config_list[i].value;
2868
2869 #if 0
2870       printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2871 #endif
2872     }
2873
2874     if (strSuffix(config_list[i].token, ".clone_from"))
2875       file_list[list_pos].default_is_cloned = TRUE;
2876   }
2877
2878   num_file_list_entries_found = list_pos + 1;
2879   if (num_file_list_entries_found != num_file_list_entries)
2880   {
2881     Error(ERR_INFO_LINE, "-");
2882     Error(ERR_INFO, "inconsistant config list information:");
2883     Error(ERR_INFO, "- should be:   %d (according to 'src/conf_xxx.h')",
2884           num_file_list_entries);
2885     Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2886           num_file_list_entries_found);
2887     Error(ERR_EXIT,   "please fix");
2888   }
2889
2890 #if 0
2891   printf("::: ---------- DONE ----------\n");
2892 #endif
2893
2894   return file_list;
2895 }
2896
2897 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2898 {
2899   int len_token = strlen(token);
2900   int len_suffix = strlen(suffix);
2901
2902   if (start_pos < 0)    /* compare suffix from end of string */
2903     start_pos += len_token;
2904
2905   if (start_pos < 0 || start_pos + len_suffix > len_token)
2906     return FALSE;
2907
2908   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2909     return FALSE;
2910
2911   if (token[start_pos + len_suffix] == '\0')
2912     return TRUE;
2913
2914   if (token[start_pos + len_suffix] == '.')
2915     return TRUE;
2916
2917   return FALSE;
2918 }
2919
2920 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
2921
2922 static void read_token_parameters(SetupFileHash *setup_file_hash,
2923                                   struct ConfigTypeInfo *suffix_list,
2924                                   struct FileInfo *file_list_entry)
2925 {
2926   /* check for config token that is the base token without any suffixes */
2927   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2928   char *known_token_value = KNOWN_TOKEN_VALUE;
2929   int i;
2930
2931   if (filename != NULL)
2932   {
2933     setString(&file_list_entry->filename, filename);
2934
2935     /* when file definition found, set all parameters to default values */
2936     for (i = 0; suffix_list[i].token != NULL; i++)
2937       setString(&file_list_entry->parameter[i], suffix_list[i].value);
2938
2939     file_list_entry->redefined = TRUE;
2940
2941     /* mark config file token as well known from default config */
2942     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2943   }
2944
2945   /* check for config tokens that can be build by base token and suffixes */
2946   for (i = 0; suffix_list[i].token != NULL; i++)
2947   {
2948     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2949     char *value = getHashEntry(setup_file_hash, token);
2950
2951     if (value != NULL)
2952     {
2953       setString(&file_list_entry->parameter[i], value);
2954
2955       /* mark config file token as well known from default config */
2956       setHashEntry(setup_file_hash, token, known_token_value);
2957     }
2958
2959     free(token);
2960   }
2961 }
2962
2963 static void add_dynamic_file_list_entry(struct FileInfo **list,
2964                                         int *num_list_entries,
2965                                         SetupFileHash *extra_file_hash,
2966                                         struct ConfigTypeInfo *suffix_list,
2967                                         int num_suffix_list_entries,
2968                                         char *token)
2969 {
2970   struct FileInfo *new_list_entry;
2971   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2972
2973   (*num_list_entries)++;
2974   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2975   new_list_entry = &(*list)[*num_list_entries - 1];
2976
2977   new_list_entry->token = getStringCopy(token);
2978   new_list_entry->default_filename = NULL;
2979   new_list_entry->filename = NULL;
2980   new_list_entry->parameter = checked_calloc(parameter_array_size);
2981
2982   new_list_entry->redefined = FALSE;
2983   new_list_entry->fallback_to_default = FALSE;
2984   new_list_entry->default_is_cloned = FALSE;
2985
2986   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2987 }
2988
2989 static void add_property_mapping(struct PropertyMapping **list,
2990                                  int *num_list_entries,
2991                                  int base_index, int ext1_index,
2992                                  int ext2_index, int ext3_index,
2993                                  int artwork_index)
2994 {
2995   struct PropertyMapping *new_list_entry;
2996
2997   (*num_list_entries)++;
2998   *list = checked_realloc(*list,
2999                           *num_list_entries * sizeof(struct PropertyMapping));
3000   new_list_entry = &(*list)[*num_list_entries - 1];
3001
3002   new_list_entry->base_index = base_index;
3003   new_list_entry->ext1_index = ext1_index;
3004   new_list_entry->ext2_index = ext2_index;
3005   new_list_entry->ext3_index = ext3_index;
3006
3007   new_list_entry->artwork_index = artwork_index;
3008 }
3009
3010 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3011                                           char *filename)
3012 {
3013   struct FileInfo *file_list = artwork_info->file_list;
3014   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3015   char **base_prefixes = artwork_info->base_prefixes;
3016   char **ext1_suffixes = artwork_info->ext1_suffixes;
3017   char **ext2_suffixes = artwork_info->ext2_suffixes;
3018   char **ext3_suffixes = artwork_info->ext3_suffixes;
3019   char **ignore_tokens = artwork_info->ignore_tokens;
3020   int num_file_list_entries = artwork_info->num_file_list_entries;
3021   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3022   int num_base_prefixes = artwork_info->num_base_prefixes;
3023   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3024   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3025   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3026   int num_ignore_tokens = artwork_info->num_ignore_tokens;
3027   SetupFileHash *setup_file_hash, *valid_file_hash;
3028   SetupFileHash *extra_file_hash, *empty_file_hash;
3029   char *known_token_value = KNOWN_TOKEN_VALUE;
3030   int i, j, k, l;
3031
3032   if (filename == NULL)
3033     return;
3034
3035 #if 0
3036   printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
3037 #endif
3038
3039   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3040     return;
3041
3042   /* separate valid (defined) from empty (undefined) config token values */
3043   valid_file_hash = newSetupFileHash();
3044   empty_file_hash = newSetupFileHash();
3045   BEGIN_HASH_ITERATION(setup_file_hash, itr)
3046   {
3047     char *value = HASH_ITERATION_VALUE(itr);
3048
3049     setHashEntry(*value ? valid_file_hash : empty_file_hash,
3050                  HASH_ITERATION_TOKEN(itr), value);
3051   }
3052   END_HASH_ITERATION(setup_file_hash, itr)
3053
3054   /* at this point, we do not need the setup file hash anymore -- free it */
3055   freeSetupFileHash(setup_file_hash);
3056
3057   /* map deprecated to current tokens (using prefix match and replace) */
3058   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3059   {
3060     char *token = HASH_ITERATION_TOKEN(itr);
3061     char *mapped_token = get_mapped_token(token);
3062
3063     if (mapped_token != NULL)
3064     {
3065       char *value = HASH_ITERATION_VALUE(itr);
3066
3067       /* add mapped token */
3068       setHashEntry(valid_file_hash, mapped_token, value);
3069
3070       /* ignore old token (by setting it to "known" keyword) */
3071       setHashEntry(valid_file_hash, token, known_token_value);
3072
3073       free(mapped_token);
3074     }
3075   }
3076   END_HASH_ITERATION(valid_file_hash, itr)
3077
3078   /* read parameters for all known config file tokens */
3079   for (i = 0; i < num_file_list_entries; i++)
3080     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3081
3082   /* set all tokens that can be ignored here to "known" keyword */
3083   for (i = 0; i < num_ignore_tokens; i++)
3084     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3085
3086   /* copy all unknown config file tokens to extra config hash */
3087   extra_file_hash = newSetupFileHash();
3088   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3089   {
3090     char *value = HASH_ITERATION_VALUE(itr);
3091
3092     if (!strEqual(value, known_token_value))
3093       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3094   }
3095   END_HASH_ITERATION(valid_file_hash, itr)
3096
3097   /* at this point, we do not need the valid file hash anymore -- free it */
3098   freeSetupFileHash(valid_file_hash);
3099
3100   /* now try to determine valid, dynamically defined config tokens */
3101
3102   BEGIN_HASH_ITERATION(extra_file_hash, itr)
3103   {
3104     struct FileInfo **dynamic_file_list =
3105       &artwork_info->dynamic_file_list;
3106     int *num_dynamic_file_list_entries =
3107       &artwork_info->num_dynamic_file_list_entries;
3108     struct PropertyMapping **property_mapping =
3109       &artwork_info->property_mapping;
3110     int *num_property_mapping_entries =
3111       &artwork_info->num_property_mapping_entries;
3112     int current_summarized_file_list_entry =
3113       artwork_info->num_file_list_entries +
3114       artwork_info->num_dynamic_file_list_entries;
3115     char *token = HASH_ITERATION_TOKEN(itr);
3116     int len_token = strlen(token);
3117     int start_pos;
3118     boolean base_prefix_found = FALSE;
3119     boolean parameter_suffix_found = FALSE;
3120
3121 #if 0
3122     printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3123 #endif
3124
3125     /* skip all parameter definitions (handled by read_token_parameters()) */
3126     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3127     {
3128       int len_suffix = strlen(suffix_list[i].token);
3129
3130       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3131         parameter_suffix_found = TRUE;
3132     }
3133
3134     if (parameter_suffix_found)
3135       continue;
3136
3137     /* ---------- step 0: search for matching base prefix ---------- */
3138
3139     start_pos = 0;
3140     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3141     {
3142       char *base_prefix = base_prefixes[i];
3143       int len_base_prefix = strlen(base_prefix);
3144       boolean ext1_suffix_found = FALSE;
3145       boolean ext2_suffix_found = FALSE;
3146       boolean ext3_suffix_found = FALSE;
3147       boolean exact_match = FALSE;
3148       int base_index = -1;
3149       int ext1_index = -1;
3150       int ext2_index = -1;
3151       int ext3_index = -1;
3152
3153       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3154
3155       if (!base_prefix_found)
3156         continue;
3157
3158       base_index = i;
3159
3160 #if 0
3161       if (IS_PARENT_PROCESS())
3162         printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3163 #endif
3164
3165       if (start_pos + len_base_prefix == len_token)     /* exact match */
3166       {
3167         exact_match = TRUE;
3168
3169 #if 0
3170         if (IS_PARENT_PROCESS())
3171           printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3172 #endif
3173
3174         add_dynamic_file_list_entry(dynamic_file_list,
3175                                     num_dynamic_file_list_entries,
3176                                     extra_file_hash,
3177                                     suffix_list,
3178                                     num_suffix_list_entries,
3179                                     token);
3180         add_property_mapping(property_mapping,
3181                              num_property_mapping_entries,
3182                              base_index, -1, -1, -1,
3183                              current_summarized_file_list_entry);
3184         continue;
3185       }
3186
3187 #if 0
3188       if (IS_PARENT_PROCESS())
3189         printf("---> examining token '%s': search 1st suffix ...\n", token);
3190 #endif
3191
3192       /* ---------- step 1: search for matching first suffix ---------- */
3193
3194       start_pos += len_base_prefix;
3195       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3196       {
3197         char *ext1_suffix = ext1_suffixes[j];
3198         int len_ext1_suffix = strlen(ext1_suffix);
3199
3200         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3201
3202         if (!ext1_suffix_found)
3203           continue;
3204
3205         ext1_index = j;
3206
3207 #if 0
3208         if (IS_PARENT_PROCESS())
3209           printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3210 #endif
3211
3212         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
3213         {
3214           exact_match = TRUE;
3215
3216 #if 0
3217         if (IS_PARENT_PROCESS())
3218           printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3219 #endif
3220
3221           add_dynamic_file_list_entry(dynamic_file_list,
3222                                       num_dynamic_file_list_entries,
3223                                       extra_file_hash,
3224                                       suffix_list,
3225                                       num_suffix_list_entries,
3226                                       token);
3227           add_property_mapping(property_mapping,
3228                                num_property_mapping_entries,
3229                                base_index, ext1_index, -1, -1,
3230                                current_summarized_file_list_entry);
3231           continue;
3232         }
3233
3234         start_pos += len_ext1_suffix;
3235       }
3236
3237       if (exact_match)
3238         break;
3239
3240 #if 0
3241       if (IS_PARENT_PROCESS())
3242         printf("---> examining token '%s': search 2nd suffix ...\n", token);
3243 #endif
3244
3245       /* ---------- step 2: search for matching second suffix ---------- */
3246
3247       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3248       {
3249         char *ext2_suffix = ext2_suffixes[k];
3250         int len_ext2_suffix = strlen(ext2_suffix);
3251
3252         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3253
3254         if (!ext2_suffix_found)
3255           continue;
3256
3257         ext2_index = k;
3258
3259 #if 0
3260         if (IS_PARENT_PROCESS())
3261           printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3262 #endif
3263
3264         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
3265         {
3266           exact_match = TRUE;
3267
3268 #if 0
3269           if (IS_PARENT_PROCESS())
3270             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3271 #endif
3272
3273           add_dynamic_file_list_entry(dynamic_file_list,
3274                                       num_dynamic_file_list_entries,
3275                                       extra_file_hash,
3276                                       suffix_list,
3277                                       num_suffix_list_entries,
3278                                       token);
3279           add_property_mapping(property_mapping,
3280                                num_property_mapping_entries,
3281                                base_index, ext1_index, ext2_index, -1,
3282                                current_summarized_file_list_entry);
3283           continue;
3284         }
3285
3286         start_pos += len_ext2_suffix;
3287       }
3288
3289       if (exact_match)
3290         break;
3291
3292 #if 0
3293       if (IS_PARENT_PROCESS())
3294         printf("---> examining token '%s': search 3rd suffix ...\n",token);
3295 #endif
3296
3297       /* ---------- step 3: search for matching third suffix ---------- */
3298
3299       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3300       {
3301         char *ext3_suffix = ext3_suffixes[l];
3302         int len_ext3_suffix = strlen(ext3_suffix);
3303
3304         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3305
3306         if (!ext3_suffix_found)
3307           continue;
3308
3309         ext3_index = l;
3310
3311 #if 0
3312         if (IS_PARENT_PROCESS())
3313           printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3314 #endif
3315
3316         if (start_pos + len_ext3_suffix == len_token) /* exact match */
3317         {
3318           exact_match = TRUE;
3319
3320 #if 0
3321           if (IS_PARENT_PROCESS())
3322             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3323 #endif
3324
3325           add_dynamic_file_list_entry(dynamic_file_list,
3326                                       num_dynamic_file_list_entries,
3327                                       extra_file_hash,
3328                                       suffix_list,
3329                                       num_suffix_list_entries,
3330                                       token);
3331           add_property_mapping(property_mapping,
3332                                num_property_mapping_entries,
3333                                base_index, ext1_index, ext2_index, ext3_index,
3334                                current_summarized_file_list_entry);
3335           continue;
3336         }
3337       }
3338     }
3339   }
3340   END_HASH_ITERATION(extra_file_hash, itr)
3341
3342   if (artwork_info->num_dynamic_file_list_entries > 0)
3343   {
3344     artwork_info->dynamic_artwork_list =
3345       checked_calloc(artwork_info->num_dynamic_file_list_entries *
3346                      artwork_info->sizeof_artwork_list_entry);
3347   }
3348
3349   if (options.verbose && IS_PARENT_PROCESS())
3350   {
3351     SetupFileList *setup_file_list, *list;
3352     boolean dynamic_tokens_found = FALSE;
3353     boolean unknown_tokens_found = FALSE;
3354     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3355
3356     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3357       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3358
3359     BEGIN_HASH_ITERATION(extra_file_hash, itr)
3360     {
3361       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3362         dynamic_tokens_found = TRUE;
3363       else
3364         unknown_tokens_found = TRUE;
3365     }
3366     END_HASH_ITERATION(extra_file_hash, itr)
3367
3368     if (options.debug && dynamic_tokens_found)
3369     {
3370       Error(ERR_INFO_LINE, "-");
3371       Error(ERR_INFO, "dynamic token(s) found in config file:");
3372       Error(ERR_INFO, "- config file: '%s'", filename);
3373
3374       for (list = setup_file_list; list != NULL; list = list->next)
3375       {
3376         char *value = getHashEntry(extra_file_hash, list->token);
3377
3378         if (value != NULL && strEqual(value, known_token_value))
3379           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3380       }
3381
3382       Error(ERR_INFO_LINE, "-");
3383     }
3384
3385     if (unknown_tokens_found)
3386     {
3387       Error(ERR_INFO_LINE, "-");
3388       Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3389       Error(ERR_INFO, "- config file: '%s'", filename);
3390
3391       for (list = setup_file_list; list != NULL; list = list->next)
3392       {
3393         char *value = getHashEntry(extra_file_hash, list->token);
3394
3395         if (value != NULL && !strEqual(value, known_token_value))
3396           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3397       }
3398
3399       Error(ERR_INFO_LINE, "-");
3400     }
3401
3402     if (undefined_values_found)
3403     {
3404       Error(ERR_INFO_LINE, "-");
3405       Error(ERR_INFO, "warning: undefined values found in config file:");
3406       Error(ERR_INFO, "- config file: '%s'", filename);
3407
3408       for (list = setup_file_list; list != NULL; list = list->next)
3409       {
3410         char *value = getHashEntry(empty_file_hash, list->token);
3411
3412         if (value != NULL)
3413           Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3414       }
3415
3416       Error(ERR_INFO_LINE, "-");
3417     }
3418
3419     freeSetupFileList(setup_file_list);
3420   }
3421
3422   freeSetupFileHash(extra_file_hash);
3423   freeSetupFileHash(empty_file_hash);
3424
3425 #if 0
3426   for (i = 0; i < num_file_list_entries; i++)
3427   {
3428     printf("'%s' ", file_list[i].token);
3429     if (file_list[i].filename)
3430       printf("-> '%s'\n", file_list[i].filename);
3431     else
3432       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3433   }
3434 #endif
3435 }
3436
3437 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3438 {
3439   struct FileInfo *file_list = artwork_info->file_list;
3440   int num_file_list_entries = artwork_info->num_file_list_entries;
3441   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3442   char *filename_base = UNDEFINED_FILENAME, *filename_local;
3443   int i, j;
3444
3445   DrawInitText("Loading artwork config", 120, FC_GREEN);
3446   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3447
3448   /* always start with reliable default values */
3449   for (i = 0; i < num_file_list_entries; i++)
3450   {
3451     setString(&file_list[i].filename, file_list[i].default_filename);
3452
3453     for (j = 0; j < num_suffix_list_entries; j++)
3454       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3455
3456     file_list[i].redefined = FALSE;
3457     file_list[i].fallback_to_default = FALSE;
3458   }
3459
3460   /* free previous dynamic artwork file array */
3461   if (artwork_info->dynamic_file_list != NULL)
3462   {
3463     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3464     {
3465       free(artwork_info->dynamic_file_list[i].token);
3466       free(artwork_info->dynamic_file_list[i].filename);
3467       free(artwork_info->dynamic_file_list[i].parameter);
3468     }
3469
3470     free(artwork_info->dynamic_file_list);
3471     artwork_info->dynamic_file_list = NULL;
3472
3473     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3474                           &artwork_info->num_dynamic_file_list_entries);
3475   }
3476
3477   /* free previous property mapping */
3478   if (artwork_info->property_mapping != NULL)
3479   {
3480     free(artwork_info->property_mapping);
3481
3482     artwork_info->property_mapping = NULL;
3483     artwork_info->num_property_mapping_entries = 0;
3484   }
3485
3486 #if 1
3487   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3488 #else
3489   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3490 #endif
3491   {
3492     /* first look for special artwork configured in level series config */
3493     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3494
3495 #if 0
3496     printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3497            leveldir_current->graphics_set,
3498            leveldir_current->graphics_path);
3499 #endif
3500
3501     if (fileExists(filename_base))
3502       LoadArtworkConfigFromFilename(artwork_info, filename_base);
3503   }
3504
3505   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3506
3507   if (filename_local != NULL && !strEqual(filename_base, filename_local))
3508     LoadArtworkConfigFromFilename(artwork_info, filename_local);
3509 }
3510
3511 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3512                                    struct ListNodeInfo **listnode)
3513 {
3514   if (*listnode)
3515   {
3516     char *filename = (*listnode)->source_filename;
3517
3518     if (--(*listnode)->num_references <= 0)
3519       deleteNodeFromList(&artwork_info->content_list, filename,
3520                          artwork_info->free_artwork);
3521
3522     *listnode = NULL;
3523   }
3524 }
3525
3526 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3527                                     struct ListNodeInfo **listnode,
3528                                     struct FileInfo *file_list_entry)
3529 {
3530   char *init_text[] =
3531   {
3532     "Loading graphics",
3533     "Loading sounds",
3534     "Loading music"
3535   };
3536
3537   ListNode *node;
3538   char *basename = file_list_entry->filename;
3539   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3540
3541   if (filename == NULL)
3542   {
3543     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3544
3545     basename = file_list_entry->default_filename;
3546
3547     /* fail for cloned default artwork that has no default filename defined */
3548     if (file_list_entry->default_is_cloned &&
3549         strEqual(basename, UNDEFINED_FILENAME))
3550     {
3551       int error_mode = ERR_WARN;
3552
3553       /* we can get away without sounds and music, but not without graphics */
3554       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3555         error_mode = ERR_EXIT;
3556
3557       Error(error_mode, "token '%s' was cloned and has no default filename",
3558             file_list_entry->token);
3559
3560       return;
3561     }
3562
3563     /* dynamic artwork has no default filename / skip empty default artwork */
3564     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3565       return;
3566
3567     file_list_entry->fallback_to_default = TRUE;
3568
3569     Error(ERR_WARN, "trying default artwork file '%s'", basename);
3570
3571     filename = getCustomArtworkFilename(basename, artwork_info->type);
3572
3573     if (filename == NULL)
3574     {
3575       int error_mode = ERR_WARN;
3576
3577       /* we can get away without sounds and music, but not without graphics */
3578       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3579         error_mode = ERR_EXIT;
3580
3581       Error(error_mode, "cannot find default artwork file '%s'", basename);
3582
3583       return;
3584     }
3585   }
3586
3587   /* check if the old and the new artwork file are the same */
3588   if (*listnode && strEqual((*listnode)->source_filename, filename))
3589   {
3590     /* The old and new artwork are the same (have the same filename and path).
3591        This usually means that this artwork does not exist in this artwork set
3592        and a fallback to the existing artwork is done. */
3593
3594 #if 0
3595     printf("[artwork '%s' already exists (same list entry)]\n", filename);
3596 #endif
3597
3598     return;
3599   }
3600
3601   /* delete existing artwork file entry */
3602   deleteArtworkListEntry(artwork_info, listnode);
3603
3604   /* check if the new artwork file already exists in the list of artworks */
3605   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3606   {
3607 #if 0
3608       printf("[artwork '%s' already exists (other list entry)]\n", filename);
3609 #endif
3610
3611       *listnode = (struct ListNodeInfo *)node->content;
3612       (*listnode)->num_references++;
3613
3614       return;
3615   }
3616
3617   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3618   DrawInitText(basename, 150, FC_YELLOW);
3619
3620   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3621   {
3622 #if 0
3623       printf("[adding new artwork '%s']\n", filename);
3624 #endif
3625
3626     (*listnode)->num_references = 1;
3627     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3628                   *listnode);
3629   }
3630   else
3631   {
3632     int error_mode = ERR_WARN;
3633
3634     /* we can get away without sounds and music, but not without graphics */
3635     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3636       error_mode = ERR_EXIT;
3637
3638     Error(error_mode, "cannot load artwork file '%s'", basename);
3639
3640     return;
3641   }
3642 }
3643
3644 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3645                               struct ListNodeInfo **listnode,
3646                               struct FileInfo *file_list_entry)
3647 {
3648 #if 0
3649   printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3650 #endif
3651
3652   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3653   {
3654     deleteArtworkListEntry(artwork_info, listnode);
3655
3656     return;
3657   }
3658
3659   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3660 }
3661
3662 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3663 {
3664   struct FileInfo *file_list = artwork_info->file_list;
3665   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3666   int num_file_list_entries = artwork_info->num_file_list_entries;
3667   int num_dynamic_file_list_entries =
3668     artwork_info->num_dynamic_file_list_entries;
3669   int i;
3670
3671   print_timestamp_init("ReloadCustomArtworkList");
3672
3673   for (i = 0; i < num_file_list_entries; i++)
3674     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3675                       &file_list[i]);
3676
3677   for (i = 0; i < num_dynamic_file_list_entries; i++)
3678     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3679                       &dynamic_file_list[i]);
3680
3681   print_timestamp_done("ReloadCustomArtworkList");
3682
3683 #if 0
3684   dumpList(artwork_info->content_list);
3685 #endif
3686 }
3687
3688 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3689                                   struct ListNodeInfo ***list,
3690                                   int *num_list_entries)
3691 {
3692   int i;
3693
3694   if (*list == NULL)
3695     return;
3696
3697   for (i = 0; i < *num_list_entries; i++)
3698     deleteArtworkListEntry(artwork_info, &(*list)[i]);
3699   free(*list);
3700
3701   *list = NULL;
3702   *num_list_entries = 0;
3703 }
3704
3705 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3706 {
3707   if (artwork_info == NULL)
3708     return;
3709
3710   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3711                         &artwork_info->num_file_list_entries);
3712
3713   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3714                         &artwork_info->num_dynamic_file_list_entries);
3715 }
3716
3717
3718 /* ------------------------------------------------------------------------- */
3719 /* functions only needed for non-Unix (non-command-line) systems             */
3720 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
3721 /* (now also added for Windows, to create files in user data directory)      */
3722 /* ------------------------------------------------------------------------- */
3723
3724 char *getErrorFilename(char *basename)
3725 {
3726   return getPath2(getUserGameDataDir(), basename);
3727 }
3728
3729 void openErrorFile()
3730 {
3731   InitUserDataDirectory();
3732
3733   if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3734   {
3735     program.error_file = stderr;
3736
3737     Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3738           program.error_filename, strerror(errno));
3739   }
3740 }
3741
3742 void closeErrorFile()
3743 {
3744   if (program.error_file != stderr)     /* do not close stream 'stderr' */
3745     fclose(program.error_file);
3746 }
3747
3748 void dumpErrorFile()
3749 {
3750   FILE *error_file = fopen(program.error_filename, MODE_READ);
3751
3752   if (error_file != NULL)
3753   {
3754     while (!feof(error_file))
3755       fputc(fgetc(error_file), stderr);
3756
3757     fclose(error_file);
3758   }
3759 }
3760
3761 void NotifyUserAboutErrorFile()
3762 {
3763 #if defined(PLATFORM_WIN32)
3764   char *title_text = getStringCat2(program.program_title, " Error Message");
3765   char *error_text = getStringCat2("The program was aborted due to an error; "
3766                                    "for details, see the following error file:"
3767                                    STRING_NEWLINE, program.error_filename);
3768
3769   MessageBox(NULL, error_text, title_text, MB_OK);
3770 #endif
3771 }
3772
3773
3774 /* ------------------------------------------------------------------------- */
3775 /* the following is only for debugging purpose and normally not used         */
3776 /* ------------------------------------------------------------------------- */
3777
3778 #if DEBUG
3779
3780 #define DEBUG_PRINT_INIT_TIMESTAMPS             FALSE
3781 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH       10
3782
3783 #define DEBUG_NUM_TIMESTAMPS                    10
3784 #define DEBUG_TIME_IN_MICROSECONDS              0
3785
3786 #if DEBUG_TIME_IN_MICROSECONDS
3787 static double Counter_Microseconds()
3788 {
3789   static struct timeval base_time = { 0, 0 };
3790   struct timeval current_time;
3791   double counter;
3792
3793   gettimeofday(&current_time, NULL);
3794
3795   /* reset base time in case of wrap-around */
3796   if (current_time.tv_sec < base_time.tv_sec)
3797     base_time = current_time;
3798
3799   counter =
3800     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
3801     ((double)(current_time.tv_usec - base_time.tv_usec));
3802
3803   return counter;               /* return microseconds since last init */
3804 }
3805 #endif
3806
3807 char *debug_print_timestamp_get_padding(int padding_size)
3808 {
3809   static char *padding = NULL;
3810   int max_padding_size = 100;
3811
3812   if (padding == NULL)
3813   {
3814     padding = checked_calloc(max_padding_size + 1);
3815     memset(padding, ' ', max_padding_size);
3816   }
3817
3818   return &padding[MAX(0, max_padding_size - padding_size)];
3819 }
3820
3821 void debug_print_timestamp(int counter_nr, char *message)
3822 {
3823   int indent_size = 8;
3824   int padding_size = 40;
3825   float timestamp_interval;
3826
3827   if (counter_nr < 0)
3828     Error(ERR_EXIT, "debugging: invalid negative counter");
3829   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3830     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3831
3832 #if DEBUG_TIME_IN_MICROSECONDS
3833   static double counter[DEBUG_NUM_TIMESTAMPS][2];
3834   char *unit = "ms";
3835
3836   counter[counter_nr][0] = Counter_Microseconds();
3837 #else
3838   static int counter[DEBUG_NUM_TIMESTAMPS][2];
3839   char *unit = "s";
3840
3841   counter[counter_nr][0] = Counter();
3842 #endif
3843
3844   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3845   counter[counter_nr][1] = counter[counter_nr][0];
3846
3847   if (message)
3848 #if 1
3849     Error(ERR_DEBUG, "%s%s%s %.3f %s",
3850 #else
3851     printf("%s%s%s %.3f %s\n",
3852 #endif
3853            debug_print_timestamp_get_padding(counter_nr * indent_size),
3854            message,
3855            debug_print_timestamp_get_padding(padding_size - strlen(message)),
3856            timestamp_interval / 1000,
3857            unit);
3858 }
3859
3860 void debug_print_parent_only(char *format, ...)
3861 {
3862   if (!IS_PARENT_PROCESS())
3863     return;
3864
3865   if (format)
3866   {
3867     va_list ap;
3868
3869     va_start(ap, format);
3870     vprintf(format, ap);
3871     va_end(ap);
3872
3873     printf("\n");
3874   }
3875 }
3876
3877 #endif  /* DEBUG */
3878
3879 void print_timestamp_ext(char *message, char *mode)
3880 {
3881 #if DEBUG_PRINT_INIT_TIMESTAMPS
3882   static char *debug_message = NULL;
3883   static char *last_message = NULL;
3884   static int counter_nr = 0;
3885   int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3886
3887   checked_free(debug_message);
3888   debug_message = getStringCat3(mode, " ", message);
3889
3890   if (strEqual(mode, "INIT"))
3891   {
3892     debug_print_timestamp(counter_nr, NULL);
3893
3894     if (counter_nr + 1 < max_depth)
3895       debug_print_timestamp(counter_nr, debug_message);
3896
3897     counter_nr++;
3898
3899     debug_print_timestamp(counter_nr, NULL);
3900   }
3901   else if (strEqual(mode, "DONE"))
3902   {
3903     counter_nr--;
3904
3905     if (counter_nr + 1 < max_depth ||
3906         (counter_nr == 0 && max_depth == 1))
3907     {
3908       last_message = message;
3909
3910       if (counter_nr == 0 && max_depth == 1)
3911       {
3912         checked_free(debug_message);
3913         debug_message = getStringCat3("TIME", " ", message);
3914       }
3915
3916       debug_print_timestamp(counter_nr, debug_message);
3917     }
3918   }
3919   else if (!strEqual(mode, "TIME") ||
3920            !strEqual(message, last_message))
3921   {
3922     if (counter_nr < max_depth)
3923       debug_print_timestamp(counter_nr, debug_message);
3924   }
3925 #endif
3926 }
3927
3928 void print_timestamp_init(char *message)
3929 {
3930   print_timestamp_ext(message, "INIT");
3931 }
3932
3933 void print_timestamp_time(char *message)
3934 {
3935   print_timestamp_ext(message, "TIME");
3936 }
3937
3938 void print_timestamp_done(char *message)
3939 {
3940   print_timestamp_ext(message, "DONE");
3941 }