src/libgame/misc.c

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