src/libgame/misc.c

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