src/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 #ifndef WIN32
  21 #include <pwd.h>
  22 #include <sys/param.h>
  23 #endif
  24
  25 #include "misc.h"
  26 #include "init.h"
  27 #include "tools.h"
  28 #include "sound.h"
  29 #include "random.h"
  30 #include "joystick.h"
  31 #include "files.h"
  32
  33 #ifdef MSDOS
  34 volatile unsigned long counter = 0;
  35
  36 void increment_counter()
  37 {
  38   counter++;
  39 }
  40
  41 END_OF_FUNCTION(increment_counter);
  42 #endif
  43
  44
  45 /* maximal allowed length of a command line option */
  46 #define MAX_OPTION_LEN          256
  47
  48 #ifdef USE_SDL_LIBRARY
  49
  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 /* !USE_SDL_LIBRARY */
  68 #ifndef MSDOS
  69
  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
  88 #endif /* !MSDOS */
  89 #endif /* !USE_SDL_LIBRARY */
  90
  91 void InitCounter()              /* set counter back to zero */
  92 {
  93 #ifndef MSDOS
  94   mainCounter(INIT_COUNTER);
  95 #else
  96   LOCK_VARIABLE(counter);
  97   LOCK_FUNCTION(increment_counter);
  98   install_int_ex(increment_counter, BPS_TO_TIMER(100));
  99 #endif
 100 }
 101
 102 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
 103 {
 104 #ifndef MSDOS
 105   return mainCounter(READ_COUNTER);
 106 #else
 107   return (counter * 10);
 108 #endif
 109 }
 110
 111 static void sleep_milliseconds(unsigned long milliseconds_delay)
 112 {
 113   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
 114
 115 #ifdef MSDOS
 116   /* don't use select() to perform waiting operations under DOS/Windows
 117      environment; always use a busy loop for waiting instead */
 118   do_busy_waiting = TRUE;
 119 #endif
 120
 121   if (do_busy_waiting)
 122   {
 123     /* we want to wait only a few ms -- if we assume that we have a
 124        kernel timer resolution of 10 ms, we would wait far to long;
 125        therefore it's better to do a short interval of busy waiting
 126        to get our sleeping time more accurate */
 127
 128     unsigned long base_counter = Counter(), actual_counter = Counter();
 129
 130     while (actual_counter < base_counter + milliseconds_delay &&
 131            actual_counter >= base_counter)
 132       actual_counter = Counter();
 133   }
 134   else
 135   {
 136 #ifdef USE_SDL_LIBRARY
 137     SDL_Delay(milliseconds_delay);
 138 #else /* !USE_SDL_LIBRARY */
 139     struct timeval delay;
 140
 141     delay.tv_sec  = milliseconds_delay / 1000;
 142     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 143
 144     if (select(0, NULL, NULL, NULL, &delay) != 0)
 145       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
 146 #endif /* !USE_SDL_LIBRARY */
 147   }
 148 }
 149
 150 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
 151 {
 152   sleep_milliseconds(delay);
 153 }
 154
 155 boolean FrameReached(unsigned long *frame_counter_var,
 156                      unsigned long frame_delay)
 157 {
 158   unsigned long actual_frame_counter = FrameCounter;
 159
 160   if (actual_frame_counter < *frame_counter_var+frame_delay &&
 161       actual_frame_counter >= *frame_counter_var)
 162     return(FALSE);
 163
 164   *frame_counter_var = actual_frame_counter;
 165   return(TRUE);
 166 }
 167
 168 boolean DelayReached(unsigned long *counter_var,
 169                      unsigned long delay)
 170 {
 171   unsigned long actual_counter = Counter();
 172
 173   if (actual_counter < *counter_var + delay &&
 174       actual_counter >= *counter_var)
 175     return(FALSE);
 176
 177   *counter_var = actual_counter;
 178   return(TRUE);
 179 }
 180
 181 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 182 {
 183   unsigned long actual_counter;
 184
 185   while(1)
 186   {
 187     actual_counter = Counter();
 188
 189     if (actual_counter < *counter_var + delay &&
 190         actual_counter >= *counter_var)
 191       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 192     else
 193       break;
 194   }
 195
 196   *counter_var = actual_counter;
 197 }
 198
 199 /* int2str() returns a number converted to a string;
 200    the used memory is static, but will be overwritten by later calls,
 201    so if you want to save the result, copy it to a private string buffer;
 202    there can be 10 local calls of int2str() without buffering the result --
 203    the 11th call will then destroy the result from the first call and so on.
 204 */
 205
 206 char *int2str(int number, int size)
 207 {
 208   static char shift_array[10][40];
 209   static int shift_counter = 0;
 210   char *s = shift_array[shift_counter];
 211
 212   shift_counter = (shift_counter + 1) % 10;
 213
 214   if (size > 20)
 215     size = 20;
 216
 217   if (size)
 218   {
 219     sprintf(s, "                    %09d", number);
 220     return &s[strlen(s) - size];
 221   }
 222   else
 223   {
 224     sprintf(s, "%d", number);
 225     return s;
 226   }
 227 }
 228
 229 unsigned int SimpleRND(unsigned int max)
 230 {
 231 #ifdef USE_SDL_LIBRARY
 232
 233   static unsigned long root = 654321;
 234   unsigned long current_ms;
 235
 236   current_ms = SDL_GetTicks();
 237   root = root * 4253261 + current_ms;
 238   return (root % max);
 239
 240 #else /* !USE_SDL_LIBRARY */
 241
 242   static unsigned long root = 654321;
 243   struct timeval current_time;
 244
 245   gettimeofday(&current_time, NULL);
 246   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
 247   return (root % max);
 248
 249 #endif /* !USE_SDL_LIBRARY */
 250 }
 251
 252 #ifdef DEBUG
 253 static unsigned int last_RND_value = 0;
 254
 255 unsigned int last_RND()
 256 {
 257   return last_RND_value;
 258 }
 259 #endif
 260
 261 unsigned int RND(unsigned int max)
 262 {
 263 #ifdef DEBUG
 264   return (last_RND_value = random_linux_libc() % max);
 265 #else
 266   return (random_linux_libc() % max);
 267 #endif
 268 }
 269
 270 unsigned int InitRND(long seed)
 271 {
 272 #ifdef USE_SDL_LIBRARY
 273   unsigned long current_ms;
 274
 275   if (seed == NEW_RANDOMIZE)
 276   {
 277     current_ms = SDL_GetTicks();
 278     srandom_linux_libc((unsigned int) current_ms);
 279     return (unsigned int) current_ms;
 280   }
 281   else
 282   {
 283     srandom_linux_libc((unsigned int) seed);
 284     return (unsigned int) seed;
 285   }
 286 #else /* !USE_SDL_LIBRARY */
 287   struct timeval current_time;
 288
 289   if (seed == NEW_RANDOMIZE)
 290   {
 291     gettimeofday(&current_time, NULL);
 292     srandom_linux_libc((unsigned int) current_time.tv_usec);
 293     return (unsigned int) current_time.tv_usec;
 294   }
 295   else
 296   {
 297     srandom_linux_libc((unsigned int) seed);
 298     return (unsigned int) seed;
 299   }
 300 #endif /* !USE_SDL_LIBRARY */
 301 }
 302
 303 char *getLoginName()
 304 {
 305 #ifdef WIN32
 306   return ANONYMOUS_NAME;
 307 #else
 308   struct passwd *pwd;
 309
 310   if ((pwd = getpwuid(getuid())) == NULL)
 311     return ANONYMOUS_NAME;
 312   else
 313     return pwd->pw_name;
 314 #endif
 315 }
 316
 317 char *getRealName()
 318 {
 319 #if defined(MSDOS) || defined(WIN32)
 320   return ANONYMOUS_NAME;
 321 #else
 322   struct passwd *pwd;
 323
 324   if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
 325     return ANONYMOUS_NAME;
 326   else
 327   {
 328     static char real_name[1024];
 329     char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
 330
 331     if (strchr(pwd->pw_gecos, 'ß') == NULL)
 332       return pwd->pw_gecos;
 333
 334     /* the user's real name contains a 'ß' character (german sharp s),
 335        which has no equivalent in upper case letters (which our fonts use) */
 336     while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
 337     {
 338       if (*from_ptr != 'ß')
 339         *to_ptr++ = *from_ptr++;
 340       else
 341       {
 342         from_ptr++;
 343         *to_ptr++ = 's';
 344         *to_ptr++ = 's';
 345       }
 346     }
 347     *to_ptr = '\0';
 348
 349     return real_name;
 350   }
 351 #endif
 352 }
 353
 354 char *getHomeDir()
 355 {
 356 #if defined(MSDOS) || defined(WIN32)
 357   return ".";
 358 #else
 359   static char *home_dir = NULL;
 360
 361   if (!home_dir)
 362   {
 363     if (!(home_dir = getenv("HOME")))
 364     {
 365       struct passwd *pwd;
 366
 367       if ((pwd = getpwuid(getuid())))
 368         home_dir = pwd->pw_dir;
 369       else
 370         home_dir = ".";
 371     }
 372   }
 373
 374   return home_dir;
 375 #endif
 376 }
 377
 378 char *getPath2(char *path1, char *path2)
 379 {
 380   char *complete_path = checked_malloc(strlen(path1) + 1 +
 381                                        strlen(path2) + 1);
 382
 383   sprintf(complete_path, "%s/%s", path1, path2);
 384   return complete_path;
 385 }
 386
 387 char *getPath3(char *path1, char *path2, char *path3)
 388 {
 389   char *complete_path = checked_malloc(strlen(path1) + 1 +
 390                                        strlen(path2) + 1 +
 391                                        strlen(path3) + 1);
 392
 393   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 394   return complete_path;
 395 }
 396
 397 char *getStringCopy(char *s)
 398 {
 399   char *s_copy;
 400
 401   if (s == NULL)
 402     return NULL;
 403
 404   s_copy = checked_malloc(strlen(s) + 1);
 405
 406   strcpy(s_copy, s);
 407   return s_copy;
 408 }
 409
 410 char *getStringToLower(char *s)
 411 {
 412   char *s_copy = checked_malloc(strlen(s) + 1);
 413   char *s_ptr = s_copy;
 414
 415   while (*s)
 416     *s_ptr++ = tolower(*s++);
 417   *s_ptr = '\0';
 418
 419   return s_copy;
 420 }
 421
 422 void MarkTileDirty(int x, int y)
 423 {
 424   int xx = redraw_x1 + x;
 425   int yy = redraw_y1 + y;
 426
 427   if (!redraw[xx][yy])
 428     redraw_tiles++;
 429
 430   redraw[xx][yy] = TRUE;
 431   redraw_mask |= REDRAW_TILES;
 432 }
 433
 434 void SetBorderElement()
 435 {
 436   int x, y;
 437
 438   BorderElement = EL_LEERRAUM;
 439
 440   for(y=0; y<lev_fieldy && BorderElement == EL_LEERRAUM; y++)
 441   {
 442     for(x=0; x<lev_fieldx; x++)
 443     {
 444       if (!IS_MASSIVE(Feld[x][y]))
 445         BorderElement = EL_BETON;
 446
 447       if (y != 0 && y != lev_fieldy - 1 && x != lev_fieldx - 1)
 448         x = lev_fieldx - 2;
 449     }
 450   }
 451 }
 452
 453 void GetOptions(char *argv[])
 454 {
 455   char **options_left = &argv[1];
 456
 457   /* initialize global program options */
 458   options.display_name = NULL;
 459   options.server_host = NULL;
 460   options.server_port = 0;
 461   options.ro_base_directory = RO_BASE_PATH;
 462   options.rw_base_directory = RW_BASE_PATH;
 463   options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
 464   options.serveronly = FALSE;
 465   options.network = FALSE;
 466   options.verbose = FALSE;
 467   options.debug = FALSE;
 468
 469   /* initialize some more global variables */
 470   global.frames_per_second = 0;
 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(MSDOS) || defined(WIN32)
 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_KEY_TO_KEYNAME        0
 751 #define TRANSLATE_KEY_TO_X11KEYNAME     1
 752 #define TRANSLATE_X11KEYNAME_TO_KEY     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     { KEY_Left,         "XK_Left",              "cursor left" },
 765     { KEY_Right,        "XK_Right",             "cursor right" },
 766     { KEY_Up,           "XK_Up",                "cursor up" },
 767     { KEY_Down,         "XK_Down",              "cursor down" },
 768
 769     /* keypad cursor keys */
 770 #ifdef KEY_KP_Left
 771     { KEY_KP_Left,      "XK_KP_Left",           "keypad left" },
 772     { KEY_KP_Right,     "XK_KP_Right",          "keypad right" },
 773     { KEY_KP_Up,        "XK_KP_Up",             "keypad up" },
 774     { KEY_KP_Down,      "XK_KP_Down",           "keypad down" },
 775 #endif
 776
 777     /* other keypad keys */
 778 #ifdef KEY_KP_Enter
 779     { KEY_KP_Enter,     "XK_KP_Enter",          "keypad enter" },
 780     { KEY_KP_Add,       "XK_KP_Add",            "keypad +" },
 781     { KEY_KP_Subtract,  "XK_KP_Subtract",       "keypad -" },
 782     { KEY_KP_Multiply,  "XK_KP_Multiply",       "keypad mltply" },
 783     { KEY_KP_Divide,    "XK_KP_Divide",         "keypad /" },
 784     { KEY_KP_Separator, "XK_KP_Separator",      "keypad ," },
 785 #endif
 786
 787     /* modifier keys */
 788     { KEY_Shift_L,      "XK_Shift_L",           "left shift" },
 789     { KEY_Shift_R,      "XK_Shift_R",           "right shift" },
 790     { KEY_Control_L,    "XK_Control_L",         "left control" },
 791     { KEY_Control_R,    "XK_Control_R",         "right control" },
 792     { KEY_Meta_L,       "XK_Meta_L",            "left meta" },
 793     { KEY_Meta_R,       "XK_Meta_R",            "right meta" },
 794     { KEY_Alt_L,        "XK_Alt_L",             "left alt" },
 795     { KEY_Alt_R,        "XK_Alt_R",             "right alt" },
 796     { KEY_Super_L,      "XK_Super_L",           "left super" },  /* Win-L */
 797     { KEY_Super_R,      "XK_Super_R",           "right super" }, /* Win-R */
 798     { KEY_Mode_switch,  "XK_Mode_switch",       "mode switch" }, /* Alt-R */
 799     { KEY_Multi_key,    "XK_Multi_key",         "multi key" },   /* Ctrl-R */
 800
 801     /* some special keys */
 802     { KEY_BackSpace,    "XK_BackSpace",         "backspace" },
 803     { KEY_Delete,       "XK_Delete",            "delete" },
 804     { KEY_Insert,       "XK_Insert",            "insert" },
 805     { KEY_Tab,          "XK_Tab",               "tab" },
 806     { KEY_Home,         "XK_Home",              "home" },
 807     { KEY_End,          "XK_End",               "end" },
 808     { KEY_Page_Up,      "XK_Page_Up",           "page up" },
 809     { KEY_Page_Down,    "XK_Page_Down",         "page down" },
 810     { KEY_Menu,         "XK_Menu",              "menu" },        /* Win-Menu */
 811
 812     /* ASCII 0x20 to 0x40 keys (except numbers) */
 813     { KEY_space,        "XK_space",             "space" },
 814     { KEY_exclam,       "XK_exclam",            "!" },
 815     { KEY_quotedbl,     "XK_quotedbl",          "\"" },
 816     { KEY_numbersign,   "XK_numbersign",        "#" },
 817     { KEY_dollar,       "XK_dollar",            "$" },
 818     { KEY_percent,      "XK_percent",           "%" },
 819     { KEY_ampersand,    "XK_ampersand",         "&" },
 820     { KEY_apostrophe,   "XK_apostrophe",        "'" },
 821     { KEY_parenleft,    "XK_parenleft",         "(" },
 822     { KEY_parenright,   "XK_parenright",        ")" },
 823     { KEY_asterisk,     "XK_asterisk",          "*" },
 824     { KEY_plus,         "XK_plus",              "+" },
 825     { KEY_comma,        "XK_comma",             "," },
 826     { KEY_minus,        "XK_minus",             "-" },
 827     { KEY_period,       "XK_period",            "." },
 828     { KEY_slash,        "XK_slash",             "/" },
 829     { KEY_colon,        "XK_colon",             ":" },
 830     { KEY_semicolon,    "XK_semicolon",         ";" },
 831     { KEY_less,         "XK_less",              "<" },
 832     { KEY_equal,        "XK_equal",             "=" },
 833     { KEY_greater,      "XK_greater",           ">" },
 834     { KEY_question,     "XK_question",          "?" },
 835     { KEY_at,           "XK_at",                "@" },
 836
 837     /* more ASCII keys */
 838     { KEY_bracketleft,  "XK_bracketleft",       "[" },
 839     { KEY_backslash,    "XK_backslash",         "backslash" },
 840     { KEY_bracketright, "XK_bracketright",      "]" },
 841     { KEY_asciicircum,  "XK_asciicircum",       "circumflex" },
 842     { KEY_underscore,   "XK_underscore",        "_" },
 843     { KEY_grave,        "XK_grave",             "grave" },
 844     { KEY_quoteleft,    "XK_quoteleft",         "quote left" },
 845     { KEY_braceleft,    "XK_braceleft",         "brace left" },
 846     { KEY_bar,          "XK_bar",               "bar" },
 847     { KEY_braceright,   "XK_braceright",        "brace right" },
 848     { KEY_asciitilde,   "XK_asciitilde",        "ascii tilde" },
 849
 850     /* special (non-ASCII) keys */
 851     { KEY_Adiaeresis,   "XK_Adiaeresis",        "Ä" },
 852     { KEY_Odiaeresis,   "XK_Odiaeresis",        "Ö" },
 853     { KEY_Udiaeresis,   "XK_Udiaeresis",        "Ü" },
 854     { KEY_adiaeresis,   "XK_adiaeresis",        "ä" },
 855     { KEY_odiaeresis,   "XK_odiaeresis",        "ö" },
 856     { KEY_udiaeresis,   "XK_udiaeresis",        "ü" },
 857     { KEY_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_KEY_TO_KEYNAME)
 866   {
 867     static char name_buffer[30];
 868     Key key = *keysym;
 869
 870     if (key >= KEY_A && key <= KEY_Z)
 871       sprintf(name_buffer, "%c", 'A' + (char)(key - KEY_A));
 872     else if (key >= KEY_a && key <= KEY_z)
 873       sprintf(name_buffer, "%c", 'a' + (char)(key - KEY_a));
 874     else if (key >= KEY_0 && key <= KEY_9)
 875       sprintf(name_buffer, "%c", '0' + (char)(key - KEY_0));
 876     else if (key >= KEY_KP_0 && key <= KEY_KP_9)
 877       sprintf(name_buffer, "keypad %c", '0' + (char)(key - KEY_KP_0));
 878     else if (key >= KEY_F1 && key <= KEY_F24)
 879       sprintf(name_buffer, "function F%d", (int)(key - KEY_F1 + 1));
 880     else if (key == KEY_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_KEY_TO_X11KEYNAME)
 903   {
 904     static char name_buffer[30];
 905     Key key = *keysym;
 906
 907     if (key >= KEY_A && key <= KEY_Z)
 908       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KEY_A));
 909     else if (key >= KEY_a && key <= KEY_z)
 910       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KEY_a));
 911     else if (key >= KEY_0 && key <= KEY_9)
 912       sprintf(name_buffer, "XK_%c", '0' + (char)(key - KEY_0));
 913     else if (key >= KEY_KP_0 && key <= KEY_KP_9)
 914       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KEY_KP_0));
 915     else if (key >= KEY_F1 && key <= KEY_F24)
 916       sprintf(name_buffer, "XK_F%d", (int)(key - KEY_F1 + 1));
 917     else if (key == KEY_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_KEY)
 940   {
 941     Key key = KEY_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 = KEY_A + (Key)(c - 'A');
 950       else if (c >= 'a' && c <= 'z')
 951         key = KEY_a + (Key)(c - 'a');
 952       else if (c >= '0' && c <= '9')
 953         key = KEY_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 = KEY_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 = KEY_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_KEY_TO_KEYNAME);
1029   return name;
1030 }
1031
1032 char *getX11KeyNameFromKey(Key key)
1033 {
1034   char *x11name;
1035
1036   translate_keyname(&key, &x11name, NULL, TRANSLATE_KEY_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_KEY);
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 #define TRANSLATE_JOYSYMBOL_TO_JOYNAME  0
1064 #define TRANSLATE_JOYNAME_TO_JOYSYMBOL  1
1065
1066 void translate_joyname(int *joysymbol, char **name, int mode)
1067 {
1068   static struct
1069   {
1070     int joysymbol;
1071     char *name;
1072   } translate_joy[] =
1073   {
1074     { JOY_LEFT,         "joystick_left" },
1075     { JOY_RIGHT,        "joystick_right" },
1076     { JOY_UP,           "joystick_up" },
1077     { JOY_DOWN,         "joystick_down" },
1078     { JOY_BUTTON_1,     "joystick_button_1" },
1079     { JOY_BUTTON_2,     "joystick_button_2" },
1080   };
1081
1082   int i;
1083
1084   if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
1085   {
1086     *name = "[undefined]";
1087
1088     for (i=0; i<6; i++)
1089     {
1090       if (*joysymbol == translate_joy[i].joysymbol)
1091       {
1092         *name = translate_joy[i].name;
1093         break;
1094       }
1095     }
1096   }
1097   else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
1098   {
1099     *joysymbol = 0;
1100
1101     for (i=0; i<6; i++)
1102     {
1103       if (strcmp(*name, translate_joy[i].name) == 0)
1104       {
1105         *joysymbol = translate_joy[i].joysymbol;
1106         break;
1107       }
1108     }
1109   }
1110 }
1111
1112 char *getJoyNameFromJoySymbol(int joysymbol)
1113 {
1114   char *name;
1115
1116   translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
1117   return name;
1118 }
1119
1120 int getJoySymbolFromJoyName(char *name)
1121 {
1122   int joysymbol;
1123
1124   translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
1125   return joysymbol;
1126 }
1127
1128 int getJoystickNrFromDeviceName(char *device_name)
1129 {
1130   char c;
1131   int joystick_nr = 0;
1132
1133   if (device_name == NULL || device_name[0] == '\0')
1134     return 0;
1135
1136   c = device_name[strlen(device_name) - 1];
1137
1138   if (c >= '0' && c <= '9')
1139     joystick_nr = (int)(c - '0');
1140
1141   if (joystick_nr < 0 || joystick_nr >= MAX_PLAYERS)
1142     joystick_nr = 0;
1143
1144   return joystick_nr;
1145 }
1146
1147 /* ------------------------------------------------------------------------- */
1148 /* some functions to handle lists of level directories                       */
1149 /* ------------------------------------------------------------------------- */
1150
1151 struct LevelDirInfo *newLevelDirInfo()
1152 {
1153   return checked_calloc(sizeof(struct LevelDirInfo));
1154 }
1155
1156 void pushLevelDirInfo(struct LevelDirInfo **node_first,
1157                       struct LevelDirInfo *node_new)
1158 {
1159   node_new->next = *node_first;
1160   *node_first = node_new;
1161 }
1162
1163 int numLevelDirInfo(struct LevelDirInfo *node)
1164 {
1165   int num = 0;
1166
1167   while (node)
1168   {
1169     num++;
1170     node = node->next;
1171   }
1172
1173   return num;
1174 }
1175
1176 boolean validLevelSeries(struct LevelDirInfo *node)
1177 {
1178   return (node != NULL && !node->node_group && !node->parent_link);
1179 }
1180
1181 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
1182 {
1183   if (node == NULL)             /* start with first level directory entry */
1184     return getFirstValidLevelSeries(leveldir_first);
1185   else if (node->node_group)    /* enter level group (step down into tree) */
1186     return getFirstValidLevelSeries(node->node_group);
1187   else if (node->parent_link)   /* skip start entry of level group */
1188   {
1189     if (node->next)             /* get first real level series entry */
1190       return getFirstValidLevelSeries(node->next);
1191     else                        /* leave empty level group and go on */
1192       return getFirstValidLevelSeries(node->node_parent->next);
1193   }
1194   else                          /* this seems to be a regular level series */
1195     return node;
1196 }
1197
1198 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
1199 {
1200   if (node == NULL)
1201     return NULL;
1202
1203   if (node->node_parent == NULL)                /* top level group */
1204     return leveldir_first;
1205   else                                          /* sub level group */
1206     return node->node_parent->node_group;
1207 }
1208
1209 int numLevelDirInfoInGroup(struct LevelDirInfo *node)
1210 {
1211   return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
1212 }
1213
1214 int posLevelDirInfo(struct LevelDirInfo *node)
1215 {
1216   struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
1217   int pos = 0;
1218
1219   while (node_cmp)
1220   {
1221     if (node_cmp == node)
1222       return pos;
1223
1224     pos++;
1225     node_cmp = node_cmp->next;
1226   }
1227
1228   return 0;
1229 }
1230
1231 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
1232 {
1233   struct LevelDirInfo *node_default = node;
1234   int pos_cmp = 0;
1235
1236   while (node)
1237   {
1238     if (pos_cmp == pos)
1239       return node;
1240
1241     pos_cmp++;
1242     node = node->next;
1243   }
1244
1245   return node_default;
1246 }
1247
1248 struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
1249                                                     char *filename)
1250 {
1251   if (filename == NULL)
1252     return NULL;
1253
1254   while (node)
1255   {
1256     if (node->node_group)
1257     {
1258       struct LevelDirInfo *node_group;
1259
1260       node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
1261
1262       if (node_group)
1263         return node_group;
1264     }
1265     else if (!node->parent_link)
1266     {
1267       if (strcmp(filename, node->filename) == 0)
1268         return node;
1269     }
1270
1271     node = node->next;
1272   }
1273
1274   return NULL;
1275 }
1276
1277 struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
1278 {
1279   return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
1280 }
1281
1282 void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
1283 {
1284   int i;
1285
1286   while (node)
1287   {
1288     for (i=0; i<depth * 3; i++)
1289       printf(" ");
1290
1291     printf("filename == '%s'\n", node->filename);
1292
1293     if (node->node_group != NULL)
1294       dumpLevelDirInfo(node->node_group, depth + 1);
1295
1296     node = node->next;
1297   }
1298 }
1299
1300 void sortLevelDirInfo(struct LevelDirInfo **node_first,
1301                       int (*compare_function)(const void *, const void *))
1302 {
1303   int num_nodes = numLevelDirInfo(*node_first);
1304   struct LevelDirInfo **sort_array;
1305   struct LevelDirInfo *node = *node_first;
1306   int i = 0;
1307
1308   if (num_nodes == 0)
1309     return;
1310
1311   /* allocate array for sorting structure pointers */
1312   sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
1313
1314   /* writing structure pointers to sorting array */
1315   while (i < num_nodes && node)         /* double boundary check... */
1316   {
1317     sort_array[i] = node;
1318
1319     i++;
1320     node = node->next;
1321   }
1322
1323   /* sorting the structure pointers in the sorting array */
1324   qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
1325         compare_function);
1326
1327   /* update the linkage of list elements with the sorted node array */
1328   for (i=0; i<num_nodes - 1; i++)
1329     sort_array[i]->next = sort_array[i + 1];
1330   sort_array[num_nodes - 1]->next = NULL;
1331
1332   /* update the linkage of the main list anchor pointer */
1333   *node_first = sort_array[0];
1334
1335   free(sort_array);
1336
1337   /* now recursively sort the level group structures */
1338   node = *node_first;
1339   while (node)
1340   {
1341     if (node->node_group != NULL)
1342       sortLevelDirInfo(&node->node_group, compare_function);
1343
1344     node = node->next;
1345   }
1346 }
1347
1348 inline void swap_numbers(int *i1, int *i2)
1349 {
1350   int help = *i1;
1351
1352   *i1 = *i2;
1353   *i2 = help;
1354 }
1355
1356 inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
1357 {
1358   int help_x = *x1;
1359   int help_y = *y1;
1360
1361   *x1 = *x2;
1362   *x2 = help_x;
1363
1364   *y1 = *y2;
1365   *y2 = help_y;
1366 }
1367
1368
1369 /* ------------------------------------------------------------------------- */
1370 /* the following is only for debugging purpose and normally not used         */
1371 /* ------------------------------------------------------------------------- */
1372
1373 #define DEBUG_NUM_TIMESTAMPS    3
1374
1375 void debug_print_timestamp(int counter_nr, char *message)
1376 {
1377   static long counter[DEBUG_NUM_TIMESTAMPS][2];
1378
1379   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
1380     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
1381
1382   counter[counter_nr][0] = Counter();
1383
1384   if (message)
1385     printf("%s %.2f seconds\n", message,
1386            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
1387
1388   counter[counter_nr][1] = Counter();
1389 }