src/libgame/misc.c

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