src/libgame/misc.c

   1 /***********************************************************
   2 *  Rocks'n'Diamonds -- McDuffin Strikes Back!              *
   3 *----------------------------------------------------------*
   4 *  (c) 1995-98 Artsoft Entertainment                       *
   5 *              Holger Schemel                              *
   6 *              Oststrasse 11a                              *
   7 *              33604 Bielefeld                             *
   8 *              phone: ++49 +521 290471                     *
   9 *              email: aeglos@valinor.owl.de                *
  10 *----------------------------------------------------------*
  11 *  misc.c                                                  *
  12 ***********************************************************/
  13
  14 #include <time.h>
  15 #include <sys/time.h>
  16 #include <sys/types.h>
  17 #include <stdarg.h>
  18 #include <ctype.h>
  19
  20 #include "platform.h"
  21
  22 #if !defined(PLATFORM_WIN32)
  23 #include <pwd.h>
  24 #include <sys/param.h>
  25 #endif
  26
  27 #include "libgame.h"
  28
  29 #include "main_TMP.h"
  30
  31 #include "misc.h"
  32
  33 #if 0
  34 #include "joystick_TMP.h"
  35 #endif
  36
  37 #if defined(PLATFORM_MSDOS)
  38 volatile unsigned long counter = 0;
  39
  40 void increment_counter()
  41 {
  42   counter++;
  43 }
  44
  45 END_OF_FUNCTION(increment_counter);
  46 #endif
  47
  48
  49 /* maximal allowed length of a command line option */
  50 #define MAX_OPTION_LEN          256
  51
  52 #ifdef TARGET_SDL
  53 static unsigned long mainCounter(int mode)
  54 {
  55   static unsigned long base_ms = 0;
  56   unsigned long current_ms;
  57   unsigned long counter_ms;
  58
  59   current_ms = SDL_GetTicks();
  60
  61   /* reset base time in case of counter initializing or wrap-around */
  62   if (mode == INIT_COUNTER || current_ms < base_ms)
  63     base_ms = current_ms;
  64
  65   counter_ms = current_ms - base_ms;
  66
  67   return counter_ms;            /* return milliseconds since last init */
  68 }
  69
  70 #else /* !TARGET_SDL */
  71
  72 #if defined(PLATFORM_UNIX)
  73 static unsigned long mainCounter(int mode)
  74 {
  75   static struct timeval base_time = { 0, 0 };
  76   struct timeval current_time;
  77   unsigned long counter_ms;
  78
  79   gettimeofday(&current_time, NULL);
  80
  81   /* reset base time in case of counter initializing or wrap-around */
  82   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
  83     base_time = current_time;
  84
  85   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
  86              + (current_time.tv_usec - base_time.tv_usec) / 1000;
  87
  88   return counter_ms;            /* return milliseconds since last init */
  89 }
  90 #endif /* PLATFORM_UNIX */
  91 #endif /* !TARGET_SDL */
  92
  93 void InitCounter()              /* set counter back to zero */
  94 {
  95 #if !defined(PLATFORM_MSDOS)
  96   mainCounter(INIT_COUNTER);
  97 #else
  98   LOCK_VARIABLE(counter);
  99   LOCK_FUNCTION(increment_counter);
 100   install_int_ex(increment_counter, BPS_TO_TIMER(100));
 101 #endif
 102 }
 103
 104 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
 105 {
 106 #if !defined(PLATFORM_MSDOS)
 107   return mainCounter(READ_COUNTER);
 108 #else
 109   return (counter * 10);
 110 #endif
 111 }
 112
 113 static void sleep_milliseconds(unsigned long milliseconds_delay)
 114 {
 115   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
 116
 117 #if defined(PLATFORM_MSDOS)
 118   /* don't use select() to perform waiting operations under DOS/Windows
 119      environment; always use a busy loop for waiting instead */
 120   do_busy_waiting = TRUE;
 121 #endif
 122
 123   if (do_busy_waiting)
 124   {
 125     /* we want to wait only a few ms -- if we assume that we have a
 126        kernel timer resolution of 10 ms, we would wait far to long;
 127        therefore it's better to do a short interval of busy waiting
 128        to get our sleeping time more accurate */
 129
 130     unsigned long base_counter = Counter(), actual_counter = Counter();
 131
 132     while (actual_counter < base_counter + milliseconds_delay &&
 133            actual_counter >= base_counter)
 134       actual_counter = Counter();
 135   }
 136   else
 137   {
 138 #if defined(TARGET_SDL)
 139     SDL_Delay(milliseconds_delay);
 140 #else
 141     struct timeval delay;
 142
 143     delay.tv_sec  = milliseconds_delay / 1000;
 144     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 145
 146     if (select(0, NULL, NULL, NULL, &delay) != 0)
 147       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
 148 #endif
 149   }
 150 }
 151
 152 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
 153 {
 154   sleep_milliseconds(delay);
 155 }
 156
 157 boolean FrameReached(unsigned long *frame_counter_var,
 158                      unsigned long frame_delay)
 159 {
 160   unsigned long actual_frame_counter = FrameCounter;
 161
 162   if (actual_frame_counter < *frame_counter_var+frame_delay &&
 163       actual_frame_counter >= *frame_counter_var)
 164     return(FALSE);
 165
 166   *frame_counter_var = actual_frame_counter;
 167   return(TRUE);
 168 }
 169
 170 boolean DelayReached(unsigned long *counter_var,
 171                      unsigned long delay)
 172 {
 173   unsigned long actual_counter = Counter();
 174
 175   if (actual_counter < *counter_var + delay &&
 176       actual_counter >= *counter_var)
 177     return(FALSE);
 178
 179   *counter_var = actual_counter;
 180   return(TRUE);
 181 }
 182
 183 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 184 {
 185   unsigned long actual_counter;
 186
 187   while(1)
 188   {
 189     actual_counter = Counter();
 190
 191     if (actual_counter < *counter_var + delay &&
 192         actual_counter >= *counter_var)
 193       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 194     else
 195       break;
 196   }
 197
 198   *counter_var = actual_counter;
 199 }
 200
 201 /* int2str() returns a number converted to a string;
 202    the used memory is static, but will be overwritten by later calls,
 203    so if you want to save the result, copy it to a private string buffer;
 204    there can be 10 local calls of int2str() without buffering the result --
 205    the 11th call will then destroy the result from the first call and so on.
 206 */
 207
 208 char *int2str(int number, int size)
 209 {
 210   static char shift_array[10][40];
 211   static int shift_counter = 0;
 212   char *s = shift_array[shift_counter];
 213
 214   shift_counter = (shift_counter + 1) % 10;
 215
 216   if (size > 20)
 217     size = 20;
 218
 219   if (size)
 220   {
 221     sprintf(s, "                    %09d", number);
 222     return &s[strlen(s) - size];
 223   }
 224   else
 225   {
 226     sprintf(s, "%d", number);
 227     return s;
 228   }
 229 }
 230
 231 unsigned int SimpleRND(unsigned int max)
 232 {
 233 #if defined(TARGET_SDL)
 234   static unsigned long root = 654321;
 235   unsigned long current_ms;
 236
 237   current_ms = SDL_GetTicks();
 238   root = root * 4253261 + current_ms;
 239   return (root % max);
 240 #else
 241   static unsigned long root = 654321;
 242   struct timeval current_time;
 243
 244   gettimeofday(&current_time, NULL);
 245   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
 246   return (root % max);
 247 #endif
 248 }
 249
 250 #ifdef DEBUG
 251 static unsigned int last_RND_value = 0;
 252
 253 unsigned int last_RND()
 254 {
 255   return last_RND_value;
 256 }
 257 #endif
 258
 259 unsigned int RND(unsigned int max)
 260 {
 261 #ifdef DEBUG
 262   return (last_RND_value = random_linux_libc() % max);
 263 #else
 264   return (random_linux_libc() % max);
 265 #endif
 266 }
 267
 268 unsigned int InitRND(long seed)
 269 {
 270 #if defined(TARGET_SDL)
 271   unsigned long current_ms;
 272
 273   if (seed == NEW_RANDOMIZE)
 274   {
 275     current_ms = SDL_GetTicks();
 276     srandom_linux_libc((unsigned int) current_ms);
 277     return (unsigned int) current_ms;
 278   }
 279   else
 280   {
 281     srandom_linux_libc((unsigned int) seed);
 282     return (unsigned int) seed;
 283   }
 284 #else
 285   struct timeval current_time;
 286
 287   if (seed == NEW_RANDOMIZE)
 288   {
 289     gettimeofday(&current_time, NULL);
 290     srandom_linux_libc((unsigned int) current_time.tv_usec);
 291     return (unsigned int) current_time.tv_usec;
 292   }
 293   else
 294   {
 295     srandom_linux_libc((unsigned int) seed);
 296     return (unsigned int) seed;
 297   }
 298 #endif
 299 }
 300
 301 char *getLoginName()
 302 {
 303 #if defined(PLATFORM_WIN32)
 304   return ANONYMOUS_NAME;
 305 #else
 306   struct passwd *pwd;
 307
 308   if ((pwd = getpwuid(getuid())) == NULL)
 309     return ANONYMOUS_NAME;
 310   else
 311     return pwd->pw_name;
 312 #endif
 313 }
 314
 315 char *getRealName()
 316 {
 317 #if defined(PLATFORM_UNIX)
 318   struct passwd *pwd;
 319
 320   if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
 321     return ANONYMOUS_NAME;
 322   else
 323   {
 324     static char real_name[1024];
 325     char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
 326
 327     if (strchr(pwd->pw_gecos, 'ß') == NULL)
 328       return pwd->pw_gecos;
 329
 330     /* the user's real name contains a 'ß' character (german sharp s),
 331        which has no equivalent in upper case letters (which our fonts use) */
 332     while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
 333     {
 334       if (*from_ptr != 'ß')
 335         *to_ptr++ = *from_ptr++;
 336       else
 337       {
 338         from_ptr++;
 339         *to_ptr++ = 's';
 340         *to_ptr++ = 's';
 341       }
 342     }
 343     *to_ptr = '\0';
 344
 345     return real_name;
 346   }
 347 #else /* !PLATFORM_UNIX */
 348   return ANONYMOUS_NAME;
 349 #endif
 350 }
 351
 352 char *getHomeDir()
 353 {
 354 #if defined(PLATFORM_UNIX)
 355   static char *home_dir = NULL;
 356
 357   if (!home_dir)
 358   {
 359     if (!(home_dir = getenv("HOME")))
 360     {
 361       struct passwd *pwd;
 362
 363       if ((pwd = getpwuid(getuid())))
 364         home_dir = pwd->pw_dir;
 365       else
 366         home_dir = ".";
 367     }
 368   }
 369
 370   return home_dir;
 371 #else
 372   return ".";
 373 #endif
 374 }
 375
 376 char *getPath2(char *path1, char *path2)
 377 {
 378   char *complete_path = checked_malloc(strlen(path1) + 1 +
 379                                        strlen(path2) + 1);
 380
 381   sprintf(complete_path, "%s/%s", path1, path2);
 382   return complete_path;
 383 }
 384
 385 char *getPath3(char *path1, char *path2, char *path3)
 386 {
 387   char *complete_path = checked_malloc(strlen(path1) + 1 +
 388                                        strlen(path2) + 1 +
 389                                        strlen(path3) + 1);
 390
 391   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 392   return complete_path;
 393 }
 394
 395 char *getStringCopy(char *s)
 396 {
 397   char *s_copy;
 398
 399   if (s == NULL)
 400     return NULL;
 401
 402   s_copy = checked_malloc(strlen(s) + 1);
 403
 404   strcpy(s_copy, s);
 405   return s_copy;
 406 }
 407
 408 char *getStringToLower(char *s)
 409 {
 410   char *s_copy = checked_malloc(strlen(s) + 1);
 411   char *s_ptr = s_copy;
 412
 413   while (*s)
 414     *s_ptr++ = tolower(*s++);
 415   *s_ptr = '\0';
 416
 417   return s_copy;
 418 }
 419
 420 void MarkTileDirty(int x, int y)
 421 {
 422   int xx = redraw_x1 + x;
 423   int yy = redraw_y1 + y;
 424
 425   if (!redraw[xx][yy])
 426     redraw_tiles++;
 427
 428   redraw[xx][yy] = TRUE;
 429   redraw_mask |= REDRAW_TILES;
 430 }
 431
 432 void SetBorderElement()
 433 {
 434   int x, y;
 435
 436   BorderElement = EL_LEERRAUM;
 437
 438   for(y=0; y<lev_fieldy && BorderElement == EL_LEERRAUM; y++)
 439   {
 440     for(x=0; x<lev_fieldx; x++)
 441     {
 442       if (!IS_MASSIVE(Feld[x][y]))
 443         BorderElement = EL_BETON;
 444
 445       if (y != 0 && y != lev_fieldy - 1 && x != lev_fieldx - 1)
 446         x = lev_fieldx - 2;
 447     }
 448   }
 449 }
 450
 451 void GetOptions(char *argv[])
 452 {
 453   char **options_left = &argv[1];
 454
 455   /* initialize global program options */
 456   options.display_name = NULL;
 457   options.server_host = NULL;
 458   options.server_port = 0;
 459   options.ro_base_directory = RO_BASE_PATH;
 460   options.rw_base_directory = RW_BASE_PATH;
 461   options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
 462   options.serveronly = FALSE;
 463   options.network = FALSE;
 464   options.verbose = FALSE;
 465   options.debug = FALSE;
 466
 467   /* initialize some more global variables */
 468   global.frames_per_second = 0;
 469   global.fps_slowdown = FALSE;
 470   global.fps_slowdown_factor = 1;
 471
 472   while (*options_left)
 473   {
 474     char option_str[MAX_OPTION_LEN];
 475     char *option = options_left[0];
 476     char *next_option = options_left[1];
 477     char *option_arg = NULL;
 478     int option_len = strlen(option);
 479
 480     if (option_len >= MAX_OPTION_LEN)
 481       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 482
 483     strcpy(option_str, option);                 /* copy argument into buffer */
 484     option = option_str;
 485
 486     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 487       break;
 488
 489     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 490       option++;
 491
 492     option_arg = strchr(option, '=');
 493     if (option_arg == NULL)                     /* no '=' in option */
 494       option_arg = next_option;
 495     else
 496     {
 497       *option_arg++ = '\0';                     /* cut argument from option */
 498       if (*option_arg == '\0')                  /* no argument after '=' */
 499         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 500     }
 501
 502     option_len = strlen(option);
 503
 504     if (strcmp(option, "-") == 0)
 505       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 506     else if (strncmp(option, "-help", option_len) == 0)
 507     {
 508       printf("Usage: %s [options] [server.name [port]]\n"
 509              "Options:\n"
 510              "  -d, --display machine:0       X server display\n"
 511              "  -b, --basepath directory      alternative base directory\n"
 512              "  -l, --level directory         alternative level directory\n"
 513              "  -s, --serveronly              only start network server\n"
 514              "  -n, --network                 network multiplayer game\n"
 515              "  -v, --verbose                 verbose mode\n",
 516              program_name);
 517       exit(0);
 518     }
 519     else if (strncmp(option, "-display", option_len) == 0)
 520     {
 521       if (option_arg == NULL)
 522         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 523
 524       options.display_name = option_arg;
 525       if (option_arg == next_option)
 526         options_left++;
 527     }
 528     else if (strncmp(option, "-basepath", option_len) == 0)
 529     {
 530       if (option_arg == NULL)
 531         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 532
 533       /* this should be extended to separate options for ro and rw data */
 534       options.ro_base_directory = option_arg;
 535       options.rw_base_directory = option_arg;
 536       if (option_arg == next_option)
 537         options_left++;
 538
 539       /* adjust path for level directory accordingly */
 540       options.level_directory =
 541         getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
 542     }
 543     else if (strncmp(option, "-levels", option_len) == 0)
 544     {
 545       if (option_arg == NULL)
 546         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 547
 548       options.level_directory = option_arg;
 549       if (option_arg == next_option)
 550         options_left++;
 551     }
 552     else if (strncmp(option, "-network", option_len) == 0)
 553     {
 554       options.network = TRUE;
 555     }
 556     else if (strncmp(option, "-serveronly", option_len) == 0)
 557     {
 558       options.serveronly = TRUE;
 559     }
 560     else if (strncmp(option, "-verbose", option_len) == 0)
 561     {
 562       options.verbose = TRUE;
 563     }
 564     else if (strncmp(option, "-debug", option_len) == 0)
 565     {
 566       options.debug = TRUE;
 567     }
 568     else if (*option == '-')
 569     {
 570       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 571     }
 572     else if (options.server_host == NULL)
 573     {
 574       options.server_host = *options_left;
 575     }
 576     else if (options.server_port == 0)
 577     {
 578       options.server_port = atoi(*options_left);
 579       if (options.server_port < 1024)
 580         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 581     }
 582     else
 583       Error(ERR_EXIT_HELP, "too many arguments");
 584
 585     options_left++;
 586   }
 587 }
 588
 589 void Error(int mode, char *format, ...)
 590 {
 591   char *process_name = "";
 592   FILE *error = stderr;
 593
 594   /* display warnings only when running in verbose mode */
 595   if (mode & ERR_WARN && !options.verbose)
 596     return;
 597
 598 #if !defined(PLATFORM_UNIX)
 599   if ((error = openErrorFile()) == NULL)
 600   {
 601     printf("Cannot write to error output file!\n");
 602     CloseAllAndExit(1);
 603   }
 604 #endif
 605
 606   if (mode & ERR_SOUND_SERVER)
 607     process_name = " sound server";
 608   else if (mode & ERR_NETWORK_SERVER)
 609     process_name = " network server";
 610   else if (mode & ERR_NETWORK_CLIENT)
 611     process_name = " network client **";
 612
 613   if (format)
 614   {
 615     va_list ap;
 616
 617     fprintf(error, "%s%s: ", program_name, process_name);
 618
 619     if (mode & ERR_WARN)
 620       fprintf(error, "warning: ");
 621
 622     va_start(ap, format);
 623     vfprintf(error, format, ap);
 624     va_end(ap);
 625
 626     fprintf(error, "\n");
 627   }
 628
 629   if (mode & ERR_HELP)
 630     fprintf(error, "%s: Try option '--help' for more information.\n",
 631             program_name);
 632
 633   if (mode & ERR_EXIT)
 634     fprintf(error, "%s%s: aborting\n", program_name, process_name);
 635
 636   if (error != stderr)
 637     fclose(error);
 638
 639   if (mode & ERR_EXIT)
 640   {
 641     if (mode & ERR_FROM_SERVER)
 642       exit(1);                          /* child process: normal exit */
 643     else
 644       CloseAllAndExit(1);               /* main process: clean up stuff */
 645   }
 646 }
 647
 648 void *checked_malloc(unsigned long size)
 649 {
 650   void *ptr;
 651
 652   ptr = malloc(size);
 653
 654   if (ptr == NULL)
 655     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 656
 657   return ptr;
 658 }
 659
 660 void *checked_calloc(unsigned long size)
 661 {
 662   void *ptr;
 663
 664   ptr = calloc(1, size);
 665
 666   if (ptr == NULL)
 667     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 668
 669   return ptr;
 670 }
 671
 672 short getFile16BitInteger(FILE *file, int byte_order)
 673 {
 674   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 675     return ((fgetc(file) <<  8) |
 676             (fgetc(file) <<  0));
 677   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 678     return ((fgetc(file) <<  0) |
 679             (fgetc(file) <<  8));
 680 }
 681
 682 void putFile16BitInteger(FILE *file, short value, int byte_order)
 683 {
 684   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 685   {
 686     fputc((value >>  8) & 0xff, file);
 687     fputc((value >>  0) & 0xff, file);
 688   }
 689   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 690   {
 691     fputc((value >>  0) & 0xff, file);
 692     fputc((value >>  8) & 0xff, file);
 693   }
 694 }
 695
 696 int getFile32BitInteger(FILE *file, int byte_order)
 697 {
 698   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 699     return ((fgetc(file) << 24) |
 700             (fgetc(file) << 16) |
 701             (fgetc(file) <<  8) |
 702             (fgetc(file) <<  0));
 703   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 704     return ((fgetc(file) <<  0) |
 705             (fgetc(file) <<  8) |
 706             (fgetc(file) << 16) |
 707             (fgetc(file) << 24));
 708 }
 709
 710 void putFile32BitInteger(FILE *file, int value, int byte_order)
 711 {
 712   if (byte_order == BYTE_ORDER_BIG_ENDIAN)
 713   {
 714     fputc((value >> 24) & 0xff, file);
 715     fputc((value >> 16) & 0xff, file);
 716     fputc((value >>  8) & 0xff, file);
 717     fputc((value >>  0) & 0xff, file);
 718   }
 719   else           /* BYTE_ORDER_LITTLE_ENDIAN */
 720   {
 721     fputc((value >>  0) & 0xff, file);
 722     fputc((value >>  8) & 0xff, file);
 723     fputc((value >> 16) & 0xff, file);
 724     fputc((value >> 24) & 0xff, file);
 725   }
 726 }
 727
 728 void getFileChunk(FILE *file, char *chunk_buffer, int *chunk_length,
 729                   int byte_order)
 730 {
 731   const int chunk_identifier_length = 4;
 732
 733   /* read chunk identifier */
 734   fgets(chunk_buffer, chunk_identifier_length + 1, file);
 735
 736   /* read chunk length */
 737   *chunk_length = getFile32BitInteger(file, byte_order);
 738 }
 739
 740 void putFileChunk(FILE *file, char *chunk_name, int chunk_length,
 741                   int byte_order)
 742 {
 743   /* write chunk identifier */
 744   fputs(chunk_name, file);
 745
 746   /* write chunk length */
 747   putFile32BitInteger(file, chunk_length, byte_order);
 748 }
 749
 750 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 751 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 752 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
 753
 754 void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
 755 {
 756   static struct
 757   {
 758     Key key;
 759     char *x11name;
 760     char *name;
 761   } translate_key[] =
 762   {
 763     /* normal cursor keys */
 764     { KSYM_Left,        "XK_Left",              "cursor left" },
 765     { KSYM_Right,       "XK_Right",             "cursor right" },
 766     { KSYM_Up,          "XK_Up",                "cursor up" },
 767     { KSYM_Down,        "XK_Down",              "cursor down" },
 768
 769     /* keypad cursor keys */
 770 #ifdef KSYM_KP_Left
 771     { KSYM_KP_Left,     "XK_KP_Left",           "keypad left" },
 772     { KSYM_KP_Right,    "XK_KP_Right",          "keypad right" },
 773     { KSYM_KP_Up,       "XK_KP_Up",             "keypad up" },
 774     { KSYM_KP_Down,     "XK_KP_Down",           "keypad down" },
 775 #endif
 776
 777     /* other keypad keys */
 778 #ifdef KSYM_KP_Enter
 779     { KSYM_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
 780     { KSYM_KP_Add,      "XK_KP_Add",            "keypad +" },
 781     { KSYM_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
 782     { KSYM_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
 783     { KSYM_KP_Divide,   "XK_KP_Divide",         "keypad /" },
 784     { KSYM_KP_Separator,"XK_KP_Separator",      "keypad ," },
 785 #endif
 786
 787     /* modifier keys */
 788     { KSYM_Shift_L,     "XK_Shift_L",           "left shift" },
 789     { KSYM_Shift_R,     "XK_Shift_R",           "right shift" },
 790     { KSYM_Control_L,   "XK_Control_L",         "left control" },
 791     { KSYM_Control_R,   "XK_Control_R",         "right control" },
 792     { KSYM_Meta_L,      "XK_Meta_L",            "left meta" },
 793     { KSYM_Meta_R,      "XK_Meta_R",            "right meta" },
 794     { KSYM_Alt_L,       "XK_Alt_L",             "left alt" },
 795     { KSYM_Alt_R,       "XK_Alt_R",             "right alt" },
 796     { KSYM_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
 797     { KSYM_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
 798     { KSYM_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
 799     { KSYM_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
 800
 801     /* some special keys */
 802     { KSYM_BackSpace,   "XK_BackSpace",         "backspace" },
 803     { KSYM_Delete,      "XK_Delete",            "delete" },
 804     { KSYM_Insert,      "XK_Insert",            "insert" },
 805     { KSYM_Tab,         "XK_Tab",               "tab" },
 806     { KSYM_Home,        "XK_Home",              "home" },
 807     { KSYM_End,         "XK_End",               "end" },
 808     { KSYM_Page_Up,     "XK_Page_Up",           "page up" },
 809     { KSYM_Page_Down,   "XK_Page_Down",         "page down" },
 810     { KSYM_Menu,        "XK_Menu",              "menu" },        /* Win-Menu */
 811
 812     /* ASCII 0x20 to 0x40 keys (except numbers) */
 813     { KSYM_space,       "XK_space",             "space" },
 814     { KSYM_exclam,      "XK_exclam",            "!" },
 815     { KSYM_quotedbl,    "XK_quotedbl",          "\"" },
 816     { KSYM_numbersign,  "XK_numbersign",        "#" },
 817     { KSYM_dollar,      "XK_dollar",            "$" },
 818     { KSYM_percent,     "XK_percent",           "%" },
 819     { KSYM_ampersand,   "XK_ampersand",         "&" },
 820     { KSYM_apostrophe,  "XK_apostrophe",        "'" },
 821     { KSYM_parenleft,   "XK_parenleft",         "(" },
 822     { KSYM_parenright,  "XK_parenright",        ")" },
 823     { KSYM_asterisk,    "XK_asterisk",          "*" },
 824     { KSYM_plus,        "XK_plus",              "+" },
 825     { KSYM_comma,       "XK_comma",             "," },
 826     { KSYM_minus,       "XK_minus",             "-" },
 827     { KSYM_period,      "XK_period",            "." },
 828     { KSYM_slash,       "XK_slash",             "/" },
 829     { KSYM_colon,       "XK_colon",             ":" },
 830     { KSYM_semicolon,   "XK_semicolon",         ";" },
 831     { KSYM_less,        "XK_less",              "<" },
 832     { KSYM_equal,       "XK_equal",             "=" },
 833     { KSYM_greater,     "XK_greater",           ">" },
 834     { KSYM_question,    "XK_question",          "?" },
 835     { KSYM_at,          "XK_at",                "@" },
 836
 837     /* more ASCII keys */
 838     { KSYM_bracketleft, "XK_bracketleft",       "[" },
 839     { KSYM_backslash,   "XK_backslash",         "backslash" },
 840     { KSYM_bracketright,"XK_bracketright",      "]" },
 841     { KSYM_asciicircum, "XK_asciicircum",       "circumflex" },
 842     { KSYM_underscore,  "XK_underscore",        "_" },
 843     { KSYM_grave,       "XK_grave",             "grave" },
 844     { KSYM_quoteleft,   "XK_quoteleft",         "quote left" },
 845     { KSYM_braceleft,   "XK_braceleft",         "brace left" },
 846     { KSYM_bar,         "XK_bar",               "bar" },
 847     { KSYM_braceright,  "XK_braceright",        "brace right" },
 848     { KSYM_asciitilde,  "XK_asciitilde",        "ascii tilde" },
 849
 850     /* special (non-ASCII) keys */
 851     { KSYM_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
 852     { KSYM_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
 853     { KSYM_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
 854     { KSYM_adiaeresis,  "XK_adiaeresis",        "ä" },
 855     { KSYM_odiaeresis,  "XK_odiaeresis",        "ö" },
 856     { KSYM_udiaeresis,  "XK_udiaeresis",        "ü" },
 857     { KSYM_ssharp,      "XK_ssharp",            "sharp s" },
 858
 859     /* end-of-array identifier */
 860     { 0,                NULL,                   NULL }
 861   };
 862
 863   int i;
 864
 865   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
 866   {
 867     static char name_buffer[30];
 868     Key key = *keysym;
 869
 870     if (key >= KSYM_A && key <= KSYM_Z)
 871       sprintf(name_buffer, "%c", 'A' + (char)(key - KSYM_A));
 872     else if (key >= KSYM_a && key <= KSYM_z)
 873       sprintf(name_buffer, "%c", 'a' + (char)(key - KSYM_a));
 874     else if (key >= KSYM_0 && key <= KSYM_9)
 875       sprintf(name_buffer, "%c", '0' + (char)(key - KSYM_0));
 876     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 877       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KSYM_KP_0));
 878     else if (key >= KSYM_F1 && key <= KSYM_F24)
 879       sprintf(name_buffer, "function F%d", (int)(key - KSYM_F1 + 1));
 880     else if (key == KSYM_UNDEFINED)
 881       strcpy(name_buffer, "(undefined)");
 882     else
 883     {
 884       i = 0;
 885
 886       do
 887       {
 888         if (key == translate_key[i].key)
 889         {
 890           strcpy(name_buffer, translate_key[i].name);
 891           break;
 892         }
 893       }
 894       while (translate_key[++i].name);
 895
 896       if (!translate_key[i].name)
 897         strcpy(name_buffer, "(unknown)");
 898     }
 899
 900     *name = name_buffer;
 901   }
 902   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
 903   {
 904     static char name_buffer[30];
 905     Key key = *keysym;
 906
 907     if (key >= KSYM_A && key <= KSYM_Z)
 908       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KSYM_A));
 909     else if (key >= KSYM_a && key <= KSYM_z)
 910       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KSYM_a));
 911     else if (key >= KSYM_0 && key <= KSYM_9)
 912       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KSYM_0));
 913     else if (key >= KSYM_KP_0 && key <= KSYM_KP_9)
 914       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KSYM_KP_0));
 915     else if (key >= KSYM_F1 && key <= KSYM_F24)
 916       sprintf(name_buffer, "XK_F%d", (int)(key - KSYM_F1 + 1));
 917     else if (key == KSYM_UNDEFINED)
 918       strcpy(name_buffer, "[undefined]");
 919     else
 920     {
 921       i = 0;
 922
 923       do
 924       {
 925         if (key == translate_key[i].key)
 926         {
 927           strcpy(name_buffer, translate_key[i].x11name);
 928           break;
 929         }
 930       }
 931       while (translate_key[++i].x11name);
 932
 933       if (!translate_key[i].x11name)
 934         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
 935     }
 936
 937     *x11name = name_buffer;
 938   }
 939   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
 940   {
 941     Key key = KSYM_UNDEFINED;
 942     char *name_ptr = *x11name;
 943
 944     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
 945     {
 946       char c = name_ptr[3];
 947
 948       if (c >= 'A' && c <= 'Z')
 949         key = KSYM_A + (Key)(c - 'A');
 950       else if (c >= 'a' && c <= 'z')
 951         key = KSYM_a + (Key)(c - 'a');
 952       else if (c >= '0' && c <= '9')
 953         key = KSYM_0 + (Key)(c - '0');
 954     }
 955     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
 956     {
 957       char c = name_ptr[6];
 958
 959       if (c >= '0' && c <= '9')
 960         key = KSYM_0 + (Key)(c - '0');
 961     }
 962     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
 963     {
 964       char c1 = name_ptr[4];
 965       char c2 = name_ptr[5];
 966       int d = 0;
 967
 968       if ((c1 >= '0' && c1 <= '9') &&
 969           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
 970         d = atoi(&name_ptr[4]);
 971
 972       if (d >=1 && d <= 24)
 973         key = KSYM_F1 + (Key)(d - 1);
 974     }
 975     else if (strncmp(name_ptr, "XK_", 3) == 0)
 976     {
 977       i = 0;
 978
 979       do
 980       {
 981         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
 982         {
 983           key = translate_key[i].key;
 984           break;
 985         }
 986       }
 987       while (translate_key[++i].x11name);
 988     }
 989     else if (strncmp(name_ptr, "0x", 2) == 0)
 990     {
 991       unsigned long value = 0;
 992
 993       name_ptr += 2;
 994
 995       while (name_ptr)
 996       {
 997         char c = *name_ptr++;
 998         int d = -1;
 999
1000         if (c >= '0' && c <= '9')
1001           d = (int)(c - '0');
1002         else if (c >= 'a' && c <= 'f')
1003           d = (int)(c - 'a' + 10);
1004         else if (c >= 'A' && c <= 'F')
1005           d = (int)(c - 'A' + 10);
1006
1007         if (d == -1)
1008         {
1009           value = -1;
1010           break;
1011         }
1012
1013         value = value * 16 + d;
1014       }
1015
1016       if (value != -1)
1017         key = (Key)value;
1018     }
1019
1020     *keysym = key;
1021   }
1022 }
1023
1024 char *getKeyNameFromKey(Key key)
1025 {
1026   char *name;
1027
1028   translate_keyname(&key, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
1029   return name;
1030 }
1031
1032 char *getX11KeyNameFromKey(Key key)
1033 {
1034   char *x11name;
1035
1036   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
1037   return x11name;
1038 }
1039
1040 Key getKeyFromX11KeyName(char *x11name)
1041 {
1042   Key key;
1043
1044   translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
1045   return key;
1046 }
1047
1048 char getCharFromKey(Key key)
1049 {
1050   char *keyname = getKeyNameFromKey(key);
1051   char letter = 0;
1052
1053   if (strlen(keyname) == 1)
1054     letter = keyname[0];
1055   else if (strcmp(keyname, "space") == 0)
1056     letter = ' ';
1057   else if (strcmp(keyname, "circumflex") == 0)
1058     letter = '^';
1059
1060   return letter;
1061 }
1062
1063 /* ------------------------------------------------------------------------- */
1064 /* some functions to handle lists of level directories                       */
1065 /* ------------------------------------------------------------------------- */
1066
1067 struct LevelDirInfo *newLevelDirInfo()
1068 {
1069   return checked_calloc(sizeof(struct LevelDirInfo));
1070 }
1071
1072 void pushLevelDirInfo(struct LevelDirInfo **node_first,
1073                       struct LevelDirInfo *node_new)
1074 {
1075   node_new->next = *node_first;
1076   *node_first = node_new;
1077 }
1078
1079 int numLevelDirInfo(struct LevelDirInfo *node)
1080 {
1081   int num = 0;
1082
1083   while (node)
1084   {
1085     num++;
1086     node = node->next;
1087   }
1088
1089   return num;
1090 }
1091
1092 boolean validLevelSeries(struct LevelDirInfo *node)
1093 {
1094   return (node != NULL && !node->node_group && !node->parent_link);
1095 }
1096
1097 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
1098 {
1099   if (node == NULL)
1100   {
1101     if (leveldir_first)         /* start with first level directory entry */
1102       return getFirstValidLevelSeries(leveldir_first);
1103     else
1104       return NULL;
1105   }
1106   else if (node->node_group)    /* enter level group (step down into tree) */
1107     return getFirstValidLevelSeries(node->node_group);
1108   else if (node->parent_link)   /* skip start entry of level group */
1109   {
1110     if (node->next)             /* get first real level series entry */
1111       return getFirstValidLevelSeries(node->next);
1112     else                        /* leave empty level group and go on */
1113       return getFirstValidLevelSeries(node->node_parent->next);
1114   }
1115   else                          /* this seems to be a regular level series */
1116     return node;
1117 }
1118
1119 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
1120 {
1121   if (node == NULL)
1122     return NULL;
1123
1124   if (node->node_parent == NULL)                /* top level group */
1125     return leveldir_first;
1126   else                                          /* sub level group */
1127     return node->node_parent->node_group;
1128 }
1129
1130 int numLevelDirInfoInGroup(struct LevelDirInfo *node)
1131 {
1132   return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
1133 }
1134
1135 int posLevelDirInfo(struct LevelDirInfo *node)
1136 {
1137   struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
1138   int pos = 0;
1139
1140   while (node_cmp)
1141   {
1142     if (node_cmp == node)
1143       return pos;
1144
1145     pos++;
1146     node_cmp = node_cmp->next;
1147   }
1148
1149   return 0;
1150 }
1151
1152 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
1153 {
1154   struct LevelDirInfo *node_default = node;
1155   int pos_cmp = 0;
1156
1157   while (node)
1158   {
1159     if (pos_cmp == pos)
1160       return node;
1161
1162     pos_cmp++;
1163     node = node->next;
1164   }
1165
1166   return node_default;
1167 }
1168
1169 struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
1170                                                     char *filename)
1171 {
1172   if (filename == NULL)
1173     return NULL;
1174
1175   while (node)
1176   {
1177     if (node->node_group)
1178     {
1179       struct LevelDirInfo *node_group;
1180
1181       node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
1182
1183       if (node_group)
1184         return node_group;
1185     }
1186     else if (!node->parent_link)
1187     {
1188       if (strcmp(filename, node->filename) == 0)
1189         return node;
1190     }
1191
1192     node = node->next;
1193   }
1194
1195   return NULL;
1196 }
1197
1198 struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
1199 {
1200   return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
1201 }
1202
1203 void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
1204 {
1205   int i;
1206
1207   while (node)
1208   {
1209     for (i=0; i<depth * 3; i++)
1210       printf(" ");
1211
1212     printf("filename == '%s'\n", node->filename);
1213
1214     if (node->node_group != NULL)
1215       dumpLevelDirInfo(node->node_group, depth + 1);
1216
1217     node = node->next;
1218   }
1219 }
1220
1221 void sortLevelDirInfo(struct LevelDirInfo **node_first,
1222                       int (*compare_function)(const void *, const void *))
1223 {
1224   int num_nodes = numLevelDirInfo(*node_first);
1225   struct LevelDirInfo **sort_array;
1226   struct LevelDirInfo *node = *node_first;
1227   int i = 0;
1228
1229   if (num_nodes == 0)
1230     return;
1231
1232   /* allocate array for sorting structure pointers */
1233   sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
1234
1235   /* writing structure pointers to sorting array */
1236   while (i < num_nodes && node)         /* double boundary check... */
1237   {
1238     sort_array[i] = node;
1239
1240     i++;
1241     node = node->next;
1242   }
1243
1244   /* sorting the structure pointers in the sorting array */
1245   qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
1246         compare_function);
1247
1248   /* update the linkage of list elements with the sorted node array */
1249   for (i=0; i<num_nodes - 1; i++)
1250     sort_array[i]->next = sort_array[i + 1];
1251   sort_array[num_nodes - 1]->next = NULL;
1252
1253   /* update the linkage of the main list anchor pointer */
1254   *node_first = sort_array[0];
1255
1256   free(sort_array);
1257
1258   /* now recursively sort the level group structures */
1259   node = *node_first;
1260   while (node)
1261   {
1262     if (node->node_group != NULL)
1263       sortLevelDirInfo(&node->node_group, compare_function);
1264
1265     node = node->next;
1266   }
1267 }
1268
1269 inline void swap_numbers(int *i1, int *i2)
1270 {
1271   int help = *i1;
1272
1273   *i1 = *i2;
1274   *i2 = help;
1275 }
1276
1277 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1278 {
1279   int help_x = *x1;
1280   int help_y = *y1;
1281
1282   *x1 = *x2;
1283   *x2 = help_x;
1284
1285   *y1 = *y2;
1286   *y2 = help_y;
1287 }
1288
1289
1290 /* ------------------------------------------------------------------------- */
1291 /* the following is only for debugging purpose and normally not used         */
1292 /* ------------------------------------------------------------------------- */
1293
1294 #define DEBUG_NUM_TIMESTAMPS    3
1295
1296 void debug_print_timestamp(int counter_nr, char *message)
1297 {
1298   static long counter[DEBUG_NUM_TIMESTAMPS][2];
1299
1300   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1301     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1302
1303   counter[counter_nr][0] = Counter();
1304
1305   if (message)
1306     printf("%s %.2f seconds\n", message,
1307            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1308
1309   counter[counter_nr][1] = Counter();
1310 }