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