src/libgame/misc.c

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