src/libgame/misc.c

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