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