src/libgame/misc.c

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