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