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