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