src/libgame/misc.c

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