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