src/libgame/misc.c

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