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