src/libgame/misc.c

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