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