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