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 <pwd.h>
  15 #include <unistd.h>
  16 #include <time.h>
  17 #include <sys/time.h>
  18 #include <sys/param.h>
  19 #include <sys/types.h>
  20 #include <stdarg.h>
  21 #include <ctype.h>
  22
  23 #include "misc.h"
  24 #include "init.h"
  25 #include "tools.h"
  26 #include "sound.h"
  27 #include "random.h"
  28 #include "joystick.h"
  29 #include "files.h"
  30
  31 #ifdef MSDOS
  32 volatile unsigned long counter = 0;
  33
  34 void increment_counter()
  35 {
  36   counter++;
  37 }
  38
  39 END_OF_FUNCTION(increment_counter);
  40 #endif
  41
  42
  43
  44 /* maximal allowed length of a command line option */
  45 #define MAX_OPTION_LEN          256
  46
  47 #ifndef MSDOS
  48 static unsigned long mainCounter(int mode)
  49 {
  50   static struct timeval base_time = { 0, 0 };
  51   struct timeval current_time;
  52   unsigned long counter_ms;
  53
  54   gettimeofday(&current_time, NULL);
  55
  56   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
  57     base_time = current_time;
  58
  59   counter_ms = (current_time.tv_sec  - base_time.tv_sec)  * 1000
  60              + (current_time.tv_usec - base_time.tv_usec) / 1000;
  61
  62   return counter_ms;            /* return milliseconds since last init */
  63 }
  64 #endif
  65
  66 void InitCounter()              /* set counter back to zero */
  67 {
  68 #ifndef MSDOS
  69   mainCounter(INIT_COUNTER);
  70 #else
  71   LOCK_VARIABLE(counter);
  72   LOCK_FUNCTION(increment_counter);
  73   install_int_ex(increment_counter, BPS_TO_TIMER(100));
  74 #endif
  75 }
  76
  77 unsigned long Counter() /* get milliseconds since last call of InitCounter() */
  78 {
  79 #ifndef MSDOS
  80   return mainCounter(READ_COUNTER);
  81 #else
  82   return (counter * 10);
  83 #endif
  84 }
  85
  86 static void sleep_milliseconds(unsigned long milliseconds_delay)
  87 {
  88   boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
  89
  90 #ifdef MSDOS
  91   /* donït use select() to perform waiting operations under DOS/Windows
  92      environment; always use a busy loop for waiting instead */
  93   do_busy_waiting = TRUE;
  94 #endif
  95
  96   if (do_busy_waiting)
  97   {
  98     /* we want to wait only a few ms -- if we assume that we have a
  99        kernel timer resolution of 10 ms, we would wait far to long;
 100        therefore it's better to do a short interval of busy waiting
 101        to get our sleeping time more accurate */
 102
 103     unsigned long base_counter = Counter(), actual_counter = Counter();
 104
 105     while (actual_counter < base_counter + milliseconds_delay &&
 106            actual_counter >= base_counter)
 107       actual_counter = Counter();
 108   }
 109   else
 110   {
 111     struct timeval delay;
 112
 113     delay.tv_sec  = milliseconds_delay / 1000;
 114     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 115
 116     if (select(0, NULL, NULL, NULL, &delay) != 0)
 117       Error(ERR_WARN, "sleep_milliseconds(): select() failed");
 118   }
 119 }
 120
 121 void Delay(unsigned long delay) /* Sleep specified number of milliseconds */
 122 {
 123   sleep_milliseconds(delay);
 124 }
 125
 126 boolean FrameReached(unsigned long *frame_counter_var,
 127                      unsigned long frame_delay)
 128 {
 129   unsigned long actual_frame_counter = FrameCounter;
 130
 131   if (actual_frame_counter < *frame_counter_var+frame_delay &&
 132       actual_frame_counter >= *frame_counter_var)
 133     return(FALSE);
 134
 135   *frame_counter_var = actual_frame_counter;
 136   return(TRUE);
 137 }
 138
 139 boolean DelayReached(unsigned long *counter_var,
 140                      unsigned long delay)
 141 {
 142   unsigned long actual_counter = Counter();
 143
 144   if (actual_counter < *counter_var + delay &&
 145       actual_counter >= *counter_var)
 146     return(FALSE);
 147
 148   *counter_var = actual_counter;
 149   return(TRUE);
 150 }
 151
 152 void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
 153 {
 154   unsigned long actual_counter;
 155
 156   while(1)
 157   {
 158     actual_counter = Counter();
 159
 160     if (actual_counter < *counter_var + delay &&
 161         actual_counter >= *counter_var)
 162       sleep_milliseconds((*counter_var + delay - actual_counter) / 2);
 163     else
 164       break;
 165   }
 166
 167   *counter_var = actual_counter;
 168 }
 169
 170 char *int2str(int number, int size)
 171 {
 172   static char s[40];
 173
 174   if (size > 20)
 175     size = 20;
 176
 177   if (size)
 178   {
 179     sprintf(s, "                    %09d", number);
 180     return &s[strlen(s) - size];
 181   }
 182   else
 183   {
 184     sprintf(s, "%d", number);
 185     return s;
 186   }
 187 }
 188
 189 unsigned int SimpleRND(unsigned int max)
 190 {
 191   static unsigned long root = 654321;
 192   struct timeval current_time;
 193
 194   gettimeofday(&current_time,NULL);
 195   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
 196   return (root % max);
 197 }
 198
 199 #ifdef DEBUG
 200 static unsigned int last_RND_value = 0;
 201
 202 unsigned int last_RND()
 203 {
 204   return last_RND_value;
 205 }
 206 #endif
 207
 208 unsigned int RND(unsigned int max)
 209 {
 210 #ifdef DEBUG
 211   return (last_RND_value = random_linux_libc() % max);
 212 #else
 213   return (random_linux_libc() % max);
 214 #endif
 215 }
 216
 217 unsigned int InitRND(long seed)
 218 {
 219   struct timeval current_time;
 220
 221   if (seed == NEW_RANDOMIZE)
 222   {
 223     gettimeofday(&current_time,NULL);
 224     srandom_linux_libc((unsigned int) current_time.tv_usec);
 225     return (unsigned int)current_time.tv_usec;
 226   }
 227   else
 228   {
 229     srandom_linux_libc((unsigned int) seed);
 230     return (unsigned int)seed;
 231   }
 232 }
 233
 234 char *getLoginName()
 235 {
 236   struct passwd *pwd;
 237
 238   if (!(pwd = getpwuid(getuid())))
 239     return "ANONYMOUS";
 240   else
 241     return pwd->pw_name;
 242 }
 243
 244 char *getHomeDir()
 245 {
 246 #ifndef MSDOS
 247   static char *home_dir = NULL;
 248
 249   if (!home_dir)
 250   {
 251     if (!(home_dir = getenv("HOME")))
 252     {
 253       struct passwd *pwd;
 254
 255       if ((pwd = getpwuid(getuid())))
 256         home_dir = pwd->pw_dir;
 257       else
 258         home_dir = ".";
 259     }
 260   }
 261
 262   return home_dir;
 263 #else
 264   return ".";
 265 #endif
 266 }
 267
 268 char *getPath2(char *path1, char *path2)
 269 {
 270   char *complete_path = checked_malloc(strlen(path1) + 1 +
 271                                        strlen(path2) + 1);
 272
 273   sprintf(complete_path, "%s/%s", path1, path2);
 274   return complete_path;
 275 }
 276
 277 char *getPath3(char *path1, char *path2, char *path3)
 278 {
 279   char *complete_path = checked_malloc(strlen(path1) + 1 +
 280                                        strlen(path2) + 1 +
 281                                        strlen(path3) + 1);
 282
 283   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 284   return complete_path;
 285 }
 286
 287 char *getStringCopy(char *s)
 288 {
 289   char *s_copy = checked_malloc(strlen(s) + 1);
 290
 291   strcpy(s_copy, s);
 292   return s_copy;
 293 }
 294
 295 char *getStringToLower(char *s)
 296 {
 297   char *s_copy = checked_malloc(strlen(s) + 1);
 298   char *s_ptr = s_copy;
 299
 300   while (*s)
 301     *s_ptr++ = tolower(*s++);
 302
 303   return s_copy;
 304 }
 305
 306 void MarkTileDirty(int x, int y)
 307 {
 308   int xx = redraw_x1 + x;
 309   int yy = redraw_y1 + y;
 310
 311   if (!redraw[xx][yy])
 312     redraw_tiles++;
 313
 314   redraw[xx][yy] = TRUE;
 315   redraw_mask |= REDRAW_TILES;
 316 }
 317
 318 void SetBorderElement()
 319 {
 320   int x, y;
 321
 322   BorderElement = EL_LEERRAUM;
 323
 324   for(y=0; y<lev_fieldy && BorderElement == EL_LEERRAUM; y++)
 325   {
 326     for(x=0; x<lev_fieldx; x++)
 327     {
 328       if (!IS_MASSIVE(Feld[x][y]))
 329         BorderElement = EL_BETON;
 330
 331       if (y != 0 && y != lev_fieldy - 1 && x != lev_fieldx - 1)
 332         x = lev_fieldx - 2;
 333     }
 334   }
 335 }
 336
 337 void GetOptions(char *argv[])
 338 {
 339   char **options_left = &argv[1];
 340
 341   /* initialize global program options */
 342   options.display_name = NULL;
 343   options.server_host = NULL;
 344   options.server_port = 0;
 345   options.base_directory = BASE_PATH;
 346   options.level_directory = BASE_PATH "/" LEVELS_DIRECTORY;
 347   options.serveronly = FALSE;
 348   options.network = FALSE;
 349   options.verbose = FALSE;
 350
 351   while (*options_left)
 352   {
 353     char option_str[MAX_OPTION_LEN];
 354     char *option = options_left[0];
 355     char *next_option = options_left[1];
 356     char *option_arg = NULL;
 357     int option_len = strlen(option);
 358
 359     if (option_len >= MAX_OPTION_LEN)
 360       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 361
 362     strcpy(option_str, option);                 /* copy argument into buffer */
 363     option = option_str;
 364
 365     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 366       break;
 367
 368     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 369       option++;
 370
 371     option_arg = strchr(option, '=');
 372     if (option_arg == NULL)                     /* no '=' in option */
 373       option_arg = next_option;
 374     else
 375     {
 376       *option_arg++ = '\0';                     /* cut argument from option */
 377       if (*option_arg == '\0')                  /* no argument after '=' */
 378         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 379     }
 380
 381     option_len = strlen(option);
 382
 383     if (strcmp(option, "-") == 0)
 384       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 385     else if (strncmp(option, "-help", option_len) == 0)
 386     {
 387       printf("Usage: %s [options] [server.name [port]]\n"
 388              "Options:\n"
 389              "  -d, --display machine:0       X server display\n"
 390              "  -b, --basepath directory      alternative base directory\n"
 391              "  -l, --levels directory        alternative level directory\n"
 392              "  -s, --serveronly              only start network server\n"
 393              "  -n, --network                 network multiplayer game\n"
 394              "  -v, --verbose                 verbose mode\n",
 395              program_name);
 396       exit(0);
 397     }
 398     else if (strncmp(option, "-display", option_len) == 0)
 399     {
 400       if (option_arg == NULL)
 401         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 402
 403       options.display_name = option_arg;
 404       if (option_arg == next_option)
 405         options_left++;
 406     }
 407     else if (strncmp(option, "-basepath", option_len) == 0)
 408     {
 409       if (option_arg == NULL)
 410         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 411
 412       options.base_directory = option_arg;
 413       if (option_arg == next_option)
 414         options_left++;
 415
 416       /* adjust path for level directory accordingly */
 417       options.level_directory =
 418         getPath2(options.base_directory, LEVELS_DIRECTORY);
 419     }
 420     else if (strncmp(option, "-levels", option_len) == 0)
 421     {
 422       if (option_arg == NULL)
 423         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 424
 425       options.level_directory = option_arg;
 426       if (option_arg == next_option)
 427         options_left++;
 428     }
 429     else if (strncmp(option, "-network", option_len) == 0)
 430     {
 431       options.network = TRUE;
 432     }
 433     else if (strncmp(option, "-serveronly", option_len) == 0)
 434     {
 435       options.serveronly = TRUE;
 436     }
 437     else if (strncmp(option, "-verbose", option_len) == 0)
 438     {
 439       options.verbose = TRUE;
 440     }
 441     else if (*option == '-')
 442     {
 443       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 444     }
 445     else if (options.server_host == NULL)
 446     {
 447       options.server_host = *options_left;
 448     }
 449     else if (options.server_port == 0)
 450     {
 451       options.server_port = atoi(*options_left);
 452       if (options.server_port < 1024)
 453         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 454     }
 455     else
 456       Error(ERR_EXIT_HELP, "too many arguments");
 457
 458     options_left++;
 459   }
 460 }
 461
 462 void Error(int mode, char *format, ...)
 463 {
 464   char *process_name = "";
 465   FILE *error = stderr;
 466
 467   /* display warnings only when running in verbose mode */
 468   if (mode & ERR_WARN && !options.verbose)
 469     return;
 470
 471 #ifdef MSDOS
 472   if ((error = openErrorFile()) == NULL)
 473   {
 474     printf("Cannot write to error output file!\n");
 475     CloseAllAndExit(1);
 476   }
 477 #endif
 478
 479   if (mode & ERR_SOUND_SERVER)
 480     process_name = " sound server";
 481   else if (mode & ERR_NETWORK_SERVER)
 482     process_name = " network server";
 483   else if (mode & ERR_NETWORK_CLIENT)
 484     process_name = " network client **";
 485
 486   if (format)
 487   {
 488     va_list ap;
 489
 490     fprintf(error, "%s%s: ", program_name, process_name);
 491
 492     if (mode & ERR_WARN)
 493       fprintf(error, "warning: ");
 494
 495     va_start(ap, format);
 496     vfprintf(error, format, ap);
 497     va_end(ap);
 498
 499     fprintf(error, "\n");
 500   }
 501
 502   if (mode & ERR_HELP)
 503     fprintf(error, "%s: Try option '--help' for more information.\n",
 504             program_name);
 505
 506   if (mode & ERR_EXIT)
 507     fprintf(error, "%s%s: aborting\n", program_name, process_name);
 508
 509   if (error != stderr)
 510     fclose(error);
 511
 512   if (mode & ERR_EXIT)
 513   {
 514     if (mode & ERR_FROM_SERVER)
 515       exit(1);                          /* child process: normal exit */
 516     else
 517       CloseAllAndExit(1);               /* main process: clean up stuff */
 518   }
 519 }
 520
 521 void *checked_malloc(unsigned long size)
 522 {
 523   void *ptr;
 524
 525   ptr = malloc(size);
 526
 527   if (ptr == NULL)
 528     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 529
 530   return ptr;
 531 }
 532
 533 void *checked_calloc(unsigned long size)
 534 {
 535   void *ptr;
 536
 537   ptr = calloc(1, size);
 538
 539   if (ptr == NULL)
 540     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 541
 542   return ptr;
 543 }
 544
 545 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 546 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 547 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
 548
 549 void translate_keyname(KeySym *keysym, char **x11name, char **name, int mode)
 550 {
 551   static struct
 552   {
 553     KeySym keysym;
 554     char *x11name;
 555     char *name;
 556   } translate_key[] =
 557   {
 558     /* normal cursor keys */
 559     { XK_Left,          "XK_Left",              "cursor left" },
 560     { XK_Right,         "XK_Right",             "cursor right" },
 561     { XK_Up,            "XK_Up",                "cursor up" },
 562     { XK_Down,          "XK_Down",              "cursor down" },
 563
 564     /* keypad cursor keys */
 565 #ifdef XK_KP_Left
 566     { XK_KP_Left,       "XK_KP_Left",           "keypad left" },
 567     { XK_KP_Right,      "XK_KP_Right",          "keypad right" },
 568     { XK_KP_Up,         "XK_KP_Up",             "keypad up" },
 569     { XK_KP_Down,       "XK_KP_Down",           "keypad down" },
 570 #endif
 571
 572     /* other keypad keys */
 573 #ifdef XK_KP_Enter
 574     { XK_KP_Enter,      "XK_KP_Enter",          "keypad enter" },
 575     { XK_KP_Add,        "XK_KP_Add",            "keypad +" },
 576     { XK_KP_Subtract,   "XK_KP_Subtract",       "keypad -" },
 577     { XK_KP_Multiply,   "XK_KP_Multiply",       "keypad mltply" },
 578     { XK_KP_Divide,     "XK_KP_Divide",         "keypad /" },
 579     { XK_KP_Separator,  "XK_KP_Separator",      "keypad ," },
 580 #endif
 581
 582     /* modifier keys */
 583     { XK_Shift_L,       "XK_Shift_L",           "left shift" },
 584     { XK_Shift_R,       "XK_Shift_R",           "right shift" },
 585     { XK_Control_L,     "XK_Control_L",         "left control" },
 586     { XK_Control_R,     "XK_Control_R",         "right control" },
 587     { XK_Meta_L,        "XK_Meta_L",            "left meta" },
 588     { XK_Meta_R,        "XK_Meta_R",            "right meta" },
 589     { XK_Alt_L,         "XK_Alt_L",             "left alt" },
 590     { XK_Alt_R,         "XK_Alt_R",             "right alt" },
 591     { XK_Mode_switch,   "XK_Mode_switch",       "mode switch" },
 592     { XK_Multi_key,     "XK_Multi_key",         "multi key" },
 593
 594     /* some special keys */
 595     { XK_BackSpace,     "XK_BackSpace",         "backspace" },
 596     { XK_Delete,        "XK_Delete",            "delete" },
 597     { XK_Insert,        "XK_Insert",            "insert" },
 598     { XK_Tab,           "XK_Tab",               "tab" },
 599     { XK_Home,          "XK_Home",              "home" },
 600     { XK_End,           "XK_End",               "end" },
 601     { XK_Page_Up,       "XK_Page_Up",           "page up" },
 602     { XK_Page_Down,     "XK_Page_Down",         "page down" },
 603
 604
 605     /* ASCII 0x20 to 0x40 keys (except numbers) */
 606     { XK_space,         "XK_space",             "space" },
 607     { XK_exclam,        "XK_exclam",            "!" },
 608     { XK_quotedbl,      "XK_quotedbl",          "\"" },
 609     { XK_numbersign,    "XK_numbersign",        "#" },
 610     { XK_dollar,        "XK_dollar",            "$" },
 611     { XK_percent,       "XK_percent",           "%" },
 612     { XK_ampersand,     "XK_ampersand",         "&" },
 613     { XK_apostrophe,    "XK_apostrophe",        "'" },
 614     { XK_parenleft,     "XK_parenleft",         "(" },
 615     { XK_parenright,    "XK_parenright",        ")" },
 616     { XK_asterisk,      "XK_asterisk",          "*" },
 617     { XK_plus,          "XK_plus",              "+" },
 618     { XK_comma,         "XK_comma",             "," },
 619     { XK_minus,         "XK_minus",             "-" },
 620     { XK_period,        "XK_period",            "." },
 621     { XK_slash,         "XK_slash",             "/" },
 622     { XK_colon,         "XK_colon",             ":" },
 623     { XK_semicolon,     "XK_semicolon",         ";" },
 624     { XK_less,          "XK_less",              "less" },
 625     { XK_equal,         "XK_equal",             "equal" },
 626     { XK_greater,       "XK_greater",           "greater" },
 627     { XK_question,      "XK_question",          "?" },
 628     { XK_at,            "XK_at",                "@" },
 629
 630     /* more ASCII keys */
 631     { XK_bracketleft,   "XK_bracketleft",       "[" },
 632     { XK_backslash,     "XK_backslash",         "backslash" },
 633     { XK_bracketright,  "XK_bracketright",      "]" },
 634     { XK_asciicircum,   "XK_asciicircum",       "circumflex" },
 635     { XK_underscore,    "XK_underscore",        "_" },
 636     { XK_grave,         "XK_grave",             "grave" },
 637     { XK_quoteleft,     "XK_quoteleft",         "quote left" },
 638     { XK_braceleft,     "XK_braceleft",         "brace left" },
 639     { XK_bar,           "XK_bar",               "bar" },
 640     { XK_braceright,    "XK_braceright",        "brace right" },
 641     { XK_asciitilde,    "XK_asciitilde",        "ascii tilde" },
 642
 643     /* special (non-ASCII) keys */
 644     { XK_Adiaeresis,    "XK_Adiaeresis",        "Ä" },
 645     { XK_Odiaeresis,    "XK_Odiaeresis",        "Ö" },
 646     { XK_Udiaeresis,    "XK_Udiaeresis",        "Ü" },
 647     { XK_adiaeresis,    "XK_adiaeresis",        "ä" },
 648     { XK_odiaeresis,    "XK_odiaeresis",        "ö" },
 649     { XK_udiaeresis,    "XK_udiaeresis",        "ü" },
 650     { XK_ssharp,        "XK_ssharp",            "sharp s" },
 651
 652     /* end-of-array identifier */
 653     { 0,                NULL,                   NULL }
 654   };
 655
 656   int i;
 657
 658   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
 659   {
 660     static char name_buffer[30];
 661     KeySym key = *keysym;
 662
 663     if (key >= XK_A && key <= XK_Z)
 664       sprintf(name_buffer, "%c", 'A' + (char)(key - XK_A));
 665     else if (key >= XK_a && key <= XK_z)
 666       sprintf(name_buffer, "%c", 'a' + (char)(key - XK_a));
 667     else if (key >= XK_0 && key <= XK_9)
 668       sprintf(name_buffer, "%c", '0' + (char)(key - XK_0));
 669     else if (key >= XK_KP_0 && key <= XK_KP_9)
 670       sprintf(name_buffer, "keypad %c", '0' + (char)(key - XK_KP_0));
 671     else if (key >= XK_F1 && key <= XK_F24)
 672       sprintf(name_buffer, "function F%d", (int)(key - XK_F1 + 1));
 673     else if (key == KEY_UNDEFINDED)
 674       strcpy(name_buffer, "(undefined)");
 675     else
 676     {
 677       i = 0;
 678
 679       do
 680       {
 681         if (key == translate_key[i].keysym)
 682         {
 683           strcpy(name_buffer, translate_key[i].name);
 684           break;
 685         }
 686       }
 687       while (translate_key[++i].name);
 688
 689       if (!translate_key[i].name)
 690         strcpy(name_buffer, "(unknown)");
 691     }
 692
 693     *name = name_buffer;
 694   }
 695   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
 696   {
 697     static char name_buffer[30];
 698     KeySym key = *keysym;
 699
 700     if (key >= XK_A && key <= XK_Z)
 701       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - XK_A));
 702     else if (key >= XK_a && key <= XK_z)
 703       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - XK_a));
 704     else if (key >= XK_0 && key <= XK_9)
 705       sprintf(name_buffer, "XK_%c", '0' + (char)(key - XK_0));
 706     else if (key >= XK_KP_0 && key <= XK_KP_9)
 707       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - XK_KP_0));
 708     else if (key >= XK_F1 && key <= XK_F24)
 709       sprintf(name_buffer, "XK_F%d", (int)(key - XK_F1 + 1));
 710     else if (key == KEY_UNDEFINDED)
 711       strcpy(name_buffer, "[undefined]");
 712     else
 713     {
 714       i = 0;
 715
 716       do
 717       {
 718         if (key == translate_key[i].keysym)
 719         {
 720           strcpy(name_buffer, translate_key[i].x11name);
 721           break;
 722         }
 723       }
 724       while (translate_key[++i].x11name);
 725
 726       if (!translate_key[i].x11name)
 727         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
 728     }
 729
 730     *x11name = name_buffer;
 731   }
 732   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
 733   {
 734     KeySym key = XK_VoidSymbol;
 735     char *name_ptr = *x11name;
 736
 737     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
 738     {
 739       char c = name_ptr[3];
 740
 741       if (c >= 'A' && c <= 'Z')
 742         key = XK_A + (KeySym)(c - 'A');
 743       else if (c >= 'a' && c <= 'z')
 744         key = XK_a + (KeySym)(c - 'a');
 745       else if (c >= '0' && c <= '9')
 746         key = XK_0 + (KeySym)(c - '0');
 747     }
 748     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
 749     {
 750       char c = name_ptr[6];
 751
 752       if (c >= '0' && c <= '9')
 753         key = XK_0 + (KeySym)(c - '0');
 754     }
 755     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
 756     {
 757       char c1 = name_ptr[4];
 758       char c2 = name_ptr[5];
 759       int d = 0;
 760
 761       if ((c1 >= '0' && c1 <= '9') &&
 762           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
 763         d = atoi(&name_ptr[4]);
 764
 765       if (d >=1 && d <= 24)
 766         key = XK_F1 + (KeySym)(d - 1);
 767     }
 768     else if (strncmp(name_ptr, "XK_", 3) == 0)
 769     {
 770       i = 0;
 771
 772       do
 773       {
 774         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
 775         {
 776           key = translate_key[i].keysym;
 777           break;
 778         }
 779       }
 780       while (translate_key[++i].x11name);
 781     }
 782     else if (strncmp(name_ptr, "0x", 2) == 0)
 783     {
 784       unsigned long value = 0;
 785
 786       name_ptr += 2;
 787
 788       while (name_ptr)
 789       {
 790         char c = *name_ptr++;
 791         int d = -1;
 792
 793         if (c >= '0' && c <= '9')
 794           d = (int)(c - '0');
 795         else if (c >= 'a' && c <= 'f')
 796           d = (int)(c - 'a' + 10);
 797         else if (c >= 'A' && c <= 'F')
 798           d = (int)(c - 'A' + 10);
 799
 800         if (d == -1)
 801         {
 802           value = -1;
 803           break;
 804         }
 805
 806         value = value * 16 + d;
 807       }
 808
 809       if (value != -1)
 810         key = (KeySym)value;
 811     }
 812
 813     *keysym = key;
 814   }
 815 }
 816
 817 char *getKeyNameFromKeySym(KeySym keysym)
 818 {
 819   char *name;
 820
 821   translate_keyname(&keysym, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
 822   return name;
 823 }
 824
 825 char *getX11KeyNameFromKeySym(KeySym keysym)
 826 {
 827   char *x11name;
 828
 829   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
 830   return x11name;
 831 }
 832
 833 KeySym getKeySymFromX11KeyName(char *x11name)
 834 {
 835   KeySym keysym;
 836
 837   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
 838   return keysym;
 839 }
 840
 841 char getCharFromKeySym(KeySym keysym)
 842 {
 843   char *keyname = getKeyNameFromKeySym(keysym);
 844   char letter = 0;
 845
 846   if (strlen(keyname) == 1)
 847     letter = keyname[0];
 848   else if (strcmp(keyname, "space") == 0)
 849     letter = ' ';
 850   else if (strcmp(keyname, "less") == 0)
 851     letter = '<';
 852   else if (strcmp(keyname, "equal") == 0)
 853     letter = '=';
 854   else if (strcmp(keyname, "greater") == 0)
 855     letter = '>';
 856
 857   return letter;
 858 }
 859
 860 #define TRANSLATE_JOYSYMBOL_TO_JOYNAME  0
 861 #define TRANSLATE_JOYNAME_TO_JOYSYMBOL  1
 862
 863 void translate_joyname(int *joysymbol, char **name, int mode)
 864 {
 865   static struct
 866   {
 867     int joysymbol;
 868     char *name;
 869   } translate_joy[] =
 870   {
 871     { JOY_LEFT,         "joystick_left" },
 872     { JOY_RIGHT,        "joystick_right" },
 873     { JOY_UP,           "joystick_up" },
 874     { JOY_DOWN,         "joystick_down" },
 875     { JOY_BUTTON_1,     "joystick_button_1" },
 876     { JOY_BUTTON_2,     "joystick_button_2" },
 877   };
 878
 879   int i;
 880
 881   if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
 882   {
 883     *name = "[undefined]";
 884
 885     for (i=0; i<6; i++)
 886     {
 887       if (*joysymbol == translate_joy[i].joysymbol)
 888       {
 889         *name = translate_joy[i].name;
 890         break;
 891       }
 892     }
 893   }
 894   else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
 895   {
 896     *joysymbol = 0;
 897
 898     for (i=0; i<6; i++)
 899     {
 900       if (strcmp(*name, translate_joy[i].name) == 0)
 901       {
 902         *joysymbol = translate_joy[i].joysymbol;
 903         break;
 904       }
 905     }
 906   }
 907 }
 908
 909 char *getJoyNameFromJoySymbol(int joysymbol)
 910 {
 911   char *name;
 912
 913   translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
 914   return name;
 915 }
 916
 917 int getJoySymbolFromJoyName(char *name)
 918 {
 919   int joysymbol;
 920
 921   translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
 922   return joysymbol;
 923 }
 924
 925 int getJoystickNrFromDeviceName(char *device_name)
 926 {
 927   char c;
 928   int joystick_nr = 0;
 929
 930   if (device_name == NULL || device_name[0] == '\0')
 931     return 0;
 932
 933   c = device_name[strlen(device_name) - 1];
 934
 935   if (c >= '0' && c <= '9')
 936     joystick_nr = (int)(c - '0');
 937
 938   if (joystick_nr < 0 || joystick_nr >= MAX_PLAYERS)
 939     joystick_nr = 0;
 940
 941   return joystick_nr;
 942 }
 943
 944 /* ----------------------------------------------------------------- */
 945 /* the following is only for debugging purpose and normally not used */
 946 /* ----------------------------------------------------------------- */
 947
 948 #define DEBUG_NUM_TIMESTAMPS    3
 949
 950 void debug_print_timestamp(int counter_nr, char *message)
 951 {
 952   static long counter[DEBUG_NUM_TIMESTAMPS][2];
 953
 954   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
 955     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
 956
 957   counter[counter_nr][0] = Counter();
 958
 959   if (message)
 960     printf("%s %.2f seconds\n", message,
 961            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
 962
 963   counter[counter_nr][1] = Counter();
 964 }