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