src/libgame/misc.c

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