src/libgame/misc.c

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