src/libgame/misc.c

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