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