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