src/libgame/misc.c

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