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.serveronly = FALSE;
 429   options.network = FALSE;
 430   options.verbose = FALSE;
 431   options.debug = FALSE;
 432
 433   while (*options_left)
 434   {
 435     char option_str[MAX_OPTION_LEN];
 436     char *option = options_left[0];
 437     char *next_option = options_left[1];
 438     char *option_arg = NULL;
 439     int option_len = strlen(option);
 440
 441     if (option_len >= MAX_OPTION_LEN)
 442       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 443
 444     strcpy(option_str, option);                 /* copy argument into buffer */
 445     option = option_str;
 446
 447     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 448       break;
 449
 450     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 451       option++;
 452
 453     option_arg = strchr(option, '=');
 454     if (option_arg == NULL)                     /* no '=' in option */
 455       option_arg = next_option;
 456     else
 457     {
 458       *option_arg++ = '\0';                     /* cut argument from option */
 459       if (*option_arg == '\0')                  /* no argument after '=' */
 460         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 461     }
 462
 463     option_len = strlen(option);
 464
 465     if (strcmp(option, "-") == 0)
 466       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 467     else if (strncmp(option, "-help", option_len) == 0)
 468     {
 469       printf("Usage: %s [options] [server.name [port]]\n"
 470              "Options:\n"
 471              "  -d, --display machine:0       X server display\n"
 472              "  -b, --basepath directory      alternative base directory\n"
 473              "  -l, --level directory         alternative level directory\n"
 474              "  -s, --serveronly              only start network server\n"
 475              "  -n, --network                 network multiplayer game\n"
 476              "  -v, --verbose                 verbose mode\n"
 477              "      --debug                   display debugging information\n",
 478              program.command_basename);
 479       exit(0);
 480     }
 481     else if (strncmp(option, "-display", option_len) == 0)
 482     {
 483       if (option_arg == NULL)
 484         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 485
 486       options.display_name = option_arg;
 487       if (option_arg == next_option)
 488         options_left++;
 489     }
 490     else if (strncmp(option, "-basepath", option_len) == 0)
 491     {
 492       if (option_arg == NULL)
 493         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 494
 495       /* this should be extended to separate options for ro and rw data */
 496       options.ro_base_directory = option_arg;
 497       options.rw_base_directory = option_arg;
 498       if (option_arg == next_option)
 499         options_left++;
 500
 501       /* adjust path for level directory accordingly */
 502       options.level_directory =
 503         getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
 504     }
 505     else if (strncmp(option, "-levels", option_len) == 0)
 506     {
 507       if (option_arg == NULL)
 508         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 509
 510       options.level_directory = option_arg;
 511       if (option_arg == next_option)
 512         options_left++;
 513     }
 514     else if (strncmp(option, "-network", option_len) == 0)
 515     {
 516       options.network = TRUE;
 517     }
 518     else if (strncmp(option, "-serveronly", option_len) == 0)
 519     {
 520       options.serveronly = TRUE;
 521     }
 522     else if (strncmp(option, "-verbose", option_len) == 0)
 523     {
 524       options.verbose = TRUE;
 525     }
 526     else if (strncmp(option, "-debug", option_len) == 0)
 527     {
 528       options.debug = TRUE;
 529     }
 530     else if (*option == '-')
 531     {
 532       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 533     }
 534     else if (options.server_host == NULL)
 535     {
 536       options.server_host = *options_left;
 537     }
 538     else if (options.server_port == 0)
 539     {
 540       options.server_port = atoi(*options_left);
 541       if (options.server_port < 1024)
 542         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 543     }
 544     else
 545       Error(ERR_EXIT_HELP, "too many arguments");
 546
 547     options_left++;
 548   }
 549 }
 550
 551 void Error(int mode, char *format, ...)
 552 {
 553   char *process_name = "";
 554   FILE *error = stderr;
 555   char *newline = "\n";
 556
 557   /* display warnings only when running in verbose mode */
 558   if (mode & ERR_WARN && !options.verbose)
 559     return;
 560
 561 #if !defined(PLATFORM_UNIX)
 562   newline = "\r\n";
 563
 564   if ((error = openErrorFile()) == NULL)
 565   {
 566     printf("Cannot write to error output file!%s", newline);
 567     program.exit_function(1);
 568   }
 569 #endif
 570
 571   if (mode & ERR_SOUND_SERVER)
 572     process_name = " sound server";
 573   else if (mode & ERR_NETWORK_SERVER)
 574     process_name = " network server";
 575   else if (mode & ERR_NETWORK_CLIENT)
 576     process_name = " network client **";
 577
 578   if (format)
 579   {
 580     va_list ap;
 581
 582     fprintf(error, "%s%s: ", program.command_basename, process_name);
 583
 584     if (mode & ERR_WARN)
 585       fprintf(error, "warning: ");
 586
 587     va_start(ap, format);
 588     vfprintf(error, format, ap);
 589     va_end(ap);
 590
 591     fprintf(error, "%s", newline);
 592   }
 593
 594   if (mode & ERR_HELP)
 595     fprintf(error, "%s: Try option '--help' for more information.%s",
 596             program.command_basename, newline);
 597
 598   if (mode & ERR_EXIT)
 599     fprintf(error, "%s%s: aborting%s",
 600             program.command_basename, process_name, newline);
 601
 602   if (error != stderr)
 603     fclose(error);
 604
 605   if (mode & ERR_EXIT)
 606   {
 607     if (mode & ERR_FROM_SERVER)
 608       exit(1);                          /* child process: normal exit */
 609     else
 610       program.exit_function(1);         /* main process: clean up stuff */
 611   }
 612 }
 613
 614 void *checked_malloc(unsigned long size)
 615 {
 616   void *ptr;
 617
 618   ptr = malloc(size);
 619
 620   if (ptr == NULL)
 621     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 622
 623   return ptr;
 624 }
 625
 626 void *checked_calloc(unsigned long size)
 627 {
 628   void *ptr;
 629
 630   ptr = calloc(1, size);
 631
 632   if (ptr == NULL)
 633     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 634
 635   return ptr;
 636 }
 637
 638 void *checked_realloc(void *ptr, unsigned long size)
 639 {
 640   ptr = realloc(ptr, size);
 641
 642   if (ptr == NULL)
 643     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 644
 645   return ptr;
 646 }
 647
 648 short getFile16BitInteger(FILE *file, int byte_order)
 649 {
 650   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 651     return ((fgetc(file) <<  8) |
 652             (fgetc(file) <<  0));
 653   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 654     return ((fgetc(file) <<  0) |
 655             (fgetc(file) <<  8));
 656 }
 657
 658 void putFile16BitInteger(FILE *file, short value, int byte_order)
 659 {
 660   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 661   {
 662     fputc((value >>  8) & 0xff, file);
 663     fputc((value >>  0) & 0xff, file);
 664   }
 665   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 666   {
 667     fputc((value >>  0) & 0xff, file);
 668     fputc((value >>  8) & 0xff, file);
 669   }
 670 }
 671
 672 int getFile32BitInteger(FILE *file, int byte_order)
 673 {
 674   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 675     return ((fgetc(file) << 24) |
 676             (fgetc(file) << 16) |
 677             (fgetc(file) <<  8) |
 678             (fgetc(file) <<  0));
 679   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 680     return ((fgetc(file) <<  0) |
 681             (fgetc(file) <<  8) |
 682             (fgetc(file) << 16) |
 683             (fgetc(file) << 24));
 684 }
 685
 686 void putFile32BitInteger(FILE *file, int value, int byte_order)
 687 {
 688   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 689   {
 690     fputc((value >> 24) & 0xff, file);
 691     fputc((value >> 16) & 0xff, file);
 692     fputc((value >>  8) & 0xff, file);
 693     fputc((value >>  0) & 0xff, file);
 694   }
 695   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 696   {
 697     fputc((value >>  0) & 0xff, file);
 698     fputc((value >>  8) & 0xff, file);
 699     fputc((value >> 16) & 0xff, file);
 700     fputc((value >> 24) & 0xff, file);
 701   }
 702 }
 703
 704 boolean getFileChunk(FILE *file, char *chunk_name, int *chunk_size,
 705                      int byte_order)
 706 {
 707   const int chunk_name_length = 4;
 708
 709   /* read chunk name */
 710   fgets(chunk_name, chunk_name_length + 1, file);
 711
 712   /* read chunk size */
 713   *chunk_size = getFile32BitInteger(file, byte_order);
 714
 715   return (feof(file) || ferror(file) ? FALSE : TRUE);
 716 }
 717
 718 void putFileChunk(FILE *file, char *chunk_name, int chunk_size,
 719                   int byte_order)
 720 {
 721   /* write chunk name */
 722   fputs(chunk_name, file);
 723
 724   /* write chunk size */
 725   putFile32BitInteger(file, chunk_size, byte_order);
 726 }
 727
 728 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 729 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 730 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
 731
 732 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
 733 {
 734   static struct
 735   {
 736     Key key;
 737     char *x11name;
 738     char *name;
 739   } translate_key[] =
 740   {
 741     /* normal cursor keys */
 742     { KSYM_Left,        "XK_Left",              "cursor left" },
 743     { KSYM_Right,       "XK_Right",             "cursor right" },
 744     { KSYM_Up,          "XK_Up",                "cursor up" },
 745     { KSYM_Down,        "XK_Down",              "cursor down" },
 746
 747     /* keypad cursor keys */
 748 #ifdef KSYM_KP_Left
 749     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
 750     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
 751     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
 752     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
 753 #endif
 754
 755     /* other keypad keys */
 756 #ifdef KSYM_KP_Enter
 757     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
 758     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
 759     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
 760     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
 761     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
 762     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
 763 #endif
 764
 765     /* modifier keys */
 766     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
 767     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
 768     { KSYM_Control_L,   "XK_Control_L",         "left control" },
 769     { KSYM_Control_R,   "XK_Control_R",         "right control" },
 770     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
 771     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
 772     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
 773     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
 774     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
 775     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
 776     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
 777     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
 778
 779     /* some special keys */
 780     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
 781     { KSYM_Delete,      "XK_Delete",            "delete" },
 782     { KSYM_Insert,      "XK_Insert",            "insert" },
 783     { KSYM_Tab,         "XK_Tab",               "tab" },
 784     { KSYM_Home,        "XK_Home",              "home" },
 785     { KSYM_End,         "XK_End",               "end" },
 786     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
 787     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
 788     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
 789
 790     /* ASCII 0x20 to 0x40 keys (except numbers) */
 791     { KSYM_space,       "XK_space",             "space" },
 792     { KSYM_exclam,      "XK_exclam",            "!" },
 793     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
 794     { KSYM_numbersign,  "XK_numbersign",        "#" },
 795     { KSYM_dollar,      "XK_dollar",            "$" },
 796     { KSYM_percent,     "XK_percent",           "%" },
 797     { KSYM_ampersand,   "XK_ampersand",         "&" },
 798     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
 799     { KSYM_parenleft,   "XK_parenleft",         "(" },
 800     { KSYM_parenright,  "XK_parenright",        ")" },
 801     { KSYM_asterisk,    "XK_asterisk",          "*" },
 802     { KSYM_plus,        "XK_plus",              "+" },
 803     { KSYM_comma,       "XK_comma",             "," },
 804     { KSYM_minus,       "XK_minus",             "-" },
 805     { KSYM_period,      "XK_period",            "." },
 806     { KSYM_slash,       "XK_slash",             "/" },
 807     { KSYM_colon,       "XK_colon",             ":" },
 808     { KSYM_semicolon,   "XK_semicolon",         ";" },
 809     { KSYM_less,        "XK_less",              "<" },
 810     { KSYM_equal,       "XK_equal",             "=" },
 811     { KSYM_greater,     "XK_greater",           ">" },
 812     { KSYM_question,    "XK_question",          "?" },
 813     { KSYM_at,          "XK_at",                "@" },
 814
 815     /* more ASCII keys */
 816     { KSYM_bracketleft, "XK_bracketleft",       "[" },
 817     { KSYM_backslash,   "XK_backslash",         "backslash" },
 818     { KSYM_bracketright,"XK_bracketright",      "]" },
 819     { KSYM_asciicircum, "XK_asciicircum",       "circumflex" },
 820     { KSYM_underscore,  "XK_underscore",        "_" },
 821     { KSYM_grave,       "XK_grave",             "grave" },
 822     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
 823     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
 824     { KSYM_bar,         "XK_bar",               "bar" },
 825     { KSYM_braceright,  "XK_braceright",        "brace right" },
 826     { KSYM_asciitilde,  "XK_asciitilde",        "ascii tilde" },
 827
 828     /* special (non-ASCII) keys */
 829     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
 830     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
 831     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
 832     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
 833     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
 834     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
 835     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
 836
 837     /* end-of-array identifier */
 838     { 0,                NULL,                   NULL }
 839   };
 840
 841   int i;
 842
 843   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
 844   {
 845     static char name_buffer[30];
 846     Key key = *keysym;
 847
 848     if (key >= KSYM_A && key <= KSYM_Z)
 849       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
 850     else if (key >= KSYM_a && key <= KSYM_z)
 851       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
 852     else if (key >= KSYM_0 && key <= KSYM_9)
 853       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
 854     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 855       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
 856     else if (key >= KSYM_F1 && key <= KSYM_F24)
 857       sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1));
 858     else if (key == KSYM_UNDEFINED)
 859       strcpy(name_buffer, "(undefined)");
 860     else
 861     {
 862       i = 0;
 863
 864       do
 865       {
 866         if (key == translate_key[i].key)
 867         {
 868           strcpy(name_buffer, translate_key[i].name);
 869           break;
 870         }
 871       }
 872       while (translate_key[++i].name);
 873
 874       if (!translate_key[i].name)
 875         strcpy(name_buffer, "(unknown)");
 876     }
 877
 878     *name = name_buffer;
 879   }
 880   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
 881   {
 882     static char name_buffer[30];
 883     Key key = *keysym;
 884
 885     if (key >= KSYM_A && key <= KSYM_Z)
 886       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
 887     else if (key >= KSYM_a && key <= KSYM_z)
 888       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
 889     else if (key >= KSYM_0 && key <= KSYM_9)
 890       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
 891     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 892       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
 893     else if (key >= KSYM_F1 && key <= KSYM_F24)
 894       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1));
 895     else if (key == KSYM_UNDEFINED)
 896       strcpy(name_buffer, "[undefined]");
 897     else
 898     {
 899       i = 0;
 900
 901       do
 902       {
 903         if (key == translate_key[i].key)
 904         {
 905           strcpy(name_buffer, translate_key[i].x11name);
 906           break;
 907         }
 908       }
 909       while (translate_key[++i].x11name);
 910
 911       if (!translate_key[i].x11name)
 912         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
 913     }
 914
 915     *x11name = name_buffer;
 916   }
 917   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
 918   {
 919     Key key = KSYM_UNDEFINED;
 920     char *name_ptr = *x11name;
 921
 922     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
 923     {
 924       char c = name_ptr[3];
 925
 926       if (c >= 'A' && c <= 'Z')
 927         key = KSYM_A + (Key)(c - 'A');
 928       else if (c >= 'a' && c <= 'z')
 929         key = KSYM_a + (Key)(c - 'a');
 930       else if (c >= '0' && c <= '9')
 931         key = KSYM_0 + (Key)(c - '0');
 932     }
 933     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
 934     {
 935       char c = name_ptr[6];
 936
 937       if (c >= '0' && c <= '9')
 938         key = KSYM_0 + (Key)(c - '0');
 939     }
 940     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
 941     {
 942       char c1 = name_ptr[4];
 943       char c2 = name_ptr[5];
 944       int d = 0;
 945
 946       if ((c1 >= '0' && c1 <= '9') &&
 947           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
 948         d = atoi(&name_ptr[4]);
 949
 950       if (d >=1 && d <= 24)
 951         key = KSYM_F1 + (Key)(d - 1);
 952     }
 953     else if (strncmp(name_ptr, "XK_", 3) == 0)
 954     {
 955       i = 0;
 956
 957       do
 958       {
 959         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
 960         {
 961           key = translate_key[i].key;
 962           break;
 963         }
 964       }
 965       while (translate_key[++i].x11name);
 966     }
 967     else if (strncmp(name_ptr, "0x", 2) == 0)
 968     {
 969       unsigned long value = 0;
 970
 971       name_ptr += 2;
 972
 973       while (name_ptr)
 974       {
 975         char c = *name_ptr++;
 976         int d = -1;
 977
 978         if (c >= '0' && c <= '9')
 979           d = (int)(c - '0');
 980         else if (c >= 'a' && c <= 'f')
 981           d = (int)(c - 'a' + 10);
 982         else if (c >= 'A' && c <= 'F')
 983           d = (int)(c - 'A' + 10);
 984
 985         if (d == -1)
 986         {
 987           value = -1;
 988           break;
 989         }
 990
 991         value = value * 16 + d;
 992       }
 993
 994       if (value != -1)
 995         key = (Key)value;
 996     }
 997
 998     *keysym = key;
 999   }
1000 }
1001
1002 char *getKeyNameFromKey(Key key)
1003 {
1004   char *name;
1005
1006   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1007   return name;
1008 }
1009
1010 char *getX11KeyNameFromKey(Key key)
1011 {
1012   char *x11name;
1013
1014   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1015   return x11name;
1016 }
1017
1018 Key getKeyFromX11KeyName(char *x11name)
1019 {
1020   Key key;
1021
1022   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1023   return key;
1024 }
1025
1026 char getCharFromKey(Key key)
1027 {
1028   char *keyname = getKeyNameFromKey(key);
1029   char letter = 0;
1030
1031   if (strlen(keyname) == 1)
1032     letter = keyname[0];
1033   else if (strcmp(keyname, "space") == 0)
1034     letter = ' ';
1035   else if (strcmp(keyname, "circumflex") == 0)
1036     letter = '^';
1037
1038   return letter;
1039 }
1040
1041 /* ------------------------------------------------------------------------- */
1042 /* some functions to handle lists of level directories                       */
1043 /* ------------------------------------------------------------------------- */
1044
1045 struct LevelDirInfo *newLevelDirInfo()
1046 {
1047   return checked_calloc(sizeof(struct LevelDirInfo));
1048 }
1049
1050 void pushLevelDirInfo(struct LevelDirInfo **node_first,
1051                       struct LevelDirInfo *node_new)
1052 {
1053   node_new->next = *node_first;
1054   *node_first = node_new;
1055 }
1056
1057 int numLevelDirInfo(struct LevelDirInfo *node)
1058 {
1059   int num = 0;
1060
1061   while (node)
1062   {
1063     num++;
1064     node = node->next;
1065   }
1066
1067   return num;
1068 }
1069
1070 boolean validLevelSeries(struct LevelDirInfo *node)
1071 {
1072   return (node != NULL && !node->node_group && !node->parent_link);
1073 }
1074
1075 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
1076 {
1077   if (node == NULL)
1078   {
1079     if (leveldir_first)         /* start with first level directory entry */
1080       return getFirstValidLevelSeries(leveldir_first);
1081     else
1082       return NULL;
1083   }
1084   else if (node->node_group)    /* enter level group (step down into tree) */
1085     return getFirstValidLevelSeries(node->node_group);
1086   else if (node->parent_link)   /* skip start entry of level group */
1087   {
1088     if (node->next)             /* get first real level series entry */
1089       return getFirstValidLevelSeries(node->next);
1090     else                        /* leave empty level group and go on */
1091       return getFirstValidLevelSeries(node->node_parent->next);
1092   }
1093   else                          /* this seems to be a regular level series */
1094     return node;
1095 }
1096
1097 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
1098 {
1099   if (node == NULL)
1100     return NULL;
1101
1102   if (node->node_parent == NULL)                /* top level group */
1103     return leveldir_first;
1104   else                                          /* sub level group */
1105     return node->node_parent->node_group;
1106 }
1107
1108 int numLevelDirInfoInGroup(struct LevelDirInfo *node)
1109 {
1110   return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
1111 }
1112
1113 int posLevelDirInfo(struct LevelDirInfo *node)
1114 {
1115   struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
1116   int pos = 0;
1117
1118   while (node_cmp)
1119   {
1120     if (node_cmp == node)
1121       return pos;
1122
1123     pos++;
1124     node_cmp = node_cmp->next;
1125   }
1126
1127   return 0;
1128 }
1129
1130 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
1131 {
1132   struct LevelDirInfo *node_default = node;
1133   int pos_cmp = 0;
1134
1135   while (node)
1136   {
1137     if (pos_cmp == pos)
1138       return node;
1139
1140     pos_cmp++;
1141     node = node->next;
1142   }
1143
1144   return node_default;
1145 }
1146
1147 struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
1148                                                     char *filename)
1149 {
1150   if (filename == NULL)
1151     return NULL;
1152
1153   while (node)
1154   {
1155     if (node->node_group)
1156     {
1157       struct LevelDirInfo *node_group;
1158
1159       node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
1160
1161       if (node_group)
1162         return node_group;
1163     }
1164     else if (!node->parent_link)
1165     {
1166       if (strcmp(filename, node->filename) == 0)
1167         return node;
1168     }
1169
1170     node = node->next;
1171   }
1172
1173   return NULL;
1174 }
1175
1176 struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
1177 {
1178   return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
1179 }
1180
1181 void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
1182 {
1183   int i;
1184
1185   while (node)
1186   {
1187     for (i=0; i<depth * 3; i++)
1188       printf(" ");
1189
1190     printf("filename == '%s'\n", node->filename);
1191
1192     if (node->node_group != NULL)
1193       dumpLevelDirInfo(node->node_group, depth + 1);
1194
1195     node = node->next;
1196   }
1197 }
1198
1199 void sortLevelDirInfo(struct LevelDirInfo **node_first,
1200                       int (*compare_function)(const void *, const void *))
1201 {
1202   int num_nodes = numLevelDirInfo(*node_first);
1203   struct LevelDirInfo **sort_array;
1204   struct LevelDirInfo *node = *node_first;
1205   int i = 0;
1206
1207   if (num_nodes == 0)
1208     return;
1209
1210   /* allocate array for sorting structure pointers */
1211   sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
1212
1213   /* writing structure pointers to sorting array */
1214   while (i < num_nodes && node)         /* double boundary check... */
1215   {
1216     sort_array[i] = node;
1217
1218     i++;
1219     node = node->next;
1220   }
1221
1222   /* sorting the structure pointers in the sorting array */
1223   qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
1224         compare_function);
1225
1226   /* update the linkage of list elements with the sorted node array */
1227   for (i=0; i<num_nodes - 1; i++)
1228     sort_array[i]->next = sort_array[i + 1];
1229   sort_array[num_nodes - 1]->next = NULL;
1230
1231   /* update the linkage of the main list anchor pointer */
1232   *node_first = sort_array[0];
1233
1234   free(sort_array);
1235
1236   /* now recursively sort the level group structures */
1237   node = *node_first;
1238   while (node)
1239   {
1240     if (node->node_group != NULL)
1241       sortLevelDirInfo(&node->node_group, compare_function);
1242
1243     node = node->next;
1244   }
1245 }
1246
1247 inline void swap_numbers(int *i1, int *i2)
1248 {
1249   int help = *i1;
1250
1251   *i1 = *i2;
1252   *i2 = help;
1253 }
1254
1255 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1256 {
1257   int help_x = *x1;
1258   int help_y = *y1;
1259
1260   *x1 = *x2;
1261   *x2 = help_x;
1262
1263   *y1 = *y2;
1264   *y2 = help_y;
1265 }
1266
1267
1268 /* ========================================================================= */
1269 /* some stuff from "files.c"                                                 */
1270 /* ========================================================================= */
1271
1272 #define MODE_R_ALL              (S_IRUSR | S_IRGRP | S_IROTH)
1273 #define MODE_W_ALL              (S_IWUSR | S_IWGRP | S_IWOTH)
1274 #define MODE_X_ALL              (S_IXUSR | S_IXGRP | S_IXOTH)
1275 #define USERDATA_DIR_MODE       (MODE_R_ALL | MODE_X_ALL | S_IWUSR)
1276
1277 char *getUserDataDir(void)
1278 {
1279   static char *userdata_dir = NULL;
1280
1281   if (!userdata_dir)
1282   {
1283     char *home_dir = getHomeDir();
1284     char *data_dir = program.userdata_directory;
1285
1286     userdata_dir = getPath2(home_dir, data_dir);
1287   }
1288
1289   return userdata_dir;
1290 }
1291
1292 void createDirectory(char *dir, char *text)
1293 {
1294   if (access(dir, F_OK) != 0)
1295 #if defined(PLATFORM_WIN32)
1296     if (mkdir(dir) != 0)
1297 #else
1298     if (mkdir(dir, USERDATA_DIR_MODE) != 0)
1299 #endif
1300       Error(ERR_WARN, "cannot create %s directory '%s'", text, dir);
1301 }
1302
1303 void InitUserDataDirectory()
1304 {
1305   createDirectory(getUserDataDir(), "user data");
1306 }
1307
1308
1309 /* ========================================================================= */
1310 /* functions only needed for non-Unix (non-command-line) systems */
1311 /* ========================================================================= */
1312
1313 #if !defined(PLATFORM_UNIX)
1314
1315 #define ERROR_FILENAME          "error.out"
1316
1317 void initErrorFile()
1318 {
1319   char *filename;
1320
1321   InitUserDataDirectory();
1322
1323   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1324   unlink(filename);
1325   free(filename);
1326 }
1327
1328 FILE *openErrorFile()
1329 {
1330   char *filename;
1331   FILE *error_file;
1332
1333   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1334   error_file = fopen(filename, MODE_APPEND);
1335   free(filename);
1336
1337   return error_file;
1338 }
1339
1340 void dumpErrorFile()
1341 {
1342   char *filename;
1343   FILE *error_file;
1344
1345   filename = getPath2(getUserDataDir(), ERROR_FILENAME);
1346   error_file = fopen(filename, MODE_READ);
1347   free(filename);
1348
1349   if (error_file != NULL)
1350   {
1351     while (!feof(error_file))
1352       fputc(fgetc(error_file), stderr);
1353
1354     fclose(error_file);
1355   }
1356 }
1357 #endif
1358
1359
1360 /* ========================================================================= */
1361 /* the following is only for debugging purpose and normally not used         */
1362 /* ========================================================================= */
1363
1364 #define DEBUG_NUM_TIMESTAMPS    3
1365
1366 void debug_print_timestamp(int counter_nr, char *message)
1367 {
1368   static long counter[DEBUG_NUM_TIMESTAMPS][2];
1369
1370   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1371     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1372
1373   counter[counter_nr][0] = Counter();
1374
1375   if (message)
1376     printf("%s %.2f seconds\n", message,
1377            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1378
1379   counter[counter_nr][1] = Counter();
1380 }