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 #if defined(TARGET_SDL2)
1572     { KSYM_Menu,        "XK_Menu",              "menu" },        /* menu key */
1573     { KSYM_Back,        "XK_Back",              "back" },        /* back key */
1574 #endif
1575
1576     /* ASCII 0x20 to 0x40 keys (except numbers) */
1577     { KSYM_space,       "XK_space",             "space" },
1578     { KSYM_exclam,      "XK_exclam",            "!" },
1579     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
1580     { KSYM_numbersign,  "XK_numbersign",        "#" },
1581     { KSYM_dollar,      "XK_dollar",            "$" },
1582     { KSYM_percent,     "XK_percent",           "%" },
1583     { KSYM_ampersand,   "XK_ampersand",         "&" },
1584     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
1585     { KSYM_parenleft,   "XK_parenleft",         "(" },
1586     { KSYM_parenright,  "XK_parenright",        ")" },
1587     { KSYM_asterisk,    "XK_asterisk",          "*" },
1588     { KSYM_plus,        "XK_plus",              "+" },
1589     { KSYM_comma,       "XK_comma",             "," },
1590     { KSYM_minus,       "XK_minus",             "-" },
1591     { KSYM_period,      "XK_period",            "." },
1592     { KSYM_slash,       "XK_slash",             "/" },
1593     { KSYM_colon,       "XK_colon",             ":" },
1594     { KSYM_semicolon,   "XK_semicolon",         ";" },
1595     { KSYM_less,        "XK_less",              "<" },
1596     { KSYM_equal,       "XK_equal",             "=" },
1597     { KSYM_greater,     "XK_greater",           ">" },
1598     { KSYM_question,    "XK_question",          "?" },
1599     { KSYM_at,          "XK_at",                "@" },
1600
1601     /* more ASCII keys */
1602     { KSYM_bracketleft, "XK_bracketleft",       "[" },
1603     { KSYM_backslash,   "XK_backslash",         "\\" },
1604     { KSYM_bracketright,"XK_bracketright",      "]" },
1605     { KSYM_asciicircum, "XK_asciicircum",       "^" },
1606     { KSYM_underscore,  "XK_underscore",        "_" },
1607     { KSYM_grave,       "XK_grave",             "grave" },
1608     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
1609     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
1610     { KSYM_bar,         "XK_bar",               "bar" },
1611     { KSYM_braceright,  "XK_braceright",        "brace right" },
1612     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
1613
1614 #if !defined(TARGET_SDL2)
1615     /* special (non-ASCII) keys */
1616     { KSYM_degree,      "XK_degree",            "°" },
1617     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
1618     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
1619     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
1620     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
1621     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
1622     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
1623     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1624 #endif
1625
1626     /* end-of-array identifier */
1627     { 0,                NULL,                   NULL }
1628   };
1629
1630   int i;
1631
1632   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1633   {
1634     static char name_buffer[30];
1635     Key key = *keysym;
1636
1637     if (key >= KSYM_A && key <= KSYM_Z)
1638       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1639     else if (key >= KSYM_a && key <= KSYM_z)
1640       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1641     else if (key >= KSYM_0 && key <= KSYM_9)
1642       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1643     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1644       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1645     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1646       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1647     else if (key == KSYM_UNDEFINED)
1648       strcpy(name_buffer, "(undefined)");
1649     else
1650     {
1651       i = 0;
1652
1653       do
1654       {
1655         if (key == translate_key[i].key)
1656         {
1657           strcpy(name_buffer, translate_key[i].name);
1658           break;
1659         }
1660       }
1661       while (translate_key[++i].name);
1662
1663       if (!translate_key[i].name)
1664         strcpy(name_buffer, "(unknown)");
1665     }
1666
1667     *name = name_buffer;
1668   }
1669   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1670   {
1671     static char name_buffer[30];
1672     Key key = *keysym;
1673
1674     if (key >= KSYM_A && key <= KSYM_Z)
1675       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1676     else if (key >= KSYM_a && key <= KSYM_z)
1677       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1678     else if (key >= KSYM_0 && key <= KSYM_9)
1679       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1680     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1681       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1682     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1683       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1684     else if (key == KSYM_UNDEFINED)
1685       strcpy(name_buffer, "[undefined]");
1686     else
1687     {
1688       i = 0;
1689
1690       do
1691       {
1692         if (key == translate_key[i].key)
1693         {
1694           strcpy(name_buffer, translate_key[i].x11name);
1695           break;
1696         }
1697       }
1698       while (translate_key[++i].x11name);
1699
1700       if (!translate_key[i].x11name)
1701         sprintf(name_buffer, "0x%04x", (unsigned int)key);
1702     }
1703
1704     *x11name = name_buffer;
1705   }
1706   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1707   {
1708     Key key = KSYM_UNDEFINED;
1709
1710     i = 0;
1711     do
1712     {
1713       if (strEqual(translate_key[i].name, *name))
1714       {
1715         key = translate_key[i].key;
1716         break;
1717       }
1718     }
1719     while (translate_key[++i].x11name);
1720
1721     if (key == KSYM_UNDEFINED)
1722       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1723
1724     *keysym = key;
1725   }
1726   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1727   {
1728     Key key = KSYM_UNDEFINED;
1729     char *name_ptr = *x11name;
1730
1731     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1732     {
1733       char c = name_ptr[3];
1734
1735       if (c >= 'A' && c <= 'Z')
1736         key = KSYM_A + (Key)(c - 'A');
1737       else if (c >= 'a' && c <= 'z')
1738         key = KSYM_a + (Key)(c - 'a');
1739       else if (c >= '0' && c <= '9')
1740         key = KSYM_0 + (Key)(c - '0');
1741     }
1742     else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1743     {
1744       char c = name_ptr[6];
1745
1746       if (c >= '0' && c <= '9')
1747         key = KSYM_KP_0 + (Key)(c - '0');
1748     }
1749     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1750     {
1751       char c1 = name_ptr[4];
1752       char c2 = name_ptr[5];
1753       int d = 0;
1754
1755       if ((c1 >= '0' && c1 <= '9') &&
1756           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1757         d = atoi(&name_ptr[4]);
1758
1759       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1760         key = KSYM_F1 + (Key)(d - 1);
1761     }
1762     else if (strPrefix(name_ptr, "XK_"))
1763     {
1764       i = 0;
1765
1766       do
1767       {
1768         if (strEqual(name_ptr, translate_key[i].x11name))
1769         {
1770           key = translate_key[i].key;
1771           break;
1772         }
1773       }
1774       while (translate_key[++i].x11name);
1775     }
1776     else if (strPrefix(name_ptr, "0x"))
1777     {
1778       unsigned int value = 0;
1779
1780       name_ptr += 2;
1781
1782       while (name_ptr)
1783       {
1784         char c = *name_ptr++;
1785         int d = -1;
1786
1787         if (c >= '0' && c <= '9')
1788           d = (int)(c - '0');
1789         else if (c >= 'a' && c <= 'f')
1790           d = (int)(c - 'a' + 10);
1791         else if (c >= 'A' && c <= 'F')
1792           d = (int)(c - 'A' + 10);
1793
1794         if (d == -1)
1795         {
1796           value = -1;
1797           break;
1798         }
1799
1800         value = value * 16 + d;
1801       }
1802
1803       if (value != -1)
1804         key = (Key)value;
1805     }
1806
1807     *keysym = key;
1808   }
1809 }
1810
1811 char *getKeyNameFromKey(Key key)
1812 {
1813   char *name;
1814
1815   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1816   return name;
1817 }
1818
1819 char *getX11KeyNameFromKey(Key key)
1820 {
1821   char *x11name;
1822
1823   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1824   return x11name;
1825 }
1826
1827 Key getKeyFromKeyName(char *name)
1828 {
1829   Key key;
1830
1831   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1832   return key;
1833 }
1834
1835 Key getKeyFromX11KeyName(char *x11name)
1836 {
1837   Key key;
1838
1839   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1840   return key;
1841 }
1842
1843 char getCharFromKey(Key key)
1844 {
1845   char *keyname = getKeyNameFromKey(key);
1846   char c = 0;
1847
1848   if (strlen(keyname) == 1)
1849     c = keyname[0];
1850   else if (strEqual(keyname, "space"))
1851     c = ' ';
1852
1853   return c;
1854 }
1855
1856 char getValidConfigValueChar(char c)
1857 {
1858   if (c == '#' ||       /* used to mark comments */
1859       c == '\\')        /* used to mark continued lines */
1860     c = 0;
1861
1862   return c;
1863 }
1864
1865
1866 /* ------------------------------------------------------------------------- */
1867 /* functions to translate string identifiers to integer or boolean value     */
1868 /* ------------------------------------------------------------------------- */
1869
1870 int get_integer_from_string(char *s)
1871 {
1872   static char *number_text[][3] =
1873   {
1874     { "0",      "zero",         "null",         },
1875     { "1",      "one",          "first"         },
1876     { "2",      "two",          "second"        },
1877     { "3",      "three",        "third"         },
1878     { "4",      "four",         "fourth"        },
1879     { "5",      "five",         "fifth"         },
1880     { "6",      "six",          "sixth"         },
1881     { "7",      "seven",        "seventh"       },
1882     { "8",      "eight",        "eighth"        },
1883     { "9",      "nine",         "ninth"         },
1884     { "10",     "ten",          "tenth"         },
1885     { "11",     "eleven",       "eleventh"      },
1886     { "12",     "twelve",       "twelfth"       },
1887
1888     { NULL,     NULL,           NULL            },
1889   };
1890
1891   int i, j;
1892   char *s_lower = getStringToLower(s);
1893   int result = -1;
1894
1895   for (i = 0; number_text[i][0] != NULL; i++)
1896     for (j = 0; j < 3; j++)
1897       if (strEqual(s_lower, number_text[i][j]))
1898         result = i;
1899
1900   if (result == -1)
1901   {
1902     if (strEqual(s_lower, "false") ||
1903         strEqual(s_lower, "no") ||
1904         strEqual(s_lower, "off"))
1905       result = 0;
1906     else if (strEqual(s_lower, "true") ||
1907              strEqual(s_lower, "yes") ||
1908              strEqual(s_lower, "on"))
1909       result = 1;
1910     else
1911       result = atoi(s);
1912   }
1913
1914   free(s_lower);
1915
1916   return result;
1917 }
1918
1919 boolean get_boolean_from_string(char *s)
1920 {
1921   char *s_lower = getStringToLower(s);
1922   boolean result = FALSE;
1923
1924   if (strEqual(s_lower, "true") ||
1925       strEqual(s_lower, "yes") ||
1926       strEqual(s_lower, "on") ||
1927       get_integer_from_string(s) == 1)
1928     result = TRUE;
1929
1930   free(s_lower);
1931
1932   return result;
1933 }
1934
1935 int get_switch3_from_string(char *s)
1936 {
1937   char *s_lower = getStringToLower(s);
1938   int result = FALSE;
1939
1940   if (strEqual(s_lower, "true") ||
1941       strEqual(s_lower, "yes") ||
1942       strEqual(s_lower, "on") ||
1943       get_integer_from_string(s) == 1)
1944     result = TRUE;
1945   else if (strEqual(s_lower, "auto"))
1946     result = AUTO;
1947
1948   free(s_lower);
1949
1950   return result;
1951 }
1952
1953
1954 /* ------------------------------------------------------------------------- */
1955 /* functions for generic lists                                               */
1956 /* ------------------------------------------------------------------------- */
1957
1958 ListNode *newListNode()
1959 {
1960   return checked_calloc(sizeof(ListNode));
1961 }
1962
1963 void addNodeToList(ListNode **node_first, char *key, void *content)
1964 {
1965   ListNode *node_new = newListNode();
1966
1967   node_new->key = getStringCopy(key);
1968   node_new->content = content;
1969   node_new->next = *node_first;
1970   *node_first = node_new;
1971 }
1972
1973 void deleteNodeFromList(ListNode **node_first, char *key,
1974                         void (*destructor_function)(void *))
1975 {
1976   if (node_first == NULL || *node_first == NULL)
1977     return;
1978
1979   if (strEqual((*node_first)->key, key))
1980   {
1981     checked_free((*node_first)->key);
1982     if (destructor_function)
1983       destructor_function((*node_first)->content);
1984     *node_first = (*node_first)->next;
1985   }
1986   else
1987     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1988 }
1989
1990 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1991 {
1992   if (node_first == NULL)
1993     return NULL;
1994
1995   if (strEqual(node_first->key, key))
1996     return node_first;
1997   else
1998     return getNodeFromKey(node_first->next, key);
1999 }
2000
2001 int getNumNodes(ListNode *node_first)
2002 {
2003   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
2004 }
2005
2006 void dumpList(ListNode *node_first)
2007 {
2008   ListNode *node = node_first;
2009
2010   while (node)
2011   {
2012     printf("['%s' (%d)]\n", node->key,
2013            ((struct ListNodeInfo *)node->content)->num_references);
2014     node = node->next;
2015   }
2016
2017   printf("[%d nodes]\n", getNumNodes(node_first));
2018 }
2019
2020
2021 /* ------------------------------------------------------------------------- */
2022 /* functions for file handling                                               */
2023 /* ------------------------------------------------------------------------- */
2024
2025 File *openFile(char *filename, char *mode)
2026 {
2027   File *file = checked_calloc(sizeof(File));
2028
2029   file->file = fopen(filename, mode);
2030
2031   if (file->file != NULL)
2032   {
2033     file->filename = getStringCopy(filename);
2034
2035     return file;
2036   }
2037
2038 #if defined(PLATFORM_ANDROID)
2039   file->asset_file = SDL_RWFromFile(filename, mode);
2040
2041   if (file->asset_file != NULL)
2042   {
2043     file->file_is_asset = TRUE;
2044     file->filename = getStringCopy(filename);
2045
2046     return file;
2047   }
2048 #endif
2049
2050   checked_free(file);
2051
2052   return NULL;
2053 }
2054
2055 int closeFile(File *file)
2056 {
2057   if (file == NULL)
2058     return -1;
2059
2060   int result = 0;
2061
2062 #if defined(PLATFORM_ANDROID)
2063   if (file->asset_file)
2064     result = SDL_RWclose(file->asset_file);
2065 #endif
2066
2067   if (file->file)
2068     result = fclose(file->file);
2069
2070   checked_free(file->filename);
2071   checked_free(file);
2072
2073   return result;
2074 }
2075
2076 int checkEndOfFile(File *file)
2077 {
2078 #if defined(PLATFORM_ANDROID)
2079   if (file->file_is_asset)
2080     return file->end_of_file;
2081 #endif
2082
2083   return feof(file->file);
2084 }
2085
2086 size_t readFile(File *file, void *buffer, size_t item_size, size_t num_items)
2087 {
2088 #if defined(PLATFORM_ANDROID)
2089   if (file->file_is_asset)
2090   {
2091     if (file->end_of_file)
2092       return 0;
2093
2094     size_t num_items_read =
2095       SDL_RWread(file->asset_file, buffer, item_size, num_items);
2096
2097     if (num_items_read < num_items)
2098       file->end_of_file = TRUE;
2099
2100     return num_items_read;
2101   }
2102 #endif
2103
2104   return fread(buffer, item_size, num_items, file->file);
2105 }
2106
2107 int seekFile(File *file, long offset, int whence)
2108 {
2109 #if defined(PLATFORM_ANDROID)
2110   if (file->file_is_asset)
2111   {
2112     int sdl_whence = (whence == SEEK_SET ? RW_SEEK_SET :
2113                       whence == SEEK_CUR ? RW_SEEK_CUR :
2114                       whence == SEEK_END ? RW_SEEK_END : 0);
2115
2116     return (SDL_RWseek(file->asset_file, offset, sdl_whence) == -1 ? -1 : 0);
2117   }
2118 #endif
2119
2120   return fseek(file->file, offset, whence);
2121 }
2122
2123 int getByteFromFile(File *file)
2124 {
2125 #if defined(PLATFORM_ANDROID)
2126   if (file->file_is_asset)
2127   {
2128     if (file->end_of_file)
2129       return EOF;
2130
2131     byte c;
2132     size_t num_bytes_read = SDL_RWread(file->asset_file, &c, 1, 1);
2133
2134     if (num_bytes_read < 1)
2135       file->end_of_file = TRUE;
2136
2137     return (file->end_of_file ? EOF : (int)c);
2138   }
2139 #endif
2140
2141   return fgetc(file->file);
2142 }
2143
2144 char *getStringFromFile(File *file, char *line, int size)
2145 {
2146 #if defined(PLATFORM_ANDROID)
2147   if (file->file_is_asset)
2148   {
2149     if (file->end_of_file)
2150       return NULL;
2151
2152     char *line_ptr = line;
2153     int num_bytes_read = 0;
2154
2155     while (num_bytes_read < size - 1 &&
2156            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
2157            *line_ptr++ != '\n')
2158       num_bytes_read++;
2159
2160     *line_ptr = '\0';
2161
2162     if (strlen(line) == 0)
2163     {
2164       file->end_of_file = TRUE;
2165
2166       return NULL;
2167     }
2168
2169     return line;
2170   }
2171 #endif
2172
2173   return fgets(line, size, file->file);
2174 }
2175
2176
2177 /* ------------------------------------------------------------------------- */
2178 /* functions for directory handling                                          */
2179 /* ------------------------------------------------------------------------- */
2180
2181 Directory *openDirectory(char *dir_name)
2182 {
2183   Directory *dir = checked_calloc(sizeof(Directory));
2184
2185   dir->dir = opendir(dir_name);
2186
2187   if (dir->dir != NULL)
2188   {
2189     dir->filename = getStringCopy(dir_name);
2190
2191     return dir;
2192   }
2193
2194 #if defined(PLATFORM_ANDROID)
2195   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2196
2197   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2198
2199   checked_free(asset_toc_filename);
2200
2201   if (dir->asset_toc_file != NULL)
2202   {
2203     dir->directory_is_asset = TRUE;
2204     dir->filename = getStringCopy(dir_name);
2205
2206     return dir;
2207   }
2208 #endif
2209
2210   checked_free(dir);
2211
2212   return NULL;
2213 }
2214
2215 int closeDirectory(Directory *dir)
2216 {
2217   if (dir == NULL)
2218     return -1;
2219
2220   int result = 0;
2221
2222 #if defined(PLATFORM_ANDROID)
2223   if (dir->asset_toc_file)
2224     result = SDL_RWclose(dir->asset_toc_file);
2225 #endif
2226
2227   if (dir->dir)
2228     result = closedir(dir->dir);
2229
2230   if (dir->dir_entry)
2231     freeDirectoryEntry(dir->dir_entry);
2232
2233   checked_free(dir->filename);
2234   checked_free(dir);
2235
2236   return result;
2237 }
2238
2239 DirectoryEntry *readDirectory(Directory *dir)
2240 {
2241   if (dir->dir_entry)
2242     freeDirectoryEntry(dir->dir_entry);
2243
2244   dir->dir_entry = NULL;
2245
2246 #if defined(PLATFORM_ANDROID)
2247   if (dir->directory_is_asset)
2248   {
2249     char line[MAX_LINE_LEN];
2250     char *line_ptr = line;
2251     int num_bytes_read = 0;
2252
2253     while (num_bytes_read < MAX_LINE_LEN - 1 &&
2254            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2255            *line_ptr != '\n')
2256     {
2257       line_ptr++;
2258       num_bytes_read++;
2259     }
2260
2261     *line_ptr = '\0';
2262
2263     if (strlen(line) == 0)
2264       return NULL;
2265
2266     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2267
2268     dir->dir_entry->is_directory = FALSE;
2269     if (line[strlen(line) - 1] == '/')
2270     {
2271       dir->dir_entry->is_directory = TRUE;
2272
2273       line[strlen(line) - 1] = '\0';
2274     }
2275
2276     dir->dir_entry->basename = getStringCopy(line);
2277     dir->dir_entry->filename = getPath2(dir->filename, line);
2278
2279     return dir->dir_entry;
2280   }
2281 #endif
2282
2283   struct dirent *dir_entry = readdir(dir->dir);
2284
2285   if (dir_entry == NULL)
2286     return NULL;
2287
2288   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2289
2290   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2291   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2292
2293   struct stat file_status;
2294
2295   dir->dir_entry->is_directory =
2296     (stat(dir->dir_entry->filename, &file_status) == 0 &&
2297      (file_status.st_mode & S_IFMT) == S_IFDIR);
2298
2299 #if 0
2300   Error(ERR_INFO, "::: '%s' is directory: %d",
2301         dir->dir_entry->basename,
2302         dir->dir_entry->is_directory);
2303 #endif
2304
2305   return dir->dir_entry;
2306 }
2307
2308 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2309 {
2310   if (dir_entry == NULL)
2311     return;
2312
2313   checked_free(dir_entry->basename);
2314   checked_free(dir_entry->filename);
2315   checked_free(dir_entry);
2316 }
2317
2318
2319 /* ------------------------------------------------------------------------- */
2320 /* functions for checking files and filenames                                */
2321 /* ------------------------------------------------------------------------- */
2322
2323 boolean directoryExists(char *dir_name)
2324 {
2325   if (dir_name == NULL)
2326     return FALSE;
2327
2328   boolean success = (access(dir_name, F_OK) == 0);
2329
2330 #if defined(PLATFORM_ANDROID)
2331   if (!success)
2332   {
2333     // this might be an asset directory; check by trying to open toc file
2334     char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2335     SDL_RWops *file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2336
2337     checked_free(asset_toc_filename);
2338
2339     success = (file != NULL);
2340
2341     if (success)
2342       SDL_RWclose(file);
2343   }
2344 #endif
2345
2346   return success;
2347 }
2348
2349 boolean fileExists(char *filename)
2350 {
2351   if (filename == NULL)
2352     return FALSE;
2353
2354   boolean success = (access(filename, F_OK) == 0);
2355
2356 #if defined(PLATFORM_ANDROID)
2357   if (!success)
2358   {
2359     // this might be an asset file; check by trying to open it
2360     SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2361
2362     success = (file != NULL);
2363
2364     if (success)
2365       SDL_RWclose(file);
2366   }
2367 #endif
2368
2369   return success;
2370 }
2371
2372 boolean fileHasPrefix(char *basename, char *prefix)
2373 {
2374   static char *basename_lower = NULL;
2375   int basename_length, prefix_length;
2376
2377   checked_free(basename_lower);
2378
2379   if (basename == NULL || prefix == NULL)
2380     return FALSE;
2381
2382   basename_lower = getStringToLower(basename);
2383   basename_length = strlen(basename_lower);
2384   prefix_length = strlen(prefix);
2385
2386   if (basename_length > prefix_length + 1 &&
2387       basename_lower[prefix_length] == '.' &&
2388       strncmp(basename_lower, prefix, prefix_length) == 0)
2389     return TRUE;
2390
2391   return FALSE;
2392 }
2393
2394 boolean fileHasSuffix(char *basename, char *suffix)
2395 {
2396   static char *basename_lower = NULL;
2397   int basename_length, suffix_length;
2398
2399   checked_free(basename_lower);
2400
2401   if (basename == NULL || suffix == NULL)
2402     return FALSE;
2403
2404   basename_lower = getStringToLower(basename);
2405   basename_length = strlen(basename_lower);
2406   suffix_length = strlen(suffix);
2407
2408   if (basename_length > suffix_length + 1 &&
2409       basename_lower[basename_length - suffix_length - 1] == '.' &&
2410       strEqual(&basename_lower[basename_length - suffix_length], suffix))
2411     return TRUE;
2412
2413   return FALSE;
2414 }
2415
2416 boolean FileIsGraphic(char *filename)
2417 {
2418   char *basename = getBaseNamePtr(filename);
2419
2420 #if defined(TARGET_SDL)
2421   return (!fileHasSuffix(basename, "txt") &&
2422           !fileHasSuffix(basename, "conf"));
2423 #else
2424   return fileHasSuffix(basename, "pcx");
2425 #endif
2426 }
2427
2428 boolean FileIsSound(char *filename)
2429 {
2430   char *basename = getBaseNamePtr(filename);
2431
2432 #if defined(TARGET_SDL)
2433   return (!fileHasSuffix(basename, "txt") &&
2434           !fileHasSuffix(basename, "conf"));
2435 #else
2436   return fileHasSuffix(basename, "wav");
2437 #endif
2438 }
2439
2440 boolean FileIsMusic(char *filename)
2441 {
2442   char *basename = getBaseNamePtr(filename);
2443
2444 #if defined(TARGET_SDL)
2445   return (!fileHasSuffix(basename, "txt") &&
2446           !fileHasSuffix(basename, "conf"));
2447 #else
2448   if (FileIsSound(basename))
2449     return TRUE;
2450
2451 #if 0
2452 #if defined(TARGET_SDL)
2453   if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2454       fileHasSuffix(basename, "mod") ||
2455       fileHasSuffix(basename, "s3m") ||
2456       fileHasSuffix(basename, "it") ||
2457       fileHasSuffix(basename, "xm") ||
2458       fileHasSuffix(basename, "midi") ||
2459       fileHasSuffix(basename, "mid") ||
2460       fileHasSuffix(basename, "mp3") ||
2461       fileHasSuffix(basename, "ogg"))
2462     return TRUE;
2463 #endif
2464 #endif
2465
2466   return FALSE;
2467 #endif
2468 }
2469
2470 boolean FileIsArtworkType(char *basename, int type)
2471 {
2472   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2473       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2474       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2475     return TRUE;
2476
2477   return FALSE;
2478 }
2479
2480 /* ------------------------------------------------------------------------- */
2481 /* functions for loading artwork configuration information                   */
2482 /* ------------------------------------------------------------------------- */
2483
2484 char *get_mapped_token(char *token)
2485 {
2486   /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2487   static char *map_token_prefix[][2] =
2488   {
2489     { "char_procent",           "char_percent"  },
2490     { NULL,                                     }
2491   };
2492   int i;
2493
2494   for (i = 0; map_token_prefix[i][0] != NULL; i++)
2495   {
2496     int len_token_prefix = strlen(map_token_prefix[i][0]);
2497
2498     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2499       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2500   }
2501
2502   return NULL;
2503 }
2504
2505 /* This function checks if a string <s> of the format "string1, string2, ..."
2506    exactly contains a string <s_contained>. */
2507
2508 static boolean string_has_parameter(char *s, char *s_contained)
2509 {
2510   char *substring;
2511
2512   if (s == NULL || s_contained == NULL)
2513     return FALSE;
2514
2515   if (strlen(s_contained) > strlen(s))
2516     return FALSE;
2517
2518   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2519   {
2520     char next_char = s[strlen(s_contained)];
2521
2522     /* check if next character is delimiter or whitespace */
2523     return (next_char == ',' || next_char == '\0' ||
2524             next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2525   }
2526
2527   /* check if string contains another parameter string after a comma */
2528   substring = strchr(s, ',');
2529   if (substring == NULL)        /* string does not contain a comma */
2530     return FALSE;
2531
2532   /* advance string pointer to next character after the comma */
2533   substring++;
2534
2535   /* skip potential whitespaces after the comma */
2536   while (*substring == ' ' || *substring == '\t')
2537     substring++;
2538
2539   return string_has_parameter(substring, s_contained);
2540 }
2541
2542 int get_parameter_value(char *value_raw, char *suffix, int type)
2543 {
2544   char *value = getStringToLower(value_raw);
2545   int result = 0;       /* probably a save default value */
2546
2547   if (strEqual(suffix, ".direction"))
2548   {
2549     result = (strEqual(value, "left")  ? MV_LEFT :
2550               strEqual(value, "right") ? MV_RIGHT :
2551               strEqual(value, "up")    ? MV_UP :
2552               strEqual(value, "down")  ? MV_DOWN : MV_NONE);
2553   }
2554   else if (strEqual(suffix, ".align"))
2555   {
2556     result = (strEqual(value, "left")   ? ALIGN_LEFT :
2557               strEqual(value, "right")  ? ALIGN_RIGHT :
2558               strEqual(value, "center") ? ALIGN_CENTER :
2559               strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2560   }
2561   else if (strEqual(suffix, ".valign"))
2562   {
2563     result = (strEqual(value, "top")    ? VALIGN_TOP :
2564               strEqual(value, "bottom") ? VALIGN_BOTTOM :
2565               strEqual(value, "middle") ? VALIGN_MIDDLE :
2566               strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2567   }
2568   else if (strEqual(suffix, ".anim_mode"))
2569   {
2570     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
2571               string_has_parameter(value, "loop")       ? ANIM_LOOP :
2572               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
2573               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
2574               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
2575               string_has_parameter(value, "random")     ? ANIM_RANDOM :
2576               string_has_parameter(value, "ce_value")   ? ANIM_CE_VALUE :
2577               string_has_parameter(value, "ce_score")   ? ANIM_CE_SCORE :
2578               string_has_parameter(value, "ce_delay")   ? ANIM_CE_DELAY :
2579               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2580               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
2581               string_has_parameter(value, "centered")   ? ANIM_CENTERED :
2582               ANIM_DEFAULT);
2583
2584     if (string_has_parameter(value, "reverse"))
2585       result |= ANIM_REVERSE;
2586
2587     if (string_has_parameter(value, "opaque_player"))
2588       result |= ANIM_OPAQUE_PLAYER;
2589
2590     if (string_has_parameter(value, "static_panel"))
2591       result |= ANIM_STATIC_PANEL;
2592   }
2593   else if (strEqual(suffix, ".class"))
2594   {
2595     result = get_hash_from_key(value);
2596   }
2597   else if (strEqual(suffix, ".style"))
2598   {
2599     result = STYLE_DEFAULT;
2600
2601     if (string_has_parameter(value, "accurate_borders"))
2602       result |= STYLE_ACCURATE_BORDERS;
2603
2604     if (string_has_parameter(value, "inner_corners"))
2605       result |= STYLE_INNER_CORNERS;
2606   }
2607   else if (strEqual(suffix, ".fade_mode"))
2608   {
2609     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
2610               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
2611               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
2612               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
2613               FADE_MODE_DEFAULT);
2614   }
2615 #if 1
2616   else if (strPrefix(suffix, ".font"))          /* (may also be ".font_xyz") */
2617 #else
2618   else if (strEqualN(suffix, ".font", 5))       /* (may also be ".font_xyz") */
2619 #endif
2620   {
2621     result = gfx.get_font_from_token_function(value);
2622   }
2623   else          /* generic parameter of type integer or boolean */
2624   {
2625     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2626               type == TYPE_INTEGER ? get_integer_from_string(value) :
2627               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2628               ARG_UNDEFINED_VALUE);
2629   }
2630
2631   free(value);
2632
2633   return result;
2634 }
2635
2636 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2637 {
2638   static struct ScreenModeInfo screen_mode;
2639   char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2640   char *screen_mode_string_copy;
2641   char *screen_mode_string_pos_w;
2642   char *screen_mode_string_pos_h;
2643
2644   if (screen_mode_string_x == NULL)     /* invalid screen mode format */
2645     return NULL;
2646
2647   screen_mode_string_copy = getStringCopy(screen_mode_string);
2648
2649   screen_mode_string_pos_w = screen_mode_string_copy;
2650   screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2651   *screen_mode_string_pos_h++ = '\0';
2652
2653   screen_mode.width  = atoi(screen_mode_string_pos_w);
2654   screen_mode.height = atoi(screen_mode_string_pos_h);
2655
2656   return &screen_mode;
2657 }
2658
2659 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2660                                        int *x, int *y)
2661 {
2662   float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2663   float aspect_ratio_new;
2664   int i = 1;
2665
2666   do
2667   {
2668     *x = i * aspect_ratio + 0.000001;
2669     *y = i;
2670
2671     aspect_ratio_new = (float)*x / (float)*y;
2672
2673     i++;
2674   }
2675   while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2676 }
2677
2678 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2679                                   struct ListNodeInfo ***, int *);
2680
2681 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2682                                            struct ConfigTypeInfo *suffix_list,
2683                                            char **ignore_tokens,
2684                                            int num_file_list_entries)
2685 {
2686   struct FileInfo *file_list;
2687   int num_file_list_entries_found = 0;
2688   int num_suffix_list_entries = 0;
2689   int list_pos;
2690   int i, j;
2691
2692   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2693
2694   for (i = 0; suffix_list[i].token != NULL; i++)
2695     num_suffix_list_entries++;
2696
2697   /* always start with reliable default values */
2698   for (i = 0; i < num_file_list_entries; i++)
2699   {
2700     file_list[i].token = NULL;
2701
2702     file_list[i].default_filename = NULL;
2703     file_list[i].filename = NULL;
2704
2705     if (num_suffix_list_entries > 0)
2706     {
2707       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2708
2709       file_list[i].default_parameter = checked_calloc(parameter_array_size);
2710       file_list[i].parameter = checked_calloc(parameter_array_size);
2711
2712       for (j = 0; j < num_suffix_list_entries; j++)
2713       {
2714         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2715         setString(&file_list[i].parameter[j], suffix_list[j].value);
2716       }
2717
2718       file_list[i].redefined = FALSE;
2719       file_list[i].fallback_to_default = FALSE;
2720       file_list[i].default_is_cloned = FALSE;
2721     }
2722   }
2723
2724   list_pos = 0;
2725
2726   for (i = 0; config_list[i].token != NULL; i++)
2727   {
2728     int len_config_token = strlen(config_list[i].token);
2729 #if 0
2730     int len_config_value = strlen(config_list[i].value);
2731 #endif
2732     boolean is_file_entry = TRUE;
2733
2734     for (j = 0; suffix_list[j].token != NULL; j++)
2735     {
2736       int len_suffix = strlen(suffix_list[j].token);
2737
2738       if (len_suffix < len_config_token &&
2739           strEqual(&config_list[i].token[len_config_token - len_suffix],
2740                    suffix_list[j].token))
2741       {
2742         setString(&file_list[list_pos].default_parameter[j],
2743                   config_list[i].value);
2744
2745         is_file_entry = FALSE;
2746
2747         break;
2748       }
2749     }
2750
2751     /* the following tokens are no file definitions, but other config tokens */
2752     for (j = 0; ignore_tokens[j] != NULL; j++)
2753       if (strEqual(config_list[i].token, ignore_tokens[j]))
2754         is_file_entry = FALSE;
2755
2756     if (is_file_entry)
2757     {
2758       if (i > 0)
2759         list_pos++;
2760
2761       if (list_pos >= num_file_list_entries)
2762         break;
2763
2764 #if 0
2765       /* simple sanity check if this is really a file definition */
2766       if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2767           !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2768           !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2769       {
2770         Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2771               config_list[i].token, config_list[i].value);
2772         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2773       }
2774 #endif
2775
2776       file_list[list_pos].token = config_list[i].token;
2777       file_list[list_pos].default_filename = config_list[i].value;
2778
2779 #if 0
2780       printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2781 #endif
2782     }
2783
2784     if (strSuffix(config_list[i].token, ".clone_from"))
2785       file_list[list_pos].default_is_cloned = TRUE;
2786   }
2787
2788   num_file_list_entries_found = list_pos + 1;
2789   if (num_file_list_entries_found != num_file_list_entries)
2790   {
2791     Error(ERR_INFO_LINE, "-");
2792     Error(ERR_INFO, "inconsistant config list information:");
2793     Error(ERR_INFO, "- should be:   %d (according to 'src/conf_xxx.h')",
2794           num_file_list_entries);
2795     Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2796           num_file_list_entries_found);
2797     Error(ERR_EXIT,   "please fix");
2798   }
2799
2800 #if 0
2801   printf("::: ---------- DONE ----------\n");
2802 #endif
2803
2804   return file_list;
2805 }
2806
2807 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2808 {
2809   int len_token = strlen(token);
2810   int len_suffix = strlen(suffix);
2811
2812   if (start_pos < 0)    /* compare suffix from end of string */
2813     start_pos += len_token;
2814
2815   if (start_pos < 0 || start_pos + len_suffix > len_token)
2816     return FALSE;
2817
2818   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2819     return FALSE;
2820
2821   if (token[start_pos + len_suffix] == '\0')
2822     return TRUE;
2823
2824   if (token[start_pos + len_suffix] == '.')
2825     return TRUE;
2826
2827   return FALSE;
2828 }
2829
2830 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
2831
2832 static void read_token_parameters(SetupFileHash *setup_file_hash,
2833                                   struct ConfigTypeInfo *suffix_list,
2834                                   struct FileInfo *file_list_entry)
2835 {
2836   /* check for config token that is the base token without any suffixes */
2837   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2838   char *known_token_value = KNOWN_TOKEN_VALUE;
2839   int i;
2840
2841   if (filename != NULL)
2842   {
2843     setString(&file_list_entry->filename, filename);
2844
2845     /* when file definition found, set all parameters to default values */
2846     for (i = 0; suffix_list[i].token != NULL; i++)
2847       setString(&file_list_entry->parameter[i], suffix_list[i].value);
2848
2849     file_list_entry->redefined = TRUE;
2850
2851     /* mark config file token as well known from default config */
2852     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2853   }
2854
2855   /* check for config tokens that can be build by base token and suffixes */
2856   for (i = 0; suffix_list[i].token != NULL; i++)
2857   {
2858     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2859     char *value = getHashEntry(setup_file_hash, token);
2860
2861     if (value != NULL)
2862     {
2863       setString(&file_list_entry->parameter[i], value);
2864
2865       /* mark config file token as well known from default config */
2866       setHashEntry(setup_file_hash, token, known_token_value);
2867     }
2868
2869     free(token);
2870   }
2871 }
2872
2873 static void add_dynamic_file_list_entry(struct FileInfo **list,
2874                                         int *num_list_entries,
2875                                         SetupFileHash *extra_file_hash,
2876                                         struct ConfigTypeInfo *suffix_list,
2877                                         int num_suffix_list_entries,
2878                                         char *token)
2879 {
2880   struct FileInfo *new_list_entry;
2881   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2882
2883   (*num_list_entries)++;
2884   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2885   new_list_entry = &(*list)[*num_list_entries - 1];
2886
2887   new_list_entry->token = getStringCopy(token);
2888   new_list_entry->default_filename = NULL;
2889   new_list_entry->filename = NULL;
2890   new_list_entry->parameter = checked_calloc(parameter_array_size);
2891
2892   new_list_entry->redefined = FALSE;
2893   new_list_entry->fallback_to_default = FALSE;
2894   new_list_entry->default_is_cloned = FALSE;
2895
2896   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2897 }
2898
2899 static void add_property_mapping(struct PropertyMapping **list,
2900                                  int *num_list_entries,
2901                                  int base_index, int ext1_index,
2902                                  int ext2_index, int ext3_index,
2903                                  int artwork_index)
2904 {
2905   struct PropertyMapping *new_list_entry;
2906
2907   (*num_list_entries)++;
2908   *list = checked_realloc(*list,
2909                           *num_list_entries * sizeof(struct PropertyMapping));
2910   new_list_entry = &(*list)[*num_list_entries - 1];
2911
2912   new_list_entry->base_index = base_index;
2913   new_list_entry->ext1_index = ext1_index;
2914   new_list_entry->ext2_index = ext2_index;
2915   new_list_entry->ext3_index = ext3_index;
2916
2917   new_list_entry->artwork_index = artwork_index;
2918 }
2919
2920 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2921                                           char *filename)
2922 {
2923   struct FileInfo *file_list = artwork_info->file_list;
2924   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2925   char **base_prefixes = artwork_info->base_prefixes;
2926   char **ext1_suffixes = artwork_info->ext1_suffixes;
2927   char **ext2_suffixes = artwork_info->ext2_suffixes;
2928   char **ext3_suffixes = artwork_info->ext3_suffixes;
2929   char **ignore_tokens = artwork_info->ignore_tokens;
2930   int num_file_list_entries = artwork_info->num_file_list_entries;
2931   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2932   int num_base_prefixes = artwork_info->num_base_prefixes;
2933   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2934   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2935   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2936   int num_ignore_tokens = artwork_info->num_ignore_tokens;
2937   SetupFileHash *setup_file_hash, *valid_file_hash;
2938   SetupFileHash *extra_file_hash, *empty_file_hash;
2939   char *known_token_value = KNOWN_TOKEN_VALUE;
2940   int i, j, k, l;
2941
2942   if (filename == NULL)
2943     return;
2944
2945 #if 0
2946   printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2947 #endif
2948
2949   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2950     return;
2951
2952   /* separate valid (defined) from empty (undefined) config token values */
2953   valid_file_hash = newSetupFileHash();
2954   empty_file_hash = newSetupFileHash();
2955   BEGIN_HASH_ITERATION(setup_file_hash, itr)
2956   {
2957     char *value = HASH_ITERATION_VALUE(itr);
2958
2959     setHashEntry(*value ? valid_file_hash : empty_file_hash,
2960                  HASH_ITERATION_TOKEN(itr), value);
2961   }
2962   END_HASH_ITERATION(setup_file_hash, itr)
2963
2964   /* at this point, we do not need the setup file hash anymore -- free it */
2965   freeSetupFileHash(setup_file_hash);
2966
2967   /* map deprecated to current tokens (using prefix match and replace) */
2968   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2969   {
2970     char *token = HASH_ITERATION_TOKEN(itr);
2971     char *mapped_token = get_mapped_token(token);
2972
2973     if (mapped_token != NULL)
2974     {
2975       char *value = HASH_ITERATION_VALUE(itr);
2976
2977       /* add mapped token */
2978       setHashEntry(valid_file_hash, mapped_token, value);
2979
2980       /* ignore old token (by setting it to "known" keyword) */
2981       setHashEntry(valid_file_hash, token, known_token_value);
2982
2983       free(mapped_token);
2984     }
2985   }
2986   END_HASH_ITERATION(valid_file_hash, itr)
2987
2988   /* read parameters for all known config file tokens */
2989   for (i = 0; i < num_file_list_entries; i++)
2990     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2991
2992   /* set all tokens that can be ignored here to "known" keyword */
2993   for (i = 0; i < num_ignore_tokens; i++)
2994     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2995
2996   /* copy all unknown config file tokens to extra config hash */
2997   extra_file_hash = newSetupFileHash();
2998   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2999   {
3000     char *value = HASH_ITERATION_VALUE(itr);
3001
3002     if (!strEqual(value, known_token_value))
3003       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
3004   }
3005   END_HASH_ITERATION(valid_file_hash, itr)
3006
3007   /* at this point, we do not need the valid file hash anymore -- free it */
3008   freeSetupFileHash(valid_file_hash);
3009
3010   /* now try to determine valid, dynamically defined config tokens */
3011
3012   BEGIN_HASH_ITERATION(extra_file_hash, itr)
3013   {
3014     struct FileInfo **dynamic_file_list =
3015       &artwork_info->dynamic_file_list;
3016     int *num_dynamic_file_list_entries =
3017       &artwork_info->num_dynamic_file_list_entries;
3018     struct PropertyMapping **property_mapping =
3019       &artwork_info->property_mapping;
3020     int *num_property_mapping_entries =
3021       &artwork_info->num_property_mapping_entries;
3022     int current_summarized_file_list_entry =
3023       artwork_info->num_file_list_entries +
3024       artwork_info->num_dynamic_file_list_entries;
3025     char *token = HASH_ITERATION_TOKEN(itr);
3026     int len_token = strlen(token);
3027     int start_pos;
3028     boolean base_prefix_found = FALSE;
3029     boolean parameter_suffix_found = FALSE;
3030
3031 #if 0
3032     printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
3033 #endif
3034
3035     /* skip all parameter definitions (handled by read_token_parameters()) */
3036     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
3037     {
3038       int len_suffix = strlen(suffix_list[i].token);
3039
3040       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
3041         parameter_suffix_found = TRUE;
3042     }
3043
3044     if (parameter_suffix_found)
3045       continue;
3046
3047     /* ---------- step 0: search for matching base prefix ---------- */
3048
3049     start_pos = 0;
3050     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
3051     {
3052       char *base_prefix = base_prefixes[i];
3053       int len_base_prefix = strlen(base_prefix);
3054       boolean ext1_suffix_found = FALSE;
3055       boolean ext2_suffix_found = FALSE;
3056       boolean ext3_suffix_found = FALSE;
3057       boolean exact_match = FALSE;
3058       int base_index = -1;
3059       int ext1_index = -1;
3060       int ext2_index = -1;
3061       int ext3_index = -1;
3062
3063       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
3064
3065       if (!base_prefix_found)
3066         continue;
3067
3068       base_index = i;
3069
3070 #if 0
3071       if (IS_PARENT_PROCESS())
3072         printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
3073 #endif
3074
3075       if (start_pos + len_base_prefix == len_token)     /* exact match */
3076       {
3077         exact_match = TRUE;
3078
3079 #if 0
3080         if (IS_PARENT_PROCESS())
3081           printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
3082 #endif
3083
3084         add_dynamic_file_list_entry(dynamic_file_list,
3085                                     num_dynamic_file_list_entries,
3086                                     extra_file_hash,
3087                                     suffix_list,
3088                                     num_suffix_list_entries,
3089                                     token);
3090         add_property_mapping(property_mapping,
3091                              num_property_mapping_entries,
3092                              base_index, -1, -1, -1,
3093                              current_summarized_file_list_entry);
3094         continue;
3095       }
3096
3097 #if 0
3098       if (IS_PARENT_PROCESS())
3099         printf("---> examining token '%s': search 1st suffix ...\n", token);
3100 #endif
3101
3102       /* ---------- step 1: search for matching first suffix ---------- */
3103
3104       start_pos += len_base_prefix;
3105       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
3106       {
3107         char *ext1_suffix = ext1_suffixes[j];
3108         int len_ext1_suffix = strlen(ext1_suffix);
3109
3110         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
3111
3112         if (!ext1_suffix_found)
3113           continue;
3114
3115         ext1_index = j;
3116
3117 #if 0
3118         if (IS_PARENT_PROCESS())
3119           printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
3120 #endif
3121
3122         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
3123         {
3124           exact_match = TRUE;
3125
3126 #if 0
3127         if (IS_PARENT_PROCESS())
3128           printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
3129 #endif
3130
3131           add_dynamic_file_list_entry(dynamic_file_list,
3132                                       num_dynamic_file_list_entries,
3133                                       extra_file_hash,
3134                                       suffix_list,
3135                                       num_suffix_list_entries,
3136                                       token);
3137           add_property_mapping(property_mapping,
3138                                num_property_mapping_entries,
3139                                base_index, ext1_index, -1, -1,
3140                                current_summarized_file_list_entry);
3141           continue;
3142         }
3143
3144         start_pos += len_ext1_suffix;
3145       }
3146
3147       if (exact_match)
3148         break;
3149
3150 #if 0
3151       if (IS_PARENT_PROCESS())
3152         printf("---> examining token '%s': search 2nd suffix ...\n", token);
3153 #endif
3154
3155       /* ---------- step 2: search for matching second suffix ---------- */
3156
3157       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
3158       {
3159         char *ext2_suffix = ext2_suffixes[k];
3160         int len_ext2_suffix = strlen(ext2_suffix);
3161
3162         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
3163
3164         if (!ext2_suffix_found)
3165           continue;
3166
3167         ext2_index = k;
3168
3169 #if 0
3170         if (IS_PARENT_PROCESS())
3171           printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
3172 #endif
3173
3174         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
3175         {
3176           exact_match = TRUE;
3177
3178 #if 0
3179           if (IS_PARENT_PROCESS())
3180             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
3181 #endif
3182
3183           add_dynamic_file_list_entry(dynamic_file_list,
3184                                       num_dynamic_file_list_entries,
3185                                       extra_file_hash,
3186                                       suffix_list,
3187                                       num_suffix_list_entries,
3188                                       token);
3189           add_property_mapping(property_mapping,
3190                                num_property_mapping_entries,
3191                                base_index, ext1_index, ext2_index, -1,
3192                                current_summarized_file_list_entry);
3193           continue;
3194         }
3195
3196         start_pos += len_ext2_suffix;
3197       }
3198
3199       if (exact_match)
3200         break;
3201
3202 #if 0
3203       if (IS_PARENT_PROCESS())
3204         printf("---> examining token '%s': search 3rd suffix ...\n",token);
3205 #endif
3206
3207       /* ---------- step 3: search for matching third suffix ---------- */
3208
3209       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
3210       {
3211         char *ext3_suffix = ext3_suffixes[l];
3212         int len_ext3_suffix = strlen(ext3_suffix);
3213
3214         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
3215
3216         if (!ext3_suffix_found)
3217           continue;
3218
3219         ext3_index = l;
3220
3221 #if 0
3222         if (IS_PARENT_PROCESS())
3223           printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
3224 #endif
3225
3226         if (start_pos + len_ext3_suffix == len_token) /* exact match */
3227         {
3228           exact_match = TRUE;
3229
3230 #if 0
3231           if (IS_PARENT_PROCESS())
3232             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
3233 #endif
3234
3235           add_dynamic_file_list_entry(dynamic_file_list,
3236                                       num_dynamic_file_list_entries,
3237                                       extra_file_hash,
3238                                       suffix_list,
3239                                       num_suffix_list_entries,
3240                                       token);
3241           add_property_mapping(property_mapping,
3242                                num_property_mapping_entries,
3243                                base_index, ext1_index, ext2_index, ext3_index,
3244                                current_summarized_file_list_entry);
3245           continue;
3246         }
3247       }
3248     }
3249   }
3250   END_HASH_ITERATION(extra_file_hash, itr)
3251
3252   if (artwork_info->num_dynamic_file_list_entries > 0)
3253   {
3254     artwork_info->dynamic_artwork_list =
3255       checked_calloc(artwork_info->num_dynamic_file_list_entries *
3256                      artwork_info->sizeof_artwork_list_entry);
3257   }
3258
3259   if (options.verbose && IS_PARENT_PROCESS())
3260   {
3261     SetupFileList *setup_file_list, *list;
3262     boolean dynamic_tokens_found = FALSE;
3263     boolean unknown_tokens_found = FALSE;
3264     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3265
3266     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3267       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3268
3269     BEGIN_HASH_ITERATION(extra_file_hash, itr)
3270     {
3271       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3272         dynamic_tokens_found = TRUE;
3273       else
3274         unknown_tokens_found = TRUE;
3275     }
3276     END_HASH_ITERATION(extra_file_hash, itr)
3277
3278     if (options.debug && dynamic_tokens_found)
3279     {
3280       Error(ERR_INFO_LINE, "-");
3281       Error(ERR_INFO, "dynamic token(s) found in config file:");
3282       Error(ERR_INFO, "- config file: '%s'", filename);
3283
3284       for (list = setup_file_list; list != NULL; list = list->next)
3285       {
3286         char *value = getHashEntry(extra_file_hash, list->token);
3287
3288         if (value != NULL && strEqual(value, known_token_value))
3289           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3290       }
3291
3292       Error(ERR_INFO_LINE, "-");
3293     }
3294
3295     if (unknown_tokens_found)
3296     {
3297       Error(ERR_INFO_LINE, "-");
3298       Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3299       Error(ERR_INFO, "- config file: '%s'", filename);
3300
3301       for (list = setup_file_list; list != NULL; list = list->next)
3302       {
3303         char *value = getHashEntry(extra_file_hash, list->token);
3304
3305         if (value != NULL && !strEqual(value, known_token_value))
3306           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3307       }
3308
3309       Error(ERR_INFO_LINE, "-");
3310     }
3311
3312     if (undefined_values_found)
3313     {
3314       Error(ERR_INFO_LINE, "-");
3315       Error(ERR_INFO, "warning: undefined values found in config file:");
3316       Error(ERR_INFO, "- config file: '%s'", filename);
3317
3318       for (list = setup_file_list; list != NULL; list = list->next)
3319       {
3320         char *value = getHashEntry(empty_file_hash, list->token);
3321
3322         if (value != NULL)
3323           Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3324       }
3325
3326       Error(ERR_INFO_LINE, "-");
3327     }
3328
3329     freeSetupFileList(setup_file_list);
3330   }
3331
3332   freeSetupFileHash(extra_file_hash);
3333   freeSetupFileHash(empty_file_hash);
3334
3335 #if 0
3336   for (i = 0; i < num_file_list_entries; i++)
3337   {
3338     printf("'%s' ", file_list[i].token);
3339     if (file_list[i].filename)
3340       printf("-> '%s'\n", file_list[i].filename);
3341     else
3342       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3343   }
3344 #endif
3345 }
3346
3347 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3348 {
3349   struct FileInfo *file_list = artwork_info->file_list;
3350   int num_file_list_entries = artwork_info->num_file_list_entries;
3351   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3352   char *filename_base = UNDEFINED_FILENAME, *filename_local;
3353   int i, j;
3354
3355   DrawInitText("Loading artwork config", 120, FC_GREEN);
3356   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3357
3358   /* always start with reliable default values */
3359   for (i = 0; i < num_file_list_entries; i++)
3360   {
3361     setString(&file_list[i].filename, file_list[i].default_filename);
3362
3363     for (j = 0; j < num_suffix_list_entries; j++)
3364       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3365
3366     file_list[i].redefined = FALSE;
3367     file_list[i].fallback_to_default = FALSE;
3368   }
3369
3370   /* free previous dynamic artwork file array */
3371   if (artwork_info->dynamic_file_list != NULL)
3372   {
3373     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3374     {
3375       free(artwork_info->dynamic_file_list[i].token);
3376       free(artwork_info->dynamic_file_list[i].filename);
3377       free(artwork_info->dynamic_file_list[i].parameter);
3378     }
3379
3380     free(artwork_info->dynamic_file_list);
3381     artwork_info->dynamic_file_list = NULL;
3382
3383     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3384                           &artwork_info->num_dynamic_file_list_entries);
3385   }
3386
3387   /* free previous property mapping */
3388   if (artwork_info->property_mapping != NULL)
3389   {
3390     free(artwork_info->property_mapping);
3391
3392     artwork_info->property_mapping = NULL;
3393     artwork_info->num_property_mapping_entries = 0;
3394   }
3395
3396 #if 1
3397   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3398 #else
3399   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3400 #endif
3401   {
3402     /* first look for special artwork configured in level series config */
3403     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3404
3405 #if 0
3406     printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3407            leveldir_current->graphics_set,
3408            leveldir_current->graphics_path);
3409 #endif
3410
3411     if (fileExists(filename_base))
3412       LoadArtworkConfigFromFilename(artwork_info, filename_base);
3413   }
3414
3415   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3416
3417   if (filename_local != NULL && !strEqual(filename_base, filename_local))
3418     LoadArtworkConfigFromFilename(artwork_info, filename_local);
3419 }
3420
3421 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3422                                    struct ListNodeInfo **listnode)
3423 {
3424   if (*listnode)
3425   {
3426     char *filename = (*listnode)->source_filename;
3427
3428     if (--(*listnode)->num_references <= 0)
3429       deleteNodeFromList(&artwork_info->content_list, filename,
3430                          artwork_info->free_artwork);
3431
3432     *listnode = NULL;
3433   }
3434 }
3435
3436 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3437                                     struct ListNodeInfo **listnode,
3438                                     struct FileInfo *file_list_entry)
3439 {
3440   char *init_text[] =
3441   {
3442     "Loading graphics",
3443     "Loading sounds",
3444     "Loading music"
3445   };
3446
3447   ListNode *node;
3448   char *basename = file_list_entry->filename;
3449   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3450
3451   if (filename == NULL)
3452   {
3453     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3454
3455     basename = file_list_entry->default_filename;
3456
3457     /* fail for cloned default artwork that has no default filename defined */
3458     if (file_list_entry->default_is_cloned &&
3459         strEqual(basename, UNDEFINED_FILENAME))
3460     {
3461       int error_mode = ERR_WARN;
3462
3463       /* we can get away without sounds and music, but not without graphics */
3464       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3465         error_mode = ERR_EXIT;
3466
3467       Error(error_mode, "token '%s' was cloned and has no default filename",
3468             file_list_entry->token);
3469
3470       return;
3471     }
3472
3473     /* dynamic artwork has no default filename / skip empty default artwork */
3474     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3475       return;
3476
3477     file_list_entry->fallback_to_default = TRUE;
3478
3479     Error(ERR_WARN, "trying default artwork file '%s'", basename);
3480
3481     filename = getCustomArtworkFilename(basename, artwork_info->type);
3482
3483     if (filename == NULL)
3484     {
3485       int error_mode = ERR_WARN;
3486
3487       /* we can get away without sounds and music, but not without graphics */
3488       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3489         error_mode = ERR_EXIT;
3490
3491       Error(error_mode, "cannot find default artwork file '%s'", basename);
3492
3493       return;
3494     }
3495   }
3496
3497   /* check if the old and the new artwork file are the same */
3498   if (*listnode && strEqual((*listnode)->source_filename, filename))
3499   {
3500     /* The old and new artwork are the same (have the same filename and path).
3501        This usually means that this artwork does not exist in this artwork set
3502        and a fallback to the existing artwork is done. */
3503
3504 #if 0
3505     printf("[artwork '%s' already exists (same list entry)]\n", filename);
3506 #endif
3507
3508     return;
3509   }
3510
3511   /* delete existing artwork file entry */
3512   deleteArtworkListEntry(artwork_info, listnode);
3513
3514   /* check if the new artwork file already exists in the list of artworks */
3515   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3516   {
3517 #if 0
3518       printf("[artwork '%s' already exists (other list entry)]\n", filename);
3519 #endif
3520
3521       *listnode = (struct ListNodeInfo *)node->content;
3522       (*listnode)->num_references++;
3523
3524       return;
3525   }
3526
3527   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3528   DrawInitText(basename, 150, FC_YELLOW);
3529
3530   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3531   {
3532 #if 0
3533       printf("[adding new artwork '%s']\n", filename);
3534 #endif
3535
3536     (*listnode)->num_references = 1;
3537     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3538                   *listnode);
3539   }
3540   else
3541   {
3542     int error_mode = ERR_WARN;
3543
3544     /* we can get away without sounds and music, but not without graphics */
3545     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3546       error_mode = ERR_EXIT;
3547
3548     Error(error_mode, "cannot load artwork file '%s'", basename);
3549
3550     return;
3551   }
3552 }
3553
3554 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3555                               struct ListNodeInfo **listnode,
3556                               struct FileInfo *file_list_entry)
3557 {
3558 #if 0
3559   printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3560 #endif
3561
3562   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3563   {
3564     deleteArtworkListEntry(artwork_info, listnode);
3565
3566     return;
3567   }
3568
3569   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3570 }
3571
3572 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3573 {
3574   struct FileInfo *file_list = artwork_info->file_list;
3575   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3576   int num_file_list_entries = artwork_info->num_file_list_entries;
3577   int num_dynamic_file_list_entries =
3578     artwork_info->num_dynamic_file_list_entries;
3579   int i;
3580
3581   print_timestamp_init("ReloadCustomArtworkList");
3582
3583   for (i = 0; i < num_file_list_entries; i++)
3584     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3585                       &file_list[i]);
3586
3587   for (i = 0; i < num_dynamic_file_list_entries; i++)
3588     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3589                       &dynamic_file_list[i]);
3590
3591   print_timestamp_done("ReloadCustomArtworkList");
3592
3593 #if 0
3594   dumpList(artwork_info->content_list);
3595 #endif
3596 }
3597
3598 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3599                                   struct ListNodeInfo ***list,
3600                                   int *num_list_entries)
3601 {
3602   int i;
3603
3604   if (*list == NULL)
3605     return;
3606
3607   for (i = 0; i < *num_list_entries; i++)
3608     deleteArtworkListEntry(artwork_info, &(*list)[i]);
3609   free(*list);
3610
3611   *list = NULL;
3612   *num_list_entries = 0;
3613 }
3614
3615 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3616 {
3617   if (artwork_info == NULL)
3618     return;
3619
3620   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3621                         &artwork_info->num_file_list_entries);
3622
3623   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3624                         &artwork_info->num_dynamic_file_list_entries);
3625 }
3626
3627
3628 /* ------------------------------------------------------------------------- */
3629 /* functions only needed for non-Unix (non-command-line) systems             */
3630 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
3631 /* (now also added for Windows, to create files in user data directory)      */
3632 /* ------------------------------------------------------------------------- */
3633
3634 char *getErrorFilename(char *basename)
3635 {
3636   return getPath2(getUserGameDataDir(), basename);
3637 }
3638
3639 void openErrorFile()
3640 {
3641   InitUserDataDirectory();
3642
3643   if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3644   {
3645     program.error_file = stderr;
3646
3647     Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3648           program.error_filename, strerror(errno));
3649   }
3650 }
3651
3652 void closeErrorFile()
3653 {
3654   if (program.error_file != stderr)     /* do not close stream 'stderr' */
3655     fclose(program.error_file);
3656 }
3657
3658 void dumpErrorFile()
3659 {
3660   FILE *error_file = fopen(program.error_filename, MODE_READ);
3661
3662   if (error_file != NULL)
3663   {
3664     while (!feof(error_file))
3665       fputc(fgetc(error_file), stderr);
3666
3667     fclose(error_file);
3668   }
3669 }
3670
3671 void NotifyUserAboutErrorFile()
3672 {
3673 #if defined(PLATFORM_WIN32)
3674   char *title_text = getStringCat2(program.program_title, " Error Message");
3675   char *error_text = getStringCat2("The program was aborted due to an error; "
3676                                    "for details, see the following error file:"
3677                                    STRING_NEWLINE, program.error_filename);
3678
3679   MessageBox(NULL, error_text, title_text, MB_OK);
3680 #endif
3681 }
3682
3683
3684 /* ------------------------------------------------------------------------- */
3685 /* the following is only for debugging purpose and normally not used         */
3686 /* ------------------------------------------------------------------------- */
3687
3688 #if DEBUG
3689
3690 #define DEBUG_PRINT_INIT_TIMESTAMPS             TRUE
3691 #define DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH       10
3692
3693 #define DEBUG_NUM_TIMESTAMPS                    10
3694 #define DEBUG_TIME_IN_MICROSECONDS              0
3695
3696 #if DEBUG_TIME_IN_MICROSECONDS
3697 static double Counter_Microseconds()
3698 {
3699   static struct timeval base_time = { 0, 0 };
3700   struct timeval current_time;
3701   double counter;
3702
3703   gettimeofday(&current_time, NULL);
3704
3705   /* reset base time in case of wrap-around */
3706   if (current_time.tv_sec < base_time.tv_sec)
3707     base_time = current_time;
3708
3709   counter =
3710     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
3711     ((double)(current_time.tv_usec - base_time.tv_usec));
3712
3713   return counter;               /* return microseconds since last init */
3714 }
3715 #endif
3716
3717 char *debug_print_timestamp_get_padding(int padding_size)
3718 {
3719   static char *padding = NULL;
3720   int max_padding_size = 100;
3721
3722   if (padding == NULL)
3723   {
3724     padding = checked_calloc(max_padding_size + 1);
3725     memset(padding, ' ', max_padding_size);
3726   }
3727
3728   return &padding[MAX(0, max_padding_size - padding_size)];
3729 }
3730
3731 void debug_print_timestamp(int counter_nr, char *message)
3732 {
3733   int indent_size = 8;
3734   int padding_size = 40;
3735   float timestamp_interval;
3736
3737   if (counter_nr < 0)
3738     Error(ERR_EXIT, "debugging: invalid negative counter");
3739   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3740     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3741
3742 #if DEBUG_TIME_IN_MICROSECONDS
3743   static double counter[DEBUG_NUM_TIMESTAMPS][2];
3744   char *unit = "ms";
3745
3746   counter[counter_nr][0] = Counter_Microseconds();
3747 #else
3748   static int counter[DEBUG_NUM_TIMESTAMPS][2];
3749   char *unit = "s";
3750
3751   counter[counter_nr][0] = Counter();
3752 #endif
3753
3754   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3755   counter[counter_nr][1] = counter[counter_nr][0];
3756
3757   if (message)
3758 #if 1
3759     Error(ERR_DEBUG, "%s%s%s %.3f %s",
3760 #else
3761     printf("%s%s%s %.3f %s\n",
3762 #endif
3763            debug_print_timestamp_get_padding(counter_nr * indent_size),
3764            message,
3765            debug_print_timestamp_get_padding(padding_size - strlen(message)),
3766            timestamp_interval / 1000,
3767            unit);
3768 }
3769
3770 void debug_print_parent_only(char *format, ...)
3771 {
3772   if (!IS_PARENT_PROCESS())
3773     return;
3774
3775   if (format)
3776   {
3777     va_list ap;
3778
3779     va_start(ap, format);
3780     vprintf(format, ap);
3781     va_end(ap);
3782
3783     printf("\n");
3784   }
3785 }
3786
3787 #endif  /* DEBUG */
3788
3789 void print_timestamp_ext(char *message, char *mode)
3790 {
3791 #if DEBUG_PRINT_INIT_TIMESTAMPS
3792   static char *debug_message = NULL;
3793   static char *last_message = NULL;
3794   static int counter_nr = 0;
3795   int max_depth = DEBUG_PRINT_INIT_TIMESTAMPS_DEPTH;
3796
3797   checked_free(debug_message);
3798   debug_message = getStringCat3(mode, " ", message);
3799
3800   if (strEqual(mode, "INIT"))
3801   {
3802     debug_print_timestamp(counter_nr, NULL);
3803
3804     if (counter_nr + 1 < max_depth)
3805       debug_print_timestamp(counter_nr, debug_message);
3806
3807     counter_nr++;
3808
3809     debug_print_timestamp(counter_nr, NULL);
3810   }
3811   else if (strEqual(mode, "DONE"))
3812   {
3813     counter_nr--;
3814
3815     if (counter_nr + 1 < max_depth ||
3816         (counter_nr == 0 && max_depth == 1))
3817     {
3818       last_message = message;
3819
3820       if (counter_nr == 0 && max_depth == 1)
3821       {
3822         checked_free(debug_message);
3823         debug_message = getStringCat3("TIME", " ", message);
3824       }
3825
3826       debug_print_timestamp(counter_nr, debug_message);
3827     }
3828   }
3829   else if (!strEqual(mode, "TIME") ||
3830            !strEqual(message, last_message))
3831   {
3832     if (counter_nr < max_depth)
3833       debug_print_timestamp(counter_nr, debug_message);
3834   }
3835 #endif
3836 }
3837
3838 void print_timestamp_init(char *message)
3839 {
3840   print_timestamp_ext(message, "INIT");
3841 }
3842
3843 void print_timestamp_time(char *message)
3844 {
3845   print_timestamp_ext(message, "TIME");
3846 }
3847
3848 void print_timestamp_done(char *message)
3849 {
3850   print_timestamp_ext(message, "DONE");
3851 }