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