src/libgame/misc.c

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