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