src/libgame/misc.c

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2001 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 <sys/stat.h>
  18 #include <stdarg.h>
  19 #include <ctype.h>
  20 #include <string.h>
  21 #include <unistd.h>
  22
  23 #include "platform.h"
  24
  25 #if !defined(PLATFORM_WIN32)
  26 #include <pwd.h>
  27 #include <sys/param.h>
  28 #endif
  29
  30 #include "misc.h"
  31 #include "random.h"
  32
  33
  34 #if defined(PLATFORM_MSDOS)
  35 volatile unsigned long counter = 0;
  36
  37 void increment_counter()
  38 {
  39   counter++;
  40 }
  41
  42 END_OF_FUNCTION(increment_counter);
  43 #endif
  44
  45
  46 /* maximal allowed length of a command line option */
  47 #define MAX_OPTION_LEN          256
  48
  49 #ifdef TARGET_SDL
  50 static unsigned long mainCounter(int mode)
  51 {
  52   static unsigned long base_ms = 0;
  53   unsigned long current_ms;
  54   unsigned long counter_ms;
  55
  56   current_ms = SDL_GetTicks();
  57
  58   /* reset base time in case of counter initializing or wrap-around */
  59   if (mode == INIT_COUNTER || current_ms < base_ms)
  60     base_ms = current_ms;
  61
  62   counter_ms = current_ms - base_ms;
  63
  64   return counter_ms;            /* return milliseconds since last init */
  65 }
  66
  67 #else /* !TARGET_SDL */
  68
  69 #if defined(PLATFORM_UNIX)
  70 static unsigned long mainCounter(int mode)
  71 {
  72   static struct timeval base_time = { 0, 0 };
  73   struct timeval current_time;
  74   unsigned long counter_ms;
  75
  76   gettimeofday(&current_time, NULL);
  77
  78   /* reset base time in case of counter initializing or wrap-around */
  79   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
  80     base_time = current_time;
  81
  82   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
  83              + (current_time.tv_usec - base_time.tv_usec) / 1000;
  84
  85   return counter_ms;            /* return milliseconds since last init */
  86 }
  87 #endif /* PLATFORM_UNIX */
  88 #endif /* !TARGET_SDL */
  89
  90 void InitCounter()              /* set counter back to zero */
  91 {
  92 #if !defined(PLATFORM_MSDOS)
  93   mainCounter(INIT_COUNTER);
  94 #else
  95   LOCK_VARIABLE(counter);
  96   LOCK_FUNCTION(increment_counter);
  97   install_int_ex(increment_counter, BPS_TO_TIMER(100));
  98 #endif
  99 }
 100
 101 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
 102 {
 103 #if !defined(PLATFORM_MSDOS)
 104   return mainCounter(READ_COUNTER);
 105 #else
 106   return (counter * 10);
 107 #endif
 108 }
 109
 110 static void sleep_milliseconds(unsigned long milliseconds_delay)
 111 {
 112   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
 113
 114 #if defined(PLATFORM_MSDOS)
 115   /* don't use select() to perform waiting operations under DOS/Windows
 116      environment; always use a busy loop for waiting instead */
 117   do_busy_waiting = TRUE;
 118 #endif
 119
 120   if (do_busy_waiting)
 121   {
 122     /* we want to wait only a few ms -- if we assume that we have a
 123        kernel timer resolution of 10 ms, we would wait far to long;
 124        therefore it's better to do a short interval of busy waiting
 125        to get our sleeping time more accurate */
 126
 127     unsigned long base_counter = Counter(), actual_counter = Counter();
 128
 129     while (actual_counter < base_counter + milliseconds_delay &&
 130            actual_counter >= base_counter)
 131       actual_counter = Counter();
 132   }
 133   else
 134   {
 135 #if defined(TARGET_SDL)
 136     SDL_Delay(milliseconds_delay);
 137 #else
 138     struct timeval delay;
 139
 140     delay.tv_sec  = milliseconds_delay / 1000;
 141     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 142
 143     if (select(0, NULL, NULL, NULL, &delay) != 0)
 144       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
 145 #endif
 146   }
 147 }
 148
 149 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
 150 {
 151   sleep_milliseconds(delay);
 152 }
 153
 154 boolean FrameReached(unsigned long *frame_counter_var,
 155                      unsigned long frame_delay)
 156 {
 157   unsigned long actual_frame_counter = FrameCounter;
 158
 159   if (actual_frame_counter < *frame_counter_var+frame_delay &&
 160       actual_frame_counter >= *frame_counter_var)
 161     return(FALSE);
 162
 163   *frame_counter_var = actual_frame_counter;
 164   return(TRUE);
 165 }
 166
 167 boolean DelayReached(unsigned long *counter_var,
 168                      unsigned long delay)
 169 {
 170   unsigned long actual_counter = Counter();
 171
 172   if (actual_counter < *counter_var + delay &&
 173       actual_counter >= *counter_var)
 174     return(FALSE);
 175
 176   *counter_var = actual_counter;
 177   return(TRUE);
 178 }
 179
 180 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 181 {
 182   unsigned long actual_counter;
 183
 184   while(1)
 185   {
 186     actual_counter = Counter();
 187
 188     if (actual_counter < *counter_var + delay &&
 189         actual_counter >= *counter_var)
 190       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 191     else
 192       break;
 193   }
 194
 195   *counter_var = actual_counter;
 196 }
 197
 198 /* int2str() returns a number converted to a string;
 199    the used memory is static, but will be overwritten by later calls,
 200    so if you want to save the result, copy it to a private string buffer;
 201    there can be 10 local calls of int2str() without buffering the result --
 202    the 11th call will then destroy the result from the first call and so on.
 203 */
 204
 205 char *int2str(int number, int size)
 206 {
 207   static char shift_array[10][40];
 208   static int shift_counter = 0;
 209   char *s = shift_array[shift_counter];
 210
 211   shift_counter = (shift_counter + 1) % 10;
 212
 213   if (size > 20)
 214     size = 20;
 215
 216   if (size)
 217   {
 218     sprintf(s, "                    %09d", number);
 219     return &s[strlen(s) - size];
 220   }
 221   else
 222   {
 223     sprintf(s, "%d", number);
 224     return s;
 225   }
 226 }
 227
 228 unsigned int SimpleRND(unsigned int max)
 229 {
 230 #if defined(TARGET_SDL)
 231   static unsigned long root = 654321;
 232   unsigned long current_ms;
 233
 234   current_ms = SDL_GetTicks();
 235   root = root * 4253261 + current_ms;
 236   return (root % max);
 237 #else
 238   static unsigned long root = 654321;
 239   struct timeval current_time;
 240
 241   gettimeofday(&current_time, NULL);
 242   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
 243   return (root % max);
 244 #endif
 245 }
 246
 247 #ifdef DEBUG
 248 static unsigned int last_RND_value = 0;
 249
 250 unsigned int last_RND()
 251 {
 252   return last_RND_value;
 253 }
 254 #endif
 255
 256 unsigned int RND(unsigned int max)
 257 {
 258 #ifdef DEBUG
 259   return (last_RND_value = random_linux_libc() % max);
 260 #else
 261   return (random_linux_libc() % max);
 262 #endif
 263 }
 264
 265 unsigned int InitRND(long seed)
 266 {
 267 #if defined(TARGET_SDL)
 268   unsigned long current_ms;
 269
 270   if (seed == NEW_RANDOMIZE)
 271   {
 272     current_ms = SDL_GetTicks();
 273     srandom_linux_libc((unsigned int) current_ms);
 274     return (unsigned int) current_ms;
 275   }
 276   else
 277   {
 278     srandom_linux_libc((unsigned int) seed);
 279     return (unsigned int) seed;
 280   }
 281 #else
 282   struct timeval current_time;
 283
 284   if (seed == NEW_RANDOMIZE)
 285   {
 286     gettimeofday(&current_time, NULL);
 287     srandom_linux_libc((unsigned int) current_time.tv_usec);
 288     return (unsigned int) current_time.tv_usec;
 289   }
 290   else
 291   {
 292     srandom_linux_libc((unsigned int) seed);
 293     return (unsigned int) seed;
 294   }
 295 #endif
 296 }
 297
 298 char *getLoginName()
 299 {
 300 #if defined(PLATFORM_WIN32)
 301   return ANONYMOUS_NAME;
 302 #else
 303   struct passwd *pwd;
 304
 305   if ((pwd = getpwuid(getuid())) == NULL)
 306     return ANONYMOUS_NAME;
 307   else
 308     return pwd->pw_name;
 309 #endif
 310 }
 311
 312 char *getRealName()
 313 {
 314 #if defined(PLATFORM_UNIX)
 315   struct passwd *pwd;
 316
 317   if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
 318     return ANONYMOUS_NAME;
 319   else
 320   {
 321     static char real_name[1024];
 322     char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
 323
 324     if (strchr(pwd->pw_gecos, 'ß') == NULL)
 325       return pwd->pw_gecos;
 326
 327     /* the user's real name contains a 'ß' character (german sharp s),
 328        which has no equivalent in upper case letters (which our fonts use) */
 329     while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
 330     {
 331       if (*from_ptr != 'ß')
 332         *to_ptr++ = *from_ptr++;
 333       else
 334       {
 335         from_ptr++;
 336         *to_ptr++ = 's';
 337         *to_ptr++ = 's';
 338       }
 339     }
 340     *to_ptr = '\0';
 341
 342     return real_name;
 343   }
 344 #else /* !PLATFORM_UNIX */
 345   return ANONYMOUS_NAME;
 346 #endif
 347 }
 348
 349 char *getHomeDir()
 350 {
 351 #if defined(PLATFORM_UNIX)
 352   static char *home_dir = NULL;
 353
 354   if (!home_dir)
 355   {
 356     if (!(home_dir = getenv("HOME")))
 357     {
 358       struct passwd *pwd;
 359
 360       if ((pwd = getpwuid(getuid())))
 361         home_dir = pwd->pw_dir;
 362       else
 363         home_dir = ".";
 364     }
 365   }
 366
 367   return home_dir;
 368 #else
 369   return ".";
 370 #endif
 371 }
 372
 373 char *getPath2(char *path1, char *path2)
 374 {
 375   char *complete_path = checked_malloc(strlen(path1) + 1 +
 376                                        strlen(path2) + 1);
 377
 378   sprintf(complete_path, "%s/%s", path1, path2);
 379   return complete_path;
 380 }
 381
 382 char *getPath3(char *path1, char *path2, char *path3)
 383 {
 384   char *complete_path = checked_malloc(strlen(path1) + 1 +
 385                                        strlen(path2) + 1 +
 386                                        strlen(path3) + 1);
 387
 388   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 389   return complete_path;
 390 }
 391
 392 char *getStringCopy(char *s)
 393 {
 394   char *s_copy;
 395
 396   if (s == NULL)
 397     return NULL;
 398
 399   s_copy = checked_malloc(strlen(s) + 1);
 400
 401   strcpy(s_copy, s);
 402   return s_copy;
 403 }
 404
 405 char *getStringToLower(char *s)
 406 {
 407   char *s_copy = checked_malloc(strlen(s) + 1);
 408   char *s_ptr = s_copy;
 409
 410   while (*s)
 411     *s_ptr++ = tolower(*s++);
 412   *s_ptr = '\0';
 413
 414   return s_copy;
 415 }
 416
 417 void GetOptions(char *argv[])
 418 {
 419   char **options_left = &argv[1];
 420
 421   /* initialize global program options */
 422   options.display_name = NULL;
 423   options.server_host = NULL;
 424   options.server_port = 0;
 425   options.ro_base_directory = RO_BASE_PATH;
 426   options.rw_base_directory = RW_BASE_PATH;
 427   options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
 428   options.graphics_directory = RO_BASE_PATH "/" GRAPHICS_DIRECTORY;
 429   options.serveronly = FALSE;
 430   options.network = FALSE;
 431   options.verbose = FALSE;
 432   options.debug = FALSE;
 433
 434   while (*options_left)
 435   {
 436     char option_str[MAX_OPTION_LEN];
 437     char *option = options_left[0];
 438     char *next_option = options_left[1];
 439     char *option_arg = NULL;
 440     int option_len = strlen(option);
 441
 442     if (option_len >= MAX_OPTION_LEN)
 443       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 444
 445     strcpy(option_str, option);                 /* copy argument into buffer */
 446     option = option_str;
 447
 448     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 449       break;
 450
 451     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 452       option++;
 453
 454     option_arg = strchr(option, '=');
 455     if (option_arg == NULL)                     /* no '=' in option */
 456       option_arg = next_option;
 457     else
 458     {
 459       *option_arg++ = '\0';                     /* cut argument from option */
 460       if (*option_arg == '\0')                  /* no argument after '=' */
 461         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 462     }
 463
 464     option_len = strlen(option);
 465
 466     if (strcmp(option, "-") == 0)
 467       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 468     else if (strncmp(option, "-help", option_len) == 0)
 469     {
 470       printf("Usage: %s [options] [server.name [port]]\n"
 471              "Options:\n"
 472              "  -d, --display machine:0       X server display\n"
 473              "  -b, --basepath directory      alternative base directory\n"
 474              "  -l, --level directory         alternative level directory\n"
 475              "  -g, --graphics directory      alternative graphics directory\n"
 476              "  -n, --network                 network multiplayer game\n"
 477              "  -s, --serveronly              only start network server\n"
 478              "  -v, --verbose                 verbose mode\n"
 479              "      --debug                   display debugging information\n",
 480              program.command_basename);
 481       exit(0);
 482     }
 483     else if (strncmp(option, "-display", option_len) == 0)
 484     {
 485       if (option_arg == NULL)
 486         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 487
 488       options.display_name = option_arg;
 489       if (option_arg == next_option)
 490         options_left++;
 491     }
 492     else if (strncmp(option, "-basepath", option_len) == 0)
 493     {
 494       if (option_arg == NULL)
 495         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 496
 497       /* this should be extended to separate options for ro and rw data */
 498       options.ro_base_directory = option_arg;
 499       options.rw_base_directory = option_arg;
 500       if (option_arg == next_option)
 501         options_left++;
 502
 503       /* adjust path for level directory accordingly */
 504       options.level_directory =
 505         getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
 506     }
 507     else if (strncmp(option, "-levels", option_len) == 0)
 508     {
 509       if (option_arg == NULL)
 510         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 511
 512       options.level_directory = option_arg;
 513       if (option_arg == next_option)
 514         options_left++;
 515     }
 516     else if (strncmp(option, "-graphics", option_len) == 0)
 517     {
 518       if (option_arg == NULL)
 519         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 520
 521       options.graphics_directory = option_arg;
 522       if (option_arg == next_option)
 523         options_left++;
 524     }
 525     else if (strncmp(option, "-network", option_len) == 0)
 526     {
 527       options.network = TRUE;
 528     }
 529     else if (strncmp(option, "-serveronly", option_len) == 0)
 530     {
 531       options.serveronly = TRUE;
 532     }
 533     else if (strncmp(option, "-verbose", option_len) == 0)
 534     {
 535       options.verbose = TRUE;
 536     }
 537     else if (strncmp(option, "-debug", option_len) == 0)
 538     {
 539       options.debug = TRUE;
 540     }
 541     else if (*option == '-')
 542     {
 543       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 544     }
 545     else if (options.server_host == NULL)
 546     {
 547       options.server_host = *options_left;
 548     }
 549     else if (options.server_port == 0)
 550     {
 551       options.server_port = atoi(*options_left);
 552       if (options.server_port < 1024)
 553         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 554     }
 555     else
 556       Error(ERR_EXIT_HELP, "too many arguments");
 557
 558     options_left++;
 559   }
 560 }
 561
 562 void Error(int mode, char *format, ...)
 563 {
 564   char *process_name = "";
 565   FILE *error = stderr;
 566   char *newline = "\n";
 567
 568   /* display warnings only when running in verbose mode */
 569   if (mode & ERR_WARN && !options.verbose)
 570     return;
 571
 572 #if !defined(PLATFORM_UNIX)
 573   newline = "\r\n";
 574
 575   if ((error = openErrorFile()) == NULL)
 576   {
 577     printf("Cannot write to error output file!%s", newline);
 578     program.exit_function(1);
 579   }
 580 #endif
 581
 582   if (mode & ERR_SOUND_SERVER)
 583     process_name = " sound server";
 584   else if (mode & ERR_NETWORK_SERVER)
 585     process_name = " network server";
 586   else if (mode & ERR_NETWORK_CLIENT)
 587     process_name = " network client **";
 588
 589   if (format)
 590   {
 591     va_list ap;
 592
 593     fprintf(error, "%s%s: ", program.command_basename, process_name);
 594
 595     if (mode & ERR_WARN)
 596       fprintf(error, "warning: ");
 597
 598     va_start(ap, format);
 599     vfprintf(error, format, ap);
 600     va_end(ap);
 601
 602     fprintf(error, "%s", newline);
 603   }
 604
 605   if (mode & ERR_HELP)
 606     fprintf(error, "%s: Try option '--help' for more information.%s",
 607             program.command_basename, newline);
 608
 609   if (mode & ERR_EXIT)
 610     fprintf(error, "%s%s: aborting%s",
 611             program.command_basename, process_name, newline);
 612
 613   if (error != stderr)
 614     fclose(error);
 615
 616   if (mode & ERR_EXIT)
 617   {
 618     if (mode & ERR_FROM_SERVER)
 619       exit(1);                          /* child process: normal exit */
 620     else
 621       program.exit_function(1);         /* main process: clean up stuff */
 622   }
 623 }
 624
 625 void *checked_malloc(unsigned long size)
 626 {
 627   void *ptr;
 628
 629   ptr = malloc(size);
 630
 631   if (ptr == NULL)
 632     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 633
 634   return ptr;
 635 }
 636
 637 void *checked_calloc(unsigned long size)
 638 {
 639   void *ptr;
 640
 641   ptr = calloc(1, size);
 642
 643   if (ptr == NULL)
 644     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 645
 646   return ptr;
 647 }
 648
 649 void *checked_realloc(void *ptr, unsigned long size)
 650 {
 651   ptr = realloc(ptr, size);
 652
 653   if (ptr == NULL)
 654     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 655
 656   return ptr;
 657 }
 658
 659 short getFile16BitInteger(FILE *file, int byte_order)
 660 {
 661   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 662     return ((fgetc(file) <<  8) |
 663             (fgetc(file) <<  0));
 664   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 665     return ((fgetc(file) <<  0) |
 666             (fgetc(file) <<  8));
 667 }
 668
 669 void putFile16BitInteger(FILE *file, short value, int byte_order)
 670 {
 671   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 672   {
 673     fputc((value >>  8) & 0xff, file);
 674     fputc((value >>  0) & 0xff, file);
 675   }
 676   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 677   {
 678     fputc((value >>  0) & 0xff, file);
 679     fputc((value >>  8) & 0xff, file);
 680   }
 681 }
 682
 683 int getFile32BitInteger(FILE *file, int byte_order)
 684 {
 685   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 686     return ((fgetc(file) << 24) |
 687             (fgetc(file) << 16) |
 688             (fgetc(file) <<  8) |
 689             (fgetc(file) <<  0));
 690   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 691     return ((fgetc(file) <<  0) |
 692             (fgetc(file) <<  8) |
 693             (fgetc(file) << 16) |
 694             (fgetc(file) << 24));
 695 }
 696
 697 void putFile32BitInteger(FILE *file, int value, int byte_order)
 698 {
 699   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 700   {
 701     fputc((value >> 24) & 0xff, file);
 702     fputc((value >> 16) & 0xff, file);
 703     fputc((value >>  8) & 0xff, file);
 704     fputc((value >>  0) & 0xff, file);
 705   }
 706   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 707   {
 708     fputc((value >>  0) & 0xff, file);
 709     fputc((value >>  8) & 0xff, file);
 710     fputc((value >> 16) & 0xff, file);
 711     fputc((value >> 24) & 0xff, file);
 712   }
 713 }
 714
 715 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
 716                      int byte_order)
 717 {
 718   const int chunk_name_length = 4;
 719
 720   /* read chunk name */
 721   fgets(chunk_name, chunk_name_length + 1, file);
 722
 723   if (chunk_size != NULL)
 724   {
 725     /* read chunk size */
 726     *chunk_size = getFile32BitInteger(file, byte_order);
 727   }
 728
 729   return (feof(file) || ferror(file) ? FALSE : TRUE);
 730 }
 731
 732 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
 733                   int byte_order)
 734 {
 735   /* write chunk name */
 736   fputs(chunk_name, file);
 737
 738   if (chunk_size >= 0)
 739   {
 740     /* write chunk size */
 741     putFile32BitInteger(file, chunk_size, byte_order);
 742   }
 743 }
 744
 745 void ReadUnusedBytesFromFile(FILE *file, unsigned long bytes)
 746 {
 747   while (bytes--)
 748     fgetc(file);
 749 }
 750
 751 void WriteUnusedBytesToFile(FILE *file, unsigned long bytes)
 752 {
 753   while (bytes--)
 754     fputc(0, file);
 755 }
 756
 757 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 758 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 759 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
 760
 761 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
 762 {
 763   static struct
 764   {
 765     Key key;
 766     char *x11name;
 767     char *name;
 768   } translate_key[] =
 769   {
 770     /* normal cursor keys */
 771     { KSYM_Left,        "XK_Left",              "cursor left" },
 772     { KSYM_Right,       "XK_Right",             "cursor right" },
 773     { KSYM_Up,          "XK_Up",                "cursor up" },
 774     { KSYM_Down,        "XK_Down",              "cursor down" },
 775
 776     /* keypad cursor keys */
 777 #ifdef KSYM_KP_Left
 778     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
 779     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
 780     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
 781     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
 782 #endif
 783
 784     /* other keypad keys */
 785 #ifdef KSYM_KP_Enter
 786     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
 787     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
 788     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
 789     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
 790     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
 791     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
 792 #endif
 793
 794     /* modifier keys */
 795     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
 796     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
 797     { KSYM_Control_L,   "XK_Control_L",         "left control" },
 798     { KSYM_Control_R,   "XK_Control_R",         "right control" },
 799     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
 800     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
 801     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
 802     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
 803     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
 804     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
 805     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
 806     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
 807
 808     /* some special keys */
 809     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
 810     { KSYM_Delete,      "XK_Delete",            "delete" },
 811     { KSYM_Insert,      "XK_Insert",            "insert" },
 812     { KSYM_Tab,         "XK_Tab",               "tab" },
 813     { KSYM_Home,        "XK_Home",              "home" },
 814     { KSYM_End,         "XK_End",               "end" },
 815     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
 816     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
 817     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
 818
 819     /* ASCII 0x20 to 0x40 keys (except numbers) */
 820     { KSYM_space,       "XK_space",             "space" },
 821     { KSYM_exclam,      "XK_exclam",            "!" },
 822     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
 823     { KSYM_numbersign,  "XK_numbersign",        "#" },
 824     { KSYM_dollar,      "XK_dollar",            "$" },
 825     { KSYM_percent,     "XK_percent",           "%" },
 826     { KSYM_ampersand,   "XK_ampersand",         "&" },
 827     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
 828     { KSYM_parenleft,   "XK_parenleft",         "(" },
 829     { KSYM_parenright,  "XK_parenright",        ")" },
 830     { KSYM_asterisk,    "XK_asterisk",          "*" },
 831     { KSYM_plus,        "XK_plus",              "+" },
 832     { KSYM_comma,       "XK_comma",             "," },
 833     { KSYM_minus,       "XK_minus",             "-" },
 834     { KSYM_period,      "XK_period",            "." },
 835     { KSYM_slash,       "XK_slash",             "/" },
 836     { KSYM_colon,       "XK_colon",             ":" },
 837     { KSYM_semicolon,   "XK_semicolon",         ";" },
 838     { KSYM_less,        "XK_less",              "<" },
 839     { KSYM_equal,       "XK_equal",             "=" },
 840     { KSYM_greater,     "XK_greater",           ">" },
 841     { KSYM_question,    "XK_question",          "?" },
 842     { KSYM_at,          "XK_at",                "@" },
 843
 844     /* more ASCII keys */
 845     { KSYM_bracketleft, "XK_bracketleft",       "[" },
 846     { KSYM_backslash,   "XK_backslash",         "backslash" },
 847     { KSYM_bracketright,"XK_bracketright",      "]" },
 848     { KSYM_asciicircum, "XK_asciicircum",       "circumflex" },
 849     { KSYM_underscore,  "XK_underscore",        "_" },
 850     { KSYM_grave,       "XK_grave",             "grave" },
 851     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
 852     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
 853     { KSYM_bar,         "XK_bar",               "bar" },
 854     { KSYM_braceright,  "XK_braceright",        "brace right" },
 855     { KSYM_asciitilde,  "XK_asciitilde",        "ascii tilde" },
 856
 857     /* special (non-ASCII) keys */
 858     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
 859     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
 860     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
 861     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
 862     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
 863     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
 864     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
 865
 866     /* end-of-array identifier */
 867     { 0,                NULL,                   NULL }
 868   };
 869
 870   int i;
 871
 872   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
 873   {
 874     static char name_buffer[30];
 875     Key key = *keysym;
 876
 877     if (key >= KSYM_A && key <= KSYM_Z)
 878       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
 879     else if (key >= KSYM_a && key <= KSYM_z)
 880       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
 881     else if (key >= KSYM_0 && key <= KSYM_9)
 882       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
 883     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 884       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
 885     else if (key >= KSYM_F1 && key <= KSYM_F24)
 886       sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1));
 887     else if (key == KSYM_UNDEFINED)
 888       strcpy(name_buffer, "(undefined)");
 889     else
 890     {
 891       i = 0;
 892
 893       do
 894       {
 895         if (key == translate_key[i].key)
 896         {
 897           strcpy(name_buffer, translate_key[i].name);
 898           break;
 899         }
 900       }
 901       while (translate_key[++i].name);
 902
 903       if (!translate_key[i].name)
 904         strcpy(name_buffer, "(unknown)");
 905     }
 906
 907     *name = name_buffer;
 908   }
 909   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
 910   {
 911     static char name_buffer[30];
 912     Key key = *keysym;
 913
 914     if (key >= KSYM_A && key <= KSYM_Z)
 915       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
 916     else if (key >= KSYM_a && key <= KSYM_z)
 917       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
 918     else if (key >= KSYM_0 && key <= KSYM_9)
 919       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
 920     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 921       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
 922     else if (key >= KSYM_F1 && key <= KSYM_F24)
 923       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1));
 924     else if (key == KSYM_UNDEFINED)
 925       strcpy(name_buffer, "[undefined]");
 926     else
 927     {
 928       i = 0;
 929
 930       do
 931       {
 932         if (key == translate_key[i].key)
 933         {
 934           strcpy(name_buffer, translate_key[i].x11name);
 935           break;
 936         }
 937       }
 938       while (translate_key[++i].x11name);
 939
 940       if (!translate_key[i].x11name)
 941         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
 942     }
 943
 944     *x11name = name_buffer;
 945   }
 946   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
 947   {
 948     Key key = KSYM_UNDEFINED;
 949     char *name_ptr = *x11name;
 950
 951     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
 952     {
 953       char c = name_ptr[3];
 954
 955       if (c >= 'A' && c <= 'Z')
 956         key = KSYM_A + (Key)(c - 'A');
 957       else if (c >= 'a' && c <= 'z')
 958         key = KSYM_a + (Key)(c - 'a');
 959       else if (c >= '0' && c <= '9')
 960         key = KSYM_0 + (Key)(c - '0');
 961     }
 962     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
 963     {
 964       char c = name_ptr[6];
 965
 966       if (c >= '0' && c <= '9')
 967         key = KSYM_0 + (Key)(c - '0');
 968     }
 969     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
 970     {
 971       char c1 = name_ptr[4];
 972       char c2 = name_ptr[5];
 973       int d = 0;
 974
 975       if ((c1 >= '0' && c1 <= '9') &&
 976           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
 977         d = atoi(&name_ptr[4]);
 978
 979       if (d >=1 && d <= 24)
 980         key = KSYM_F1 + (Key)(d - 1);
 981     }
 982     else if (strncmp(name_ptr, "XK_", 3) == 0)
 983     {
 984       i = 0;
 985
 986       do
 987       {
 988         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
 989         {
 990           key = translate_key[i].key;
 991           break;
 992         }
 993       }
 994       while (translate_key[++i].x11name);
 995     }
 996     else if (strncmp(name_ptr, "0x", 2) == 0)
 997     {
 998       unsigned long value = 0;
 999
1000       name_ptr += 2;
1001
1002       while (name_ptr)
1003       {
1004         char c = *name_ptr++;
1005         int d = -1;
1006
1007         if (c >= '0' && c <= '9')
1008           d = (int)(c - '0');
1009         else if (c >= 'a' && c <= 'f')
1010           d = (int)(c - 'a' + 10);
1011         else if (c >= 'A' && c <= 'F')
1012           d = (int)(c - 'A' + 10);
1013
1014         if (d == -1)
1015         {
1016           value = -1;
1017           break;
1018         }
1019
1020         value = value * 16 + d;
1021       }
1022
1023       if (value != -1)
1024         key = (Key)value;
1025     }
1026
1027     *keysym = key;
1028   }
1029 }
1030
1031 char *getKeyNameFromKey(Key key)
1032 {
1033   char *name;
1034
1035   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1036   return name;
1037 }
1038
1039 char *getX11KeyNameFromKey(Key key)
1040 {
1041   char *x11name;
1042
1043   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1044   return x11name;
1045 }
1046
1047 Key getKeyFromX11KeyName(char *x11name)
1048 {
1049   Key key;
1050
1051   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1052   return key;
1053 }
1054
1055 char getCharFromKey(Key key)
1056 {
1057   char *keyname = getKeyNameFromKey(key);
1058   char letter = 0;
1059
1060   if (strlen(keyname) == 1)
1061     letter = keyname[0];
1062   else if (strcmp(keyname, "space") == 0)
1063     letter = ' ';
1064   else if (strcmp(keyname, "circumflex") == 0)
1065     letter = '^';
1066
1067   return letter;
1068 }
1069
1070 /* ------------------------------------------------------------------------- */
1071 /* some functions to handle lists of level directories                       */
1072 /* ------------------------------------------------------------------------- */
1073
1074 struct LevelDirInfo *newLevelDirInfo()
1075 {
1076   return checked_calloc(sizeof(struct LevelDirInfo));
1077 }
1078
1079 void pushLevelDirInfo(struct LevelDirInfo **node_first,
1080                       struct LevelDirInfo *node_new)
1081 {
1082   node_new->next = *node_first;
1083   *node_first = node_new;
1084 }
1085
1086 int numLevelDirInfo(struct LevelDirInfo *node)
1087 {
1088   int num = 0;
1089
1090   while (node)
1091   {
1092     num++;
1093     node = node->next;
1094   }
1095
1096   return num;
1097 }
1098
1099 boolean validLevelSeries(struct LevelDirInfo *node)
1100 {
1101   return (node != NULL && !node->node_group && !node->parent_link);
1102 }
1103
1104 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
1105 {
1106   if (node == NULL)
1107   {
1108     if (leveldir_first)         /* start with first level directory entry */
1109       return getFirstValidLevelSeries(leveldir_first);
1110     else
1111       return NULL;
1112   }
1113   else if (node->node_group)    /* enter level group (step down into tree) */
1114     return getFirstValidLevelSeries(node->node_group);
1115   else if (node->parent_link)   /* skip start entry of level group */
1116   {
1117     if (node->next)             /* get first real level series entry */
1118       return getFirstValidLevelSeries(node->next);
1119     else                        /* leave empty level group and go on */
1120       return getFirstValidLevelSeries(node->node_parent->next);
1121   }
1122   else                          /* this seems to be a regular level series */
1123     return node;
1124 }
1125
1126 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
1127 {
1128   if (node == NULL)
1129     return NULL;
1130
1131   if (node->node_parent == NULL)                /* top level group */
1132     return leveldir_first;
1133   else                                          /* sub level group */
1134     return node->node_parent->node_group;
1135 }
1136
1137 int numLevelDirInfoInGroup(struct LevelDirInfo *node)
1138 {
1139   return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
1140 }
1141
1142 int posLevelDirInfo(struct LevelDirInfo *node)
1143 {
1144   struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
1145   int pos = 0;
1146
1147   while (node_cmp)
1148   {
1149     if (node_cmp == node)
1150       return pos;
1151
1152     pos++;
1153     node_cmp = node_cmp->next;
1154   }
1155
1156   return 0;
1157 }
1158
1159 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
1160 {
1161   struct LevelDirInfo *node_default = node;
1162   int pos_cmp = 0;
1163
1164   while (node)
1165   {
1166     if (pos_cmp == pos)
1167       return node;
1168
1169     pos_cmp++;
1170     node = node->next;
1171   }
1172
1173   return node_default;
1174 }
1175
1176 struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
1177                                                     char *filename)
1178 {
1179   if (filename == NULL)
1180     return NULL;
1181
1182   while (node)
1183   {
1184     if (node->node_group)
1185     {
1186       struct LevelDirInfo *node_group;
1187
1188       node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
1189
1190       if (node_group)
1191         return node_group;
1192     }
1193     else if (!node->parent_link)
1194     {
1195       if (strcmp(filename, node->filename) == 0)
1196         return node;
1197     }
1198
1199     node = node->next;
1200   }
1201
1202   return NULL;
1203 }
1204
1205 struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
1206 {
1207   return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
1208 }
1209
1210 void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
1211 {
1212   int i;
1213
1214   while (node)
1215   {
1216     for (i=0; i<depth * 3; i++)
1217       printf(" ");
1218
1219     printf("filename == '%s'\n", node->filename);
1220
1221     if (node->node_group != NULL)
1222       dumpLevelDirInfo(node->node_group, depth + 1);
1223
1224     node = node->next;
1225   }
1226 }
1227
1228 void sortLevelDirInfo(struct LevelDirInfo **node_first,
1229                       int (*compare_function)(const void *, const void *))
1230 {
1231   int num_nodes = numLevelDirInfo(*node_first);
1232   struct LevelDirInfo **sort_array;
1233   struct LevelDirInfo *node = *node_first;
1234   int i = 0;
1235
1236   if (num_nodes == 0)
1237     return;
1238
1239   /* allocate array for sorting structure pointers */
1240   sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
1241
1242   /* writing structure pointers to sorting array */
1243   while (i < num_nodes && node)         /* double boundary check... */
1244   {
1245     sort_array[i] = node;
1246
1247     i++;
1248     node = node->next;
1249   }
1250
1251   /* sorting the structure pointers in the sorting array */
1252   qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
1253         compare_function);
1254
1255   /* update the linkage of list elements with the sorted node array */
1256   for (i=0; i<num_nodes - 1; i++)
1257     sort_array[i]->next = sort_array[i + 1];
1258   sort_array[num_nodes - 1]->next = NULL;
1259
1260   /* update the linkage of the main list anchor pointer */
1261   *node_first = sort_array[0];
1262
1263   free(sort_array);
1264
1265   /* now recursively sort the level group structures */
1266   node = *node_first;
1267   while (node)
1268   {
1269     if (node->node_group != NULL)
1270       sortLevelDirInfo(&node->node_group, compare_function);
1271
1272     node = node->next;
1273   }
1274 }
1275
1276 inline void swap_numbers(int *i1, int *i2)
1277 {
1278   int help = *i1;
1279
1280   *i1 = *i2;
1281   *i2 = help;
1282 }
1283
1284 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1285 {
1286   int help_x = *x1;
1287   int help_y = *y1;
1288
1289   *x1 = *x2;
1290   *x2 = help_x;
1291
1292   *y1 = *y2;
1293   *y2 = help_y;
1294 }
1295
1296
1297 /* ========================================================================= */
1298 /* some stuff from "files.c"                                                 */
1299 /* ========================================================================= */
1300
1301 #if defined(PLATFORM_WIN32)
1302 #ifndef S_IRGRP
1303 #define S_IRGRP S_IRUSR
1304 #endif
1305 #ifndef S_IROTH
1306 #define S_IROTH S_IRUSR
1307 #endif
1308 #ifndef S_IWGRP
1309 #define S_IWGRP S_IWUSR
1310 #endif
1311 #ifndef S_IWOTH
1312 #define S_IWOTH S_IWUSR
1313 #endif
1314 #ifndef S_IXGRP
1315 #define S_IXGRP S_IXUSR
1316 #endif
1317 #ifndef S_IXOTH
1318 #define S_IXOTH S_IXUSR
1319 #endif
1320 #ifndef S_IRWXG
1321 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
1322 #endif
1323 #ifndef S_ISGID
1324 #define S_ISGID 0
1325 #endif
1326 #endif  /* PLATFORM_WIN32 */
1327
1328 /* file permissions for newly written files */
1329 #define MODE_R_ALL              (S_IRUSR | S_IRGRP | S_IROTH)
1330 #define MODE_W_ALL              (S_IWUSR | S_IWGRP | S_IWOTH)
1331 #define MODE_X_ALL              (S_IXUSR | S_IXGRP | S_IXOTH)
1332
1333 #define MODE_W_PRIVATE          (S_IWUSR)
1334 #define MODE_W_PUBLIC           (S_IWUSR | S_IWGRP)
1335 #define MODE_W_PUBLIC_DIR       (S_IWUSR | S_IWGRP | S_ISGID)
1336
1337 #define DIR_PERMS_PRIVATE       (MODE_R_ALL | MODE_X_ALL | MODE_W_PRIVATE)
1338 #define DIR_PERMS_PUBLIC        (MODE_R_ALL | MODE_X_ALL | MODE_W_PUBLIC_DIR)
1339
1340 #define FILE_PERMS_PRIVATE      (MODE_R_ALL | MODE_W_PRIVATE)
1341 #define FILE_PERMS_PUBLIC       (MODE_R_ALL | MODE_W_PUBLIC)
1342
1343 char *getUserDataDir(void)
1344 {
1345   static char *userdata_dir = NULL;
1346
1347   if (!userdata_dir)
1348   {
1349     char *home_dir = getHomeDir();
1350     char *data_dir = program.userdata_directory;
1351
1352     userdata_dir = getPath2(home_dir, data_dir);
1353   }
1354
1355   return userdata_dir;
1356 }
1357
1358 char *getSetupDir()
1359 {
1360   return getUserDataDir();
1361 }
1362
1363 static mode_t posix_umask(mode_t mask)
1364 {
1365 #if defined(PLATFORM_UNIX)
1366   return umask(mask);
1367 #else
1368   return 0;
1369 #endif
1370 }
1371
1372 static int posix_mkdir(const char *pathname, mode_t mode)
1373 {
1374 #if defined(PLATFORM_WIN32)
1375   return mkdir(pathname);
1376 #else
1377   return mkdir(pathname, mode);
1378 #endif
1379 }
1380
1381 void createDirectory(char *dir, char *text, int permission_class)
1382 {
1383   /* leave "other" permissions in umask untouched, but ensure group parts
1384      of USERDATA_DIR_MODE are not masked */
1385   mode_t dir_mode = (permission_class == PERMS_PRIVATE ?
1386                      DIR_PERMS_PRIVATE : DIR_PERMS_PUBLIC);
1387   mode_t normal_umask = posix_umask(0);
1388   mode_t group_umask = ~(dir_mode & S_IRWXG);
1389   posix_umask(normal_umask & group_umask);
1390
1391   if (access(dir, F_OK) != 0)
1392     if (posix_mkdir(dir, dir_mode) != 0)
1393       Error(ERR_WARN, "cannot create %s directory '%s'", text, dir);
1394
1395   posix_umask(normal_umask);            /* reset normal umask */
1396 }
1397
1398 void InitUserDataDirectory()
1399 {
1400   createDirectory(getUserDataDir(), "user data", PERMS_PRIVATE);
1401 }
1402
1403 void SetFilePermissions(char *filename, int permission_class)
1404 {
1405   chmod(filename, (permission_class == PERMS_PRIVATE ?
1406                    FILE_PERMS_PRIVATE : FILE_PERMS_PUBLIC));
1407 }
1408
1409 int getFileVersionFromCookieString(const char *cookie)
1410 {
1411   const char *ptr_cookie1, *ptr_cookie2;
1412   const char *pattern1 = "_FILE_VERSION_";
1413   const char *pattern2 = "?.?";
1414   const int len_cookie = strlen(cookie);
1415   const int len_pattern1 = strlen(pattern1);
1416   const int len_pattern2 = strlen(pattern2);
1417   const int len_pattern = len_pattern1 + len_pattern2;
1418   int version_major, version_minor;
1419
1420   if (len_cookie <= len_pattern)
1421     return -1;
1422
1423   ptr_cookie1 = &cookie[len_cookie - len_pattern];
1424   ptr_cookie2 = &cookie[len_cookie - len_pattern2];
1425
1426   if (strncmp(ptr_cookie1, pattern1, len_pattern1) != 0)
1427     return -1;
1428
1429   if (ptr_cookie2[0] < '0' || ptr_cookie2[0] > '9' ||
1430       ptr_cookie2[1] != '.' ||
1431       ptr_cookie2[2] < '0' || ptr_cookie2[2] > '9')
1432     return -1;
1433
1434   version_major = ptr_cookie2[0] - '0';
1435   version_minor = ptr_cookie2[2] - '0';
1436
1437   return VERSION_IDENT(version_major, version_minor, 0);
1438 }
1439
1440 boolean checkCookieString(const char *cookie, const char *template)
1441 {
1442   const char *pattern = "_FILE_VERSION_?.?";
1443   const int len_cookie = strlen(cookie);
1444   const int len_template = strlen(template);
1445   const int len_pattern = strlen(pattern);
1446
1447   if (len_cookie != len_template)
1448     return FALSE;
1449
1450   if (strncmp(cookie, template, len_cookie - len_pattern) != 0)
1451     return FALSE;
1452
1453   return TRUE;
1454 }
1455
1456 /* ------------------------------------------------------------------------- */
1457 /* setup file stuff                                                          */
1458 /* ------------------------------------------------------------------------- */
1459
1460 static char *string_tolower(char *s)
1461 {
1462   static char s_lower[100];
1463   int i;
1464
1465   if (strlen(s) >= 100)
1466     return s;
1467
1468   strcpy(s_lower, s);
1469
1470   for (i=0; i<strlen(s_lower); i++)
1471     s_lower[i] = tolower(s_lower[i]);
1472
1473   return s_lower;
1474 }
1475
1476 int get_string_integer_value(char *s)
1477 {
1478   static char *number_text[][3] =
1479   {
1480     { "0", "zero", "null", },
1481     { "1", "one", "first" },
1482     { "2", "two", "second" },
1483     { "3", "three", "third" },
1484     { "4", "four", "fourth" },
1485     { "5", "five", "fifth" },
1486     { "6", "six", "sixth" },
1487     { "7", "seven", "seventh" },
1488     { "8", "eight", "eighth" },
1489     { "9", "nine", "ninth" },
1490     { "10", "ten", "tenth" },
1491     { "11", "eleven", "eleventh" },
1492     { "12", "twelve", "twelfth" },
1493   };
1494
1495   int i, j;
1496
1497   for (i=0; i<13; i++)
1498     for (j=0; j<3; j++)
1499       if (strcmp(string_tolower(s), number_text[i][j]) == 0)
1500         return i;
1501
1502   return atoi(s);
1503 }
1504
1505 boolean get_string_boolean_value(char *s)
1506 {
1507   if (strcmp(string_tolower(s), "true") == 0 ||
1508       strcmp(string_tolower(s), "yes") == 0 ||
1509       strcmp(string_tolower(s), "on") == 0 ||
1510       get_string_integer_value(s) == 1)
1511     return TRUE;
1512   else
1513     return FALSE;
1514 }
1515
1516 char *getFormattedSetupEntry(char *token, char *value)
1517 {
1518   int i;
1519   static char entry[MAX_LINE_LEN];
1520
1521   sprintf(entry, "%s:", token);
1522   for (i=strlen(entry); i<TOKEN_VALUE_POSITION; i++)
1523     entry[i] = ' ';
1524   entry[i] = '\0';
1525
1526   strcat(entry, value);
1527
1528   return entry;
1529 }
1530
1531 void freeSetupFileList(struct SetupFileList *setup_file_list)
1532 {
1533   if (!setup_file_list)
1534     return;
1535
1536   if (setup_file_list->token)
1537     free(setup_file_list->token);
1538   if (setup_file_list->value)
1539     free(setup_file_list->value);
1540   if (setup_file_list->next)
1541     freeSetupFileList(setup_file_list->next);
1542   free(setup_file_list);
1543 }
1544
1545 static struct SetupFileList *newSetupFileList(char *token, char *value)
1546 {
1547   struct SetupFileList *new = checked_malloc(sizeof(struct SetupFileList));
1548
1549   new->token = checked_malloc(strlen(token) + 1);
1550   strcpy(new->token, token);
1551
1552   new->value = checked_malloc(strlen(value) + 1);
1553   strcpy(new->value, value);
1554
1555   new->next = NULL;
1556
1557   return new;
1558 }
1559
1560 char *getTokenValue(struct SetupFileList *setup_file_list, char *token)
1561 {
1562   if (!setup_file_list)
1563     return NULL;
1564
1565   if (strcmp(setup_file_list->token, token) == 0)
1566     return setup_file_list->value;
1567   else
1568     return getTokenValue(setup_file_list->next, token);
1569 }
1570
1571 static void setTokenValue(struct SetupFileList *setup_file_list,
1572                           char *token, char *value)
1573 {
1574   if (!setup_file_list)
1575     return;
1576
1577   if (strcmp(setup_file_list->token, token) == 0)
1578   {
1579     free(setup_file_list->value);
1580     setup_file_list->value = checked_malloc(strlen(value) + 1);
1581     strcpy(setup_file_list->value, value);
1582   }
1583   else if (setup_file_list->next == NULL)
1584     setup_file_list->next = newSetupFileList(token, value);
1585   else
1586     setTokenValue(setup_file_list->next, token, value);
1587 }
1588
1589 #ifdef DEBUG
1590 static void printSetupFileList(struct SetupFileList *setup_file_list)
1591 {
1592   if (!setup_file_list)
1593     return;
1594
1595   printf("token: '%s'\n", setup_file_list->token);
1596   printf("value: '%s'\n", setup_file_list->value);
1597
1598   printSetupFileList(setup_file_list->next);
1599 }
1600 #endif
1601
1602 struct SetupFileList *loadSetupFileList(char *filename)
1603 {
1604   int line_len;
1605   char line[MAX_LINE_LEN];
1606   char *token, *value, *line_ptr;
1607   struct SetupFileList *setup_file_list = newSetupFileList("", "");
1608   struct SetupFileList *first_valid_list_entry;
1609
1610   FILE *file;
1611
1612   if (!(file = fopen(filename, MODE_READ)))
1613   {
1614     Error(ERR_WARN, "cannot open configuration file '%s'", filename);
1615     return NULL;
1616   }
1617
1618   while(!feof(file))
1619   {
1620     /* read next line of input file */
1621     if (!fgets(line, MAX_LINE_LEN, file))
1622       break;
1623
1624     /* cut trailing comment or whitespace from input line */
1625     for (line_ptr = line; *line_ptr; line_ptr++)
1626     {
1627       if (*line_ptr == '#' || *line_ptr == '\n' || *line_ptr == '\r')
1628       {
1629         *line_ptr = '\0';
1630         break;
1631       }
1632     }
1633
1634     /* cut trailing whitespaces from input line */
1635     for (line_ptr = &line[strlen(line)]; line_ptr > line; line_ptr--)
1636       if ((*line_ptr == ' ' || *line_ptr == '\t') && line_ptr[1] == '\0')
1637         *line_ptr = '\0';
1638
1639     /* ignore empty lines */
1640     if (*line == '\0')
1641       continue;
1642
1643     line_len = strlen(line);
1644
1645     /* cut leading whitespaces from token */
1646     for (token = line; *token; token++)
1647       if (*token != ' ' && *token != '\t')
1648         break;
1649
1650     /* find end of token */
1651     for (line_ptr = token; *line_ptr; line_ptr++)
1652     {
1653       if (*line_ptr == ' ' || *line_ptr == '\t' || *line_ptr == ':')
1654       {
1655         *line_ptr = '\0';
1656         break;
1657       }
1658     }
1659
1660     if (line_ptr < line + line_len)
1661       value = line_ptr + 1;
1662     else
1663       value = "\0";
1664
1665     /* cut leading whitespaces from value */
1666     for (; *value; value++)
1667       if (*value != ' ' && *value != '\t')
1668         break;
1669
1670     if (*token && *value)
1671       setTokenValue(setup_file_list, token, value);
1672   }
1673
1674   fclose(file);
1675
1676   first_valid_list_entry = setup_file_list->next;
1677
1678   /* free empty list header */
1679   setup_file_list->next = NULL;
1680   freeSetupFileList(setup_file_list);
1681
1682   if (first_valid_list_entry == NULL)
1683     Error(ERR_WARN, "configuration file '%s' is empty", filename);
1684
1685   return first_valid_list_entry;
1686 }
1687
1688 void checkSetupFileListIdentifier(struct SetupFileList *setup_file_list,
1689                                   char *identifier)
1690 {
1691   if (!setup_file_list)
1692     return;
1693
1694   if (strcmp(setup_file_list->token, TOKEN_STR_FILE_IDENTIFIER) == 0)
1695   {
1696     if (strcmp(setup_file_list->value, identifier) != 0)
1697     {
1698       Error(ERR_WARN, "configuration file has wrong version");
1699       return;
1700     }
1701     else
1702       return;
1703   }
1704
1705   if (setup_file_list->next)
1706     checkSetupFileListIdentifier(setup_file_list->next, identifier);
1707   else
1708   {
1709     Error(ERR_WARN, "configuration file has no version information");
1710     return;
1711   }
1712 }
1713
1714
1715 /* ========================================================================= */
1716 /* functions only needed for non-Unix (non-command-line) systems */
1717 /* ========================================================================= */
1718
1719 #if !defined(PLATFORM_UNIX)
1720
1721 #define ERROR_FILENAME          "error.out"
1722
1723 void initErrorFile()
1724 {
1725   char *filename;
1726
1727   InitUserDataDirectory();
1728
1729   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1730   unlink(filename);
1731   free(filename);
1732 }
1733
1734 FILE *openErrorFile()
1735 {
1736   char *filename;
1737   FILE *error_file;
1738
1739   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1740   error_file = fopen(filename, MODE_APPEND);
1741   free(filename);
1742
1743   return error_file;
1744 }
1745
1746 void dumpErrorFile()
1747 {
1748   char *filename;
1749   FILE *error_file;
1750
1751   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1752   error_file = fopen(filename, MODE_READ);
1753   free(filename);
1754
1755   if (error_file != NULL)
1756   {
1757     while (!feof(error_file))
1758       fputc(fgetc(error_file), stderr);
1759
1760     fclose(error_file);
1761   }
1762 }
1763 #endif
1764
1765
1766 /* ========================================================================= */
1767 /* the following is only for debugging purpose and normally not used         */
1768 /* ========================================================================= */
1769
1770 #define DEBUG_NUM_TIMESTAMPS    3
1771
1772 void debug_print_timestamp(int counter_nr, char *message)
1773 {
1774   static long counter[DEBUG_NUM_TIMESTAMPS][2];
1775
1776   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1777     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1778
1779   counter[counter_nr][0] = Counter();
1780
1781   if (message)
1782     printf("%s %.2f seconds\n", message,
1783            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1784
1785   counter[counter_nr][1] = Counter();
1786 }