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
1303   options.mytapes = FALSE;
1304   options.serveronly = FALSE;
1305   options.network = FALSE;
1306   options.verbose = FALSE;
1307   options.debug = FALSE;
1308
1309 #if 1
1310   options.verbose = TRUE;
1311 #else
1312 #if !defined(PLATFORM_UNIX)
1313   if (*options_left == NULL)    // no options given -- enable verbose mode
1314     options.verbose = TRUE;
1315 #endif
1316 #endif
1317
1318 #if DEBUG
1319 #if defined(PLATFORM_ANDROID)
1320   options.debug = TRUE;
1321 #endif
1322 #endif
1323
1324   while (*options_left)
1325   {
1326     char option_str[MAX_OPTION_LEN];
1327     char *option = options_left[0];
1328     char *next_option = options_left[1];
1329     char *option_arg = NULL;
1330     int option_len = strlen(option);
1331
1332     if (option_len >= MAX_OPTION_LEN)
1333       FailWithHelp("unrecognized option '%s'", option);
1334
1335     strcpy(option_str, option);                 // copy argument into buffer
1336     option = option_str;
1337
1338     if (strEqual(option, "--"))                 // stop scanning arguments
1339       break;
1340
1341     if (strPrefix(option, "--"))                // treat '--' like '-'
1342       option++;
1343
1344     option_arg = strchr(option, '=');
1345     if (option_arg == NULL)                     // no '=' in option
1346       option_arg = next_option;
1347     else
1348     {
1349       *option_arg++ = '\0';                     // cut argument from option
1350       if (*option_arg == '\0')                  // no argument after '='
1351         FailWithHelp("option '%s' has invalid argument", option_str);
1352     }
1353
1354     option_len = strlen(option);
1355
1356     if (strEqual(option, "-"))
1357     {
1358       FailWithHelp("unrecognized option '%s'", option);
1359     }
1360     else if (strncmp(option, "-help", option_len) == 0)
1361     {
1362       print_usage_function();
1363
1364       exit(0);
1365     }
1366     else if (strncmp(option, "-basepath", option_len) == 0)
1367     {
1368       if (option_arg == NULL)
1369         FailWithHelp("option '%s' requires an argument", option_str);
1370
1371       options.base_directory = base_path = getStringCopy(option_arg);
1372       if (option_arg == next_option)
1373         options_left++;
1374
1375       // adjust paths for sub-directories in base directory accordingly
1376       options.level_directory    = getPath2(base_path, LEVELS_DIRECTORY);
1377       options.graphics_directory = getPath2(base_path, GRAPHICS_DIRECTORY);
1378       options.sounds_directory   = getPath2(base_path, SOUNDS_DIRECTORY);
1379       options.music_directory    = getPath2(base_path, MUSIC_DIRECTORY);
1380       options.docs_directory     = getPath2(base_path, DOCS_DIRECTORY);
1381       options.conf_directory     = getPath2(base_path, CONF_DIRECTORY);
1382     }
1383     else if (strncmp(option, "-levels", option_len) == 0)
1384     {
1385       if (option_arg == NULL)
1386         FailWithHelp("option '%s' requires an argument", option_str);
1387
1388       options.level_directory = getStringCopy(option_arg);
1389       if (option_arg == next_option)
1390         options_left++;
1391     }
1392     else if (strncmp(option, "-graphics", option_len) == 0)
1393     {
1394       if (option_arg == NULL)
1395         FailWithHelp("option '%s' requires an argument", option_str);
1396
1397       options.graphics_directory = getStringCopy(option_arg);
1398       if (option_arg == next_option)
1399         options_left++;
1400     }
1401     else if (strncmp(option, "-sounds", option_len) == 0)
1402     {
1403       if (option_arg == NULL)
1404         FailWithHelp("option '%s' requires an argument", option_str);
1405
1406       options.sounds_directory = getStringCopy(option_arg);
1407       if (option_arg == next_option)
1408         options_left++;
1409     }
1410     else if (strncmp(option, "-music", option_len) == 0)
1411     {
1412       if (option_arg == NULL)
1413         FailWithHelp("option '%s' requires an argument", option_str);
1414
1415       options.music_directory = getStringCopy(option_arg);
1416       if (option_arg == next_option)
1417         options_left++;
1418     }
1419     else if (strncmp(option, "-mytapes", option_len) == 0)
1420     {
1421       options.mytapes = TRUE;
1422     }
1423     else if (strncmp(option, "-network", option_len) == 0)
1424     {
1425       options.network = TRUE;
1426     }
1427     else if (strncmp(option, "-serveronly", option_len) == 0)
1428     {
1429       options.serveronly = TRUE;
1430     }
1431     else if (strncmp(option, "-debug", option_len) == 0)
1432     {
1433       options.debug = TRUE;
1434
1435       // optionally, debug output can be limited to a specific debug mode
1436       if (option_arg != next_option)
1437         options.debug_mode = getStringCopy(option_arg);
1438     }
1439     else if (strncmp(option, "-verbose", option_len) == 0)
1440     {
1441       options.verbose = TRUE;
1442     }
1443     else if (strncmp(option, "-version", option_len) == 0 ||
1444              strncmp(option, "-V", option_len) == 0)
1445     {
1446       print_version_function();
1447
1448       exit(0);
1449     }
1450     else if (strPrefix(option, "-D"))
1451     {
1452       options.special_flags = getStringCopy(&option[2]);
1453     }
1454     else if (strncmp(option, "-execute", option_len) == 0)
1455     {
1456       if (option_arg == NULL)
1457         FailWithHelp("option '%s' requires an argument", option_str);
1458
1459       options.execute_command = getStringCopy(option_arg);
1460       if (option_arg == next_option)
1461         options_left++;
1462
1463       // when doing batch processing, always enable verbose mode (warnings)
1464       options.verbose = TRUE;
1465     }
1466     else if (strncmp(option, "-tape_logfile", option_len) == 0)
1467     {
1468       if (option_arg == NULL)
1469         FailWithHelp("option '%s' requires an argument", option_str);
1470
1471       options.tape_log_filename = getStringCopy(option_arg);
1472       if (option_arg == next_option)
1473         options_left++;
1474     }
1475 #if defined(PLATFORM_MACOSX)
1476     else if (strPrefix(option, "-psn"))
1477     {
1478       // ignore process serial number when launched via GUI on Mac OS X
1479     }
1480 #endif
1481     else if (*option == '-')
1482     {
1483       FailWithHelp("unrecognized option '%s'", option_str);
1484     }
1485     else if (options.server_host == NULL)
1486     {
1487       options.server_host = *options_left;
1488     }
1489     else if (options.server_port == 0)
1490     {
1491       options.server_port = atoi(*options_left);
1492       if (options.server_port < 1024)
1493         FailWithHelp("bad port number '%d'", options.server_port);
1494     }
1495     else
1496       FailWithHelp("too many arguments");
1497
1498     options_left++;
1499   }
1500 }
1501
1502
1503 // ----------------------------------------------------------------------------
1504 // checked memory allocation and freeing functions
1505 // ----------------------------------------------------------------------------
1506
1507 void *checked_malloc(unsigned int size)
1508 {
1509   void *ptr;
1510
1511   ptr = malloc(size);
1512
1513   if (ptr == NULL)
1514     Fail("cannot allocate %d bytes -- out of memory", size);
1515
1516   return ptr;
1517 }
1518
1519 void *checked_calloc(unsigned int size)
1520 {
1521   void *ptr;
1522
1523   ptr = calloc(1, size);
1524
1525   if (ptr == NULL)
1526     Fail("cannot allocate %d bytes -- out of memory", size);
1527
1528   return ptr;
1529 }
1530
1531 void *checked_realloc(void *ptr, unsigned int size)
1532 {
1533   ptr = realloc(ptr, size);
1534
1535   if (ptr == NULL)
1536     Fail("cannot allocate %d bytes -- out of memory", size);
1537
1538   return ptr;
1539 }
1540
1541 void checked_free(void *ptr)
1542 {
1543   if (ptr != NULL)      // this check should be done by free() anyway
1544     free(ptr);
1545 }
1546
1547 void clear_mem(void *ptr, unsigned int size)
1548 {
1549 #if defined(PLATFORM_WIN32)
1550   // for unknown reason, memset() sometimes crashes when compiled with MinGW
1551   char *cptr = (char *)ptr;
1552
1553   while (size--)
1554     *cptr++ = 0;
1555 #else
1556   memset(ptr, 0, size);
1557 #endif
1558 }
1559
1560
1561 // ----------------------------------------------------------------------------
1562 // various helper functions
1563 // ----------------------------------------------------------------------------
1564
1565 void swap_numbers(int *i1, int *i2)
1566 {
1567   int help = *i1;
1568
1569   *i1 = *i2;
1570   *i2 = help;
1571 }
1572
1573 void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1574 {
1575   int help_x = *x1;
1576   int help_y = *y1;
1577
1578   *x1 = *x2;
1579   *x2 = help_x;
1580
1581   *y1 = *y2;
1582   *y2 = help_y;
1583 }
1584
1585 /* the "put" variants of the following file access functions check for the file
1586    pointer being != NULL and return the number of bytes they have or would have
1587    written; this allows for chunk writing functions to first determine the size
1588    of the (not yet written) chunk, write the correct chunk size and finally
1589    write the chunk itself */
1590
1591 int getFile8BitInteger(File *file)
1592 {
1593   return getByteFromFile(file);
1594 }
1595
1596 int putFile8BitInteger(FILE *file, int value)
1597 {
1598   if (file != NULL)
1599     fputc(value, file);
1600
1601   return 1;
1602 }
1603
1604 int getFile16BitInteger(File *file, int byte_order)
1605 {
1606   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1607     return ((getByteFromFile(file) << 8) |
1608             (getByteFromFile(file) << 0));
1609   else           // BYTE_ORDER_LITTLE_ENDIAN
1610     return ((getByteFromFile(file) << 0) |
1611             (getByteFromFile(file) << 8));
1612 }
1613
1614 int putFile16BitInteger(FILE *file, int value, int byte_order)
1615 {
1616   if (file != NULL)
1617   {
1618     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1619     {
1620       fputc((value >> 8) & 0xff, file);
1621       fputc((value >> 0) & 0xff, file);
1622     }
1623     else           // BYTE_ORDER_LITTLE_ENDIAN
1624     {
1625       fputc((value >> 0) & 0xff, file);
1626       fputc((value >> 8) & 0xff, file);
1627     }
1628   }
1629
1630   return 2;
1631 }
1632
1633 int getFile32BitInteger(File *file, int byte_order)
1634 {
1635   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1636     return ((getByteFromFile(file) << 24) |
1637             (getByteFromFile(file) << 16) |
1638             (getByteFromFile(file) <<  8) |
1639             (getByteFromFile(file) <<  0));
1640   else           // BYTE_ORDER_LITTLE_ENDIAN
1641     return ((getByteFromFile(file) <<  0) |
1642             (getByteFromFile(file) <<  8) |
1643             (getByteFromFile(file) << 16) |
1644             (getByteFromFile(file) << 24));
1645 }
1646
1647 int putFile32BitInteger(FILE *file, int value, int byte_order)
1648 {
1649   if (file != NULL)
1650   {
1651     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1652     {
1653       fputc((value >> 24) & 0xff, file);
1654       fputc((value >> 16) & 0xff, file);
1655       fputc((value >>  8) & 0xff, file);
1656       fputc((value >>  0) & 0xff, file);
1657     }
1658     else           // BYTE_ORDER_LITTLE_ENDIAN
1659     {
1660       fputc((value >>  0) & 0xff, file);
1661       fputc((value >>  8) & 0xff, file);
1662       fputc((value >> 16) & 0xff, file);
1663       fputc((value >> 24) & 0xff, file);
1664     }
1665   }
1666
1667   return 4;
1668 }
1669
1670 boolean getFileChunk(File *file, char *chunk_name, int *chunk_size,
1671                      int byte_order)
1672 {
1673   const int chunk_name_length = 4;
1674
1675   // read chunk name
1676   if (getStringFromFile(file, chunk_name, chunk_name_length + 1) == NULL)
1677     return FALSE;
1678
1679   if (chunk_size != NULL)
1680   {
1681     // read chunk size
1682     *chunk_size = getFile32BitInteger(file, byte_order);
1683   }
1684
1685   return (checkEndOfFile(file) ? FALSE : TRUE);
1686 }
1687
1688 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1689                  int byte_order)
1690 {
1691   int num_bytes = 0;
1692
1693   // write chunk name
1694   if (file != NULL)
1695     fputs(chunk_name, file);
1696
1697   num_bytes += strlen(chunk_name);
1698
1699   if (chunk_size >= 0)
1700   {
1701     // write chunk size
1702     if (file != NULL)
1703       putFile32BitInteger(file, chunk_size, byte_order);
1704
1705     num_bytes += 4;
1706   }
1707
1708   return num_bytes;
1709 }
1710
1711 int getFileVersion(File *file)
1712 {
1713   int version_super = getByteFromFile(file);
1714   int version_major = getByteFromFile(file);
1715   int version_minor = getByteFromFile(file);
1716   int version_patch = getByteFromFile(file);
1717
1718   return VERSION_IDENT(version_super, version_major, version_minor,
1719                        version_patch);
1720 }
1721
1722 int putFileVersion(FILE *file, int version)
1723 {
1724   if (file != NULL)
1725   {
1726     int version_super = VERSION_SUPER(version);
1727     int version_major = VERSION_MAJOR(version);
1728     int version_minor = VERSION_MINOR(version);
1729     int version_patch = VERSION_PATCH(version);
1730
1731     fputc(version_super, file);
1732     fputc(version_major, file);
1733     fputc(version_minor, file);
1734     fputc(version_patch, file);
1735   }
1736
1737   return 4;
1738 }
1739
1740 void ReadBytesFromFile(File *file, byte *buffer, unsigned int bytes)
1741 {
1742   int i;
1743
1744   for (i = 0; i < bytes && !checkEndOfFile(file); i++)
1745     buffer[i] = getByteFromFile(file);
1746 }
1747
1748 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1749 {
1750   int i;
1751
1752   for (i = 0; i < bytes; i++)
1753     fputc(buffer[i], file);
1754 }
1755
1756 void ReadUnusedBytesFromFile(File *file, unsigned int bytes)
1757 {
1758   while (bytes-- && !checkEndOfFile(file))
1759     getByteFromFile(file);
1760 }
1761
1762 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1763 {
1764   while (bytes--)
1765     fputc(0, file);
1766 }
1767
1768
1769 // ----------------------------------------------------------------------------
1770 // functions to convert between ISO-8859-1 and UTF-8
1771 // ----------------------------------------------------------------------------
1772
1773 char *getUTF8FromLatin1(char *latin1)
1774 {
1775   int max_utf8_size = 2 * strlen(latin1) + 1;
1776   char *utf8 = checked_calloc(max_utf8_size);
1777   unsigned char *src = (unsigned char *)latin1;
1778   unsigned char *dst = (unsigned char *)utf8;
1779
1780   while (*src)
1781   {
1782     if (*src < 128)             // pure 7-bit ASCII
1783     {
1784       *dst++ = *src;
1785     }
1786     else if (*src >= 160)       // non-ASCII characters
1787     {
1788       *dst++ = 194 + (*src >= 192);
1789       *dst++ = 128 + (*src & 63);
1790     }
1791     else                        // undefined in ISO-8859-1
1792     {
1793       *dst++ = '?';
1794     }
1795
1796     src++;
1797   }
1798
1799   // only use the smallest possible string buffer size
1800   utf8 = checked_realloc(utf8, strlen(utf8) + 1);
1801
1802   return utf8;
1803 }
1804
1805 char *getLatin1FromUTF8(char *utf8)
1806 {
1807   int max_latin1_size = strlen(utf8) + 1;
1808   char *latin1 = checked_calloc(max_latin1_size);
1809   unsigned char *src = (unsigned char *)utf8;
1810   unsigned char *dst = (unsigned char *)latin1;
1811
1812   while (*src)
1813   {
1814     if (*src < 128)                             // pure 7-bit ASCII
1815     {
1816       *dst++ = *src++;
1817     }
1818     else if (src[0] == 194 &&
1819              src[1] >= 128 && src[1] < 192)     // non-ASCII characters
1820     {
1821       *dst++ = src[1];
1822       src += 2;
1823     }
1824     else if (src[0] == 195 &&
1825              src[1] >= 128 && src[1] < 192)     // non-ASCII characters
1826     {
1827       *dst++ = src[1] + 64;
1828       src += 2;
1829     }
1830
1831     // all other UTF-8 characters are undefined in ISO-8859-1
1832
1833     else if (src[0] >= 192 && src[0] < 224 &&
1834              src[1] >= 128 && src[1] < 192)
1835     {
1836       *dst++ = '?';
1837       src += 2;
1838     }
1839     else if (src[0] >= 224 && src[0] < 240 &&
1840              src[1] >= 128 && src[1] < 192 &&
1841              src[2] >= 128 && src[2] < 192)
1842     {
1843       *dst++ = '?';
1844       src += 3;
1845     }
1846     else if (src[0] >= 240 && src[0] < 248 &&
1847              src[1] >= 128 && src[1] < 192 &&
1848              src[2] >= 128 && src[2] < 192 &&
1849              src[3] >= 128 && src[3] < 192)
1850     {
1851       *dst++ = '?';
1852       src += 4;
1853     }
1854     else if (src[0] >= 248 && src[0] < 252 &&
1855              src[1] >= 128 && src[1] < 192 &&
1856              src[2] >= 128 && src[2] < 192 &&
1857              src[3] >= 128 && src[3] < 192 &&
1858              src[4] >= 128 && src[4] < 192)
1859     {
1860       *dst++ = '?';
1861       src += 5;
1862     }
1863     else if (src[0] >= 252 && src[0] < 254 &&
1864              src[1] >= 128 && src[1] < 192 &&
1865              src[2] >= 128 && src[2] < 192 &&
1866              src[3] >= 128 && src[3] < 192 &&
1867              src[4] >= 128 && src[4] < 192 &&
1868              src[5] >= 128 && src[5] < 192)
1869     {
1870       *dst++ = '?';
1871       src += 6;
1872     }
1873     else
1874     {
1875       *dst++ = '?';
1876       src++;
1877     }
1878   }
1879
1880   // only use the smallest possible string buffer size
1881   latin1 = checked_realloc(latin1, strlen(latin1) + 1);
1882
1883   return latin1;
1884 }
1885
1886
1887 // ----------------------------------------------------------------------------
1888 // functions for JSON handling
1889 // ----------------------------------------------------------------------------
1890
1891 char *getEscapedJSON(char *s)
1892 {
1893   int max_json_size = 2 * strlen(s) + 1;
1894   char *json = checked_calloc(max_json_size);
1895   unsigned char *src = (unsigned char *)s;
1896   unsigned char *dst = (unsigned char *)json;
1897   char *escaped[256] =
1898   {
1899     ['\b'] = "\\b",
1900     ['\f'] = "\\f",
1901     ['\n'] = "\\n",
1902     ['\r'] = "\\r",
1903     ['\t'] = "\\t",
1904     ['\"'] = "\\\"",
1905     ['\\'] = "\\\\",
1906   };
1907
1908   while (*src)
1909   {
1910     if (escaped[*src] != NULL)
1911     {
1912       char *esc = escaped[*src++];
1913
1914       while (*esc)
1915         *dst++ = *esc++;
1916     }
1917     else
1918     {
1919       *dst++ = *src++;
1920     }
1921   }
1922
1923   // only use the smallest possible string buffer size
1924   json = checked_realloc(json, strlen(json) + 1);
1925
1926   return json;
1927 }
1928
1929
1930 // ----------------------------------------------------------------------------
1931 // functions to translate key identifiers between different format
1932 // ----------------------------------------------------------------------------
1933
1934 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
1935 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
1936 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
1937 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
1938
1939 static void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1940 {
1941   static struct
1942   {
1943     Key key;
1944     char *x11name;
1945     char *name;
1946   } translate_key[] =
1947   {
1948     // return and escape keys
1949     { KSYM_Return,      "XK_Return",            "return" },
1950     { KSYM_Escape,      "XK_Escape",            "escape" },
1951
1952     // normal cursor keys
1953     { KSYM_Left,        "XK_Left",              "cursor left" },
1954     { KSYM_Right,       "XK_Right",             "cursor right" },
1955     { KSYM_Up,          "XK_Up",                "cursor up" },
1956     { KSYM_Down,        "XK_Down",              "cursor down" },
1957
1958     // keypad cursor keys
1959 #ifdef KSYM_KP_Left
1960     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
1961     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
1962     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
1963     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
1964 #endif
1965
1966     // other keypad keys
1967 #ifdef KSYM_KP_Enter
1968     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
1969     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
1970     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
1971     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
1972     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
1973     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
1974 #endif
1975
1976     // modifier keys
1977     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
1978     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
1979     { KSYM_Control_L,   "XK_Control_L",         "left control" },
1980     { KSYM_Control_R,   "XK_Control_R",         "right control" },
1981     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
1982     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
1983     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
1984     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
1985     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, // Alt-R
1986     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   // Ctrl-R
1987
1988     // some special keys
1989     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
1990     { KSYM_Delete,      "XK_Delete",            "delete" },
1991     { KSYM_Insert,      "XK_Insert",            "insert" },
1992     { KSYM_Tab,         "XK_Tab",               "tab" },
1993     { KSYM_Home,        "XK_Home",              "home" },
1994     { KSYM_End,         "XK_End",               "end" },
1995     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
1996     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
1997
1998     { KSYM_Select,      "XK_Select",            "select" },
1999     { KSYM_Menu,        "XK_Menu",              "menu" },        // menu key
2000     { KSYM_Back,        "XK_Back",              "back" },        // back key
2001     { KSYM_PlayPause,   "XK_PlayPause",         "play/pause" },
2002 #if defined(PLATFORM_ANDROID)
2003     { KSYM_Rewind,      "XK_Rewind",            "rewind" },
2004     { KSYM_FastForward, "XK_FastForward",       "fast forward" },
2005 #endif
2006
2007     // ASCII 0x20 to 0x40 keys (except numbers)
2008     { KSYM_space,       "XK_space",             "space" },
2009     { KSYM_exclam,      "XK_exclam",            "!" },
2010     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
2011     { KSYM_numbersign,  "XK_numbersign",        "#" },
2012     { KSYM_dollar,      "XK_dollar",            "$" },
2013     { KSYM_percent,     "XK_percent",           "%" },
2014     { KSYM_ampersand,   "XK_ampersand",         "&" },
2015     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
2016     { KSYM_parenleft,   "XK_parenleft",         "(" },
2017     { KSYM_parenright,  "XK_parenright",        ")" },
2018     { KSYM_asterisk,    "XK_asterisk",          "*" },
2019     { KSYM_plus,        "XK_plus",              "+" },
2020     { KSYM_comma,       "XK_comma",             "," },
2021     { KSYM_minus,       "XK_minus",             "-" },
2022     { KSYM_period,      "XK_period",            "." },
2023     { KSYM_slash,       "XK_slash",             "/" },
2024     { KSYM_colon,       "XK_colon",             ":" },
2025     { KSYM_semicolon,   "XK_semicolon",         ";" },
2026     { KSYM_less,        "XK_less",              "<" },
2027     { KSYM_equal,       "XK_equal",             "=" },
2028     { KSYM_greater,     "XK_greater",           ">" },
2029     { KSYM_question,    "XK_question",          "?" },
2030     { KSYM_at,          "XK_at",                "@" },
2031
2032     // more ASCII keys
2033     { KSYM_bracketleft, "XK_bracketleft",       "[" },
2034     { KSYM_backslash,   "XK_backslash",         "\\" },
2035     { KSYM_bracketright,"XK_bracketright",      "]" },
2036     { KSYM_asciicircum, "XK_asciicircum",       "^" },
2037     { KSYM_underscore,  "XK_underscore",        "_" },
2038     { KSYM_grave,       "XK_grave",             "grave" },
2039     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
2040     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
2041     { KSYM_bar,         "XK_bar",               "bar" },
2042     { KSYM_braceright,  "XK_braceright",        "brace right" },
2043     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
2044
2045     // special (non-ASCII) keys
2046     { KSYM_degree,      "XK_degree",            "degree" },
2047     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "A umlaut" },
2048     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "O umlaut" },
2049     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "U umlaut" },
2050     { KSYM_adiaeresis,  "XK_adiaeresis",        "a umlaut" },
2051     { KSYM_odiaeresis,  "XK_odiaeresis",        "o umlaut" },
2052     { KSYM_udiaeresis,  "XK_udiaeresis",        "u umlaut" },
2053     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
2054
2055     // special (non-ASCII) keys (UTF-8, for reverse mapping only)
2056     { KSYM_degree,      "XK_degree",            "\xc2\xb0" },
2057     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "\xc3\x84" },
2058     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "\xc3\x96" },
2059     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "\xc3\x9c" },
2060     { KSYM_adiaeresis,  "XK_adiaeresis",        "\xc3\xa4" },
2061     { KSYM_odiaeresis,  "XK_odiaeresis",        "\xc3\xb6" },
2062     { KSYM_udiaeresis,  "XK_udiaeresis",        "\xc3\xbc" },
2063     { KSYM_ssharp,      "XK_ssharp",            "\xc3\x9f" },
2064
2065     // other keys (for reverse mapping only)
2066     { KSYM_space,       "XK_space",             " " },
2067
2068     // keypad keys are not in numerical order in SDL2
2069     { KSYM_KP_0,        "XK_KP_0",              "keypad 0" },
2070     { KSYM_KP_1,        "XK_KP_1",              "keypad 1" },
2071     { KSYM_KP_2,        "XK_KP_2",              "keypad 2" },
2072     { KSYM_KP_3,        "XK_KP_3",              "keypad 3" },
2073     { KSYM_KP_4,        "XK_KP_4",              "keypad 4" },
2074     { KSYM_KP_5,        "XK_KP_5",              "keypad 5" },
2075     { KSYM_KP_6,        "XK_KP_6",              "keypad 6" },
2076     { KSYM_KP_7,        "XK_KP_7",              "keypad 7" },
2077     { KSYM_KP_8,        "XK_KP_8",              "keypad 8" },
2078     { KSYM_KP_9,        "XK_KP_9",              "keypad 9" },
2079
2080     // end-of-array identifier
2081     { 0,                NULL,                   NULL }
2082   };
2083
2084   int i;
2085
2086   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
2087   {
2088     static char name_buffer[30];
2089     Key key = *keysym;
2090
2091     if (key >= KSYM_A && key <= KSYM_Z)
2092       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
2093     else if (key >= KSYM_a && key <= KSYM_z)
2094       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
2095     else if (key >= KSYM_0 && key <= KSYM_9)
2096       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
2097     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2098       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2099     else if (key == KSYM_UNDEFINED)
2100       strcpy(name_buffer, "(undefined)");
2101     else
2102     {
2103       i = 0;
2104
2105       do
2106       {
2107         if (key == translate_key[i].key)
2108         {
2109           strcpy(name_buffer, translate_key[i].name);
2110           break;
2111         }
2112       }
2113       while (translate_key[++i].name);
2114
2115       if (!translate_key[i].name)
2116         strcpy(name_buffer, "(unknown)");
2117     }
2118
2119     *name = name_buffer;
2120   }
2121   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
2122   {
2123     static char name_buffer[30];
2124     Key key = *keysym;
2125
2126     if (key >= KSYM_A && key <= KSYM_Z)
2127       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
2128     else if (key >= KSYM_a && key <= KSYM_z)
2129       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
2130     else if (key >= KSYM_0 && key <= KSYM_9)
2131       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
2132     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
2133       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
2134     else if (key == KSYM_UNDEFINED)
2135       strcpy(name_buffer, "[undefined]");
2136     else
2137     {
2138       i = 0;
2139
2140       do
2141       {
2142         if (key == translate_key[i].key)
2143         {
2144           strcpy(name_buffer, translate_key[i].x11name);
2145           break;
2146         }
2147       }
2148       while (translate_key[++i].x11name);
2149
2150       if (!translate_key[i].x11name)
2151         sprintf(name_buffer, "0x%04x", (unsigned int)key);
2152     }
2153
2154     *x11name = name_buffer;
2155   }
2156   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
2157   {
2158     Key key = KSYM_UNDEFINED;
2159     char *name_ptr = *name;
2160
2161     if (strlen(*name) == 1)
2162     {
2163       char c = name_ptr[0];
2164
2165       if (c >= 'A' && c <= 'Z')
2166         key = KSYM_A + (Key)(c - 'A');
2167       else if (c >= 'a' && c <= 'z')
2168         key = KSYM_a + (Key)(c - 'a');
2169       else if (c >= '0' && c <= '9')
2170         key = KSYM_0 + (Key)(c - '0');
2171     }
2172
2173     if (key == KSYM_UNDEFINED)
2174     {
2175       i = 0;
2176
2177       do
2178       {
2179         if (strEqual(translate_key[i].name, *name))
2180         {
2181           key = translate_key[i].key;
2182           break;
2183         }
2184       }
2185       while (translate_key[++i].x11name);
2186     }
2187
2188     if (key == KSYM_UNDEFINED)
2189       Warn("getKeyFromKeyName(): not completely implemented");
2190
2191     *keysym = key;
2192   }
2193   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
2194   {
2195     Key key = KSYM_UNDEFINED;
2196     char *name_ptr = *x11name;
2197
2198     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
2199     {
2200       char c = name_ptr[3];
2201
2202       if (c >= 'A' && c <= 'Z')
2203         key = KSYM_A + (Key)(c - 'A');
2204       else if (c >= 'a' && c <= 'z')
2205         key = KSYM_a + (Key)(c - 'a');
2206       else if (c >= '0' && c <= '9')
2207         key = KSYM_0 + (Key)(c - '0');
2208     }
2209     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
2210     {
2211       char c1 = name_ptr[4];
2212       char c2 = name_ptr[5];
2213       int d = 0;
2214
2215       if ((c1 >= '0' && c1 <= '9') &&
2216           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
2217         d = atoi(&name_ptr[4]);
2218
2219       if (d >= 1 && d <= KSYM_NUM_FKEYS)
2220         key = KSYM_F1 + (Key)(d - 1);
2221     }
2222     else if (strPrefix(name_ptr, "XK_"))
2223     {
2224       i = 0;
2225
2226       do
2227       {
2228         if (strEqual(name_ptr, translate_key[i].x11name))
2229         {
2230           key = translate_key[i].key;
2231           break;
2232         }
2233       }
2234       while (translate_key[++i].x11name);
2235     }
2236     else if (strPrefix(name_ptr, "0x"))
2237     {
2238       unsigned int value = 0;
2239
2240       name_ptr += 2;
2241
2242       while (name_ptr)
2243       {
2244         char c = *name_ptr++;
2245         int d = -1;
2246
2247         if (c >= '0' && c <= '9')
2248           d = (int)(c - '0');
2249         else if (c >= 'a' && c <= 'f')
2250           d = (int)(c - 'a' + 10);
2251         else if (c >= 'A' && c <= 'F')
2252           d = (int)(c - 'A' + 10);
2253
2254         if (d == -1)
2255         {
2256           value = -1;
2257           break;
2258         }
2259
2260         value = value * 16 + d;
2261       }
2262
2263       if (value != -1)
2264         key = (Key)value;
2265     }
2266
2267     *keysym = key;
2268   }
2269 }
2270
2271 char *getKeyNameFromKey(Key key)
2272 {
2273   char *name;
2274
2275   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
2276   return name;
2277 }
2278
2279 char *getX11KeyNameFromKey(Key key)
2280 {
2281   char *x11name;
2282
2283   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
2284   return x11name;
2285 }
2286
2287 Key getKeyFromKeyName(char *name)
2288 {
2289   Key key;
2290
2291   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
2292   return key;
2293 }
2294
2295 Key getKeyFromX11KeyName(char *x11name)
2296 {
2297   Key key;
2298
2299   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
2300   return key;
2301 }
2302
2303 char getCharFromKey(Key key)
2304 {
2305   static struct
2306   {
2307     Key key;
2308     byte key_char;
2309   } translate_key_char[] =
2310   {
2311     // special (non-ASCII) keys (ISO-8859-1)
2312     { KSYM_degree,      CHAR_BYTE_DEGREE        },
2313     { KSYM_Adiaeresis,  CHAR_BYTE_UMLAUT_A      },
2314     { KSYM_Odiaeresis,  CHAR_BYTE_UMLAUT_O      },
2315     { KSYM_Udiaeresis,  CHAR_BYTE_UMLAUT_U      },
2316     { KSYM_adiaeresis,  CHAR_BYTE_UMLAUT_a      },
2317     { KSYM_odiaeresis,  CHAR_BYTE_UMLAUT_o      },
2318     { KSYM_udiaeresis,  CHAR_BYTE_UMLAUT_u      },
2319     { KSYM_ssharp,      CHAR_BYTE_SHARP_S       },
2320
2321     // end-of-array identifier
2322     { 0,                0                       }
2323   };
2324
2325   char *keyname = getKeyNameFromKey(key);
2326   char c = 0;
2327
2328   if (strlen(keyname) == 1)
2329     c = keyname[0];
2330   else if (strEqual(keyname, "space"))
2331     c = ' ';
2332   else
2333   {
2334     int i = 0;
2335
2336     do
2337     {
2338       if (key == translate_key_char[i].key)
2339       {
2340         c = translate_key_char[i].key_char;
2341
2342         break;
2343       }
2344     }
2345     while (translate_key_char[++i].key_char);
2346   }
2347
2348   return c;
2349 }
2350
2351 char getValidConfigValueChar(char c)
2352 {
2353   if (c == '#' ||       // used to mark comments
2354       c == '\\')        // used to mark continued lines
2355     c = 0;
2356
2357   return c;
2358 }
2359
2360
2361 // ----------------------------------------------------------------------------
2362 // functions to translate string identifiers to integer or boolean value
2363 // ----------------------------------------------------------------------------
2364
2365 int get_integer_from_string(char *s)
2366 {
2367   static char *number_text[][3] =
2368   {
2369     { "0",      "zero",         "null",         },
2370     { "1",      "one",          "first"         },
2371     { "2",      "two",          "second"        },
2372     { "3",      "three",        "third"         },
2373     { "4",      "four",         "fourth"        },
2374     { "5",      "five",         "fifth"         },
2375     { "6",      "six",          "sixth"         },
2376     { "7",      "seven",        "seventh"       },
2377     { "8",      "eight",        "eighth"        },
2378     { "9",      "nine",         "ninth"         },
2379     { "10",     "ten",          "tenth"         },
2380     { "11",     "eleven",       "eleventh"      },
2381     { "12",     "twelve",       "twelfth"       },
2382
2383     { NULL,     NULL,           NULL            },
2384   };
2385
2386   int i, j;
2387   char *s_lower = getStringToLower(s);
2388   int result = -1;
2389
2390   for (i = 0; number_text[i][0] != NULL; i++)
2391     for (j = 0; j < 3; j++)
2392       if (strEqual(s_lower, number_text[i][j]))
2393         result = i;
2394
2395   if (result == -1)
2396   {
2397     if (strEqual(s_lower, "false") ||
2398         strEqual(s_lower, "no") ||
2399         strEqual(s_lower, "off"))
2400       result = 0;
2401     else if (strEqual(s_lower, "true") ||
2402              strEqual(s_lower, "yes") ||
2403              strEqual(s_lower, "on"))
2404       result = 1;
2405     else
2406       result = atoi(s);
2407   }
2408
2409   free(s_lower);
2410
2411   return result;
2412 }
2413
2414 boolean get_boolean_from_string(char *s)
2415 {
2416   char *s_lower = getStringToLower(s);
2417   boolean result = FALSE;
2418
2419   if (strEqual(s_lower, "true") ||
2420       strEqual(s_lower, "yes") ||
2421       strEqual(s_lower, "on") ||
2422       get_integer_from_string(s) == 1)
2423     result = TRUE;
2424
2425   free(s_lower);
2426
2427   return result;
2428 }
2429
2430 int get_switch3_from_string(char *s)
2431 {
2432   char *s_lower = getStringToLower(s);
2433   int result = FALSE;
2434
2435   if (strEqual(s_lower, "true") ||
2436       strEqual(s_lower, "yes") ||
2437       strEqual(s_lower, "on") ||
2438       get_integer_from_string(s) == 1)
2439     result = TRUE;
2440   else if (strEqual(s_lower, "auto"))
2441     result = AUTO;
2442
2443   free(s_lower);
2444
2445   return result;
2446 }
2447
2448 int get_player_nr_from_string(char *s)
2449 {
2450   static char *player_text[] =
2451   {
2452     "player_1",
2453     "player_2",
2454     "player_3",
2455     "player_4",
2456
2457     NULL
2458   };
2459
2460   char *s_lower = getStringToLower(s);
2461   int result = 0;
2462   int i;
2463
2464   for (i = 0; player_text[i] != NULL; i++)
2465     if (strEqual(s_lower, player_text[i]))
2466       result = i;
2467
2468   free(s_lower);
2469
2470   return result;
2471 }
2472
2473
2474 // ----------------------------------------------------------------------------
2475 // functions for generic lists
2476 // ----------------------------------------------------------------------------
2477
2478 ListNode *newListNode(void)
2479 {
2480   return checked_calloc(sizeof(ListNode));
2481 }
2482
2483 void addNodeToList(ListNode **node_first, char *key, void *content)
2484 {
2485   ListNode *node_new = newListNode();
2486
2487   node_new->key = getStringCopy(key);
2488   node_new->content = content;
2489   node_new->next = *node_first;
2490
2491   if (*node_first)
2492     (*node_first)->prev = node_new;
2493
2494   *node_first = node_new;
2495 }
2496
2497 void deleteNodeFromList(ListNode **node_first, char *key,
2498                         void (*destructor_function)(void *))
2499 {
2500   if (node_first == NULL || *node_first == NULL)
2501     return;
2502
2503   if (strEqual((*node_first)->key, key))
2504   {
2505     // after first recursion, (*node_first)->prev->next == *node_first,
2506     // so *node_first would be overwritten with (*node_first)->next
2507     // => use a copy of *node_first (and later of (*node_first)->next)
2508     ListNode *node = *node_first;
2509     ListNode *node_next = node->next;
2510
2511     checked_free(node->key);
2512
2513     if (destructor_function)
2514       destructor_function(node->content);
2515
2516     if (node->prev)
2517       node->prev->next = node->next;
2518
2519     if (node->next)
2520       node->next->prev = node->prev;
2521
2522     checked_free(node);
2523
2524     // after removing node, set list pointer to next valid list node
2525     // (this is important if the first node of the list was deleted)
2526     *node_first = node_next;
2527   }
2528   else
2529   {
2530     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
2531   }
2532 }
2533
2534 ListNode *getNodeFromKey(ListNode *node_first, char *key)
2535 {
2536   if (node_first == NULL)
2537     return NULL;
2538
2539   if (strEqual(node_first->key, key))
2540     return node_first;
2541   else
2542     return getNodeFromKey(node_first->next, key);
2543 }
2544
2545 int getNumNodes(ListNode *node_first)
2546 {
2547   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2548 }
2549
2550 #if 0
2551 static void dumpList(ListNode *node_first)
2552 {
2553   ListNode *node = node_first;
2554
2555   while (node)
2556   {
2557     Debug("internal:dumpList", "['%s' (%d)]", node->key,
2558           ((struct ListNodeInfo *)node->content)->num_references);
2559     node = node->next;
2560   }
2561
2562   Debug("internal:dumpList", "[%d nodes]", getNumNodes(node_first));
2563 }
2564 #endif
2565
2566
2567 // ----------------------------------------------------------------------------
2568 // functions for file handling
2569 // ----------------------------------------------------------------------------
2570
2571 #define MAX_BUFFER_SIZE                 4096
2572
2573 File *openFile(char *filename, char *mode)
2574 {
2575   File *file = checked_calloc(sizeof(File));
2576
2577   file->file = fopen(filename, mode);
2578
2579   if (file->file != NULL)
2580   {
2581     file->filename = getStringCopy(filename);
2582
2583     return file;
2584   }
2585
2586 #if defined(PLATFORM_ANDROID)
2587   file->asset_file = SDL_RWFromFile(filename, mode);
2588
2589   if (file->asset_file != NULL)
2590   {
2591     file->file_is_asset = TRUE;
2592     file->filename = getStringCopy(filename);
2593
2594     return file;
2595   }
2596 #endif
2597
2598   checked_free(file);
2599
2600   return NULL;
2601 }
2602
2603 int closeFile(File *file)
2604 {
2605   if (file == NULL)
2606     return -1;
2607
2608   int result = 0;
2609
2610 #if defined(PLATFORM_ANDROID)
2611   if (file->asset_file)
2612     result = SDL_RWclose(file->asset_file);
2613 #endif
2614
2615   if (file->file)
2616     result = fclose(file->file);
2617
2618   checked_free(file->filename);
2619   checked_free(file);
2620
2621   return result;
2622 }
2623
2624 int checkEndOfFile(File *file)
2625 {
2626 #if defined(PLATFORM_ANDROID)
2627   if (file->file_is_asset)
2628     return file->end_of_file;
2629 #endif
2630
2631   return feof(file->file);
2632 }
2633
2634 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2635 {
2636 #if defined(PLATFORM_ANDROID)
2637   if (file->file_is_asset)
2638   {
2639     if (file->end_of_file)
2640       return 0;
2641
2642     size_t num_items_read =
2643       SDL_RWread(file->asset_file, buffer, item_size, num_items);
2644
2645     if (num_items_read < num_items)
2646       file->end_of_file = TRUE;
2647
2648     return num_items_read;
2649   }
2650 #endif
2651
2652   return fread(buffer, item_size, num_items, file->file);
2653 }
2654
2655 size_t writeFile(File *file, void *buffer, size_t item_size, size_t num_items)
2656 {
2657   return fwrite(buffer, item_size, num_items, file->file);
2658 }
2659
2660 int seekFile(File *file, long offset, int whence)
2661 {
2662 #if defined(PLATFORM_ANDROID)
2663   if (file->file_is_asset)
2664   {
2665     int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2666                       whence == SEEK_CUR ? RW_SEEK_CUR :
2667                       whence == SEEK_END ? RW_SEEK_END : 0);
2668
2669     return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2670   }
2671 #endif
2672
2673   return fseek(file->file, offset, whence);
2674 }
2675
2676 int getByteFromFile(File *file)
2677 {
2678 #if defined(PLATFORM_ANDROID)
2679   if (file->file_is_asset)
2680   {
2681     if (file->end_of_file)
2682       return EOF;
2683
2684     byte c;
2685     size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2686
2687     if (num_bytes_read < 1)
2688       file->end_of_file = TRUE;
2689
2690     return (file->end_of_file ? EOF : (int)c);
2691   }
2692 #endif
2693
2694   return fgetc(file->file);
2695 }
2696
2697 char *getStringFromFile(File *file, char *line, int size)
2698 {
2699 #if defined(PLATFORM_ANDROID)
2700   if (file->file_is_asset)
2701   {
2702     if (file->end_of_file)
2703       return NULL;
2704
2705     char *line_ptr = line;
2706     int num_bytes_read = 0;
2707
2708     while (num_bytes_read < size - 1 &&
2709            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2710            *line_ptr++ != '\n')
2711       num_bytes_read++;
2712
2713     *line_ptr = '\0';
2714
2715     if (strlen(line) == 0)
2716     {
2717       file->end_of_file = TRUE;
2718
2719       return NULL;
2720     }
2721
2722     return line;
2723   }
2724 #endif
2725
2726   return fgets(line, size, file->file);
2727 }
2728
2729 int copyFile(char *filename_from, char *filename_to)
2730 {
2731   File *file_from, *file_to;
2732
2733   if ((file_from = openFile(filename_from, MODE_READ)) == NULL)
2734   {
2735     return -1;
2736   }
2737
2738   if ((file_to = openFile(filename_to, MODE_WRITE)) == NULL)
2739   {
2740     closeFile(file_from);
2741
2742     return -1;
2743   }
2744
2745   while (!checkEndOfFile(file_from))
2746   {
2747     byte buffer[MAX_BUFFER_SIZE];
2748     size_t bytes_read = readFile(file_from, buffer, 1, MAX_BUFFER_SIZE);
2749
2750     writeFile(file_to, buffer, 1, bytes_read);
2751   }
2752
2753   closeFile(file_from);
2754   closeFile(file_to);
2755
2756   return 0;
2757 }
2758
2759
2760 // ----------------------------------------------------------------------------
2761 // functions for directory handling
2762 // ----------------------------------------------------------------------------
2763
2764 Directory *openDirectory(char *dir_name)
2765 {
2766   Directory *dir = checked_calloc(sizeof(Directory));
2767
2768   dir->dir = opendir(dir_name);
2769
2770   if (dir->dir != NULL)
2771   {
2772     dir->filename = getStringCopy(dir_name);
2773
2774     return dir;
2775   }
2776
2777 #if defined(PLATFORM_ANDROID)
2778   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2779
2780   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2781
2782   checked_free(asset_toc_filename);
2783
2784   if (dir->asset_toc_file != NULL)
2785   {
2786     dir->directory_is_asset = TRUE;
2787     dir->filename = getStringCopy(dir_name);
2788
2789     return dir;
2790   }
2791 #endif
2792
2793   checked_free(dir);
2794
2795   return NULL;
2796 }
2797
2798 int closeDirectory(Directory *dir)
2799 {
2800   if (dir == NULL)
2801     return -1;
2802
2803   int result = 0;
2804
2805 #if defined(PLATFORM_ANDROID)
2806   if (dir->asset_toc_file)
2807     result = SDL_RWclose(dir->asset_toc_file);
2808 #endif
2809
2810   if (dir->dir)
2811     result = closedir(dir->dir);
2812
2813   if (dir->dir_entry)
2814     freeDirectoryEntry(dir->dir_entry);
2815
2816   checked_free(dir->filename);
2817   checked_free(dir);
2818
2819   return result;
2820 }
2821
2822 DirectoryEntry *readDirectory(Directory *dir)
2823 {
2824   if (dir->dir_entry)
2825     freeDirectoryEntry(dir->dir_entry);
2826
2827   dir->dir_entry = NULL;
2828
2829 #if defined(PLATFORM_ANDROID)
2830   if (dir->directory_is_asset)
2831   {
2832     char line[MAX_LINE_LEN];
2833     char *line_ptr = line;
2834     int num_bytes_read = 0;
2835
2836     while (num_bytes_read < MAX_LINE_LEN - 1 &&
2837            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2838            *line_ptr != '\n')
2839     {
2840       line_ptr++;
2841       num_bytes_read++;
2842     }
2843
2844     *line_ptr = '\0';
2845
2846     if (strlen(line) == 0)
2847       return NULL;
2848
2849     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2850
2851     dir->dir_entry->is_directory = FALSE;
2852     if (line[strlen(line) - 1] == '/')
2853     {
2854       dir->dir_entry->is_directory = TRUE;
2855
2856       line[strlen(line) - 1] = '\0';
2857     }
2858
2859     dir->dir_entry->basename = getStringCopy(line);
2860     dir->dir_entry->filename = getPath2(dir->filename, line);
2861
2862     return dir->dir_entry;
2863   }
2864 #endif
2865
2866   struct dirent *dir_entry = readdir(dir->dir);
2867
2868   if (dir_entry == NULL)
2869     return NULL;
2870
2871   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2872
2873   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2874   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2875
2876   struct stat file_status;
2877
2878   dir->dir_entry->is_directory =
2879     (stat(dir->dir_entry->filename, &file_status) == 0 &&
2880      S_ISDIR(file_status.st_mode));
2881
2882   return dir->dir_entry;
2883 }
2884
2885 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2886 {
2887   if (dir_entry == NULL)
2888     return;
2889
2890   checked_free(dir_entry->basename);
2891   checked_free(dir_entry->filename);
2892   checked_free(dir_entry);
2893 }
2894
2895
2896 // ----------------------------------------------------------------------------
2897 // functions for checking files and filenames
2898 // ----------------------------------------------------------------------------
2899
2900 boolean directoryExists(char *dir_name)
2901 {
2902   if (dir_name == NULL)
2903     return FALSE;
2904
2905   struct stat file_status;
2906   boolean success = (stat(dir_name, &file_status) == 0 &&
2907                      S_ISDIR(file_status.st_mode));
2908
2909 #if defined(PLATFORM_ANDROID)
2910   if (!success)
2911   {
2912     // this might be an asset directory; check by trying to open toc file
2913     char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2914     SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2915
2916     checked_free(asset_toc_filename);
2917
2918     success = (file != NULL);
2919
2920     if (success)
2921       SDL_RWclose(file);
2922   }
2923 #endif
2924
2925   return success;
2926 }
2927
2928 boolean fileExists(char *filename)
2929 {
2930   if (filename == NULL)
2931     return FALSE;
2932
2933   boolean success = (access(filename, F_OK) == 0);
2934
2935 #if defined(PLATFORM_ANDROID)
2936   if (!success)
2937   {
2938     // this might be an asset file; check by trying to open it
2939     SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2940
2941     success = (file != NULL);
2942
2943     if (success)
2944       SDL_RWclose(file);
2945   }
2946 #endif
2947
2948   return success;
2949 }
2950
2951 #if 0
2952 static boolean fileHasPrefix(char *basename, char *prefix)
2953 {
2954   static char *basename_lower = NULL;
2955   int basename_length, prefix_length;
2956
2957   checked_free(basename_lower);
2958
2959   if (basename == NULL || prefix == NULL)
2960     return FALSE;
2961
2962   basename_lower = getStringToLower(basename);
2963   basename_length = strlen(basename_lower);
2964   prefix_length = strlen(prefix);
2965
2966   if (basename_length > prefix_length + 1 &&
2967       basename_lower[prefix_length] == '.' &&
2968       strncmp(basename_lower, prefix, prefix_length) == 0)
2969     return TRUE;
2970
2971   return FALSE;
2972 }
2973 #endif
2974
2975 static boolean fileHasSuffix(char *basename, char *suffix)
2976 {
2977   static char *basename_lower = NULL;
2978   int basename_length, suffix_length;
2979
2980   checked_free(basename_lower);
2981
2982   if (basename == NULL || suffix == NULL)
2983     return FALSE;
2984
2985   basename_lower = getStringToLower(basename);
2986   basename_length = strlen(basename_lower);
2987   suffix_length = strlen(suffix);
2988
2989   if (basename_length > suffix_length + 1 &&
2990       basename_lower[basename_length - suffix_length - 1] == '.' &&
2991       strEqual(&basename_lower[basename_length - suffix_length], suffix))
2992     return TRUE;
2993
2994   return FALSE;
2995 }
2996
2997 static boolean FileCouldBeArtwork(char *filename)
2998 {
2999   char *basename = getBaseNamePtr(filename);
3000
3001   return (!strEqual(basename, ".") &&
3002           !strEqual(basename, "..") &&
3003           !fileHasSuffix(basename, "txt") &&
3004           !fileHasSuffix(basename, "conf") &&
3005           !directoryExists(filename));
3006 }
3007
3008 boolean FileIsGraphic(char *filename)
3009 {
3010   return FileCouldBeArtwork(filename);
3011 }
3012
3013 boolean FileIsSound(char *filename)
3014 {
3015   return FileCouldBeArtwork(filename);
3016 }
3017
3018 boolean FileIsMusic(char *filename)
3019 {
3020   return FileCouldBeArtwork(filename);
3021 }
3022
3023 boolean FileIsArtworkType(char *filename, int type)
3024 {
3025   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(filename)) ||
3026       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(filename)) ||
3027       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(filename)))
3028     return TRUE;
3029
3030   return FALSE;
3031 }
3032
3033 // ----------------------------------------------------------------------------
3034 // functions for loading artwork configuration information
3035 // ----------------------------------------------------------------------------
3036
3037 char *get_mapped_token(char *token)
3038 {
3039   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3040   static char *map_token_prefix[][2] =
3041   {
3042     { "char_procent",           "char_percent"                  },
3043     { "bd_magic_wall_filling",  "bd_magic_wall.filling"         },
3044     { "bd_magic_wall_emptying", "bd_magic_wall.emptying"        },
3045     { "bd_butterfly_left",      "bd_butterfly.left"             },
3046     { "bd_butterfly_right",     "bd_butterfly.right"            },
3047     { "bd_butterfly_up",        "bd_butterfly.up"               },
3048     { "bd_butterfly_down",      "bd_butterfly.down"             },
3049     { "bd_firefly_left",        "bd_firefly.left"               },
3050     { "bd_firefly_right",       "bd_firefly.right"              },
3051     { "bd_firefly_up",          "bd_firefly.up"                 },
3052     { "bd_firefly_down",        "bd_firefly.down"               },
3053
3054     { NULL,                                                     }
3055   };
3056   int i;
3057
3058   for (i = 0; map_token_prefix[i][0] != NULL; i++)
3059   {
3060     int len_token_prefix = strlen(map_token_prefix[i][0]);
3061
3062     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
3063       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
3064   }
3065
3066   // change tokens containing ".gfx" by moving the "gfx" part to the very left
3067   char *gfx_substring = ".gfx";
3068   char *gfx_prefix = "gfx.";
3069   if (strstr(token, gfx_substring) != NULL)
3070   {
3071     char *token_prefix = getStringCopy(token);
3072     char *token_gfx_pos = strstr(token_prefix, gfx_substring);
3073     char *token_suffix = &token_gfx_pos[strlen(gfx_substring)];
3074     char *mapped_token;
3075
3076     // cut off token string at ".gfx" substring position
3077     *token_gfx_pos = '\0';
3078
3079     // put together prefix "gfx." and token prefix and suffix without ".gfx"
3080     mapped_token = getStringCat3(gfx_prefix, token_prefix, token_suffix);
3081
3082     free(token_prefix);
3083
3084     return mapped_token;
3085   }
3086
3087   return NULL;
3088 }
3089
3090 static char *get_special_base_token(struct ArtworkListInfo *artwork_info,
3091                                     char *token)
3092 {
3093   // !!! make this dynamically configurable (init.c:InitArtworkConfig) !!!
3094   static struct ConfigTypeInfo prefix_list[] =
3095   {
3096     { "global.anim_1"   },
3097     { "global.anim_2"   },
3098     { "global.anim_3"   },
3099     { "global.anim_4"   },
3100     { "global.anim_5"   },
3101     { "global.anim_6"   },
3102     { "global.anim_7"   },
3103     { "global.anim_8"   },
3104     { "global.anim_9"   },
3105     { "global.anim_10"  },
3106     { "global.anim_11"  },
3107     { "global.anim_12"  },
3108     { "global.anim_13"  },
3109     { "global.anim_14"  },
3110     { "global.anim_15"  },
3111     { "global.anim_16"  },
3112     { "global.anim_17"  },
3113     { "global.anim_18"  },
3114     { "global.anim_19"  },
3115     { "global.anim_20"  },
3116     { "global.anim_21"  },
3117     { "global.anim_22"  },
3118     { "global.anim_23"  },
3119     { "global.anim_24"  },
3120     { "global.anim_25"  },
3121     { "global.anim_26"  },
3122     { "global.anim_27"  },
3123     { "global.anim_28"  },
3124     { "global.anim_29"  },
3125     { "global.anim_30"  },
3126     { "global.anim_31"  },
3127     { "global.anim_32"  },
3128
3129     { NULL              }
3130   };
3131   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3132   boolean prefix_found = FALSE;
3133   int len_suffix = 0;
3134   int i;
3135
3136   // search for prefix to check if base token has to be created
3137   for (i = 0; prefix_list[i].token != NULL; i++)
3138     if (strPrefix(token, prefix_list[i].token))
3139       prefix_found = TRUE;
3140
3141   if (!prefix_found)
3142     return NULL;
3143
3144   // search for suffix (parameter) to determine base token length
3145   for (i = 0; suffix_list[i].token != NULL; i++)
3146     if (strSuffix(token, suffix_list[i].token))
3147       len_suffix = strlen(suffix_list[i].token);
3148
3149   return getStringCopyN(token, strlen(token) - len_suffix);
3150 }
3151
3152 static void FreeCustomArtworkList(struct ArtworkListInfo *,
3153                                   struct ListNodeInfo ***, int *);
3154
3155 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
3156                                            struct ConfigTypeInfo *suffix_list,
3157                                            char **ignore_tokens,
3158                                            int num_file_list_entries)
3159 {
3160   SetupFileHash *ignore_tokens_hash;
3161   struct FileInfo *file_list;
3162   int num_file_list_entries_found = 0;
3163   int num_suffix_list_entries = 0;
3164   int list_pos;
3165   int i, j;
3166
3167   // create hash from list of tokens to be ignored (for quick access)
3168   ignore_tokens_hash = newSetupFileHash();
3169   for (i = 0; ignore_tokens[i] != NULL; i++)
3170     setHashEntry(ignore_tokens_hash, ignore_tokens[i], "");
3171
3172   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
3173
3174   for (i = 0; suffix_list[i].token != NULL; i++)
3175     num_suffix_list_entries++;
3176
3177   // always start with reliable default values
3178   for (i = 0; i < num_file_list_entries; i++)
3179   {
3180     file_list[i].token = NULL;
3181
3182     file_list[i].default_filename = NULL;
3183     file_list[i].filename = NULL;
3184
3185     if (num_suffix_list_entries > 0)
3186     {
3187       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3188
3189       file_list[i].default_parameter = checked_calloc(parameter_array_size);
3190       file_list[i].parameter = checked_calloc(parameter_array_size);
3191
3192       for (j = 0; j < num_suffix_list_entries; j++)
3193       {
3194         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
3195         setString(&file_list[i].parameter[j], suffix_list[j].value);
3196       }
3197
3198       file_list[i].redefined = FALSE;
3199       file_list[i].fallback_to_default = FALSE;
3200       file_list[i].default_is_cloned = FALSE;
3201     }
3202   }
3203
3204   list_pos = 0;
3205
3206   for (i = 0; config_list[i].token != NULL; i++)
3207   {
3208     int len_config_token = strlen(config_list[i].token);
3209     boolean is_file_entry = TRUE;
3210
3211     for (j = 0; suffix_list[j].token != NULL; j++)
3212     {
3213       int len_suffix = strlen(suffix_list[j].token);
3214
3215       if (len_suffix < len_config_token &&
3216           strEqual(&config_list[i].token[len_config_token - len_suffix],
3217                    suffix_list[j].token))
3218       {
3219         setString(&file_list[list_pos].default_parameter[j],
3220                   config_list[i].value);
3221
3222         is_file_entry = FALSE;
3223
3224         break;
3225       }
3226     }
3227
3228     // the following tokens are no file definitions, but other config tokens
3229     if (getHashEntry(ignore_tokens_hash, config_list[i].token) != NULL)
3230       is_file_entry = FALSE;
3231
3232     if (is_file_entry)
3233     {
3234       if (i > 0)
3235         list_pos++;
3236
3237       if (list_pos >= num_file_list_entries)
3238         break;
3239
3240       file_list[list_pos].token = config_list[i].token;
3241       file_list[list_pos].default_filename = config_list[i].value;
3242     }
3243
3244     if (strSuffix(config_list[i].token, ".clone_from"))
3245       file_list[list_pos].default_is_cloned = TRUE;
3246   }
3247
3248   num_file_list_entries_found = list_pos + 1;
3249   if (num_file_list_entries_found != num_file_list_entries)
3250   {
3251     Error("---");
3252     Error("inconsistant config list information:");
3253     Error("- should be:   %d (according to 'src/conf_xxx.h')",
3254           num_file_list_entries);
3255     Error("- found to be: %d (according to 'src/conf_xxx.c')",
3256           num_file_list_entries_found);
3257
3258     Fail("please fix");
3259   }
3260
3261   freeSetupFileHash(ignore_tokens_hash);
3262
3263   return file_list;
3264 }
3265
3266 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
3267 {
3268   int len_token = strlen(token);
3269   int len_suffix = strlen(suffix);
3270
3271   if (start_pos < 0)    // compare suffix from end of string
3272     start_pos += len_token;
3273
3274   if (start_pos < 0 || start_pos + len_suffix > len_token)
3275     return FALSE;
3276
3277   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
3278     return FALSE;
3279
3280   if (token[start_pos + len_suffix] == '\0')
3281     return TRUE;
3282
3283   if (token[start_pos + len_suffix] == '.')
3284     return TRUE;
3285
3286   return FALSE;
3287 }
3288
3289 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
3290
3291 static void read_token_parameters(SetupFileHash *setup_file_hash,
3292                                   struct ConfigTypeInfo *suffix_list,
3293                                   struct FileInfo *file_list_entry)
3294 {
3295   // check for config token that is the base token without any suffixes
3296   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
3297   char *known_token_value = KNOWN_TOKEN_VALUE;
3298   int i;
3299
3300   if (filename != NULL)
3301   {
3302     setString(&file_list_entry->filename, filename);
3303
3304     // when file definition found, set all parameters to default values
3305     for (i = 0; suffix_list[i].token != NULL; i++)
3306       setString(&file_list_entry->parameter[i], suffix_list[i].value);
3307
3308     file_list_entry->redefined = TRUE;
3309
3310     // mark config file token as well known from default config
3311     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
3312   }
3313
3314   // check for config tokens that can be build by base token and suffixes
3315   for (i = 0; suffix_list[i].token != NULL; i++)
3316   {
3317     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
3318     char *value = getHashEntry(setup_file_hash, token);
3319
3320     if (value != NULL)
3321     {
3322       setString(&file_list_entry->parameter[i], value);
3323
3324       // mark config file token as well known from default config
3325       setHashEntry(setup_file_hash, token, known_token_value);
3326     }
3327
3328     free(token);
3329   }
3330 }
3331
3332 static void add_dynamic_file_list_entry(struct FileInfo **list,
3333                                         int *num_list_entries,
3334                                         SetupFileHash *extra_file_hash,
3335                                         struct ConfigTypeInfo *suffix_list,
3336                                         int num_suffix_list_entries,
3337                                         char *token)
3338 {
3339   struct FileInfo *new_list_entry;
3340   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
3341
3342   (*num_list_entries)++;
3343   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
3344   new_list_entry = &(*list)[*num_list_entries - 1];
3345
3346   new_list_entry->token = getStringCopy(token);
3347   new_list_entry->default_filename = NULL;
3348   new_list_entry->filename = NULL;
3349   new_list_entry->parameter = checked_calloc(parameter_array_size);
3350
3351   new_list_entry->redefined = FALSE;
3352   new_list_entry->fallback_to_default = FALSE;
3353   new_list_entry->default_is_cloned = FALSE;
3354
3355   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
3356 }
3357
3358 static void add_property_mapping(struct PropertyMapping **list,
3359                                  int *num_list_entries,
3360                                  int base_index, int ext1_index,
3361                                  int ext2_index, int ext3_index,
3362                                  int artwork_index)
3363 {
3364   struct PropertyMapping *new_list_entry;
3365
3366   (*num_list_entries)++;
3367   *list = checked_realloc(*list,
3368                           *num_list_entries * sizeof(struct PropertyMapping));
3369   new_list_entry = &(*list)[*num_list_entries - 1];
3370
3371   new_list_entry->base_index = base_index;
3372   new_list_entry->ext1_index = ext1_index;
3373   new_list_entry->ext2_index = ext2_index;
3374   new_list_entry->ext3_index = ext3_index;
3375
3376   new_list_entry->artwork_index = artwork_index;
3377 }
3378
3379 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
3380                                           char *filename)
3381 {
3382   struct FileInfo *file_list = artwork_info->file_list;
3383   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
3384   char **base_prefixes = artwork_info->base_prefixes;
3385   char **ext1_suffixes = artwork_info->ext1_suffixes;
3386   char **ext2_suffixes = artwork_info->ext2_suffixes;
3387   char **ext3_suffixes = artwork_info->ext3_suffixes;
3388   char **ignore_tokens = artwork_info->ignore_tokens;
3389   int num_file_list_entries = artwork_info->num_file_list_entries;
3390   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3391   int num_base_prefixes = artwork_info->num_base_prefixes;
3392   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
3393   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
3394   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
3395   int num_ignore_tokens = artwork_info->num_ignore_tokens;
3396   SetupFileHash *setup_file_hash, *valid_file_hash, *valid_file_hash_tmp;
3397   SetupFileHash *extra_file_hash, *empty_file_hash;
3398   char *known_token_value = KNOWN_TOKEN_VALUE;
3399   char *base_token_value = UNDEFINED_FILENAME;
3400   int i, j, k, l;
3401
3402   if (filename == NULL)
3403     return;
3404
3405   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
3406     return;
3407
3408   // separate valid (defined) from empty (undefined) config token values
3409   valid_file_hash = newSetupFileHash();
3410   empty_file_hash = newSetupFileHash();
3411   BEGIN_HASH_ITERATION(setup_file_hash, itr)
3412   {
3413     char *value = HASH_ITERATION_VALUE(itr);
3414
3415     setHashEntry(*value ? valid_file_hash : empty_file_hash,
3416                  HASH_ITERATION_TOKEN(itr), value);
3417   }
3418   END_HASH_ITERATION(setup_file_hash, itr)
3419
3420   // at this point, we do not need the setup file hash anymore -- free it
3421   freeSetupFileHash(setup_file_hash);
3422
3423   // prevent changing hash while iterating over it by using a temporary copy
3424   valid_file_hash_tmp = newSetupFileHash();
3425   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3426   {
3427     setHashEntry(valid_file_hash_tmp,
3428                  HASH_ITERATION_TOKEN(itr),
3429                  HASH_ITERATION_VALUE(itr));
3430   }
3431   END_HASH_ITERATION(valid_file_hash, itr)
3432
3433   // (iterate over same temporary hash, as modifications are independent)
3434
3435   // map deprecated to current tokens (using prefix match and replace)
3436   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3437   {
3438     char *token = HASH_ITERATION_TOKEN(itr);
3439     char *mapped_token = get_mapped_token(token);
3440
3441     if (mapped_token != NULL)
3442     {
3443       char *value = HASH_ITERATION_VALUE(itr);
3444
3445       // add mapped token
3446       setHashEntry(valid_file_hash, mapped_token, value);
3447
3448       // ignore old token (by setting it to "known" keyword)
3449       setHashEntry(valid_file_hash, token, known_token_value);
3450
3451       free(mapped_token);
3452     }
3453   }
3454   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3455
3456   // add special base tokens (using prefix match and replace)
3457   BEGIN_HASH_ITERATION(valid_file_hash_tmp, itr)
3458   {
3459     char *token = HASH_ITERATION_TOKEN(itr);
3460     char *base_token = get_special_base_token(artwork_info, token);
3461
3462     if (base_token != NULL)
3463     {
3464       // add base token only if it does not already exist
3465       if (getHashEntry(valid_file_hash, base_token) == NULL)
3466         setHashEntry(valid_file_hash, base_token, base_token_value);
3467
3468       free(base_token);
3469     }
3470   }
3471   END_HASH_ITERATION(valid_file_hash_tmp, itr)
3472
3473   // free temporary hash used for iteration
3474   freeSetupFileHash(valid_file_hash_tmp);
3475
3476   // read parameters for all known config file tokens
3477   for (i = 0; i < num_file_list_entries; i++)
3478     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
3479
3480   // set all tokens that can be ignored here to "known" keyword
3481   for (i = 0; i < num_ignore_tokens; i++)
3482     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
3483
3484   // copy all unknown config file tokens to extra config hash
3485   extra_file_hash = newSetupFileHash();
3486   BEGIN_HASH_ITERATION(valid_file_hash, itr)
3487   {
3488     char *value = HASH_ITERATION_VALUE(itr);
3489
3490     if (!strEqual(value, known_token_value))
3491       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3492   }
3493   END_HASH_ITERATION(valid_file_hash, itr)
3494
3495   // at this point, we do not need the valid file hash anymore -- free it
3496   freeSetupFileHash(valid_file_hash);
3497
3498   // now try to determine valid, dynamically defined config tokens
3499
3500   BEGIN_HASH_ITERATION(extra_file_hash, itr)
3501   {
3502     struct FileInfo **dynamic_file_list =
3503       &artwork_info->dynamic_file_list;
3504     int *num_dynamic_file_list_entries =
3505       &artwork_info->num_dynamic_file_list_entries;
3506     struct PropertyMapping **property_mapping =
3507       &artwork_info->property_mapping;
3508     int *num_property_mapping_entries =
3509       &artwork_info->num_property_mapping_entries;
3510     int current_summarized_file_list_entry =
3511       artwork_info->num_file_list_entries +
3512       artwork_info->num_dynamic_file_list_entries;
3513     char *token = HASH_ITERATION_TOKEN(itr);
3514     int len_token = strlen(token);
3515     int start_pos;
3516     boolean base_prefix_found = FALSE;
3517     boolean parameter_suffix_found = FALSE;
3518
3519     // skip all parameter definitions (handled by read_token_parameters())
3520     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3521     {
3522       int len_suffix = strlen(suffix_list[i].token);
3523
3524       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3525         parameter_suffix_found = TRUE;
3526     }
3527
3528     if (parameter_suffix_found)
3529       continue;
3530
3531     // ---------- step 0: search for matching base prefix ----------
3532
3533     start_pos = 0;
3534     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3535     {
3536       char *base_prefix = base_prefixes[i];
3537       int len_base_prefix = strlen(base_prefix);
3538       boolean ext1_suffix_found = FALSE;
3539       boolean ext2_suffix_found = FALSE;
3540       boolean ext3_suffix_found = FALSE;
3541       boolean exact_match = FALSE;
3542       int base_index = -1;
3543       int ext1_index = -1;
3544       int ext2_index = -1;
3545       int ext3_index = -1;
3546
3547       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3548
3549       if (!base_prefix_found)
3550         continue;
3551
3552       base_index = i;
3553
3554       if (start_pos + len_base_prefix == len_token)     // exact match
3555       {
3556         exact_match = TRUE;
3557
3558         add_dynamic_file_list_entry(dynamic_file_list,
3559                                     num_dynamic_file_list_entries,
3560                                     extra_file_hash,
3561                                     suffix_list,
3562                                     num_suffix_list_entries,
3563                                     token);
3564         add_property_mapping(property_mapping,
3565                              num_property_mapping_entries,
3566                              base_index, -1, -1, -1,
3567                              current_summarized_file_list_entry);
3568         continue;
3569       }
3570
3571       // ---------- step 1: search for matching first suffix ----------
3572
3573       start_pos += len_base_prefix;
3574       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3575       {
3576         char *ext1_suffix = ext1_suffixes[j];
3577         int len_ext1_suffix = strlen(ext1_suffix);
3578
3579         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3580
3581         if (!ext1_suffix_found)
3582           continue;
3583
3584         ext1_index = j;
3585
3586         if (start_pos + len_ext1_suffix == len_token)   // exact match
3587         {
3588           exact_match = TRUE;
3589
3590           add_dynamic_file_list_entry(dynamic_file_list,
3591                                       num_dynamic_file_list_entries,
3592                                       extra_file_hash,
3593                                       suffix_list,
3594                                       num_suffix_list_entries,
3595                                       token);
3596           add_property_mapping(property_mapping,
3597                                num_property_mapping_entries,
3598                                base_index, ext1_index, -1, -1,
3599                                current_summarized_file_list_entry);
3600           continue;
3601         }
3602
3603         start_pos += len_ext1_suffix;
3604       }
3605
3606       if (exact_match)
3607         break;
3608
3609       // ---------- step 2: search for matching second suffix ----------
3610
3611       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3612       {
3613         char *ext2_suffix = ext2_suffixes[k];
3614         int len_ext2_suffix = strlen(ext2_suffix);
3615
3616         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3617
3618         if (!ext2_suffix_found)
3619           continue;
3620
3621         ext2_index = k;
3622
3623         if (start_pos + len_ext2_suffix == len_token)   // exact match
3624         {
3625           exact_match = TRUE;
3626
3627           add_dynamic_file_list_entry(dynamic_file_list,
3628                                       num_dynamic_file_list_entries,
3629                                       extra_file_hash,
3630                                       suffix_list,
3631                                       num_suffix_list_entries,
3632                                       token);
3633           add_property_mapping(property_mapping,
3634                                num_property_mapping_entries,
3635                                base_index, ext1_index, ext2_index, -1,
3636                                current_summarized_file_list_entry);
3637           continue;
3638         }
3639
3640         start_pos += len_ext2_suffix;
3641       }
3642
3643       if (exact_match)
3644         break;
3645
3646       // ---------- step 3: search for matching third suffix ----------
3647
3648       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3649       {
3650         char *ext3_suffix = ext3_suffixes[l];
3651         int len_ext3_suffix = strlen(ext3_suffix);
3652
3653         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3654
3655         if (!ext3_suffix_found)
3656           continue;
3657
3658         ext3_index = l;
3659
3660         if (start_pos + len_ext3_suffix == len_token) // exact match
3661         {
3662           exact_match = TRUE;
3663
3664           add_dynamic_file_list_entry(dynamic_file_list,
3665                                       num_dynamic_file_list_entries,
3666                                       extra_file_hash,
3667                                       suffix_list,
3668                                       num_suffix_list_entries,
3669                                       token);
3670           add_property_mapping(property_mapping,
3671                                num_property_mapping_entries,
3672                                base_index, ext1_index, ext2_index, ext3_index,
3673                                current_summarized_file_list_entry);
3674           continue;
3675         }
3676       }
3677     }
3678   }
3679   END_HASH_ITERATION(extra_file_hash, itr)
3680
3681   if (artwork_info->num_dynamic_file_list_entries > 0)
3682   {
3683     artwork_info->dynamic_artwork_list =
3684       checked_calloc(artwork_info->num_dynamic_file_list_entries *
3685                      artwork_info->sizeof_artwork_list_entry);
3686   }
3687
3688   if (options.verbose && IS_PARENT_PROCESS())
3689   {
3690     SetupFileList *setup_file_list, *list;
3691     boolean dynamic_tokens_found = FALSE;
3692     boolean unknown_tokens_found = FALSE;
3693     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3694
3695     // list may be NULL for empty artwork config files
3696     setup_file_list = loadSetupFileList(filename);
3697
3698     BEGIN_HASH_ITERATION(extra_file_hash, itr)
3699     {
3700       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3701         dynamic_tokens_found = TRUE;
3702       else
3703         unknown_tokens_found = TRUE;
3704     }
3705     END_HASH_ITERATION(extra_file_hash, itr)
3706
3707     if (options.debug && dynamic_tokens_found)
3708     {
3709       Debug("config", "---");
3710       Debug("config", "dynamic token(s) found in config file:");
3711       Debug("config", "- config file: '%s'", filename);
3712
3713       for (list = setup_file_list; list != NULL; list = list->next)
3714       {
3715         char *value = getHashEntry(extra_file_hash, list->token);
3716
3717         if (value != NULL && strEqual(value, known_token_value))
3718           Debug("config", "- dynamic token: '%s'", list->token);
3719       }
3720
3721       Debug("config", "---");
3722     }
3723
3724     if (unknown_tokens_found)
3725     {
3726       Warn("---");
3727       Warn("unknown token(s) found in config file:");
3728       Warn("- config file: '%s'", filename);
3729
3730       for (list = setup_file_list; list != NULL; list = list->next)
3731       {
3732         char *value = getHashEntry(extra_file_hash, list->token);
3733
3734         if (value != NULL && !strEqual(value, known_token_value))
3735           Warn("- dynamic token: '%s'", list->token);
3736       }
3737
3738       Warn("---");
3739     }
3740
3741     if (undefined_values_found)
3742     {
3743       Warn("---");
3744       Warn("undefined values found in config file:");
3745       Warn("- config file: '%s'", filename);
3746
3747       for (list = setup_file_list; list != NULL; list = list->next)
3748       {
3749         char *value = getHashEntry(empty_file_hash, list->token);
3750
3751         if (value != NULL)
3752           Warn("- undefined value for token: '%s'", list->token);
3753       }
3754
3755       Warn("---");
3756     }
3757
3758     freeSetupFileList(setup_file_list);
3759   }
3760
3761   freeSetupFileHash(extra_file_hash);
3762   freeSetupFileHash(empty_file_hash);
3763 }
3764
3765 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3766 {
3767   struct FileInfo *file_list = artwork_info->file_list;
3768   int num_file_list_entries = artwork_info->num_file_list_entries;
3769   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3770   char *filename_base = UNDEFINED_FILENAME, *filename_local;
3771   int i, j;
3772
3773   DrawInitText("Loading artwork config", 120, FC_GREEN);
3774   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3775
3776   // always start with reliable default values
3777   for (i = 0; i < num_file_list_entries; i++)
3778   {
3779     setString(&file_list[i].filename, file_list[i].default_filename);
3780
3781     for (j = 0; j < num_suffix_list_entries; j++)
3782       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3783
3784     file_list[i].redefined = FALSE;
3785     file_list[i].fallback_to_default = FALSE;
3786   }
3787
3788   // free previous dynamic artwork file array
3789   if (artwork_info->dynamic_file_list != NULL)
3790   {
3791     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3792     {
3793       free(artwork_info->dynamic_file_list[i].token);
3794       free(artwork_info->dynamic_file_list[i].filename);
3795       free(artwork_info->dynamic_file_list[i].parameter);
3796     }
3797
3798     free(artwork_info->dynamic_file_list);
3799     artwork_info->dynamic_file_list = NULL;
3800
3801     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3802                           &artwork_info->num_dynamic_file_list_entries);
3803   }
3804
3805   // free previous property mapping
3806   if (artwork_info->property_mapping != NULL)
3807   {
3808     free(artwork_info->property_mapping);
3809
3810     artwork_info->property_mapping = NULL;
3811     artwork_info->num_property_mapping_entries = 0;
3812   }
3813
3814   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3815   {
3816     // first look for special artwork configured in level series config
3817     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3818
3819     if (fileExists(filename_base))
3820       LoadArtworkConfigFromFilename(artwork_info, filename_base);
3821   }
3822
3823   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3824
3825   if (filename_local != NULL && !strEqual(filename_base, filename_local))
3826     LoadArtworkConfigFromFilename(artwork_info, filename_local);
3827 }
3828
3829 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3830                                    struct ListNodeInfo **listnode)
3831 {
3832   if (*listnode)
3833   {
3834     char *filename = (*listnode)->source_filename;
3835
3836     if (--(*listnode)->num_references <= 0)
3837       deleteNodeFromList(&artwork_info->content_list, filename,
3838                          artwork_info->free_artwork);
3839
3840     *listnode = NULL;
3841   }
3842 }
3843
3844 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3845                                     struct ListNodeInfo **listnode,
3846                                     struct FileInfo *file_list_entry)
3847 {
3848   char *init_text[] =
3849   {
3850     "Loading graphics",
3851     "Loading sounds",
3852     "Loading music"
3853   };
3854
3855   ListNode *node;
3856   char *basename = file_list_entry->filename;
3857   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3858
3859   // mark all images from non-default graphics directory as "redefined"
3860   if (artwork_info->type == ARTWORK_TYPE_GRAPHICS &&
3861       !strPrefix(filename, options.graphics_directory))
3862     file_list_entry->redefined = TRUE;
3863
3864   if (filename == NULL)
3865   {
3866     Warn("cannot find artwork file '%s'", basename);
3867
3868     basename = file_list_entry->default_filename;
3869
3870     // fail for cloned default artwork that has no default filename defined
3871     if (file_list_entry->default_is_cloned &&
3872         strEqual(basename, UNDEFINED_FILENAME))
3873     {
3874       void (*error_func)(char *, ...) = Warn;
3875
3876       // we can get away without sounds and music, but not without graphics
3877       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3878         error_func = Fail;
3879
3880       error_func("token '%s' was cloned and has no default filename",
3881                  file_list_entry->token);
3882
3883       return;
3884     }
3885
3886     // dynamic artwork has no default filename / skip empty default artwork
3887     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3888       return;
3889
3890     file_list_entry->fallback_to_default = TRUE;
3891
3892     Warn("trying default artwork file '%s'", basename);
3893
3894     filename = getCustomArtworkFilename(basename, artwork_info->type);
3895
3896     if (filename == NULL)
3897     {
3898       void (*error_func)(char *, ...) = Warn;
3899
3900       // we can get away without sounds and music, but not without graphics
3901       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3902         error_func = Fail;
3903
3904       error_func("cannot find default artwork file '%s'", basename);
3905
3906       return;
3907     }
3908   }
3909
3910   // check if the old and the new artwork file are the same
3911   if (*listnode && strEqual((*listnode)->source_filename, filename))
3912   {
3913     // The old and new artwork are the same (have the same filename and path).
3914     // This usually means that this artwork does not exist in this artwork set
3915     // and a fallback to the existing artwork is done.
3916
3917     return;
3918   }
3919
3920   // delete existing artwork file entry
3921   deleteArtworkListEntry(artwork_info, listnode);
3922
3923   // check if the new artwork file already exists in the list of artwork
3924   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3925   {
3926       *listnode = (struct ListNodeInfo *)node->content;
3927       (*listnode)->num_references++;
3928
3929       return;
3930   }
3931
3932   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3933   DrawInitText(basename, 150, FC_YELLOW);
3934
3935   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3936   {
3937     // add new artwork file entry to the list of artwork files
3938     (*listnode)->num_references = 1;
3939     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3940                   *listnode);
3941   }
3942   else
3943   {
3944     void (*error_func)(char *, ...) = Warn;
3945
3946     // we can get away without sounds and music, but not without graphics
3947     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3948       error_func = Fail;
3949
3950     error_func("cannot load artwork file '%s'", basename);
3951
3952     return;
3953   }
3954 }
3955
3956 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3957                               struct ListNodeInfo **listnode,
3958                               struct FileInfo *file_list_entry)
3959 {
3960   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3961   {
3962     deleteArtworkListEntry(artwork_info, listnode);
3963
3964     return;
3965   }
3966
3967   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3968 }
3969
3970 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3971 {
3972   struct FileInfo *file_list = artwork_info->file_list;
3973   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3974   int num_file_list_entries = artwork_info->num_file_list_entries;
3975   int num_dynamic_file_list_entries =
3976     artwork_info->num_dynamic_file_list_entries;
3977   int i;
3978
3979   print_timestamp_init("ReloadCustomArtworkList");
3980
3981   for (i = 0; i < num_file_list_entries; i++)
3982     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3983                       &file_list[i]);
3984
3985   for (i = 0; i < num_dynamic_file_list_entries; i++)
3986     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3987                       &dynamic_file_list[i]);
3988
3989   print_timestamp_done("ReloadCustomArtworkList");
3990
3991 #if 0
3992   dumpList(artwork_info->content_list);
3993 #endif
3994 }
3995
3996 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3997                                   struct ListNodeInfo ***list,
3998                                   int *num_list_entries)
3999 {
4000   int i;
4001
4002   if (*list == NULL)
4003     return;
4004
4005   for (i = 0; i < *num_list_entries; i++)
4006     deleteArtworkListEntry(artwork_info, &(*list)[i]);
4007   free(*list);
4008
4009   *list = NULL;
4010   *num_list_entries = 0;
4011 }
4012
4013 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
4014 {
4015   if (artwork_info == NULL)
4016     return;
4017
4018   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
4019                         &artwork_info->num_file_list_entries);
4020
4021   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
4022                         &artwork_info->num_dynamic_file_list_entries);
4023 }
4024
4025
4026 // ----------------------------------------------------------------------------
4027 // functions only needed for non-Unix (non-command-line) systems
4028 // (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")
4029 // (now also added for Windows, to create files in user data directory)
4030 // ----------------------------------------------------------------------------
4031
4032 char *getLogFilename(char *basename)
4033 {
4034   return getPath2(getMainUserGameDataDir(), basename);
4035 }
4036
4037 void OpenLogFiles(void)
4038 {
4039   int i;
4040
4041   InitMainUserDataDirectory();
4042
4043   for (i = 0; i < NUM_LOGS; i++)
4044   {
4045     if ((program.log_file[i] = fopen(program.log_filename[i], MODE_WRITE))
4046         == NULL)
4047     {
4048       program.log_file[i] = program.log_file_default[i];   // reset to default
4049
4050       Warn("cannot open file '%s' for writing: %s",
4051            program.log_filename[i], strerror(errno));
4052     }
4053
4054     // output should be unbuffered so it is not truncated in a crash
4055     setbuf(program.log_file[i], NULL);
4056   }
4057 }
4058
4059 void CloseLogFiles(void)
4060 {
4061   int i;
4062
4063   for (i = 0; i < NUM_LOGS; i++)
4064     if (program.log_file[i] != program.log_file_default[i])
4065       fclose(program.log_file[i]);
4066 }
4067
4068 void DumpLogFile(int nr)
4069 {
4070   FILE *log_file = fopen(program.log_filename[nr], MODE_READ);
4071
4072   if (log_file == NULL)
4073     return;
4074
4075   while (!feof(log_file))
4076     fputc(fgetc(log_file), stdout);
4077
4078   fclose(log_file);
4079 }
4080
4081 void NotifyUserAboutErrorFile(void)
4082 {
4083 #if defined(PLATFORM_WIN32)
4084   char *title_text = getStringCat2(program.program_title, " Error Message");
4085   char *error_text = getStringCat2("The program was aborted due to an error; "
4086                                    "for details, see the following error file:"
4087                                    STRING_NEWLINE,
4088                                    program.log_filename[LOG_ERR_ID]);
4089
4090   MessageBox(NULL, error_text, title_text, MB_OK);
4091 #endif
4092 }
4093
4094
4095 // ----------------------------------------------------------------------------
4096 // the following is only for debugging purpose and normally not used
4097 // ----------------------------------------------------------------------------
4098
4099 #if DEBUG
4100
4101 #define DEBUG_PRINT_INIT_TIMESTAMPS             TRUE
4102 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH       10
4103
4104 #define DEBUG_NUM_TIMESTAMPS                    10
4105 #define DEBUG_TIME_IN_MICROSECONDS              0
4106
4107 #if DEBUG_TIME_IN_MICROSECONDS
4108 static double Counter_Microseconds(void)
4109 {
4110   static struct timeval base_time = { 0, 0 };
4111   struct timeval current_time;
4112   double counter;
4113
4114   gettimeofday(&current_time, NULL);
4115
4116   // reset base time in case of wrap-around
4117   if (current_time.tv_sec < base_time.tv_sec)
4118     base_time = current_time;
4119
4120   counter =
4121     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
4122     ((double)(current_time.tv_usec - base_time.tv_usec));
4123
4124   return counter;               // return microseconds since last init
4125 }
4126 #endif
4127
4128 static char *debug_print_timestamp_get_padding(int padding_size)
4129 {
4130   static char *padding = NULL;
4131   int max_padding_size = 100;
4132
4133   if (padding == NULL)
4134   {
4135     padding = checked_calloc(max_padding_size + 1);
4136     memset(padding, ' ', max_padding_size);
4137   }
4138
4139   return &padding[MAX(0, max_padding_size - padding_size)];
4140 }
4141
4142 void debug_print_timestamp(int counter_nr, char *message)
4143 {
4144   int indent_size = 8;
4145   int padding_size = 40;
4146   float timestamp_interval;
4147
4148   if (counter_nr < 0)
4149     Fail("debugging: invalid negative counter");
4150   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
4151     Fail("debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
4152
4153 #if DEBUG_TIME_IN_MICROSECONDS
4154   static double counter[DEBUG_NUM_TIMESTAMPS][2];
4155   char *unit = "ms";
4156
4157   counter[counter_nr][0] = Counter_Microseconds();
4158 #else
4159   static int counter[DEBUG_NUM_TIMESTAMPS][2];
4160   char *unit = "s";
4161
4162   counter[counter_nr][0] = Counter();
4163 #endif
4164
4165   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
4166   counter[counter_nr][1] = counter[counter_nr][0];
4167
4168   if (message)
4169     Debug("time:init", "%s%s%s %.3f %s",
4170           debug_print_timestamp_get_padding(counter_nr * indent_size),
4171           message,
4172           debug_print_timestamp_get_padding(padding_size - strlen(message)),
4173           timestamp_interval / 1000,
4174           unit);
4175 }
4176
4177 #if 0
4178 static void debug_print_parent_only(char *format, ...)
4179 {
4180   if (!IS_PARENT_PROCESS())
4181     return;
4182
4183   if (format)
4184   {
4185     va_list ap;
4186
4187     va_start(ap, format);
4188     vprintf(format, ap);
4189     va_end(ap);
4190
4191     printf("\n");
4192   }
4193 }
4194 #endif
4195
4196 #endif  // DEBUG
4197
4198 static void print_timestamp_ext(char *message, char *mode)
4199 {
4200 #if DEBUG_PRINT_INIT_TIMESTAMPS
4201   static char *debug_message = NULL;
4202   static char *last_message = NULL;
4203   static int counter_nr = 0;
4204   int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
4205
4206   checked_free(debug_message);
4207   debug_message = getStringCat3(mode, " ", message);
4208
4209   if (strEqual(mode, "INIT"))
4210   {
4211     debug_print_timestamp(counter_nr, NULL);
4212
4213     if (counter_nr + 1 < max_depth)
4214       debug_print_timestamp(counter_nr, debug_message);
4215
4216     counter_nr++;
4217
4218     debug_print_timestamp(counter_nr, NULL);
4219   }
4220   else if (strEqual(mode, "DONE"))
4221   {
4222     counter_nr--;
4223
4224     if (counter_nr + 1 < max_depth ||
4225         (counter_nr == 0 && max_depth == 1))
4226     {
4227       last_message = message;
4228
4229       if (counter_nr == 0 && max_depth == 1)
4230       {
4231         checked_free(debug_message);
4232         debug_message = getStringCat3("TIME", " ", message);
4233       }
4234
4235       debug_print_timestamp(counter_nr, debug_message);
4236     }
4237   }
4238   else if (!strEqual(mode, "TIME") ||
4239            !strEqual(message, last_message))
4240   {
4241     if (counter_nr < max_depth)
4242       debug_print_timestamp(counter_nr, debug_message);
4243   }
4244 #endif
4245 }
4246
4247 void print_timestamp_init(char *message)
4248 {
4249   print_timestamp_ext(message, "INIT");
4250 }
4251
4252 void print_timestamp_time(char *message)
4253 {
4254   print_timestamp_ext(message, "TIME");
4255 }
4256
4257 void print_timestamp_done(char *message)
4258 {
4259   print_timestamp_ext(message, "DONE");
4260 }