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)
 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_WARN ? ANDROID_LOG_WARN :
1051                       mode & ERR_EXIT ? ANDROID_LOG_FATAL : ANDROID_LOG_INFO);
1052 #endif
1053
1054 #if 1
1055   /* display warnings only when running in verbose mode */
1056   if (mode & ERR_WARN && !options.verbose)
1057     return;
1058 #endif
1059
1060   if (mode == ERR_INFO_LINE)
1061   {
1062     if (!last_line_was_separator)
1063       fprintf_line(program.error_file, format, 79);
1064
1065     last_line_was_separator = TRUE;
1066
1067     return;
1068   }
1069
1070   last_line_was_separator = FALSE;
1071
1072   if (mode & ERR_SOUND_SERVER)
1073     process_name = " sound server";
1074   else if (mode & ERR_NETWORK_SERVER)
1075     process_name = " network server";
1076   else if (mode & ERR_NETWORK_CLIENT)
1077     process_name = " network client **";
1078
1079   if (format)
1080   {
1081     va_list ap;
1082
1083     fprintf(program.error_file, "%s%s: ", program.command_basename,
1084             process_name);
1085
1086     if (mode & ERR_WARN)
1087       fprintf(program.error_file, "warning: ");
1088
1089     va_start(ap, format);
1090     vfprintf_newline(program.error_file, format, ap);
1091     va_end(ap);
1092
1093     if ((mode & ERR_EXIT) && !(mode & ERR_FROM_SERVER))
1094     {
1095       va_start(ap, format);
1096       program.exit_message_function(format, ap);
1097       va_end(ap);
1098     }
1099   }
1100
1101   if (mode & ERR_HELP)
1102     fprintf_newline(program.error_file,
1103                     "%s: Try option '--help' for more information.",
1104                     program.command_basename);
1105
1106   if (mode & ERR_EXIT)
1107     fprintf_newline(program.error_file, "%s%s: aborting",
1108                     program.command_basename, process_name);
1109
1110   if (mode & ERR_EXIT)
1111   {
1112     if (mode & ERR_FROM_SERVER)
1113       exit(1);                          /* child process: normal exit */
1114     else
1115       program.exit_function(1);         /* main process: clean up stuff */
1116   }
1117 }
1118
1119
1120 /* ------------------------------------------------------------------------- */
1121 /* checked memory allocation and freeing functions                           */
1122 /* ------------------------------------------------------------------------- */
1123
1124 void *checked_malloc(unsigned int size)
1125 {
1126   void *ptr;
1127
1128   ptr = malloc(size);
1129
1130   if (ptr == NULL)
1131     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1132
1133   return ptr;
1134 }
1135
1136 void *checked_calloc(unsigned int size)
1137 {
1138   void *ptr;
1139
1140   ptr = calloc(1, size);
1141
1142   if (ptr == NULL)
1143     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1144
1145   return ptr;
1146 }
1147
1148 void *checked_realloc(void *ptr, unsigned int size)
1149 {
1150   ptr = realloc(ptr, size);
1151
1152   if (ptr == NULL)
1153     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
1154
1155   return ptr;
1156 }
1157
1158 void checked_free(void *ptr)
1159 {
1160   if (ptr != NULL)      /* this check should be done by free() anyway */
1161     free(ptr);
1162 }
1163
1164 void clear_mem(void *ptr, unsigned int size)
1165 {
1166 #if defined(PLATFORM_WIN32)
1167   /* for unknown reason, memset() sometimes crashes when compiled with MinGW */
1168   char *cptr = (char *)ptr;
1169
1170   while (size--)
1171     *cptr++ = 0;
1172 #else
1173   memset(ptr, 0, size);
1174 #endif
1175 }
1176
1177
1178 /* ------------------------------------------------------------------------- */
1179 /* various helper functions                                                  */
1180 /* ------------------------------------------------------------------------- */
1181
1182 inline void swap_numbers(int *i1, int *i2)
1183 {
1184   int help = *i1;
1185
1186   *i1 = *i2;
1187   *i2 = help;
1188 }
1189
1190 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1191 {
1192   int help_x = *x1;
1193   int help_y = *y1;
1194
1195   *x1 = *x2;
1196   *x2 = help_x;
1197
1198   *y1 = *y2;
1199   *y2 = help_y;
1200 }
1201
1202 /* the "put" variants of the following file access functions check for the file
1203    pointer being != NULL and return the number of bytes they have or would have
1204    written; this allows for chunk writing functions to first determine the size
1205    of the (not yet written) chunk, write the correct chunk size and finally
1206    write the chunk itself */
1207
1208 int getFile8BitInteger(FILE *file)
1209 {
1210   return fgetc(file);
1211 }
1212
1213 int putFile8BitInteger(FILE *file, int value)
1214 {
1215   if (file != NULL)
1216     fputc(value, file);
1217
1218   return 1;
1219 }
1220
1221 int getFile16BitInteger(FILE *file, int byte_order)
1222 {
1223   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1224     return ((fgetc(file) << 8) |
1225             (fgetc(file) << 0));
1226   else           /* BYTE_ORDER_LITTLE_ENDIAN */
1227     return ((fgetc(file) << 0) |
1228             (fgetc(file) << 8));
1229 }
1230
1231 int putFile16BitInteger(FILE *file, int value, int byte_order)
1232 {
1233   if (file != NULL)
1234   {
1235     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1236     {
1237       fputc((value >> 8) & 0xff, file);
1238       fputc((value >> 0) & 0xff, file);
1239     }
1240     else           /* BYTE_ORDER_LITTLE_ENDIAN */
1241     {
1242       fputc((value >> 0) & 0xff, file);
1243       fputc((value >> 8) & 0xff, file);
1244     }
1245   }
1246
1247   return 2;
1248 }
1249
1250 int getFile32BitInteger(FILE *file, int byte_order)
1251 {
1252   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1253     return ((fgetc(file) << 24) |
1254             (fgetc(file) << 16) |
1255             (fgetc(file) <<  8) |
1256             (fgetc(file) <<  0));
1257   else           /* BYTE_ORDER_LITTLE_ENDIAN */
1258     return ((fgetc(file) <<  0) |
1259             (fgetc(file) <<  8) |
1260             (fgetc(file) << 16) |
1261             (fgetc(file) << 24));
1262 }
1263
1264 int putFile32BitInteger(FILE *file, int value, int byte_order)
1265 {
1266   if (file != NULL)
1267   {
1268     if (byte_order == BYTE_ORDER_BIG_ENDIAN)
1269     {
1270       fputc((value >> 24) & 0xff, file);
1271       fputc((value >> 16) & 0xff, file);
1272       fputc((value >>  8) & 0xff, file);
1273       fputc((value >>  0) & 0xff, file);
1274     }
1275     else           /* BYTE_ORDER_LITTLE_ENDIAN */
1276     {
1277       fputc((value >>  0) & 0xff, file);
1278       fputc((value >>  8) & 0xff, file);
1279       fputc((value >> 16) & 0xff, file);
1280       fputc((value >> 24) & 0xff, file);
1281     }
1282   }
1283
1284   return 4;
1285 }
1286
1287 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
1288                      int byte_order)
1289 {
1290   const int chunk_name_length = 4;
1291
1292   /* read chunk name */
1293   if (fgets(chunk_name, chunk_name_length + 1, file) == NULL)
1294     return FALSE;
1295
1296   if (chunk_size != NULL)
1297   {
1298     /* read chunk size */
1299     *chunk_size = getFile32BitInteger(file, byte_order);
1300   }
1301
1302   return (feof(file) || ferror(file) ? FALSE : TRUE);
1303 }
1304
1305 int putFileChunk(FILE *file, char *chunk_name, int chunk_size,
1306                  int byte_order)
1307 {
1308   int num_bytes = 0;
1309
1310   /* write chunk name */
1311   if (file != NULL)
1312     fputs(chunk_name, file);
1313
1314   num_bytes += strlen(chunk_name);
1315
1316   if (chunk_size >= 0)
1317   {
1318     /* write chunk size */
1319     if (file != NULL)
1320       putFile32BitInteger(file, chunk_size, byte_order);
1321
1322     num_bytes += 4;
1323   }
1324
1325   return num_bytes;
1326 }
1327
1328 int getFileVersion(FILE *file)
1329 {
1330   int version_major = fgetc(file);
1331   int version_minor = fgetc(file);
1332   int version_patch = fgetc(file);
1333   int version_build = fgetc(file);
1334
1335   return VERSION_IDENT(version_major, version_minor, version_patch,
1336                        version_build);
1337 }
1338
1339 int putFileVersion(FILE *file, int version)
1340 {
1341   if (file != NULL)
1342   {
1343     int version_major = VERSION_MAJOR(version);
1344     int version_minor = VERSION_MINOR(version);
1345     int version_patch = VERSION_PATCH(version);
1346     int version_build = VERSION_BUILD(version);
1347
1348     fputc(version_major, file);
1349     fputc(version_minor, file);
1350     fputc(version_patch, file);
1351     fputc(version_build, file);
1352   }
1353
1354   return 4;
1355 }
1356
1357 void ReadBytesFromFile(FILE *file, byte *buffer, unsigned int bytes)
1358 {
1359   int i;
1360
1361   for(i = 0; i < bytes && !feof(file); i++)
1362     buffer[i] = fgetc(file);
1363 }
1364
1365 void WriteBytesToFile(FILE *file, byte *buffer, unsigned int bytes)
1366 {
1367   int i;
1368
1369   for(i = 0; i < bytes; i++)
1370     fputc(buffer[i], file);
1371 }
1372
1373 void ReadUnusedBytesFromFile(FILE *file, unsigned int bytes)
1374 {
1375   while (bytes-- && !feof(file))
1376     fgetc(file);
1377 }
1378
1379 void WriteUnusedBytesToFile(FILE *file, unsigned int bytes)
1380 {
1381   while (bytes--)
1382     fputc(0, file);
1383 }
1384
1385
1386 /* ------------------------------------------------------------------------- */
1387 /* functions to translate key identifiers between different format           */
1388 /* ------------------------------------------------------------------------- */
1389
1390 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
1391 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
1392 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
1393 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
1394
1395 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
1396 {
1397   static struct
1398   {
1399     Key key;
1400     char *x11name;
1401     char *name;
1402   } translate_key[] =
1403   {
1404     /* normal cursor keys */
1405     { KSYM_Left,        "XK_Left",              "cursor left" },
1406     { KSYM_Right,       "XK_Right",             "cursor right" },
1407     { KSYM_Up,          "XK_Up",                "cursor up" },
1408     { KSYM_Down,        "XK_Down",              "cursor down" },
1409
1410     /* keypad cursor keys */
1411 #ifdef KSYM_KP_Left
1412     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
1413     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
1414     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
1415     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
1416 #endif
1417
1418     /* other keypad keys */
1419 #ifdef KSYM_KP_Enter
1420     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
1421     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
1422     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
1423     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
1424     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
1425     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
1426 #endif
1427
1428     /* modifier keys */
1429     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
1430     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
1431     { KSYM_Control_L,   "XK_Control_L",         "left control" },
1432     { KSYM_Control_R,   "XK_Control_R",         "right control" },
1433     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
1434     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
1435     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
1436     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
1437 #if !defined(TARGET_SDL2)
1438     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
1439     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
1440 #endif
1441     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
1442     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
1443
1444     /* some special keys */
1445     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
1446     { KSYM_Delete,      "XK_Delete",            "delete" },
1447     { KSYM_Insert,      "XK_Insert",            "insert" },
1448     { KSYM_Tab,         "XK_Tab",               "tab" },
1449     { KSYM_Home,        "XK_Home",              "home" },
1450     { KSYM_End,         "XK_End",               "end" },
1451     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
1452     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
1453     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
1454
1455     /* ASCII 0x20 to 0x40 keys (except numbers) */
1456     { KSYM_space,       "XK_space",             "space" },
1457     { KSYM_exclam,      "XK_exclam",            "!" },
1458     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
1459     { KSYM_numbersign,  "XK_numbersign",        "#" },
1460     { KSYM_dollar,      "XK_dollar",            "$" },
1461     { KSYM_percent,     "XK_percent",           "%" },
1462     { KSYM_ampersand,   "XK_ampersand",         "&" },
1463     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
1464     { KSYM_parenleft,   "XK_parenleft",         "(" },
1465     { KSYM_parenright,  "XK_parenright",        ")" },
1466     { KSYM_asterisk,    "XK_asterisk",          "*" },
1467     { KSYM_plus,        "XK_plus",              "+" },
1468     { KSYM_comma,       "XK_comma",             "," },
1469     { KSYM_minus,       "XK_minus",             "-" },
1470     { KSYM_period,      "XK_period",            "." },
1471     { KSYM_slash,       "XK_slash",             "/" },
1472     { KSYM_colon,       "XK_colon",             ":" },
1473     { KSYM_semicolon,   "XK_semicolon",         ";" },
1474     { KSYM_less,        "XK_less",              "<" },
1475     { KSYM_equal,       "XK_equal",             "=" },
1476     { KSYM_greater,     "XK_greater",           ">" },
1477     { KSYM_question,    "XK_question",          "?" },
1478     { KSYM_at,          "XK_at",                "@" },
1479
1480     /* more ASCII keys */
1481     { KSYM_bracketleft, "XK_bracketleft",       "[" },
1482     { KSYM_backslash,   "XK_backslash",         "\\" },
1483     { KSYM_bracketright,"XK_bracketright",      "]" },
1484     { KSYM_asciicircum, "XK_asciicircum",       "^" },
1485     { KSYM_underscore,  "XK_underscore",        "_" },
1486     { KSYM_grave,       "XK_grave",             "grave" },
1487     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
1488     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
1489     { KSYM_bar,         "XK_bar",               "bar" },
1490     { KSYM_braceright,  "XK_braceright",        "brace right" },
1491     { KSYM_asciitilde,  "XK_asciitilde",        "~" },
1492
1493 #if !defined(TARGET_SDL2)
1494     /* special (non-ASCII) keys */
1495     { KSYM_degree,      "XK_degree",            "°" },
1496     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
1497     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
1498     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
1499     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
1500     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
1501     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
1502     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1503 #endif
1504
1505     /* end-of-array identifier */
1506     { 0,                NULL,                   NULL }
1507   };
1508
1509   int i;
1510
1511   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1512   {
1513     static char name_buffer[30];
1514     Key key = *keysym;
1515
1516     if (key >= KSYM_A && key <= KSYM_Z)
1517       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1518     else if (key >= KSYM_a && key <= KSYM_z)
1519       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1520     else if (key >= KSYM_0 && key <= KSYM_9)
1521       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1522     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1523       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1524     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1525       sprintf(name_buffer, "F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1526     else if (key == KSYM_UNDEFINED)
1527       strcpy(name_buffer, "(undefined)");
1528     else
1529     {
1530       i = 0;
1531
1532       do
1533       {
1534         if (key == translate_key[i].key)
1535         {
1536           strcpy(name_buffer, translate_key[i].name);
1537           break;
1538         }
1539       }
1540       while (translate_key[++i].name);
1541
1542       if (!translate_key[i].name)
1543         strcpy(name_buffer, "(unknown)");
1544     }
1545
1546     *name = name_buffer;
1547   }
1548   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1549   {
1550     static char name_buffer[30];
1551     Key key = *keysym;
1552
1553     if (key >= KSYM_A && key <= KSYM_Z)
1554       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1555     else if (key >= KSYM_a && key <= KSYM_z)
1556       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1557     else if (key >= KSYM_0 && key <= KSYM_9)
1558       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1559     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1560       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1561     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1562       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1563     else if (key == KSYM_UNDEFINED)
1564       strcpy(name_buffer, "[undefined]");
1565     else
1566     {
1567       i = 0;
1568
1569       do
1570       {
1571         if (key == translate_key[i].key)
1572         {
1573           strcpy(name_buffer, translate_key[i].x11name);
1574           break;
1575         }
1576       }
1577       while (translate_key[++i].x11name);
1578
1579       if (!translate_key[i].x11name)
1580         sprintf(name_buffer, "0x%04x", (unsigned int)key);
1581     }
1582
1583     *x11name = name_buffer;
1584   }
1585   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1586   {
1587     Key key = KSYM_UNDEFINED;
1588
1589     i = 0;
1590     do
1591     {
1592       if (strEqual(translate_key[i].name, *name))
1593       {
1594         key = translate_key[i].key;
1595         break;
1596       }
1597     }
1598     while (translate_key[++i].x11name);
1599
1600     if (key == KSYM_UNDEFINED)
1601       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1602
1603     *keysym = key;
1604   }
1605   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1606   {
1607     Key key = KSYM_UNDEFINED;
1608     char *name_ptr = *x11name;
1609
1610     if (strPrefix(name_ptr, "XK_") && strlen(name_ptr) == 4)
1611     {
1612       char c = name_ptr[3];
1613
1614       if (c >= 'A' && c <= 'Z')
1615         key = KSYM_A + (Key)(c - 'A');
1616       else if (c >= 'a' && c <= 'z')
1617         key = KSYM_a + (Key)(c - 'a');
1618       else if (c >= '0' && c <= '9')
1619         key = KSYM_0 + (Key)(c - '0');
1620     }
1621     else if (strPrefix(name_ptr, "XK_KP_") && strlen(name_ptr) == 7)
1622     {
1623       char c = name_ptr[6];
1624
1625       if (c >= '0' && c <= '9')
1626         key = KSYM_KP_0 + (Key)(c - '0');
1627     }
1628     else if (strPrefix(name_ptr, "XK_F") && strlen(name_ptr) <= 6)
1629     {
1630       char c1 = name_ptr[4];
1631       char c2 = name_ptr[5];
1632       int d = 0;
1633
1634       if ((c1 >= '0' && c1 <= '9') &&
1635           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1636         d = atoi(&name_ptr[4]);
1637
1638       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1639         key = KSYM_F1 + (Key)(d - 1);
1640     }
1641     else if (strPrefix(name_ptr, "XK_"))
1642     {
1643       i = 0;
1644
1645       do
1646       {
1647         if (strEqual(name_ptr, translate_key[i].x11name))
1648         {
1649           key = translate_key[i].key;
1650           break;
1651         }
1652       }
1653       while (translate_key[++i].x11name);
1654     }
1655     else if (strPrefix(name_ptr, "0x"))
1656     {
1657       unsigned int value = 0;
1658
1659       name_ptr += 2;
1660
1661       while (name_ptr)
1662       {
1663         char c = *name_ptr++;
1664         int d = -1;
1665
1666         if (c >= '0' && c <= '9')
1667           d = (int)(c - '0');
1668         else if (c >= 'a' && c <= 'f')
1669           d = (int)(c - 'a' + 10);
1670         else if (c >= 'A' && c <= 'F')
1671           d = (int)(c - 'A' + 10);
1672
1673         if (d == -1)
1674         {
1675           value = -1;
1676           break;
1677         }
1678
1679         value = value * 16 + d;
1680       }
1681
1682       if (value != -1)
1683         key = (Key)value;
1684     }
1685
1686     *keysym = key;
1687   }
1688 }
1689
1690 char *getKeyNameFromKey(Key key)
1691 {
1692   char *name;
1693
1694   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1695   return name;
1696 }
1697
1698 char *getX11KeyNameFromKey(Key key)
1699 {
1700   char *x11name;
1701
1702   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1703   return x11name;
1704 }
1705
1706 Key getKeyFromKeyName(char *name)
1707 {
1708   Key key;
1709
1710   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1711   return key;
1712 }
1713
1714 Key getKeyFromX11KeyName(char *x11name)
1715 {
1716   Key key;
1717
1718   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1719   return key;
1720 }
1721
1722 char getCharFromKey(Key key)
1723 {
1724   char *keyname = getKeyNameFromKey(key);
1725   char c = 0;
1726
1727   if (strlen(keyname) == 1)
1728     c = keyname[0];
1729   else if (strEqual(keyname, "space"))
1730     c = ' ';
1731
1732   return c;
1733 }
1734
1735 char getValidConfigValueChar(char c)
1736 {
1737   if (c == '#' ||       /* used to mark comments */
1738       c == '\\')        /* used to mark continued lines */
1739     c = 0;
1740
1741   return c;
1742 }
1743
1744
1745 /* ------------------------------------------------------------------------- */
1746 /* functions to translate string identifiers to integer or boolean value     */
1747 /* ------------------------------------------------------------------------- */
1748
1749 int get_integer_from_string(char *s)
1750 {
1751   static char *number_text[][3] =
1752   {
1753     { "0",      "zero",         "null",         },
1754     { "1",      "one",          "first"         },
1755     { "2",      "two",          "second"        },
1756     { "3",      "three",        "third"         },
1757     { "4",      "four",         "fourth"        },
1758     { "5",      "five",         "fifth"         },
1759     { "6",      "six",          "sixth"         },
1760     { "7",      "seven",        "seventh"       },
1761     { "8",      "eight",        "eighth"        },
1762     { "9",      "nine",         "ninth"         },
1763     { "10",     "ten",          "tenth"         },
1764     { "11",     "eleven",       "eleventh"      },
1765     { "12",     "twelve",       "twelfth"       },
1766
1767     { NULL,     NULL,           NULL            },
1768   };
1769
1770   int i, j;
1771   char *s_lower = getStringToLower(s);
1772   int result = -1;
1773
1774   for (i = 0; number_text[i][0] != NULL; i++)
1775     for (j = 0; j < 3; j++)
1776       if (strEqual(s_lower, number_text[i][j]))
1777         result = i;
1778
1779   if (result == -1)
1780   {
1781     if (strEqual(s_lower, "false") ||
1782         strEqual(s_lower, "no") ||
1783         strEqual(s_lower, "off"))
1784       result = 0;
1785     else if (strEqual(s_lower, "true") ||
1786              strEqual(s_lower, "yes") ||
1787              strEqual(s_lower, "on"))
1788       result = 1;
1789     else
1790       result = atoi(s);
1791   }
1792
1793   free(s_lower);
1794
1795   return result;
1796 }
1797
1798 boolean get_boolean_from_string(char *s)
1799 {
1800   char *s_lower = getStringToLower(s);
1801   boolean result = FALSE;
1802
1803   if (strEqual(s_lower, "true") ||
1804       strEqual(s_lower, "yes") ||
1805       strEqual(s_lower, "on") ||
1806       get_integer_from_string(s) == 1)
1807     result = TRUE;
1808
1809   free(s_lower);
1810
1811   return result;
1812 }
1813
1814 int get_switch3_from_string(char *s)
1815 {
1816   char *s_lower = getStringToLower(s);
1817   int result = FALSE;
1818
1819   if (strEqual(s_lower, "true") ||
1820       strEqual(s_lower, "yes") ||
1821       strEqual(s_lower, "on") ||
1822       get_integer_from_string(s) == 1)
1823     result = TRUE;
1824   else if (strEqual(s_lower, "auto"))
1825     result = AUTO;
1826
1827   free(s_lower);
1828
1829   return result;
1830 }
1831
1832
1833 /* ------------------------------------------------------------------------- */
1834 /* functions for generic lists                                               */
1835 /* ------------------------------------------------------------------------- */
1836
1837 ListNode *newListNode()
1838 {
1839   return checked_calloc(sizeof(ListNode));
1840 }
1841
1842 void addNodeToList(ListNode **node_first, char *key, void *content)
1843 {
1844   ListNode *node_new = newListNode();
1845
1846   node_new->key = getStringCopy(key);
1847   node_new->content = content;
1848   node_new->next = *node_first;
1849   *node_first = node_new;
1850 }
1851
1852 void deleteNodeFromList(ListNode **node_first, char *key,
1853                         void (*destructor_function)(void *))
1854 {
1855   if (node_first == NULL || *node_first == NULL)
1856     return;
1857
1858   if (strEqual((*node_first)->key, key))
1859   {
1860     checked_free((*node_first)->key);
1861     if (destructor_function)
1862       destructor_function((*node_first)->content);
1863     *node_first = (*node_first)->next;
1864   }
1865   else
1866     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1867 }
1868
1869 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1870 {
1871   if (node_first == NULL)
1872     return NULL;
1873
1874   if (strEqual(node_first->key, key))
1875     return node_first;
1876   else
1877     return getNodeFromKey(node_first->next, key);
1878 }
1879
1880 int getNumNodes(ListNode *node_first)
1881 {
1882   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1883 }
1884
1885 void dumpList(ListNode *node_first)
1886 {
1887   ListNode *node = node_first;
1888
1889   while (node)
1890   {
1891     printf("['%s' (%d)]\n", node->key,
1892            ((struct ListNodeInfo *)node->content)->num_references);
1893     node = node->next;
1894   }
1895
1896   printf("[%d nodes]\n", getNumNodes(node_first));
1897 }
1898
1899
1900 /* ------------------------------------------------------------------------- */
1901 /* functions for file handling                                               */
1902 /* ------------------------------------------------------------------------- */
1903
1904 File *openFile(char *filename, char *mode)
1905 {
1906   File *file = checked_calloc(sizeof(File));
1907
1908   file->file = fopen(filename, mode);
1909
1910   if (file->file != NULL)
1911   {
1912     file->filename = getStringCopy(filename);
1913
1914     return file;
1915   }
1916
1917 #if defined(PLATFORM_ANDROID)
1918   file->asset_file = SDL_RWFromFile(filename, mode);
1919
1920   if (file->asset_file != NULL)
1921   {
1922     file->file_is_asset = TRUE;
1923     file->filename = getStringCopy(filename);
1924
1925     return file;
1926   }
1927 #endif
1928
1929   checked_free(file);
1930
1931   return NULL;
1932 }
1933
1934 int closeFile(File *file)
1935 {
1936   if (file == NULL)
1937     return -1;
1938
1939   int result;
1940
1941 #if defined(PLATFORM_ANDROID)
1942   if (file->asset_file)
1943     result = SDL_RWclose(file->asset_file);
1944 #endif
1945
1946   if (file->file)
1947     result = fclose(file->file);
1948
1949   checked_free(file->filename);
1950   checked_free(file);
1951
1952   return result;
1953 }
1954
1955 int checkEndOfFile(File *file)
1956 {
1957 #if defined(PLATFORM_ANDROID)
1958   if (file->file_is_asset)
1959     return file->end_of_file;
1960 #endif
1961
1962   return feof(file->file);
1963 }
1964
1965 char *getStringFromFile(File *file, char *line, int size)
1966 {
1967 #if defined(PLATFORM_ANDROID)
1968   if (file->file_is_asset)
1969   {
1970     if (file->end_of_file)
1971       return NULL;
1972
1973     char *line_ptr = line;
1974     int num_bytes_read = 0;
1975
1976     while (num_bytes_read < size - 1 &&
1977            SDL_RWread(file->asset_file, line_ptr, 1, 1) == 1 &&
1978            *line_ptr++ != '\n')
1979       num_bytes_read++;
1980
1981     *line_ptr = '\0';
1982
1983     if (strlen(line) == 0)
1984     {
1985       file->end_of_file = TRUE;
1986
1987       return NULL;
1988     }
1989
1990     return line;
1991   }
1992 #endif
1993
1994   return fgets(line, size, file->file);
1995 }
1996
1997
1998 /* ------------------------------------------------------------------------- */
1999 /* functions for directory handling                                          */
2000 /* ------------------------------------------------------------------------- */
2001
2002 Directory *openDirectory(char *dir_name)
2003 {
2004   Directory *dir = checked_calloc(sizeof(Directory));
2005
2006   dir->dir = opendir(dir_name);
2007
2008   if (dir->dir != NULL)
2009   {
2010     dir->filename = getStringCopy(dir_name);
2011
2012     return dir;
2013   }
2014
2015 #if defined(PLATFORM_ANDROID)
2016   char *asset_toc_filename = getPath2(dir_name, ASSET_TOC_BASENAME);
2017
2018   dir->asset_toc_file = SDL_RWFromFile(asset_toc_filename, MODE_READ);
2019
2020   checked_free(asset_toc_filename);
2021
2022   if (dir->asset_toc_file != NULL)
2023   {
2024     dir->directory_is_asset = TRUE;
2025     dir->filename = getStringCopy(dir_name);
2026
2027     return dir;
2028   }
2029 #endif
2030
2031   checked_free(dir);
2032
2033   return NULL;
2034 }
2035
2036 int closeDirectory(Directory *dir)
2037 {
2038   if (dir == NULL)
2039     return -1;
2040
2041   int result;
2042
2043 #if defined(PLATFORM_ANDROID)
2044   if (dir->asset_toc_file)
2045     result = SDL_RWclose(dir->asset_toc_file);
2046 #endif
2047
2048   if (dir->dir)
2049     result = closedir(dir->dir);
2050
2051   if (dir->dir_entry)
2052     freeDirectoryEntry(dir->dir_entry);
2053
2054   checked_free(dir->filename);
2055   checked_free(dir);
2056
2057   return result;
2058 }
2059
2060 DirectoryEntry *readDirectory(Directory *dir)
2061 {
2062   if (dir->dir_entry)
2063     freeDirectoryEntry(dir->dir_entry);
2064
2065   dir->dir_entry = NULL;
2066
2067 #if defined(PLATFORM_ANDROID)
2068   if (dir->directory_is_asset)
2069   {
2070     char line[MAX_LINE_LEN];
2071     char *line_ptr = line;
2072     int num_bytes_read = 0;
2073
2074     while (num_bytes_read < MAX_LINE_LEN - 1 &&
2075            SDL_RWread(dir->asset_toc_file, line_ptr, 1, 1) == 1 &&
2076            *line_ptr != '\n')
2077     {
2078       line_ptr++;
2079       num_bytes_read++;
2080     }
2081
2082     *line_ptr = '\0';
2083
2084     if (strlen(line) == 0)
2085       return NULL;
2086
2087     dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2088
2089     dir->dir_entry->is_directory = FALSE;
2090     if (line[strlen(line) - 1] = '/')
2091     {
2092       dir->dir_entry->is_directory = TRUE;
2093
2094       line[strlen(line) - 1] = '\0';
2095     }
2096
2097     dir->dir_entry->basename = getStringCopy(line);
2098     dir->dir_entry->filename = getPath2(dir->filename, line);
2099
2100     return dir->dir_entry;
2101   }
2102 #endif
2103
2104   struct dirent *dir_entry = readdir(dir->dir);
2105
2106   if (dir_entry == NULL)
2107     return NULL;
2108
2109   dir->dir_entry = checked_calloc(sizeof(DirectoryEntry));
2110
2111   dir->dir_entry->basename = getStringCopy(dir_entry->d_name);
2112   dir->dir_entry->filename = getPath2(dir->filename, dir_entry->d_name);
2113
2114   struct stat file_status;
2115
2116   dir->dir_entry->is_directory =
2117     (stat(dir->dir_entry->filename, &file_status) == 0 &&
2118      (file_status.st_mode & S_IFMT) != S_IFDIR);
2119
2120   return dir->dir_entry;
2121 }
2122
2123 void freeDirectoryEntry(DirectoryEntry *dir_entry)
2124 {
2125   if (dir_entry == NULL)
2126     return;
2127
2128   checked_free(dir_entry->basename);
2129   checked_free(dir_entry->filename);
2130   checked_free(dir_entry);
2131 }
2132
2133
2134 /* ------------------------------------------------------------------------- */
2135 /* functions for checking files and filenames                                */
2136 /* ------------------------------------------------------------------------- */
2137
2138 boolean fileExists(char *filename)
2139 {
2140   if (filename == NULL)
2141     return FALSE;
2142
2143 #if defined(PLATFORM_ANDROID)
2144   // workaround: check if file exists by opening and closing it
2145   SDL_RWops *file = SDL_RWFromFile(filename, MODE_READ);
2146   boolean success = (file != NULL);
2147
2148   if (success)
2149     SDL_RWclose(file);
2150
2151   return success;
2152 #else
2153   return (access(filename, F_OK) == 0);
2154 #endif
2155 }
2156
2157 boolean fileHasPrefix(char *basename, char *prefix)
2158 {
2159   static char *basename_lower = NULL;
2160   int basename_length, prefix_length;
2161
2162   checked_free(basename_lower);
2163
2164   if (basename == NULL || prefix == NULL)
2165     return FALSE;
2166
2167   basename_lower = getStringToLower(basename);
2168   basename_length = strlen(basename_lower);
2169   prefix_length = strlen(prefix);
2170
2171   if (basename_length > prefix_length + 1 &&
2172       basename_lower[prefix_length] == '.' &&
2173       strncmp(basename_lower, prefix, prefix_length) == 0)
2174     return TRUE;
2175
2176   return FALSE;
2177 }
2178
2179 boolean fileHasSuffix(char *basename, char *suffix)
2180 {
2181   static char *basename_lower = NULL;
2182   int basename_length, suffix_length;
2183
2184   checked_free(basename_lower);
2185
2186   if (basename == NULL || suffix == NULL)
2187     return FALSE;
2188
2189   basename_lower = getStringToLower(basename);
2190   basename_length = strlen(basename_lower);
2191   suffix_length = strlen(suffix);
2192
2193   if (basename_length > suffix_length + 1 &&
2194       basename_lower[basename_length - suffix_length - 1] == '.' &&
2195       strEqual(&basename_lower[basename_length - suffix_length], suffix))
2196     return TRUE;
2197
2198   return FALSE;
2199 }
2200
2201 boolean FileIsGraphic(char *filename)
2202 {
2203   char *basename = getBaseNamePtr(filename);
2204
2205   return fileHasSuffix(basename, "pcx");
2206 }
2207
2208 boolean FileIsSound(char *filename)
2209 {
2210   char *basename = getBaseNamePtr(filename);
2211
2212   return fileHasSuffix(basename, "wav");
2213 }
2214
2215 boolean FileIsMusic(char *filename)
2216 {
2217   char *basename = getBaseNamePtr(filename);
2218
2219   if (FileIsSound(basename))
2220     return TRUE;
2221
2222 #if defined(TARGET_SDL)
2223   if ((fileHasPrefix(basename, "mod") && !fileHasSuffix(basename, "txt")) ||
2224       fileHasSuffix(basename, "mod") ||
2225       fileHasSuffix(basename, "s3m") ||
2226       fileHasSuffix(basename, "it") ||
2227       fileHasSuffix(basename, "xm") ||
2228       fileHasSuffix(basename, "midi") ||
2229       fileHasSuffix(basename, "mid") ||
2230       fileHasSuffix(basename, "mp3") ||
2231       fileHasSuffix(basename, "ogg"))
2232     return TRUE;
2233 #endif
2234
2235   return FALSE;
2236 }
2237
2238 boolean FileIsArtworkType(char *basename, int type)
2239 {
2240   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
2241       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
2242       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
2243     return TRUE;
2244
2245   return FALSE;
2246 }
2247
2248 /* ------------------------------------------------------------------------- */
2249 /* functions for loading artwork configuration information                   */
2250 /* ------------------------------------------------------------------------- */
2251
2252 char *get_mapped_token(char *token)
2253 {
2254   /* !!! make this dynamically configurable (init.c:InitArtworkConfig) !!! */
2255   static char *map_token_prefix[][2] =
2256   {
2257     { "char_procent",           "char_percent"  },
2258     { NULL,                                     }
2259   };
2260   int i;
2261
2262   for (i = 0; map_token_prefix[i][0] != NULL; i++)
2263   {
2264     int len_token_prefix = strlen(map_token_prefix[i][0]);
2265
2266     if (strncmp(token, map_token_prefix[i][0], len_token_prefix) == 0)
2267       return getStringCat2(map_token_prefix[i][1], &token[len_token_prefix]);
2268   }
2269
2270   return NULL;
2271 }
2272
2273 /* This function checks if a string <s> of the format "string1, string2, ..."
2274    exactly contains a string <s_contained>. */
2275
2276 static boolean string_has_parameter(char *s, char *s_contained)
2277 {
2278   char *substring;
2279
2280   if (s == NULL || s_contained == NULL)
2281     return FALSE;
2282
2283   if (strlen(s_contained) > strlen(s))
2284     return FALSE;
2285
2286   if (strncmp(s, s_contained, strlen(s_contained)) == 0)
2287   {
2288     char next_char = s[strlen(s_contained)];
2289
2290     /* check if next character is delimiter or whitespace */
2291     return (next_char == ',' || next_char == '\0' ||
2292             next_char == ' ' || next_char == '\t' ? TRUE : FALSE);
2293   }
2294
2295   /* check if string contains another parameter string after a comma */
2296   substring = strchr(s, ',');
2297   if (substring == NULL)        /* string does not contain a comma */
2298     return FALSE;
2299
2300   /* advance string pointer to next character after the comma */
2301   substring++;
2302
2303   /* skip potential whitespaces after the comma */
2304   while (*substring == ' ' || *substring == '\t')
2305     substring++;
2306
2307   return string_has_parameter(substring, s_contained);
2308 }
2309
2310 int get_parameter_value(char *value_raw, char *suffix, int type)
2311 {
2312   char *value = getStringToLower(value_raw);
2313   int result = 0;       /* probably a save default value */
2314
2315   if (strEqual(suffix, ".direction"))
2316   {
2317     result = (strEqual(value, "left")  ? MV_LEFT :
2318               strEqual(value, "right") ? MV_RIGHT :
2319               strEqual(value, "up")    ? MV_UP :
2320               strEqual(value, "down")  ? MV_DOWN : MV_NONE);
2321   }
2322   else if (strEqual(suffix, ".align"))
2323   {
2324     result = (strEqual(value, "left")   ? ALIGN_LEFT :
2325               strEqual(value, "right")  ? ALIGN_RIGHT :
2326               strEqual(value, "center") ? ALIGN_CENTER :
2327               strEqual(value, "middle") ? ALIGN_CENTER : ALIGN_DEFAULT);
2328   }
2329   else if (strEqual(suffix, ".valign"))
2330   {
2331     result = (strEqual(value, "top")    ? VALIGN_TOP :
2332               strEqual(value, "bottom") ? VALIGN_BOTTOM :
2333               strEqual(value, "middle") ? VALIGN_MIDDLE :
2334               strEqual(value, "center") ? VALIGN_MIDDLE : VALIGN_DEFAULT);
2335   }
2336   else if (strEqual(suffix, ".anim_mode"))
2337   {
2338     result = (string_has_parameter(value, "none")       ? ANIM_NONE :
2339               string_has_parameter(value, "loop")       ? ANIM_LOOP :
2340               string_has_parameter(value, "linear")     ? ANIM_LINEAR :
2341               string_has_parameter(value, "pingpong")   ? ANIM_PINGPONG :
2342               string_has_parameter(value, "pingpong2")  ? ANIM_PINGPONG2 :
2343               string_has_parameter(value, "random")     ? ANIM_RANDOM :
2344               string_has_parameter(value, "ce_value")   ? ANIM_CE_VALUE :
2345               string_has_parameter(value, "ce_score")   ? ANIM_CE_SCORE :
2346               string_has_parameter(value, "ce_delay")   ? ANIM_CE_DELAY :
2347               string_has_parameter(value, "horizontal") ? ANIM_HORIZONTAL :
2348               string_has_parameter(value, "vertical")   ? ANIM_VERTICAL :
2349               string_has_parameter(value, "centered")   ? ANIM_CENTERED :
2350               ANIM_DEFAULT);
2351
2352     if (string_has_parameter(value, "reverse"))
2353       result |= ANIM_REVERSE;
2354
2355     if (string_has_parameter(value, "opaque_player"))
2356       result |= ANIM_OPAQUE_PLAYER;
2357
2358     if (string_has_parameter(value, "static_panel"))
2359       result |= ANIM_STATIC_PANEL;
2360   }
2361   else if (strEqual(suffix, ".class"))
2362   {
2363     result = get_hash_from_key(value);
2364   }
2365   else if (strEqual(suffix, ".style"))
2366   {
2367     result = STYLE_DEFAULT;
2368
2369     if (string_has_parameter(value, "accurate_borders"))
2370       result |= STYLE_ACCURATE_BORDERS;
2371
2372     if (string_has_parameter(value, "inner_corners"))
2373       result |= STYLE_INNER_CORNERS;
2374   }
2375   else if (strEqual(suffix, ".fade_mode"))
2376   {
2377     result = (string_has_parameter(value, "none")       ? FADE_MODE_NONE :
2378               string_has_parameter(value, "fade")       ? FADE_MODE_FADE :
2379               string_has_parameter(value, "crossfade")  ? FADE_MODE_CROSSFADE :
2380               string_has_parameter(value, "melt")       ? FADE_MODE_MELT :
2381               FADE_MODE_DEFAULT);
2382   }
2383 #if 1
2384   else if (strPrefix(suffix, ".font"))          /* (may also be ".font_xyz") */
2385 #else
2386   else if (strEqualN(suffix, ".font", 5))       /* (may also be ".font_xyz") */
2387 #endif
2388   {
2389     result = gfx.get_font_from_token_function(value);
2390   }
2391   else          /* generic parameter of type integer or boolean */
2392   {
2393     result = (strEqual(value, ARG_UNDEFINED) ? ARG_UNDEFINED_VALUE :
2394               type == TYPE_INTEGER ? get_integer_from_string(value) :
2395               type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
2396               ARG_UNDEFINED_VALUE);
2397   }
2398
2399   free(value);
2400
2401   return result;
2402 }
2403
2404 struct ScreenModeInfo *get_screen_mode_from_string(char *screen_mode_string)
2405 {
2406   static struct ScreenModeInfo screen_mode;
2407   char *screen_mode_string_x = strchr(screen_mode_string, 'x');
2408   char *screen_mode_string_copy;
2409   char *screen_mode_string_pos_w;
2410   char *screen_mode_string_pos_h;
2411
2412   if (screen_mode_string_x == NULL)     /* invalid screen mode format */
2413     return NULL;
2414
2415   screen_mode_string_copy = getStringCopy(screen_mode_string);
2416
2417   screen_mode_string_pos_w = screen_mode_string_copy;
2418   screen_mode_string_pos_h = strchr(screen_mode_string_copy, 'x');
2419   *screen_mode_string_pos_h++ = '\0';
2420
2421   screen_mode.width  = atoi(screen_mode_string_pos_w);
2422   screen_mode.height = atoi(screen_mode_string_pos_h);
2423
2424   return &screen_mode;
2425 }
2426
2427 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *screen_mode,
2428                                        int *x, int *y)
2429 {
2430   float aspect_ratio = (float)screen_mode->width / (float)screen_mode->height;
2431   float aspect_ratio_new;
2432   int i = 1;
2433
2434   do
2435   {
2436     *x = i * aspect_ratio + 0.000001;
2437     *y = i;
2438
2439     aspect_ratio_new = (float)*x / (float)*y;
2440
2441     i++;
2442   }
2443   while (aspect_ratio_new != aspect_ratio && *y < screen_mode->height);
2444 }
2445
2446 static void FreeCustomArtworkList(struct ArtworkListInfo *,
2447                                   struct ListNodeInfo ***, int *);
2448
2449 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
2450                                            struct ConfigTypeInfo *suffix_list,
2451                                            char **ignore_tokens,
2452                                            int num_file_list_entries)
2453 {
2454   struct FileInfo *file_list;
2455   int num_file_list_entries_found = 0;
2456   int num_suffix_list_entries = 0;
2457   int list_pos;
2458   int i, j;
2459
2460   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
2461
2462   for (i = 0; suffix_list[i].token != NULL; i++)
2463     num_suffix_list_entries++;
2464
2465   /* always start with reliable default values */
2466   for (i = 0; i < num_file_list_entries; i++)
2467   {
2468     file_list[i].token = NULL;
2469
2470     file_list[i].default_filename = NULL;
2471     file_list[i].filename = NULL;
2472
2473     if (num_suffix_list_entries > 0)
2474     {
2475       int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2476
2477       file_list[i].default_parameter = checked_calloc(parameter_array_size);
2478       file_list[i].parameter = checked_calloc(parameter_array_size);
2479
2480       for (j = 0; j < num_suffix_list_entries; j++)
2481       {
2482         setString(&file_list[i].default_parameter[j], suffix_list[j].value);
2483         setString(&file_list[i].parameter[j], suffix_list[j].value);
2484       }
2485
2486       file_list[i].redefined = FALSE;
2487       file_list[i].fallback_to_default = FALSE;
2488       file_list[i].default_is_cloned = FALSE;
2489     }
2490   }
2491
2492   list_pos = 0;
2493   for (i = 0; config_list[i].token != NULL; i++)
2494   {
2495     int len_config_token = strlen(config_list[i].token);
2496     int len_config_value = strlen(config_list[i].value);
2497     boolean is_file_entry = TRUE;
2498
2499     for (j = 0; suffix_list[j].token != NULL; j++)
2500     {
2501       int len_suffix = strlen(suffix_list[j].token);
2502
2503       if (len_suffix < len_config_token &&
2504           strEqual(&config_list[i].token[len_config_token - len_suffix],
2505                    suffix_list[j].token))
2506       {
2507         setString(&file_list[list_pos].default_parameter[j],
2508                   config_list[i].value);
2509
2510         is_file_entry = FALSE;
2511         break;
2512       }
2513     }
2514
2515     /* the following tokens are no file definitions, but other config tokens */
2516     for (j = 0; ignore_tokens[j] != NULL; j++)
2517       if (strEqual(config_list[i].token, ignore_tokens[j]))
2518         is_file_entry = FALSE;
2519
2520     if (is_file_entry)
2521     {
2522       if (i > 0)
2523         list_pos++;
2524
2525       if (list_pos >= num_file_list_entries)
2526         break;
2527
2528       /* simple sanity check if this is really a file definition */
2529       if (!strEqual(&config_list[i].value[len_config_value - 4], ".pcx") &&
2530           !strEqual(&config_list[i].value[len_config_value - 4], ".wav") &&
2531           !strEqual(config_list[i].value, UNDEFINED_FILENAME))
2532       {
2533         Error(ERR_INFO, "Configuration directive '%s' -> '%s':",
2534               config_list[i].token, config_list[i].value);
2535         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
2536       }
2537
2538       file_list[list_pos].token = config_list[i].token;
2539       file_list[list_pos].default_filename = config_list[i].value;
2540
2541 #if 0
2542       printf("::: '%s' => '%s'\n", config_list[i].token, config_list[i].value);
2543 #endif
2544     }
2545
2546     if (strSuffix(config_list[i].token, ".clone_from"))
2547       file_list[list_pos].default_is_cloned = TRUE;
2548   }
2549
2550   num_file_list_entries_found = list_pos + 1;
2551   if (num_file_list_entries_found != num_file_list_entries)
2552   {
2553     Error(ERR_INFO_LINE, "-");
2554     Error(ERR_INFO, "inconsistant config list information:");
2555     Error(ERR_INFO, "- should be:   %d (according to 'src/conf_xxx.h')",
2556           num_file_list_entries);
2557     Error(ERR_INFO, "- found to be: %d (according to 'src/conf_xxx.c')",
2558           num_file_list_entries_found);
2559     Error(ERR_EXIT,   "please fix");
2560   }
2561
2562 #if 0
2563   printf("::: ---------- DONE ----------\n");
2564 #endif
2565
2566   return file_list;
2567 }
2568
2569 static boolean token_suffix_match(char *token, char *suffix, int start_pos)
2570 {
2571   int len_token = strlen(token);
2572   int len_suffix = strlen(suffix);
2573
2574   if (start_pos < 0)    /* compare suffix from end of string */
2575     start_pos += len_token;
2576
2577   if (start_pos < 0 || start_pos + len_suffix > len_token)
2578     return FALSE;
2579
2580   if (strncmp(&token[start_pos], suffix, len_suffix) != 0)
2581     return FALSE;
2582
2583   if (token[start_pos + len_suffix] == '\0')
2584     return TRUE;
2585
2586   if (token[start_pos + len_suffix] == '.')
2587     return TRUE;
2588
2589   return FALSE;
2590 }
2591
2592 #define KNOWN_TOKEN_VALUE       "[KNOWN_TOKEN_VALUE]"
2593
2594 static void read_token_parameters(SetupFileHash *setup_file_hash,
2595                                   struct ConfigTypeInfo *suffix_list,
2596                                   struct FileInfo *file_list_entry)
2597 {
2598   /* check for config token that is the base token without any suffixes */
2599   char *filename = getHashEntry(setup_file_hash, file_list_entry->token);
2600   char *known_token_value = KNOWN_TOKEN_VALUE;
2601   int i;
2602
2603   if (filename != NULL)
2604   {
2605     setString(&file_list_entry->filename, filename);
2606
2607     /* when file definition found, set all parameters to default values */
2608     for (i = 0; suffix_list[i].token != NULL; i++)
2609       setString(&file_list_entry->parameter[i], suffix_list[i].value);
2610
2611     file_list_entry->redefined = TRUE;
2612
2613     /* mark config file token as well known from default config */
2614     setHashEntry(setup_file_hash, file_list_entry->token, known_token_value);
2615   }
2616
2617   /* check for config tokens that can be build by base token and suffixes */
2618   for (i = 0; suffix_list[i].token != NULL; i++)
2619   {
2620     char *token = getStringCat2(file_list_entry->token, suffix_list[i].token);
2621     char *value = getHashEntry(setup_file_hash, token);
2622
2623     if (value != NULL)
2624     {
2625       setString(&file_list_entry->parameter[i], value);
2626
2627       /* mark config file token as well known from default config */
2628       setHashEntry(setup_file_hash, token, known_token_value);
2629     }
2630
2631     free(token);
2632   }
2633 }
2634
2635 static void add_dynamic_file_list_entry(struct FileInfo **list,
2636                                         int *num_list_entries,
2637                                         SetupFileHash *extra_file_hash,
2638                                         struct ConfigTypeInfo *suffix_list,
2639                                         int num_suffix_list_entries,
2640                                         char *token)
2641 {
2642   struct FileInfo *new_list_entry;
2643   int parameter_array_size = num_suffix_list_entries * sizeof(char *);
2644
2645   (*num_list_entries)++;
2646   *list = checked_realloc(*list, *num_list_entries * sizeof(struct FileInfo));
2647   new_list_entry = &(*list)[*num_list_entries - 1];
2648
2649   new_list_entry->token = getStringCopy(token);
2650   new_list_entry->default_filename = NULL;
2651   new_list_entry->filename = NULL;
2652   new_list_entry->parameter = checked_calloc(parameter_array_size);
2653
2654   new_list_entry->redefined = FALSE;
2655   new_list_entry->fallback_to_default = FALSE;
2656   new_list_entry->default_is_cloned = FALSE;
2657
2658   read_token_parameters(extra_file_hash, suffix_list, new_list_entry);
2659 }
2660
2661 static void add_property_mapping(struct PropertyMapping **list,
2662                                  int *num_list_entries,
2663                                  int base_index, int ext1_index,
2664                                  int ext2_index, int ext3_index,
2665                                  int artwork_index)
2666 {
2667   struct PropertyMapping *new_list_entry;
2668
2669   (*num_list_entries)++;
2670   *list = checked_realloc(*list,
2671                           *num_list_entries * sizeof(struct PropertyMapping));
2672   new_list_entry = &(*list)[*num_list_entries - 1];
2673
2674   new_list_entry->base_index = base_index;
2675   new_list_entry->ext1_index = ext1_index;
2676   new_list_entry->ext2_index = ext2_index;
2677   new_list_entry->ext3_index = ext3_index;
2678
2679   new_list_entry->artwork_index = artwork_index;
2680 }
2681
2682 static void LoadArtworkConfigFromFilename(struct ArtworkListInfo *artwork_info,
2683                                           char *filename)
2684 {
2685   struct FileInfo *file_list = artwork_info->file_list;
2686   struct ConfigTypeInfo *suffix_list = artwork_info->suffix_list;
2687   char **base_prefixes = artwork_info->base_prefixes;
2688   char **ext1_suffixes = artwork_info->ext1_suffixes;
2689   char **ext2_suffixes = artwork_info->ext2_suffixes;
2690   char **ext3_suffixes = artwork_info->ext3_suffixes;
2691   char **ignore_tokens = artwork_info->ignore_tokens;
2692   int num_file_list_entries = artwork_info->num_file_list_entries;
2693   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
2694   int num_base_prefixes = artwork_info->num_base_prefixes;
2695   int num_ext1_suffixes = artwork_info->num_ext1_suffixes;
2696   int num_ext2_suffixes = artwork_info->num_ext2_suffixes;
2697   int num_ext3_suffixes = artwork_info->num_ext3_suffixes;
2698   int num_ignore_tokens = artwork_info->num_ignore_tokens;
2699   SetupFileHash *setup_file_hash, *valid_file_hash;
2700   SetupFileHash *extra_file_hash, *empty_file_hash;
2701   char *known_token_value = KNOWN_TOKEN_VALUE;
2702   int i, j, k, l;
2703
2704   if (filename == NULL)
2705     return;
2706
2707 #if 0
2708   printf("LoadArtworkConfigFromFilename '%s' ...\n", filename);
2709 #endif
2710
2711   if ((setup_file_hash = loadSetupFileHash(filename)) == NULL)
2712     return;
2713
2714   /* separate valid (defined) from empty (undefined) config token values */
2715   valid_file_hash = newSetupFileHash();
2716   empty_file_hash = newSetupFileHash();
2717   BEGIN_HASH_ITERATION(setup_file_hash, itr)
2718   {
2719     char *value = HASH_ITERATION_VALUE(itr);
2720
2721     setHashEntry(*value ? valid_file_hash : empty_file_hash,
2722                  HASH_ITERATION_TOKEN(itr), value);
2723   }
2724   END_HASH_ITERATION(setup_file_hash, itr)
2725
2726   /* at this point, we do not need the setup file hash anymore -- free it */
2727   freeSetupFileHash(setup_file_hash);
2728
2729   /* map deprecated to current tokens (using prefix match and replace) */
2730   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2731   {
2732     char *token = HASH_ITERATION_TOKEN(itr);
2733     char *mapped_token = get_mapped_token(token);
2734
2735     if (mapped_token != NULL)
2736     {
2737       char *value = HASH_ITERATION_VALUE(itr);
2738
2739       /* add mapped token */
2740       setHashEntry(valid_file_hash, mapped_token, value);
2741
2742       /* ignore old token (by setting it to "known" keyword) */
2743       setHashEntry(valid_file_hash, token, known_token_value);
2744
2745       free(mapped_token);
2746     }
2747   }
2748   END_HASH_ITERATION(valid_file_hash, itr)
2749
2750   /* read parameters for all known config file tokens */
2751   for (i = 0; i < num_file_list_entries; i++)
2752     read_token_parameters(valid_file_hash, suffix_list, &file_list[i]);
2753
2754   /* set all tokens that can be ignored here to "known" keyword */
2755   for (i = 0; i < num_ignore_tokens; i++)
2756     setHashEntry(valid_file_hash, ignore_tokens[i], known_token_value);
2757
2758   /* copy all unknown config file tokens to extra config hash */
2759   extra_file_hash = newSetupFileHash();
2760   BEGIN_HASH_ITERATION(valid_file_hash, itr)
2761   {
2762     char *value = HASH_ITERATION_VALUE(itr);
2763
2764     if (!strEqual(value, known_token_value))
2765       setHashEntry(extra_file_hash, HASH_ITERATION_TOKEN(itr), value);
2766   }
2767   END_HASH_ITERATION(valid_file_hash, itr)
2768
2769   /* at this point, we do not need the valid file hash anymore -- free it */
2770   freeSetupFileHash(valid_file_hash);
2771
2772   /* now try to determine valid, dynamically defined config tokens */
2773
2774   BEGIN_HASH_ITERATION(extra_file_hash, itr)
2775   {
2776     struct FileInfo **dynamic_file_list =
2777       &artwork_info->dynamic_file_list;
2778     int *num_dynamic_file_list_entries =
2779       &artwork_info->num_dynamic_file_list_entries;
2780     struct PropertyMapping **property_mapping =
2781       &artwork_info->property_mapping;
2782     int *num_property_mapping_entries =
2783       &artwork_info->num_property_mapping_entries;
2784     int current_summarized_file_list_entry =
2785       artwork_info->num_file_list_entries +
2786       artwork_info->num_dynamic_file_list_entries;
2787     char *token = HASH_ITERATION_TOKEN(itr);
2788     int len_token = strlen(token);
2789     int start_pos;
2790     boolean base_prefix_found = FALSE;
2791     boolean parameter_suffix_found = FALSE;
2792
2793 #if 0
2794     printf("::: examining '%s' -> '%s'\n", token, HASH_ITERATION_VALUE(itr));
2795 #endif
2796
2797     /* skip all parameter definitions (handled by read_token_parameters()) */
2798     for (i = 0; i < num_suffix_list_entries && !parameter_suffix_found; i++)
2799     {
2800       int len_suffix = strlen(suffix_list[i].token);
2801
2802       if (token_suffix_match(token, suffix_list[i].token, -len_suffix))
2803         parameter_suffix_found = TRUE;
2804     }
2805
2806     if (parameter_suffix_found)
2807       continue;
2808
2809     /* ---------- step 0: search for matching base prefix ---------- */
2810
2811     start_pos = 0;
2812     for (i = 0; i < num_base_prefixes && !base_prefix_found; i++)
2813     {
2814       char *base_prefix = base_prefixes[i];
2815       int len_base_prefix = strlen(base_prefix);
2816       boolean ext1_suffix_found = FALSE;
2817       boolean ext2_suffix_found = FALSE;
2818       boolean ext3_suffix_found = FALSE;
2819       boolean exact_match = FALSE;
2820       int base_index = -1;
2821       int ext1_index = -1;
2822       int ext2_index = -1;
2823       int ext3_index = -1;
2824
2825       base_prefix_found = token_suffix_match(token, base_prefix, start_pos);
2826
2827       if (!base_prefix_found)
2828         continue;
2829
2830       base_index = i;
2831
2832 #if 0
2833       if (IS_PARENT_PROCESS())
2834         printf("===> MATCH: '%s', '%s'\n", token, base_prefix);
2835 #endif
2836
2837       if (start_pos + len_base_prefix == len_token)     /* exact match */
2838       {
2839         exact_match = TRUE;
2840
2841 #if 0
2842         if (IS_PARENT_PROCESS())
2843           printf("===> EXACT MATCH: '%s', '%s'\n", token, base_prefix);
2844 #endif
2845
2846         add_dynamic_file_list_entry(dynamic_file_list,
2847                                     num_dynamic_file_list_entries,
2848                                     extra_file_hash,
2849                                     suffix_list,
2850                                     num_suffix_list_entries,
2851                                     token);
2852         add_property_mapping(property_mapping,
2853                              num_property_mapping_entries,
2854                              base_index, -1, -1, -1,
2855                              current_summarized_file_list_entry);
2856         continue;
2857       }
2858
2859 #if 0
2860       if (IS_PARENT_PROCESS())
2861         printf("---> examining token '%s': search 1st suffix ...\n", token);
2862 #endif
2863
2864       /* ---------- step 1: search for matching first suffix ---------- */
2865
2866       start_pos += len_base_prefix;
2867       for (j = 0; j < num_ext1_suffixes && !ext1_suffix_found; j++)
2868       {
2869         char *ext1_suffix = ext1_suffixes[j];
2870         int len_ext1_suffix = strlen(ext1_suffix);
2871
2872         ext1_suffix_found = token_suffix_match(token, ext1_suffix, start_pos);
2873
2874         if (!ext1_suffix_found)
2875           continue;
2876
2877         ext1_index = j;
2878
2879 #if 0
2880         if (IS_PARENT_PROCESS())
2881           printf("===> MATCH: '%s', '%s'\n", token, ext1_suffix);
2882 #endif
2883
2884         if (start_pos + len_ext1_suffix == len_token)   /* exact match */
2885         {
2886           exact_match = TRUE;
2887
2888 #if 0
2889         if (IS_PARENT_PROCESS())
2890           printf("===> EXACT MATCH: '%s', '%s'\n", token, ext1_suffix);
2891 #endif
2892
2893           add_dynamic_file_list_entry(dynamic_file_list,
2894                                       num_dynamic_file_list_entries,
2895                                       extra_file_hash,
2896                                       suffix_list,
2897                                       num_suffix_list_entries,
2898                                       token);
2899           add_property_mapping(property_mapping,
2900                                num_property_mapping_entries,
2901                                base_index, ext1_index, -1, -1,
2902                                current_summarized_file_list_entry);
2903           continue;
2904         }
2905
2906         start_pos += len_ext1_suffix;
2907       }
2908
2909       if (exact_match)
2910         break;
2911
2912 #if 0
2913       if (IS_PARENT_PROCESS())
2914         printf("---> examining token '%s': search 2nd suffix ...\n", token);
2915 #endif
2916
2917       /* ---------- step 2: search for matching second suffix ---------- */
2918
2919       for (k = 0; k < num_ext2_suffixes && !ext2_suffix_found; k++)
2920       {
2921         char *ext2_suffix = ext2_suffixes[k];
2922         int len_ext2_suffix = strlen(ext2_suffix);
2923
2924         ext2_suffix_found = token_suffix_match(token, ext2_suffix, start_pos);
2925
2926         if (!ext2_suffix_found)
2927           continue;
2928
2929         ext2_index = k;
2930
2931 #if 0
2932         if (IS_PARENT_PROCESS())
2933           printf("===> MATCH: '%s', '%s'\n", token, ext2_suffix);
2934 #endif
2935
2936         if (start_pos + len_ext2_suffix == len_token)   /* exact match */
2937         {
2938           exact_match = TRUE;
2939
2940 #if 0
2941           if (IS_PARENT_PROCESS())
2942             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext2_suffix);
2943 #endif
2944
2945           add_dynamic_file_list_entry(dynamic_file_list,
2946                                       num_dynamic_file_list_entries,
2947                                       extra_file_hash,
2948                                       suffix_list,
2949                                       num_suffix_list_entries,
2950                                       token);
2951           add_property_mapping(property_mapping,
2952                                num_property_mapping_entries,
2953                                base_index, ext1_index, ext2_index, -1,
2954                                current_summarized_file_list_entry);
2955           continue;
2956         }
2957
2958         start_pos += len_ext2_suffix;
2959       }
2960
2961       if (exact_match)
2962         break;
2963
2964 #if 0
2965       if (IS_PARENT_PROCESS())
2966         printf("---> examining token '%s': search 3rd suffix ...\n",token);
2967 #endif
2968
2969       /* ---------- step 3: search for matching third suffix ---------- */
2970
2971       for (l = 0; l < num_ext3_suffixes && !ext3_suffix_found; l++)
2972       {
2973         char *ext3_suffix = ext3_suffixes[l];
2974         int len_ext3_suffix = strlen(ext3_suffix);
2975
2976         ext3_suffix_found = token_suffix_match(token, ext3_suffix, start_pos);
2977
2978         if (!ext3_suffix_found)
2979           continue;
2980
2981         ext3_index = l;
2982
2983 #if 0
2984         if (IS_PARENT_PROCESS())
2985           printf("===> MATCH: '%s', '%s'\n", token, ext3_suffix);
2986 #endif
2987
2988         if (start_pos + len_ext3_suffix == len_token) /* exact match */
2989         {
2990           exact_match = TRUE;
2991
2992 #if 0
2993           if (IS_PARENT_PROCESS())
2994             printf("===> EXACT MATCH: '%s', '%s'\n", token, ext3_suffix);
2995 #endif
2996
2997           add_dynamic_file_list_entry(dynamic_file_list,
2998                                       num_dynamic_file_list_entries,
2999                                       extra_file_hash,
3000                                       suffix_list,
3001                                       num_suffix_list_entries,
3002                                       token);
3003           add_property_mapping(property_mapping,
3004                                num_property_mapping_entries,
3005                                base_index, ext1_index, ext2_index, ext3_index,
3006                                current_summarized_file_list_entry);
3007           continue;
3008         }
3009       }
3010     }
3011   }
3012   END_HASH_ITERATION(extra_file_hash, itr)
3013
3014   if (artwork_info->num_dynamic_file_list_entries > 0)
3015   {
3016     artwork_info->dynamic_artwork_list =
3017       checked_calloc(artwork_info->num_dynamic_file_list_entries *
3018                      artwork_info->sizeof_artwork_list_entry);
3019   }
3020
3021   if (options.verbose && IS_PARENT_PROCESS())
3022   {
3023     SetupFileList *setup_file_list, *list;
3024     boolean dynamic_tokens_found = FALSE;
3025     boolean unknown_tokens_found = FALSE;
3026     boolean undefined_values_found = (hashtable_count(empty_file_hash) != 0);
3027
3028     if ((setup_file_list = loadSetupFileList(filename)) == NULL)
3029       Error(ERR_EXIT, "loadSetupFileHash works, but loadSetupFileList fails");
3030
3031     BEGIN_HASH_ITERATION(extra_file_hash, itr)
3032     {
3033       if (strEqual(HASH_ITERATION_VALUE(itr), known_token_value))
3034         dynamic_tokens_found = TRUE;
3035       else
3036         unknown_tokens_found = TRUE;
3037     }
3038     END_HASH_ITERATION(extra_file_hash, itr)
3039
3040     if (options.debug && dynamic_tokens_found)
3041     {
3042       Error(ERR_INFO_LINE, "-");
3043       Error(ERR_INFO, "dynamic token(s) found in config file:");
3044       Error(ERR_INFO, "- config file: '%s'", filename);
3045
3046       for (list = setup_file_list; list != NULL; list = list->next)
3047       {
3048         char *value = getHashEntry(extra_file_hash, list->token);
3049
3050         if (value != NULL && strEqual(value, known_token_value))
3051           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3052       }
3053
3054       Error(ERR_INFO_LINE, "-");
3055     }
3056
3057     if (unknown_tokens_found)
3058     {
3059       Error(ERR_INFO_LINE, "-");
3060       Error(ERR_INFO, "warning: unknown token(s) found in config file:");
3061       Error(ERR_INFO, "- config file: '%s'", filename);
3062
3063       for (list = setup_file_list; list != NULL; list = list->next)
3064       {
3065         char *value = getHashEntry(extra_file_hash, list->token);
3066
3067         if (value != NULL && !strEqual(value, known_token_value))
3068           Error(ERR_INFO, "- dynamic token: '%s'", list->token);
3069       }
3070
3071       Error(ERR_INFO_LINE, "-");
3072     }
3073
3074     if (undefined_values_found)
3075     {
3076       Error(ERR_INFO_LINE, "-");
3077       Error(ERR_INFO, "warning: undefined values found in config file:");
3078       Error(ERR_INFO, "- config file: '%s'", filename);
3079
3080       for (list = setup_file_list; list != NULL; list = list->next)
3081       {
3082         char *value = getHashEntry(empty_file_hash, list->token);
3083
3084         if (value != NULL)
3085           Error(ERR_INFO, "- undefined value for token: '%s'", list->token);
3086       }
3087
3088       Error(ERR_INFO_LINE, "-");
3089     }
3090
3091     freeSetupFileList(setup_file_list);
3092   }
3093
3094   freeSetupFileHash(extra_file_hash);
3095   freeSetupFileHash(empty_file_hash);
3096
3097 #if 0
3098   for (i = 0; i < num_file_list_entries; i++)
3099   {
3100     printf("'%s' ", file_list[i].token);
3101     if (file_list[i].filename)
3102       printf("-> '%s'\n", file_list[i].filename);
3103     else
3104       printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
3105   }
3106 #endif
3107 }
3108
3109 void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
3110 {
3111   struct FileInfo *file_list = artwork_info->file_list;
3112   int num_file_list_entries = artwork_info->num_file_list_entries;
3113   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
3114   char *filename_base = UNDEFINED_FILENAME, *filename_local;
3115   int i, j;
3116
3117   DrawInitText("Loading artwork config", 120, FC_GREEN);
3118   DrawInitText(ARTWORKINFO_FILENAME(artwork_info->type), 150, FC_YELLOW);
3119
3120   /* always start with reliable default values */
3121   for (i = 0; i < num_file_list_entries; i++)
3122   {
3123     setString(&file_list[i].filename, file_list[i].default_filename);
3124
3125     for (j = 0; j < num_suffix_list_entries; j++)
3126       setString(&file_list[i].parameter[j], file_list[i].default_parameter[j]);
3127
3128     file_list[i].redefined = FALSE;
3129     file_list[i].fallback_to_default = FALSE;
3130   }
3131
3132   /* free previous dynamic artwork file array */
3133   if (artwork_info->dynamic_file_list != NULL)
3134   {
3135     for (i = 0; i < artwork_info->num_dynamic_file_list_entries; i++)
3136     {
3137       free(artwork_info->dynamic_file_list[i].token);
3138       free(artwork_info->dynamic_file_list[i].filename);
3139       free(artwork_info->dynamic_file_list[i].parameter);
3140     }
3141
3142     free(artwork_info->dynamic_file_list);
3143     artwork_info->dynamic_file_list = NULL;
3144
3145     FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3146                           &artwork_info->num_dynamic_file_list_entries);
3147   }
3148
3149   /* free previous property mapping */
3150   if (artwork_info->property_mapping != NULL)
3151   {
3152     free(artwork_info->property_mapping);
3153
3154     artwork_info->property_mapping = NULL;
3155     artwork_info->num_property_mapping_entries = 0;
3156   }
3157
3158 #if 1
3159   if (!GFX_OVERRIDE_ARTWORK(artwork_info->type))
3160 #else
3161   if (!SETUP_OVERRIDE_ARTWORK(setup, artwork_info->type))
3162 #endif
3163   {
3164     /* first look for special artwork configured in level series config */
3165     filename_base = getCustomArtworkLevelConfigFilename(artwork_info->type);
3166
3167 #if 0
3168     printf("::: filename_base == '%s' [%s, %s]\n", filename_base,
3169            leveldir_current->graphics_set,
3170            leveldir_current->graphics_path);
3171 #endif
3172
3173     if (fileExists(filename_base))
3174       LoadArtworkConfigFromFilename(artwork_info, filename_base);
3175   }
3176
3177   filename_local = getCustomArtworkConfigFilename(artwork_info->type);
3178
3179   if (filename_local != NULL && !strEqual(filename_base, filename_local))
3180     LoadArtworkConfigFromFilename(artwork_info, filename_local);
3181 }
3182
3183 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
3184                                    struct ListNodeInfo **listnode)
3185 {
3186   if (*listnode)
3187   {
3188     char *filename = (*listnode)->source_filename;
3189
3190     if (--(*listnode)->num_references <= 0)
3191       deleteNodeFromList(&artwork_info->content_list, filename,
3192                          artwork_info->free_artwork);
3193
3194     *listnode = NULL;
3195   }
3196 }
3197
3198 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
3199                                     struct ListNodeInfo **listnode,
3200                                     struct FileInfo *file_list_entry)
3201 {
3202   char *init_text[] =
3203   {
3204     "Loading graphics",
3205     "Loading sounds",
3206     "Loading music"
3207   };
3208
3209   ListNode *node;
3210   char *basename = file_list_entry->filename;
3211   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
3212
3213   if (filename == NULL)
3214   {
3215     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
3216
3217     basename = file_list_entry->default_filename;
3218
3219     /* fail for cloned default artwork that has no default filename defined */
3220     if (file_list_entry->default_is_cloned &&
3221         strEqual(basename, UNDEFINED_FILENAME))
3222     {
3223       int error_mode = ERR_WARN;
3224
3225       /* we can get away without sounds and music, but not without graphics */
3226       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3227         error_mode = ERR_EXIT;
3228
3229       Error(error_mode, "token '%s' was cloned and has no default filename",
3230             file_list_entry->token);
3231
3232       return;
3233     }
3234
3235     /* dynamic artwork has no default filename / skip empty default artwork */
3236     if (basename == NULL || strEqual(basename, UNDEFINED_FILENAME))
3237       return;
3238
3239     file_list_entry->fallback_to_default = TRUE;
3240
3241     Error(ERR_WARN, "trying default artwork file '%s'", basename);
3242
3243     filename = getCustomArtworkFilename(basename, artwork_info->type);
3244
3245     if (filename == NULL)
3246     {
3247       int error_mode = ERR_WARN;
3248
3249       /* we can get away without sounds and music, but not without graphics */
3250       if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3251         error_mode = ERR_EXIT;
3252
3253       Error(error_mode, "cannot find default artwork file '%s'", basename);
3254
3255       return;
3256     }
3257   }
3258
3259   /* check if the old and the new artwork file are the same */
3260   if (*listnode && strEqual((*listnode)->source_filename, filename))
3261   {
3262     /* The old and new artwork are the same (have the same filename and path).
3263        This usually means that this artwork does not exist in this artwork set
3264        and a fallback to the existing artwork is done. */
3265
3266 #if 0
3267     printf("[artwork '%s' already exists (same list entry)]\n", filename);
3268 #endif
3269
3270     return;
3271   }
3272
3273   /* delete existing artwork file entry */
3274   deleteArtworkListEntry(artwork_info, listnode);
3275
3276   /* check if the new artwork file already exists in the list of artworks */
3277   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
3278   {
3279 #if 0
3280       printf("[artwork '%s' already exists (other list entry)]\n", filename);
3281 #endif
3282
3283       *listnode = (struct ListNodeInfo *)node->content;
3284       (*listnode)->num_references++;
3285
3286       return;
3287   }
3288
3289   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
3290   DrawInitText(basename, 150, FC_YELLOW);
3291
3292   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
3293   {
3294 #if 0
3295       printf("[adding new artwork '%s']\n", filename);
3296 #endif
3297
3298     (*listnode)->num_references = 1;
3299     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
3300                   *listnode);
3301   }
3302   else
3303   {
3304     int error_mode = ERR_WARN;
3305
3306     /* we can get away without sounds and music, but not without graphics */
3307     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
3308       error_mode = ERR_EXIT;
3309
3310     Error(error_mode, "cannot load artwork file '%s'", basename);
3311
3312     return;
3313   }
3314 }
3315
3316 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
3317                               struct ListNodeInfo **listnode,
3318                               struct FileInfo *file_list_entry)
3319 {
3320 #if 0
3321   printf("GOT CUSTOM ARTWORK FILE '%s'\n", file_list_entry->filename);
3322 #endif
3323
3324   if (strEqual(file_list_entry->filename, UNDEFINED_FILENAME))
3325   {
3326     deleteArtworkListEntry(artwork_info, listnode);
3327     return;
3328   }
3329
3330   replaceArtworkListEntry(artwork_info, listnode, file_list_entry);
3331 }
3332
3333 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
3334 {
3335   struct FileInfo *file_list = artwork_info->file_list;
3336   struct FileInfo *dynamic_file_list = artwork_info->dynamic_file_list;
3337   int num_file_list_entries = artwork_info->num_file_list_entries;
3338   int num_dynamic_file_list_entries =
3339     artwork_info->num_dynamic_file_list_entries;
3340   int i;
3341
3342   for (i = 0; i < num_file_list_entries; i++)
3343     LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[i],
3344                       &file_list[i]);
3345
3346   for (i = 0; i < num_dynamic_file_list_entries; i++)
3347     LoadCustomArtwork(artwork_info, &artwork_info->dynamic_artwork_list[i],
3348                       &dynamic_file_list[i]);
3349
3350 #if 0
3351   dumpList(artwork_info->content_list);
3352 #endif
3353 }
3354
3355 static void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info,
3356                                   struct ListNodeInfo ***list,
3357                                   int *num_list_entries)
3358 {
3359   int i;
3360
3361   if (*list == NULL)
3362     return;
3363
3364   for (i = 0; i < *num_list_entries; i++)
3365     deleteArtworkListEntry(artwork_info, &(*list)[i]);
3366   free(*list);
3367
3368   *list = NULL;
3369   *num_list_entries = 0;
3370 }
3371
3372 void FreeCustomArtworkLists(struct ArtworkListInfo *artwork_info)
3373 {
3374   if (artwork_info == NULL)
3375     return;
3376
3377   FreeCustomArtworkList(artwork_info, &artwork_info->artwork_list,
3378                         &artwork_info->num_file_list_entries);
3379
3380   FreeCustomArtworkList(artwork_info, &artwork_info->dynamic_artwork_list,
3381                         &artwork_info->num_dynamic_file_list_entries);
3382 }
3383
3384
3385 /* ------------------------------------------------------------------------- */
3386 /* functions only needed for non-Unix (non-command-line) systems             */
3387 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
3388 /* (now also added for Windows, to create files in user data directory)      */
3389 /* ------------------------------------------------------------------------- */
3390
3391 char *getErrorFilename(char *basename)
3392 {
3393   return getPath2(getUserGameDataDir(), basename);
3394 }
3395
3396 void openErrorFile()
3397 {
3398   InitUserDataDirectory();
3399
3400   if ((program.error_file = fopen(program.error_filename, MODE_WRITE)) == NULL)
3401   {
3402     program.error_file = stderr;
3403
3404     Error(ERR_WARN, "cannot open file '%s' for writing: %s",
3405           program.error_filename, strerror(errno));
3406   }
3407 }
3408
3409 void closeErrorFile()
3410 {
3411   if (program.error_file != stderr)     /* do not close stream 'stderr' */
3412     fclose(program.error_file);
3413 }
3414
3415 void dumpErrorFile()
3416 {
3417   FILE *error_file = fopen(program.error_filename, MODE_READ);
3418
3419   if (error_file != NULL)
3420   {
3421     while (!feof(error_file))
3422       fputc(fgetc(error_file), stderr);
3423
3424     fclose(error_file);
3425   }
3426 }
3427
3428 void NotifyUserAboutErrorFile()
3429 {
3430 #if defined(PLATFORM_WIN32)
3431   char *title_text = getStringCat2(program.program_title, " Error Message");
3432   char *error_text = getStringCat2("The program was aborted due to an error; "
3433                                    "for details, see the following error file:"
3434                                    STRING_NEWLINE, program.error_filename);
3435
3436   MessageBox(NULL, error_text, title_text, MB_OK);
3437 #endif
3438 }
3439
3440
3441 /* ------------------------------------------------------------------------- */
3442 /* the following is only for debugging purpose and normally not used         */
3443 /* ------------------------------------------------------------------------- */
3444
3445 #if DEBUG
3446
3447 #define DEBUG_NUM_TIMESTAMPS            5
3448 #define DEBUG_TIME_IN_MICROSECONDS      0
3449
3450 #if DEBUG_TIME_IN_MICROSECONDS
3451 static double Counter_Microseconds()
3452 {
3453   static struct timeval base_time = { 0, 0 };
3454   struct timeval current_time;
3455   double counter;
3456
3457   gettimeofday(&current_time, NULL);
3458
3459   /* reset base time in case of wrap-around */
3460   if (current_time.tv_sec < base_time.tv_sec)
3461     base_time = current_time;
3462
3463   counter =
3464     ((double)(current_time.tv_sec  - base_time.tv_sec)) * 1000000 +
3465     ((double)(current_time.tv_usec - base_time.tv_usec));
3466
3467   return counter;               /* return microseconds since last init */
3468 }
3469 #endif
3470
3471 char *debug_print_timestamp_get_padding(int padding_size)
3472 {
3473   static char *padding = NULL;
3474   int max_padding_size = 100;
3475
3476   if (padding == NULL)
3477   {
3478     padding = checked_calloc(max_padding_size + 1);
3479     memset(padding, ' ', max_padding_size);
3480   }
3481
3482   return &padding[MAX(0, max_padding_size - padding_size)];
3483 }
3484
3485 void debug_print_timestamp(int counter_nr, char *message)
3486 {
3487   int indent_size = 8;
3488   int padding_size = 40;
3489   float timestamp_interval;
3490
3491   if (counter_nr < 0)
3492     Error(ERR_EXIT, "debugging: invalid negative counter");
3493   else if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
3494     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
3495
3496 #if DEBUG_TIME_IN_MICROSECONDS
3497   static double counter[DEBUG_NUM_TIMESTAMPS][2];
3498   char *unit = "ms";
3499
3500   counter[counter_nr][0] = Counter_Microseconds();
3501 #else
3502   static int counter[DEBUG_NUM_TIMESTAMPS][2];
3503   char *unit = "s";
3504
3505   counter[counter_nr][0] = Counter();
3506 #endif
3507
3508   timestamp_interval = counter[counter_nr][0] - counter[counter_nr][1];
3509   counter[counter_nr][1] = counter[counter_nr][0];
3510
3511   if (message)
3512     printf("%s%s%s %.3f %s\n",
3513            debug_print_timestamp_get_padding(counter_nr * indent_size),
3514            message,
3515            debug_print_timestamp_get_padding(padding_size - strlen(message)),
3516            timestamp_interval / 1000,
3517            unit);
3518 }
3519
3520 void debug_print_parent_only(char *format, ...)
3521 {
3522   if (!IS_PARENT_PROCESS())
3523     return;
3524
3525   if (format)
3526   {
3527     va_list ap;
3528
3529     va_start(ap, format);
3530     vprintf(format, ap);
3531     va_end(ap);
3532
3533     printf("\n");
3534   }
3535 }
3536 #endif