src/libgame/misc.c

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