src/libgame/misc.c

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