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