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