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