src/libgame/misc.c

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