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
  34
  35 #if defined(PLATFORM_MSDOS)
  36 volatile unsigned long counter = 0;
  37
  38 void increment_counter()
  39 {
  40   counter++;
  41 }
  42
  43 END_OF_FUNCTION(increment_counter);
  44 #endif
  45
  46
  47 /* maximal allowed length of a command line option */
  48 #define MAX_OPTION_LEN          256
  49
  50 #ifdef TARGET_SDL
  51 static unsigned long mainCounter(int mode)
  52 {
  53   static unsigned long base_ms = 0;
  54   unsigned long current_ms;
  55   unsigned long counter_ms;
  56
  57   current_ms = SDL_GetTicks();
  58
  59   /* reset base time in case of counter initializing or wrap-around */
  60   if (mode == INIT_COUNTER || current_ms < base_ms)
  61     base_ms = current_ms;
  62
  63   counter_ms = current_ms - base_ms;
  64
  65   return counter_ms;            /* return milliseconds since last init */
  66 }
  67
  68 #else /* !TARGET_SDL */
  69
  70 #if defined(PLATFORM_UNIX)
  71 static unsigned long mainCounter(int mode)
  72 {
  73   static struct timeval base_time = { 0, 0 };
  74   struct timeval current_time;
  75   unsigned long counter_ms;
  76
  77   gettimeofday(&current_time, NULL);
  78
  79   /* reset base time in case of counter initializing or wrap-around */
  80   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
  81     base_time = current_time;
  82
  83   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
  84              + (current_time.tv_usec - base_time.tv_usec) / 1000;
  85
  86   return counter_ms;            /* return milliseconds since last init */
  87 }
  88 #endif /* PLATFORM_UNIX */
  89 #endif /* !TARGET_SDL */
  90
  91 void InitCounter()              /* set counter back to zero */
  92 {
  93 #if !defined(PLATFORM_MSDOS)
  94   mainCounter(INIT_COUNTER);
  95 #else
  96   LOCK_VARIABLE(counter);
  97   LOCK_FUNCTION(increment_counter);
  98   install_int_ex(increment_counter, BPS_TO_TIMER(100));
  99 #endif
 100 }
 101
 102 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
 103 {
 104 #if !defined(PLATFORM_MSDOS)
 105   return mainCounter(READ_COUNTER);
 106 #else
 107   return (counter * 10);
 108 #endif
 109 }
 110
 111 static void sleep_milliseconds(unsigned long milliseconds_delay)
 112 {
 113   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
 114
 115 #if 0
 116 #if defined(PLATFORM_MSDOS)
 117   /* don't use select() to perform waiting operations under DOS
 118      environment; always use a busy loop for waiting instead */
 119   do_busy_waiting = TRUE;
 120 #endif
 121 #endif
 122
 123   if (do_busy_waiting)
 124   {
 125     /* we want to wait only a few ms -- if we assume that we have a
 126        kernel timer resolution of 10 ms, we would wait far to long;
 127        therefore it's better to do a short interval of busy waiting
 128        to get our sleeping time more accurate */
 129
 130     unsigned long base_counter = Counter(), actual_counter = Counter();
 131
 132     while (actual_counter < base_counter + milliseconds_delay &&
 133            actual_counter >= base_counter)
 134       actual_counter = Counter();
 135   }
 136   else
 137   {
 138 #if defined(TARGET_SDL)
 139     SDL_Delay(milliseconds_delay);
 140 #elif defined(TARGET_ALLEGRO)
 141     rest(milliseconds_delay);
 142 #else
 143     struct timeval delay;
 144
 145     delay.tv_sec  = milliseconds_delay / 1000;
 146     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 147
 148     if (select(0, NULL, NULL, NULL, &delay) != 0)
 149       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
 150 #endif
 151   }
 152 }
 153
 154 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
 155 {
 156   sleep_milliseconds(delay);
 157 }
 158
 159 boolean FrameReached(unsigned long *frame_counter_var,
 160                      unsigned long frame_delay)
 161 {
 162   unsigned long actual_frame_counter = FrameCounter;
 163
 164   if (actual_frame_counter < *frame_counter_var + frame_delay &&
 165       actual_frame_counter >= *frame_counter_var)
 166     return FALSE;
 167
 168   *frame_counter_var = actual_frame_counter;
 169
 170   return TRUE;
 171 }
 172
 173 boolean DelayReached(unsigned long *counter_var,
 174                      unsigned long delay)
 175 {
 176   unsigned long actual_counter = Counter();
 177
 178   if (actual_counter < *counter_var + delay &&
 179       actual_counter >= *counter_var)
 180     return FALSE;
 181
 182   *counter_var = actual_counter;
 183
 184   return TRUE;
 185 }
 186
 187 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 188 {
 189   unsigned long actual_counter;
 190
 191   while(1)
 192   {
 193     actual_counter = Counter();
 194
 195     if (actual_counter < *counter_var + delay &&
 196         actual_counter >= *counter_var)
 197       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 198     else
 199       break;
 200   }
 201
 202   *counter_var = actual_counter;
 203 }
 204
 205 /* int2str() returns a number converted to a string;
 206    the used memory is static, but will be overwritten by later calls,
 207    so if you want to save the result, copy it to a private string buffer;
 208    there can be 10 local calls of int2str() without buffering the result --
 209    the 11th call will then destroy the result from the first call and so on.
 210 */
 211
 212 char *int2str(int number, int size)
 213 {
 214   static char shift_array[10][40];
 215   static int shift_counter = 0;
 216   char *s = shift_array[shift_counter];
 217
 218   shift_counter = (shift_counter + 1) % 10;
 219
 220   if (size > 20)
 221     size = 20;
 222
 223   if (size)
 224   {
 225     sprintf(s, "                    %09d", number);
 226     return &s[strlen(s) - size];
 227   }
 228   else
 229   {
 230     sprintf(s, "%d", number);
 231     return s;
 232   }
 233 }
 234
 235 unsigned int SimpleRND(unsigned int max)
 236 {
 237 #if defined(TARGET_SDL)
 238   static unsigned long root = 654321;
 239   unsigned long current_ms;
 240
 241   current_ms = SDL_GetTicks();
 242   root = root * 4253261 + current_ms;
 243   return (root % max);
 244 #else
 245   static unsigned long root = 654321;
 246   struct timeval current_time;
 247
 248   gettimeofday(&current_time, NULL);
 249   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
 250   return (root % max);
 251 #endif
 252 }
 253
 254 #ifdef DEBUG
 255 static unsigned int last_RND_value = 0;
 256
 257 unsigned int last_RND()
 258 {
 259   return last_RND_value;
 260 }
 261 #endif
 262
 263 unsigned int RND(unsigned int max)
 264 {
 265 #ifdef DEBUG
 266   return (last_RND_value = random_linux_libc() % max);
 267 #else
 268   return (random_linux_libc() % max);
 269 #endif
 270 }
 271
 272 unsigned int InitRND(long seed)
 273 {
 274 #if defined(TARGET_SDL)
 275   unsigned long current_ms;
 276
 277   if (seed == NEW_RANDOMIZE)
 278   {
 279     current_ms = SDL_GetTicks();
 280     srandom_linux_libc((unsigned int) current_ms);
 281     return (unsigned int) current_ms;
 282   }
 283   else
 284   {
 285     srandom_linux_libc((unsigned int) seed);
 286     return (unsigned int) seed;
 287   }
 288 #else
 289   struct timeval current_time;
 290
 291   if (seed == NEW_RANDOMIZE)
 292   {
 293     gettimeofday(&current_time, NULL);
 294     srandom_linux_libc((unsigned int) current_time.tv_usec);
 295     return (unsigned int) current_time.tv_usec;
 296   }
 297   else
 298   {
 299     srandom_linux_libc((unsigned int) seed);
 300     return (unsigned int) seed;
 301   }
 302 #endif
 303 }
 304
 305 char *getLoginName()
 306 {
 307 #if defined(PLATFORM_WIN32)
 308   return ANONYMOUS_NAME;
 309 #else
 310   static char *login_name = NULL;
 311
 312   if (login_name == NULL)
 313   {
 314     struct passwd *pwd;
 315
 316     if ((pwd = getpwuid(getuid())) == NULL)
 317       login_name = ANONYMOUS_NAME;
 318     else
 319       login_name = getStringCopy(pwd->pw_name);
 320   }
 321
 322   return login_name;
 323 #endif
 324 }
 325
 326 char *getRealName()
 327 {
 328 #if defined(PLATFORM_UNIX)
 329   struct passwd *pwd;
 330
 331   if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
 332     return ANONYMOUS_NAME;
 333   else
 334   {
 335     static char real_name[1024];
 336     char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
 337
 338     if (strchr(pwd->pw_gecos, 'ß') == NULL)
 339       return pwd->pw_gecos;
 340
 341     /* the user's real name contains a 'ß' character (german sharp s),
 342        which has no equivalent in upper case letters (which our fonts use) */
 343     while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
 344     {
 345       if (*from_ptr != 'ß')
 346         *to_ptr++ = *from_ptr++;
 347       else
 348       {
 349         from_ptr++;
 350         *to_ptr++ = 's';
 351         *to_ptr++ = 's';
 352       }
 353     }
 354     *to_ptr = '\0';
 355
 356     return real_name;
 357   }
 358 #else /* !PLATFORM_UNIX */
 359   return ANONYMOUS_NAME;
 360 #endif
 361 }
 362
 363 char *getHomeDir()
 364 {
 365 #if defined(PLATFORM_UNIX)
 366   static char *home_dir = NULL;
 367
 368   if (home_dir == NULL)
 369   {
 370     if ((home_dir = getenv("HOME")) == NULL)
 371     {
 372       struct passwd *pwd;
 373
 374       if ((pwd = getpwuid(getuid())) == NULL)
 375         home_dir = ".";
 376       else
 377         home_dir = getStringCopy(pwd->pw_dir);
 378     }
 379   }
 380
 381   return home_dir;
 382 #else
 383   return ".";
 384 #endif
 385 }
 386
 387 char *getPath2(char *path1, char *path2)
 388 {
 389   char *complete_path = checked_malloc(strlen(path1) + 1 +
 390                                        strlen(path2) + 1);
 391
 392   sprintf(complete_path, "%s/%s", path1, path2);
 393   return complete_path;
 394 }
 395
 396 char *getPath3(char *path1, char *path2, char *path3)
 397 {
 398   char *complete_path = checked_malloc(strlen(path1) + 1 +
 399                                        strlen(path2) + 1 +
 400                                        strlen(path3) + 1);
 401
 402   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 403   return complete_path;
 404 }
 405
 406 static char *getStringCat2(char *s1, char *s2)
 407 {
 408   char *complete_string = checked_malloc(strlen(s1) + strlen(s2) + 1);
 409
 410   sprintf(complete_string, "%s%s", s1, s2);
 411   return complete_string;
 412 }
 413
 414 char *getStringCopy(char *s)
 415 {
 416   char *s_copy;
 417
 418   if (s == NULL)
 419     return NULL;
 420
 421   s_copy = checked_malloc(strlen(s) + 1);
 422
 423   strcpy(s_copy, s);
 424   return s_copy;
 425 }
 426
 427 char *getStringToLower(char *s)
 428 {
 429   char *s_copy = checked_malloc(strlen(s) + 1);
 430   char *s_ptr = s_copy;
 431
 432   while (*s)
 433     *s_ptr++ = tolower(*s++);
 434   *s_ptr = '\0';
 435
 436   return s_copy;
 437 }
 438
 439 static void printUsage()
 440 {
 441   printf("\n"
 442          "Usage: %s [OPTION]... [HOSTNAME [PORT]]\n"
 443          "\n"
 444          "Options:\n"
 445          "  -d, --display HOSTNAME[:SCREEN]  specify X server display\n"
 446          "  -b, --basepath DIRECTORY         alternative base DIRECTORY\n"
 447          "  -l, --level DIRECTORY            alternative level DIRECTORY\n"
 448          "  -g, --graphics DIRECTORY         alternative graphics DIRECTORY\n"
 449          "  -s, --sounds DIRECTORY           alternative sounds DIRECTORY\n"
 450          "  -m, --music DIRECTORY            alternative music DIRECTORY\n"
 451          "  -n, --network                    network multiplayer game\n"
 452          "      --serveronly                 only start network server\n"
 453          "  -v, --verbose                    verbose mode\n"
 454          "      --debug                      display debugging information\n"
 455          "  -e, --execute COMMAND            execute batch COMMAND:\n"
 456          "\n"
 457          "Valid commands for '--execute' option:\n"
 458          "  \"print graphicsinfo.conf\"        print default graphics config\n"
 459          "  \"print soundsinfo.conf\"          print default sounds config\n"
 460          "  \"print musicinfo.conf\"           print default music config\n"
 461          "  \"dump tape FILE\"                 dump tape data from FILE\n"
 462          "  \"autoplay LEVELDIR\"              play level tapes for LEVELDIR\n"
 463          "\n",
 464          program.command_basename);
 465 }
 466
 467 void GetOptions(char *argv[])
 468 {
 469   char **options_left = &argv[1];
 470
 471   /* initialize global program options */
 472   options.display_name = NULL;
 473   options.server_host = NULL;
 474   options.server_port = 0;
 475   options.ro_base_directory = RO_BASE_PATH;
 476   options.rw_base_directory = RW_BASE_PATH;
 477   options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
 478   options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
 479   options.sounds_directory = RO_BASE_PATH "/" SOUNDS_DIRECTORY;
 480   options.music_directory = RO_BASE_PATH "/" MUSIC_DIRECTORY;
 481   options.execute_command = NULL;
 482   options.serveronly = FALSE;
 483   options.network = FALSE;
 484   options.verbose = FALSE;
 485   options.debug = FALSE;
 486
 487   while (*options_left)
 488   {
 489     char option_str[MAX_OPTION_LEN];
 490     char *option = options_left[0];
 491     char *next_option = options_left[1];
 492     char *option_arg = NULL;
 493     int option_len = strlen(option);
 494
 495     if (option_len >= MAX_OPTION_LEN)
 496       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 497
 498     strcpy(option_str, option);                 /* copy argument into buffer */
 499     option = option_str;
 500
 501     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 502       break;
 503
 504     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 505       option++;
 506
 507     option_arg = strchr(option, '=');
 508     if (option_arg == NULL)                     /* no '=' in option */
 509       option_arg = next_option;
 510     else
 511     {
 512       *option_arg++ = '\0';                     /* cut argument from option */
 513       if (*option_arg == '\0')                  /* no argument after '=' */
 514         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 515     }
 516
 517     option_len = strlen(option);
 518
 519     if (strcmp(option, "-") == 0)
 520       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 521     else if (strncmp(option, "-help", option_len) == 0)
 522     {
 523       printUsage();
 524
 525       exit(0);
 526     }
 527     else if (strncmp(option, "-display", option_len) == 0)
 528     {
 529       if (option_arg == NULL)
 530         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 531
 532       options.display_name = option_arg;
 533       if (option_arg == next_option)
 534         options_left++;
 535     }
 536     else if (strncmp(option, "-basepath", option_len) == 0)
 537     {
 538       if (option_arg == NULL)
 539         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 540
 541       /* this should be extended to separate options for ro and rw data */
 542       options.ro_base_directory = option_arg;
 543       options.rw_base_directory = option_arg;
 544       if (option_arg == next_option)
 545         options_left++;
 546
 547       /* adjust path for level directory accordingly */
 548       options.level_directory =
 549         getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
 550     }
 551     else if (strncmp(option, "-levels", option_len) == 0)
 552     {
 553       if (option_arg == NULL)
 554         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 555
 556       options.level_directory = option_arg;
 557       if (option_arg == next_option)
 558         options_left++;
 559     }
 560     else if (strncmp(option, "-graphics", option_len) == 0)
 561     {
 562       if (option_arg == NULL)
 563         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 564
 565       options.graphics_directory = option_arg;
 566       if (option_arg == next_option)
 567         options_left++;
 568     }
 569     else if (strncmp(option, "-sounds", option_len) == 0)
 570     {
 571       if (option_arg == NULL)
 572         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 573
 574       options.sounds_directory = option_arg;
 575       if (option_arg == next_option)
 576         options_left++;
 577     }
 578     else if (strncmp(option, "-music", option_len) == 0)
 579     {
 580       if (option_arg == NULL)
 581         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 582
 583       options.music_directory = option_arg;
 584       if (option_arg == next_option)
 585         options_left++;
 586     }
 587     else if (strncmp(option, "-network", option_len) == 0)
 588     {
 589       options.network = TRUE;
 590     }
 591     else if (strncmp(option, "-serveronly", option_len) == 0)
 592     {
 593       options.serveronly = TRUE;
 594     }
 595     else if (strncmp(option, "-verbose", option_len) == 0)
 596     {
 597       options.verbose = TRUE;
 598     }
 599     else if (strncmp(option, "-debug", option_len) == 0)
 600     {
 601       options.debug = TRUE;
 602     }
 603     else if (strncmp(option, "-execute", option_len) == 0)
 604     {
 605       if (option_arg == NULL)
 606         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 607
 608       options.execute_command = option_arg;
 609       if (option_arg == next_option)
 610         options_left++;
 611     }
 612     else if (*option == '-')
 613     {
 614       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 615     }
 616     else if (options.server_host == NULL)
 617     {
 618       options.server_host = *options_left;
 619     }
 620     else if (options.server_port == 0)
 621     {
 622       options.server_port = atoi(*options_left);
 623       if (options.server_port < 1024)
 624         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 625     }
 626     else
 627       Error(ERR_EXIT_HELP, "too many arguments");
 628
 629     options_left++;
 630   }
 631 }
 632
 633 /* used by SetError() and GetError() to store internal error messages */
 634 static char internal_error[1024];       /* this is bad */
 635
 636 void SetError(char *format, ...)
 637 {
 638   va_list ap;
 639
 640   va_start(ap, format);
 641   vsprintf(internal_error, format, ap);
 642   va_end(ap);
 643 }
 644
 645 char *GetError()
 646 {
 647   return internal_error;
 648 }
 649
 650 void Error(int mode, char *format, ...)
 651 {
 652   char *process_name = "";
 653   FILE *error = stderr;
 654   char *newline = "\n";
 655
 656   /* display warnings only when running in verbose mode */
 657   if (mode & ERR_WARN && !options.verbose)
 658     return;
 659
 660 #if defined(PLATFORM_MSDOS)
 661   newline = "\r\n";
 662
 663   if ((error = openErrorFile()) == NULL)
 664   {
 665     printf("Cannot write to error output file!%s", newline);
 666     program.exit_function(1);
 667   }
 668 #endif
 669
 670   if (mode & ERR_SOUND_SERVER)
 671     process_name = " sound server";
 672   else if (mode & ERR_NETWORK_SERVER)
 673     process_name = " network server";
 674   else if (mode & ERR_NETWORK_CLIENT)
 675     process_name = " network client **";
 676
 677   if (format)
 678   {
 679     va_list ap;
 680
 681     fprintf(error, "%s%s: ", program.command_basename, process_name);
 682
 683     if (mode & ERR_WARN)
 684       fprintf(error, "warning: ");
 685
 686     va_start(ap, format);
 687     vfprintf(error, format, ap);
 688     va_end(ap);
 689
 690     fprintf(error, "%s", newline);
 691   }
 692
 693   if (mode & ERR_HELP)
 694     fprintf(error, "%s: Try option '--help' for more information.%s",
 695             program.command_basename, newline);
 696
 697   if (mode & ERR_EXIT)
 698     fprintf(error, "%s%s: aborting%s",
 699             program.command_basename, process_name, newline);
 700
 701   if (error != stderr)
 702     fclose(error);
 703
 704   if (mode & ERR_EXIT)
 705   {
 706     if (mode & ERR_FROM_SERVER)
 707       exit(1);                          /* child process: normal exit */
 708     else
 709       program.exit_function(1);         /* main process: clean up stuff */
 710   }
 711 }
 712
 713 void *checked_malloc(unsigned long size)
 714 {
 715   void *ptr;
 716
 717   ptr = malloc(size);
 718
 719   if (ptr == NULL)
 720     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 721
 722   return ptr;
 723 }
 724
 725 void *checked_calloc(unsigned long size)
 726 {
 727   void *ptr;
 728
 729   ptr = calloc(1, size);
 730
 731   if (ptr == NULL)
 732     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 733
 734   return ptr;
 735 }
 736
 737 void *checked_realloc(void *ptr, unsigned long size)
 738 {
 739   ptr = realloc(ptr, size);
 740
 741   if (ptr == NULL)
 742     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 743
 744   return ptr;
 745 }
 746
 747 inline void swap_numbers(int *i1, int *i2)
 748 {
 749   int help = *i1;
 750
 751   *i1 = *i2;
 752   *i2 = help;
 753 }
 754
 755 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
 756 {
 757   int help_x = *x1;
 758   int help_y = *y1;
 759
 760   *x1 = *x2;
 761   *x2 = help_x;
 762
 763   *y1 = *y2;
 764   *y2 = help_y;
 765 }
 766
 767 short getFile16BitInteger(FILE *file, int byte_order)
 768 {
 769   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 770     return ((fgetc(file) <<  8) |
 771             (fgetc(file) <<  0));
 772   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 773     return ((fgetc(file) <<  0) |
 774             (fgetc(file) <<  8));
 775 }
 776
 777 void putFile16BitInteger(FILE *file, short value, int byte_order)
 778 {
 779   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 780   {
 781     fputc((value >>  8) & 0xff, file);
 782     fputc((value >>  0) & 0xff, file);
 783   }
 784   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 785   {
 786     fputc((value >>  0) & 0xff, file);
 787     fputc((value >>  8) & 0xff, file);
 788   }
 789 }
 790
 791 int getFile32BitInteger(FILE *file, int byte_order)
 792 {
 793   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 794     return ((fgetc(file) << 24) |
 795             (fgetc(file) << 16) |
 796             (fgetc(file) <<  8) |
 797             (fgetc(file) <<  0));
 798   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 799     return ((fgetc(file) <<  0) |
 800             (fgetc(file) <<  8) |
 801             (fgetc(file) << 16) |
 802             (fgetc(file) << 24));
 803 }
 804
 805 void putFile32BitInteger(FILE *file, int value, int byte_order)
 806 {
 807   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 808   {
 809     fputc((value >> 24) & 0xff, file);
 810     fputc((value >> 16) & 0xff, file);
 811     fputc((value >>  8) & 0xff, file);
 812     fputc((value >>  0) & 0xff, file);
 813   }
 814   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 815   {
 816     fputc((value >>  0) & 0xff, file);
 817     fputc((value >>  8) & 0xff, file);
 818     fputc((value >> 16) & 0xff, file);
 819     fputc((value >> 24) & 0xff, file);
 820   }
 821 }
 822
 823 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
 824                      int byte_order)
 825 {
 826   const int chunk_name_length = 4;
 827
 828   /* read chunk name */
 829   fgets(chunk_name, chunk_name_length + 1, file);
 830
 831   if (chunk_size != NULL)
 832   {
 833     /* read chunk size */
 834     *chunk_size = getFile32BitInteger(file, byte_order);
 835   }
 836
 837   return (feof(file) || ferror(file) ? FALSE : TRUE);
 838 }
 839
 840 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
 841                   int byte_order)
 842 {
 843   /* write chunk name */
 844   fputs(chunk_name, file);
 845
 846   if (chunk_size >= 0)
 847   {
 848     /* write chunk size */
 849     putFile32BitInteger(file, chunk_size, byte_order);
 850   }
 851 }
 852
 853 int getFileVersion(FILE *file)
 854 {
 855   int version_major, version_minor, version_patch;
 856
 857   version_major = fgetc(file);
 858   version_minor = fgetc(file);
 859   version_patch = fgetc(file);
 860   fgetc(file);          /* not used */
 861
 862   return VERSION_IDENT(version_major, version_minor, version_patch);
 863 }
 864
 865 void putFileVersion(FILE *file, int version)
 866 {
 867   int version_major = VERSION_MAJOR(version);
 868   int version_minor = VERSION_MINOR(version);
 869   int version_patch = VERSION_PATCH(version);
 870
 871   fputc(version_major, file);
 872   fputc(version_minor, file);
 873   fputc(version_patch, file);
 874   fputc(0, file);       /* not used */
 875 }
 876
 877 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
 878 {
 879   while (bytes-- && !feof(file))
 880     fgetc(file);
 881 }
 882
 883 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
 884 {
 885   while (bytes--)
 886     fputc(0, file);
 887 }
 888
 889
 890 /* ------------------------------------------------------------------------- */
 891 /* functions to translate key identifiers between different format           */
 892 /* ------------------------------------------------------------------------- */
 893
 894 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 895 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 896 #define TRANSLATE_KEYNAME_TO_KEYSYM     2
 897 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  3
 898
 899 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
 900 {
 901   static struct
 902   {
 903     Key key;
 904     char *x11name;
 905     char *name;
 906   } translate_key[] =
 907   {
 908     /* normal cursor keys */
 909     { KSYM_Left,        "XK_Left",              "cursor left" },
 910     { KSYM_Right,       "XK_Right",             "cursor right" },
 911     { KSYM_Up,          "XK_Up",                "cursor up" },
 912     { KSYM_Down,        "XK_Down",              "cursor down" },
 913
 914     /* keypad cursor keys */
 915 #ifdef KSYM_KP_Left
 916     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
 917     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
 918     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
 919     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
 920 #endif
 921
 922     /* other keypad keys */
 923 #ifdef KSYM_KP_Enter
 924     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
 925     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
 926     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
 927     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
 928     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
 929     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
 930 #endif
 931
 932     /* modifier keys */
 933     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
 934     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
 935     { KSYM_Control_L,   "XK_Control_L",         "left control" },
 936     { KSYM_Control_R,   "XK_Control_R",         "right control" },
 937     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
 938     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
 939     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
 940     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
 941     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
 942     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
 943     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
 944     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
 945
 946     /* some special keys */
 947     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
 948     { KSYM_Delete,      "XK_Delete",            "delete" },
 949     { KSYM_Insert,      "XK_Insert",            "insert" },
 950     { KSYM_Tab,         "XK_Tab",               "tab" },
 951     { KSYM_Home,        "XK_Home",              "home" },
 952     { KSYM_End,         "XK_End",               "end" },
 953     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
 954     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
 955     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
 956
 957     /* ASCII 0x20 to 0x40 keys (except numbers) */
 958     { KSYM_space,       "XK_space",             "space" },
 959     { KSYM_exclam,      "XK_exclam",            "!" },
 960     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
 961     { KSYM_numbersign,  "XK_numbersign",        "#" },
 962     { KSYM_dollar,      "XK_dollar",            "$" },
 963     { KSYM_percent,     "XK_percent",           "%" },
 964     { KSYM_ampersand,   "XK_ampersand",         "&" },
 965     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
 966     { KSYM_parenleft,   "XK_parenleft",         "(" },
 967     { KSYM_parenright,  "XK_parenright",        ")" },
 968     { KSYM_asterisk,    "XK_asterisk",          "*" },
 969     { KSYM_plus,        "XK_plus",              "+" },
 970     { KSYM_comma,       "XK_comma",             "," },
 971     { KSYM_minus,       "XK_minus",             "-" },
 972     { KSYM_period,      "XK_period",            "." },
 973     { KSYM_slash,       "XK_slash",             "/" },
 974     { KSYM_colon,       "XK_colon",             ":" },
 975     { KSYM_semicolon,   "XK_semicolon",         ";" },
 976     { KSYM_less,        "XK_less",              "<" },
 977     { KSYM_equal,       "XK_equal",             "=" },
 978     { KSYM_greater,     "XK_greater",           ">" },
 979     { KSYM_question,    "XK_question",          "?" },
 980     { KSYM_at,          "XK_at",                "@" },
 981
 982     /* more ASCII keys */
 983     { KSYM_bracketleft, "XK_bracketleft",       "[" },
 984     { KSYM_backslash,   "XK_backslash",         "backslash" },
 985     { KSYM_bracketright,"XK_bracketright",      "]" },
 986     { KSYM_asciicircum, "XK_asciicircum",       "circumflex" },
 987     { KSYM_underscore,  "XK_underscore",        "_" },
 988     { KSYM_grave,       "XK_grave",             "grave" },
 989     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
 990     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
 991     { KSYM_bar,         "XK_bar",               "bar" },
 992     { KSYM_braceright,  "XK_braceright",        "brace right" },
 993     { KSYM_asciitilde,  "XK_asciitilde",        "ascii tilde" },
 994
 995     /* special (non-ASCII) keys */
 996     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
 997     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
 998     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
 999     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
1000     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
1001     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
1002     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
1003
1004     /* end-of-array identifier */
1005     { 0,                NULL,                   NULL }
1006   };
1007
1008   int i;
1009
1010   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
1011   {
1012     static char name_buffer[30];
1013     Key key = *keysym;
1014
1015     if (key >= KSYM_A && key <= KSYM_Z)
1016       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
1017     else if (key >= KSYM_a && key <= KSYM_z)
1018       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
1019     else if (key >= KSYM_0 && key <= KSYM_9)
1020       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
1021     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1022       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
1023     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1024       sprintf(name_buffer, "function F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1025     else if (key == KSYM_UNDEFINED)
1026       strcpy(name_buffer, "(undefined)");
1027     else
1028     {
1029       i = 0;
1030
1031       do
1032       {
1033         if (key == translate_key[i].key)
1034         {
1035           strcpy(name_buffer, translate_key[i].name);
1036           break;
1037         }
1038       }
1039       while (translate_key[++i].name);
1040
1041       if (!translate_key[i].name)
1042         strcpy(name_buffer, "(unknown)");
1043     }
1044
1045     *name = name_buffer;
1046   }
1047   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
1048   {
1049     static char name_buffer[30];
1050     Key key = *keysym;
1051
1052     if (key >= KSYM_A && key <= KSYM_Z)
1053       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
1054     else if (key >= KSYM_a && key <= KSYM_z)
1055       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
1056     else if (key >= KSYM_0 && key <= KSYM_9)
1057       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
1058     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
1059       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
1060     else if (key >= KSYM_FKEY_FIRST && key <= KSYM_FKEY_LAST)
1061       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_FKEY_FIRST + 1));
1062     else if (key == KSYM_UNDEFINED)
1063       strcpy(name_buffer, "[undefined]");
1064     else
1065     {
1066       i = 0;
1067
1068       do
1069       {
1070         if (key == translate_key[i].key)
1071         {
1072           strcpy(name_buffer, translate_key[i].x11name);
1073           break;
1074         }
1075       }
1076       while (translate_key[++i].x11name);
1077
1078       if (!translate_key[i].x11name)
1079         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
1080     }
1081
1082     *x11name = name_buffer;
1083   }
1084   else if (mode == TRANSLATE_KEYNAME_TO_KEYSYM)
1085   {
1086     Key key = KSYM_UNDEFINED;
1087
1088     i = 0;
1089     do
1090     {
1091       if (strcmp(translate_key[i].name, *name) == 0)
1092       {
1093         key = translate_key[i].key;
1094         break;
1095       }
1096     }
1097     while (translate_key[++i].x11name);
1098
1099     if (key == KSYM_UNDEFINED)
1100       Error(ERR_WARN, "getKeyFromKeyName(): not completely implemented");
1101
1102     *keysym = key;
1103   }
1104   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
1105   {
1106     Key key = KSYM_UNDEFINED;
1107     char *name_ptr = *x11name;
1108
1109     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
1110     {
1111       char c = name_ptr[3];
1112
1113       if (c >= 'A' && c <= 'Z')
1114         key = KSYM_A + (Key)(c - 'A');
1115       else if (c >= 'a' && c <= 'z')
1116         key = KSYM_a + (Key)(c - 'a');
1117       else if (c >= '0' && c <= '9')
1118         key = KSYM_0 + (Key)(c - '0');
1119     }
1120     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
1121     {
1122       char c = name_ptr[6];
1123
1124       if (c >= '0' && c <= '9')
1125         key = KSYM_0 + (Key)(c - '0');
1126     }
1127     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
1128     {
1129       char c1 = name_ptr[4];
1130       char c2 = name_ptr[5];
1131       int d = 0;
1132
1133       if ((c1 >= '0' && c1 <= '9') &&
1134           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
1135         d = atoi(&name_ptr[4]);
1136
1137       if (d >= 1 && d <= KSYM_NUM_FKEYS)
1138         key = KSYM_F1 + (Key)(d - 1);
1139     }
1140     else if (strncmp(name_ptr, "XK_", 3) == 0)
1141     {
1142       i = 0;
1143
1144       do
1145       {
1146         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
1147         {
1148           key = translate_key[i].key;
1149           break;
1150         }
1151       }
1152       while (translate_key[++i].x11name);
1153     }
1154     else if (strncmp(name_ptr, "0x", 2) == 0)
1155     {
1156       unsigned long value = 0;
1157
1158       name_ptr += 2;
1159
1160       while (name_ptr)
1161       {
1162         char c = *name_ptr++;
1163         int d = -1;
1164
1165         if (c >= '0' && c <= '9')
1166           d = (int)(c - '0');
1167         else if (c >= 'a' && c <= 'f')
1168           d = (int)(c - 'a' + 10);
1169         else if (c >= 'A' && c <= 'F')
1170           d = (int)(c - 'A' + 10);
1171
1172         if (d == -1)
1173         {
1174           value = -1;
1175           break;
1176         }
1177
1178         value = value * 16 + d;
1179       }
1180
1181       if (value != -1)
1182         key = (Key)value;
1183     }
1184
1185     *keysym = key;
1186   }
1187 }
1188
1189 char *getKeyNameFromKey(Key key)
1190 {
1191   char *name;
1192
1193   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1194   return name;
1195 }
1196
1197 char *getX11KeyNameFromKey(Key key)
1198 {
1199   char *x11name;
1200
1201   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1202   return x11name;
1203 }
1204
1205 Key getKeyFromKeyName(char *name)
1206 {
1207   Key key;
1208
1209   translate_keyname(&key, NULL, &name, TRANSLATE_KEYNAME_TO_KEYSYM);
1210   return key;
1211 }
1212
1213 Key getKeyFromX11KeyName(char *x11name)
1214 {
1215   Key key;
1216
1217   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1218   return key;
1219 }
1220
1221 char getCharFromKey(Key key)
1222 {
1223   char *keyname = getKeyNameFromKey(key);
1224   char letter = 0;
1225
1226   if (strlen(keyname) == 1)
1227     letter = keyname[0];
1228   else if (strcmp(keyname, "space") == 0)
1229     letter = ' ';
1230   else if (strcmp(keyname, "circumflex") == 0)
1231     letter = '^';
1232
1233   return letter;
1234 }
1235
1236
1237 /* ------------------------------------------------------------------------- */
1238 /* functions to translate string identifiers to integer or boolean value     */
1239 /* ------------------------------------------------------------------------- */
1240
1241 int get_integer_from_string(char *s)
1242 {
1243   static char *number_text[][3] =
1244   {
1245     { "0", "zero", "null", },
1246     { "1", "one", "first" },
1247     { "2", "two", "second" },
1248     { "3", "three", "third" },
1249     { "4", "four", "fourth" },
1250     { "5", "five", "fifth" },
1251     { "6", "six", "sixth" },
1252     { "7", "seven", "seventh" },
1253     { "8", "eight", "eighth" },
1254     { "9", "nine", "ninth" },
1255     { "10", "ten", "tenth" },
1256     { "11", "eleven", "eleventh" },
1257     { "12", "twelve", "twelfth" },
1258   };
1259
1260   int i, j;
1261   char *s_lower = getStringToLower(s);
1262   int result = -1;
1263
1264   for (i=0; i<13; i++)
1265     for (j=0; j<3; j++)
1266       if (strcmp(s_lower, number_text[i][j]) == 0)
1267         result = i;
1268
1269   if (result == -1)
1270     result = atoi(s);
1271
1272   free(s_lower);
1273
1274   return result;
1275 }
1276
1277 boolean get_boolean_from_string(char *s)
1278 {
1279   char *s_lower = getStringToLower(s);
1280   boolean result = FALSE;
1281
1282   if (strcmp(s_lower, "true") == 0 ||
1283       strcmp(s_lower, "yes") == 0 ||
1284       strcmp(s_lower, "on") == 0 ||
1285       get_integer_from_string(s) == 1)
1286     result = TRUE;
1287
1288   free(s_lower);
1289
1290   return result;
1291 }
1292
1293
1294 /* ========================================================================= */
1295 /* functions for generic lists                                               */
1296 /* ========================================================================= */
1297
1298 ListNode *newListNode()
1299 {
1300   return checked_calloc(sizeof(ListNode));
1301 }
1302
1303 void addNodeToList(ListNode **node_first, char *key, void *content)
1304 {
1305   ListNode *node_new = newListNode();
1306
1307 #if 0
1308   printf("LIST: adding node with key '%s'\n", key);
1309 #endif
1310
1311   node_new->key = getStringCopy(key);
1312   node_new->content = content;
1313   node_new->next = *node_first;
1314   *node_first = node_new;
1315 }
1316
1317 void deleteNodeFromList(ListNode **node_first, char *key,
1318                         void (*destructor_function)(void *))
1319 {
1320   if (node_first == NULL || *node_first == NULL)
1321     return;
1322
1323 #if 0
1324   printf("[CHECKING LIST KEY '%s' == '%s']\n",
1325          (*node_first)->key, key);
1326 #endif
1327
1328   if (strcmp((*node_first)->key, key) == 0)
1329   {
1330 #if 0
1331     printf("[DELETING LIST ENTRY]\n");
1332 #endif
1333
1334     free((*node_first)->key);
1335     if (destructor_function)
1336       destructor_function((*node_first)->content);
1337     *node_first = (*node_first)->next;
1338   }
1339   else
1340     deleteNodeFromList(&(*node_first)->next, key, destructor_function);
1341 }
1342
1343 ListNode *getNodeFromKey(ListNode *node_first, char *key)
1344 {
1345   if (node_first == NULL)
1346     return NULL;
1347
1348   if (strcmp(node_first->key, key) == 0)
1349     return node_first;
1350   else
1351     return getNodeFromKey(node_first->next, key);
1352 }
1353
1354 int getNumNodes(ListNode *node_first)
1355 {
1356   return (node_first ? 1 + getNumNodes(node_first->next) : 0);
1357 }
1358
1359 void dumpList(ListNode *node_first)
1360 {
1361   ListNode *node = node_first;
1362
1363   while (node)
1364   {
1365     printf("['%s' (%d)]\n", node->key,
1366            ((struct ListNodeInfo *)node->content)->num_references);
1367     node = node->next;
1368   }
1369
1370   printf("[%d nodes]\n", getNumNodes(node_first));
1371 }
1372
1373
1374 /* ========================================================================= */
1375 /* functions for checking filenames                                          */
1376 /* ========================================================================= */
1377
1378 boolean FileIsGraphic(char *filename)
1379 {
1380   if (strlen(filename) > 4 &&
1381       strcmp(&filename[strlen(filename) - 4], ".pcx") == 0)
1382     return TRUE;
1383
1384   return FALSE;
1385 }
1386
1387 boolean FileIsSound(char *basename)
1388 {
1389   if (strlen(basename) > 4 &&
1390       strcmp(&basename[strlen(basename) - 4], ".wav") == 0)
1391     return TRUE;
1392
1393   return FALSE;
1394 }
1395
1396 boolean FileIsMusic(char *basename)
1397 {
1398   /* "music" can be a WAV (loop) file or (if compiled with SDL) a MOD file */
1399
1400   if (FileIsSound(basename))
1401     return TRUE;
1402
1403 #if defined(TARGET_SDL)
1404   if (strlen(basename) > 4 &&
1405       (strcmp(&basename[strlen(basename) - 4], ".mod") == 0 ||
1406        strcmp(&basename[strlen(basename) - 4], ".MOD") == 0 ||
1407        strncmp(basename, "mod.", 4) == 0 ||
1408        strncmp(basename, "MOD.", 4) == 0))
1409     return TRUE;
1410 #endif
1411
1412   return FALSE;
1413 }
1414
1415 boolean FileIsArtworkType(char *basename, int type)
1416 {
1417   if ((type == TREE_TYPE_GRAPHICS_DIR && FileIsGraphic(basename)) ||
1418       (type == TREE_TYPE_SOUNDS_DIR && FileIsSound(basename)) ||
1419       (type == TREE_TYPE_MUSIC_DIR && FileIsMusic(basename)))
1420     return TRUE;
1421
1422   return FALSE;
1423 }
1424
1425 /* ========================================================================= */
1426 /* functions for loading artwork configuration information                   */
1427 /* ========================================================================= */
1428
1429 static int get_parameter_value(int type, char *value)
1430 {
1431   return (type == TYPE_INTEGER ? get_integer_from_string(value) :
1432           type == TYPE_BOOLEAN ? get_boolean_from_string(value) :
1433           -1);
1434 }
1435
1436 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *config_list,
1437                                            struct ConfigInfo *suffix_list,
1438                                            int num_file_list_entries)
1439 {
1440   struct FileInfo *file_list;
1441   int num_file_list_entries_found = 0;
1442   int num_suffix_list_entries = 0;
1443   int list_pos = 0;
1444   int i, j;
1445
1446   file_list = checked_calloc(num_file_list_entries * sizeof(struct FileInfo));
1447
1448   for (i=0; suffix_list[i].token != NULL; i++)
1449     num_suffix_list_entries++;
1450
1451   /* always start with reliable default values */
1452   for (i=0; i<num_file_list_entries; i++)
1453   {
1454     file_list[i].token = NULL;
1455     file_list[i].default_filename = NULL;
1456     file_list[i].filename = NULL;
1457
1458     if (num_suffix_list_entries > 0)
1459     {
1460       int parameter_array_size = num_suffix_list_entries * sizeof(int);
1461
1462       file_list[i].default_parameter = checked_calloc(parameter_array_size);
1463       file_list[i].parameter = checked_calloc(parameter_array_size);
1464
1465       for (j=0; j<num_suffix_list_entries; j++)
1466       {
1467         int default_parameter =
1468           get_parameter_value(suffix_list[j].type, suffix_list[j].value);
1469
1470         file_list[i].default_parameter[j] = default_parameter;
1471         file_list[i].parameter[j] = default_parameter;
1472       }
1473     }
1474   }
1475
1476   for (i=0; config_list[i].token != NULL; i++)
1477   {
1478     int len_config_token = strlen(config_list[i].token);
1479     int len_config_value = strlen(config_list[i].value);
1480     boolean is_file_entry = TRUE;
1481
1482     for (j=0; suffix_list[j].token != NULL; j++)
1483     {
1484       int len_suffix = strlen(suffix_list[j].token);
1485
1486       if (len_suffix < len_config_token &&
1487           strcmp(&config_list[i].token[len_config_token - len_suffix],
1488                  suffix_list[j].token) == 0)
1489       {
1490         file_list[list_pos].default_parameter[j] =
1491           get_parameter_value(suffix_list[j].type, config_list[i].value);
1492
1493         is_file_entry = FALSE;
1494         break;
1495       }
1496     }
1497
1498     if (is_file_entry)
1499     {
1500       if (i > 0)
1501         list_pos++;
1502
1503       if (list_pos >= num_file_list_entries)
1504         break;
1505
1506       /* simple sanity check if this is really a file definition */
1507       if (strcmp(&config_list[i].value[len_config_value - 4], ".pcx") != 0 &&
1508           strcmp(&config_list[i].value[len_config_value - 4], ".wav") != 0 &&
1509           strcmp(config_list[i].value, UNDEFINED_FILENAME) != 0)
1510       {
1511         Error(ERR_RETURN, "Configuration directive '%s' -> '%s':",
1512               config_list[i].token, config_list[i].value);
1513         Error(ERR_EXIT, "This seems to be no valid definition -- please fix");
1514       }
1515
1516       file_list[list_pos].token = config_list[i].token;
1517       file_list[list_pos].default_filename = config_list[i].value;
1518     }
1519   }
1520
1521   num_file_list_entries_found = list_pos + 1;
1522   if (num_file_list_entries_found != num_file_list_entries)
1523   {
1524     Error(ERR_RETURN, "inconsistant config list information:");
1525     Error(ERR_RETURN, "- should be:   %d (according to 'src/conf_gfx.h')",
1526           num_file_list_entries);
1527     Error(ERR_RETURN, "- found to be: %d (according to 'src/conf_gfx.c')",
1528           num_file_list_entries_found);
1529     Error(ERR_EXIT,   "please fix");
1530   }
1531
1532   return file_list;
1533 }
1534
1535 static void LoadArtworkConfig(struct ArtworkListInfo *artwork_info)
1536 {
1537   struct FileInfo *file_list = artwork_info->file_list;
1538   struct ConfigInfo *suffix_list = artwork_info->suffix_list;
1539   int num_file_list_entries = artwork_info->num_file_list_entries;
1540   int num_suffix_list_entries = artwork_info->num_suffix_list_entries;
1541   char *filename = getCustomArtworkConfigFilename(artwork_info->type);
1542   struct SetupFileList *setup_file_list;
1543   int i, j;
1544
1545 #if 0
1546   printf("GOT CUSTOM ARTWORK CONFIG FILE '%s'\n", filename);
1547 #endif
1548
1549   /* always start with reliable default values */
1550   for (i=0; i<num_file_list_entries; i++)
1551   {
1552     if (file_list[i].filename != NULL)
1553       free(file_list[i].filename);
1554     file_list[i].filename = NULL;
1555
1556     for (j=0; j<num_suffix_list_entries; j++)
1557       file_list[i].parameter[j] = file_list[i].default_parameter[j];
1558   }
1559
1560   if (filename == NULL)
1561     return;
1562
1563   if ((setup_file_list = loadSetupFileList(filename)))
1564   {
1565     for (i=0; i<num_file_list_entries; i++)
1566     {
1567       char *filename = getTokenValue(setup_file_list, file_list[i].token);
1568
1569       if (filename)
1570         for (j=0; j<num_suffix_list_entries; j++)
1571           file_list[i].parameter[j] =
1572             get_parameter_value(suffix_list[j].type, suffix_list[j].value);
1573       else
1574         filename = file_list[i].default_filename;
1575
1576       file_list[i].filename = getStringCopy(filename);
1577
1578       for (j=0; j<num_suffix_list_entries; j++)
1579       {
1580         char *token = getStringCat2(file_list[i].token, suffix_list[j].token);
1581         char *value = getTokenValue(setup_file_list, token);
1582
1583         if (value != NULL)
1584           file_list[i].parameter[j] =
1585             get_parameter_value(suffix_list[j].type, value);
1586
1587         free(token);
1588       }
1589     }
1590
1591     freeSetupFileList(setup_file_list);
1592
1593 #if 0
1594     for (i=0; i<num_file_list_entries; i++)
1595     {
1596       printf("'%s' ", file_list[i].token);
1597       if (file_list[i].filename)
1598         printf("-> '%s'\n", file_list[i].filename);
1599       else
1600         printf("-> UNDEFINED [-> '%s']\n", file_list[i].default_filename);
1601     }
1602 #endif
1603   }
1604 }
1605
1606 static void deleteArtworkListEntry(struct ArtworkListInfo *artwork_info,
1607                                    struct ListNodeInfo **listnode)
1608 {
1609   if (*listnode)
1610   {
1611     char *filename = (*listnode)->source_filename;
1612
1613 #if 0
1614     printf("[decrementing reference counter of artwork '%s']\n", filename);
1615 #endif
1616
1617     if (--(*listnode)->num_references <= 0)
1618     {
1619 #if 0
1620       printf("[deleting artwork '%s']\n", filename);
1621 #endif
1622
1623       deleteNodeFromList(&artwork_info->content_list, filename,
1624                          artwork_info->free_artwork);
1625     }
1626
1627     *listnode = NULL;
1628   }
1629 }
1630
1631 static void replaceArtworkListEntry(struct ArtworkListInfo *artwork_info,
1632                                     struct ListNodeInfo **listnode,
1633                                     char *basename)
1634 {
1635   char *init_text[] =
1636   { "",
1637     "Loading graphics:",
1638     "Loading sounds:",
1639     "Loading music:"
1640   };
1641
1642   ListNode *node;
1643   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
1644
1645   if (filename == NULL)
1646   {
1647     int error_mode = ERR_WARN;
1648
1649     /* we can get away without sounds and music, but not without graphics */
1650     if (*listnode == NULL && artwork_info->type == ARTWORK_TYPE_GRAPHICS)
1651       error_mode = ERR_EXIT;
1652
1653     Error(error_mode, "cannot find artwork file '%s'", basename);
1654     return;
1655   }
1656
1657   /* check if the old and the new artwork file are the same */
1658   if (*listnode && strcmp((*listnode)->source_filename, filename) == 0)
1659   {
1660     /* The old and new artwork are the same (have the same filename and path).
1661        This usually means that this artwork does not exist in this artwork set
1662        and a fallback to the existing artwork is done. */
1663
1664 #if 0
1665     printf("[artwork '%s' already exists (same list entry)]\n", filename);
1666 #endif
1667
1668     return;
1669   }
1670
1671   /* delete existing artwork file entry */
1672   deleteArtworkListEntry(artwork_info, listnode);
1673
1674   /* check if the new artwork file already exists in the list of artworks */
1675   if ((node = getNodeFromKey(artwork_info->content_list, filename)) != NULL)
1676   {
1677 #if 0
1678       printf("[artwork '%s' already exists (other list entry)]\n", filename);
1679 #endif
1680
1681       *listnode = (struct ListNodeInfo *)node->content;
1682       (*listnode)->num_references++;
1683
1684       return;
1685   }
1686
1687   DrawInitText(init_text[artwork_info->type], 120, FC_GREEN);
1688   DrawInitText(basename, 150, FC_YELLOW);
1689
1690   if ((*listnode = artwork_info->load_artwork(filename)) != NULL)
1691   {
1692 #if 0
1693       printf("[adding new artwork '%s']\n", filename);
1694 #endif
1695
1696     (*listnode)->num_references = 1;
1697     addNodeToList(&artwork_info->content_list, (*listnode)->source_filename,
1698                   *listnode);
1699   }
1700   else
1701   {
1702     int error_mode = ERR_WARN;
1703
1704     /* we can get away without sounds and music, but not without graphics */
1705     if (artwork_info->type == ARTWORK_TYPE_GRAPHICS)
1706       error_mode = ERR_EXIT;
1707
1708     Error(error_mode, "cannot load artwork file '%s'", basename);
1709     return;
1710   }
1711 }
1712
1713 static void LoadCustomArtwork(struct ArtworkListInfo *artwork_info,
1714                               struct ListNodeInfo **listnode,
1715                               char *basename)
1716 {
1717 #if 0
1718   char *filename = getCustomArtworkFilename(basename, artwork_info->type);
1719 #endif
1720
1721 #if 0
1722   printf("GOT CUSTOM ARTWORK FILE '%s'\n", filename);
1723 #endif
1724
1725   if (strcmp(basename, UNDEFINED_FILENAME) == 0)
1726   {
1727     deleteArtworkListEntry(artwork_info, listnode);
1728     return;
1729   }
1730
1731 #if 0
1732   if (filename == NULL)
1733   {
1734     Error(ERR_WARN, "cannot find artwork file '%s'", basename);
1735     return;
1736   }
1737
1738   replaceArtworkListEntry(artwork_info, listnode, filename);
1739 #else
1740   replaceArtworkListEntry(artwork_info, listnode, basename);
1741 #endif
1742 }
1743
1744 static void LoadArtworkToList(struct ArtworkListInfo *artwork_info,
1745                               char *basename, int list_pos)
1746 {
1747   if (artwork_info->artwork_list == NULL ||
1748       list_pos >= artwork_info->num_file_list_entries)
1749     return;
1750
1751 #if 0
1752   printf("loading artwork '%s' ...  [%d]\n",
1753          basename, getNumNodes(artwork_info->content_list));
1754 #endif
1755
1756   LoadCustomArtwork(artwork_info, &artwork_info->artwork_list[list_pos],
1757                     basename);
1758
1759 #if 0
1760   printf("loading artwork '%s' done [%d]\n",
1761          basename, getNumNodes(artwork_info->content_list));
1762 #endif
1763 }
1764
1765 void ReloadCustomArtworkList(struct ArtworkListInfo *artwork_info)
1766 {
1767 #if 0
1768   static struct
1769   {
1770     char *text;
1771     boolean do_it;
1772   }
1773   draw_init[] =
1774   {
1775     { "",                       FALSE },
1776     { "Loading graphics:",      TRUE },
1777     { "Loading sounds:",        TRUE },
1778     { "Loading music:",         TRUE }
1779   };
1780 #endif
1781
1782   int num_file_list_entries = artwork_info->num_file_list_entries;
1783   struct FileInfo *file_list = artwork_info->file_list;
1784   int i;
1785
1786   LoadArtworkConfig(artwork_info);
1787
1788 #if 0
1789   if (draw_init[artwork_info->type].do_it)
1790     DrawInitText(draw_init[artwork_info->type].text, 120, FC_GREEN);
1791 #endif
1792
1793 #if 0
1794   printf("DEBUG: reloading %d artwork files ...\n", num_file_list_entries);
1795 #endif
1796
1797   for(i=0; i<num_file_list_entries; i++)
1798   {
1799 #if 0
1800     if (draw_init[artwork_info->type].do_it)
1801       DrawInitText(file_list[i].token, 150, FC_YELLOW);
1802 #endif
1803
1804     LoadArtworkToList(artwork_info, file_list[i].filename, i);
1805
1806 #if 0
1807     printf("DEBUG:   loading artwork file '%s'...\n", file_list[i].filename);
1808 #endif
1809   }
1810
1811 #if 0
1812   draw_init[artwork_info->type].do_it = FALSE;
1813 #endif
1814
1815   /*
1816   printf("list size == %d\n", getNumNodes(artwork_info->content_list));
1817   */
1818
1819 #if 0
1820   dumpList(artwork_info->content_list);
1821 #endif
1822 }
1823
1824 void FreeCustomArtworkList(struct ArtworkListInfo *artwork_info)
1825 {
1826   int i;
1827
1828   if (artwork_info == NULL || artwork_info->artwork_list == NULL)
1829     return;
1830
1831 #if 0
1832   printf("%s: FREEING ARTWORK ...\n",
1833          IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
1834 #endif
1835
1836   for(i=0; i<artwork_info->num_file_list_entries; i++)
1837     deleteArtworkListEntry(artwork_info, &artwork_info->artwork_list[i]);
1838
1839 #if 0
1840   printf("%s: FREEING ARTWORK -- DONE\n",
1841          IS_CHILD_PROCESS(audio.mixer_pid) ? "CHILD" : "PARENT");
1842 #endif
1843
1844   free(artwork_info->artwork_list);
1845
1846   artwork_info->artwork_list = NULL;
1847   artwork_info->num_file_list_entries = 0;
1848 }
1849
1850
1851 /* ========================================================================= */
1852 /* functions only needed for non-Unix (non-command-line) systems             */
1853 /* (MS-DOS only; SDL/Windows creates files "stdout.txt" and "stderr.txt")    */
1854 /* ========================================================================= */
1855
1856 #if defined(PLATFORM_MSDOS)
1857
1858 #define ERROR_FILENAME          "stderr.txt"
1859
1860 void initErrorFile()
1861 {
1862   unlink(ERROR_FILENAME);
1863 }
1864
1865 FILE *openErrorFile()
1866 {
1867   return fopen(ERROR_FILENAME, MODE_APPEND);
1868 }
1869
1870 void dumpErrorFile()
1871 {
1872   FILE *error_file = fopen(ERROR_FILENAME, MODE_READ);
1873
1874   if (error_file != NULL)
1875   {
1876     while (!feof(error_file))
1877       fputc(fgetc(error_file), stderr);
1878
1879     fclose(error_file);
1880   }
1881 }
1882 #endif
1883
1884
1885 /* ========================================================================= */
1886 /* some generic helper functions                                             */
1887 /* ========================================================================= */
1888
1889 void printf_line(char line_char, int line_length)
1890 {
1891   int i;
1892
1893   for (i=0; i<line_length; i++)
1894     printf("%c", line_char);
1895
1896   printf("\n");
1897 }
1898
1899
1900 /* ========================================================================= */
1901 /* the following is only for debugging purpose and normally not used         */
1902 /* ========================================================================= */
1903
1904 #define DEBUG_NUM_TIMESTAMPS    3
1905
1906 void debug_print_timestamp(int counter_nr, char *message)
1907 {
1908   static long counter[DEBUG_NUM_TIMESTAMPS][2];
1909
1910   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1911     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1912
1913   counter[counter_nr][0] = Counter();
1914
1915   if (message)
1916     printf("%s %.2f seconds\n", message,
1917            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1918
1919   counter[counter_nr][1] = Counter();
1920 }