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