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())) == NULL)
 239     return ANONYMOUS_NAME;
 240   else
 241     return pwd->pw_name;
 242 }
 243
 244 char *getRealName()
 245 {
 246   struct passwd *pwd;
 247
 248   if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
 249     return ANONYMOUS_NAME;
 250   else
 251   {
 252     static char real_name[1024];
 253     char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
 254
 255     if (strchr(pwd->pw_gecos, 'ß') == NULL)
 256       return pwd->pw_gecos;
 257
 258     /* the user's real name contains a 'ß' character (german sharp s),
 259        which has no equivalent in upper case letters (which our fonts use) */
 260     while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
 261     {
 262       if (*from_ptr != 'ß')
 263         *to_ptr++ = *from_ptr++;
 264       else
 265       {
 266         from_ptr++;
 267         *to_ptr++ = 's';
 268         *to_ptr++ = 's';
 269       }
 270     }
 271     *to_ptr = '\0';
 272
 273     return real_name;
 274   }
 275 }
 276
 277 char *getHomeDir()
 278 {
 279 #ifndef MSDOS
 280   static char *home_dir = NULL;
 281
 282   if (!home_dir)
 283   {
 284     if (!(home_dir = getenv("HOME")))
 285     {
 286       struct passwd *pwd;
 287
 288       if ((pwd = getpwuid(getuid())))
 289         home_dir = pwd->pw_dir;
 290       else
 291         home_dir = ".";
 292     }
 293   }
 294
 295   return home_dir;
 296 #else
 297   return ".";
 298 #endif
 299 }
 300
 301 char *getPath2(char *path1, char *path2)
 302 {
 303   char *complete_path = checked_malloc(strlen(path1) + 1 +
 304                                        strlen(path2) + 1);
 305
 306   sprintf(complete_path, "%s/%s", path1, path2);
 307   return complete_path;
 308 }
 309
 310 char *getPath3(char *path1, char *path2, char *path3)
 311 {
 312   char *complete_path = checked_malloc(strlen(path1) + 1 +
 313                                        strlen(path2) + 1 +
 314                                        strlen(path3) + 1);
 315
 316   sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
 317   return complete_path;
 318 }
 319
 320 char *getStringCopy(char *s)
 321 {
 322   char *s_copy = checked_malloc(strlen(s) + 1);
 323
 324   strcpy(s_copy, s);
 325   return s_copy;
 326 }
 327
 328 char *getStringToLower(char *s)
 329 {
 330   char *s_copy = checked_malloc(strlen(s) + 1);
 331   char *s_ptr = s_copy;
 332
 333   while (*s)
 334     *s_ptr++ = tolower(*s++);
 335
 336   return s_copy;
 337 }
 338
 339 void MarkTileDirty(int x, int y)
 340 {
 341   int xx = redraw_x1 + x;
 342   int yy = redraw_y1 + y;
 343
 344   if (!redraw[xx][yy])
 345     redraw_tiles++;
 346
 347   redraw[xx][yy] = TRUE;
 348   redraw_mask |= REDRAW_TILES;
 349 }
 350
 351 void SetBorderElement()
 352 {
 353   int x, y;
 354
 355   BorderElement = EL_LEERRAUM;
 356
 357   for(y=0; y<lev_fieldy && BorderElement == EL_LEERRAUM; y++)
 358   {
 359     for(x=0; x<lev_fieldx; x++)
 360     {
 361       if (!IS_MASSIVE(Feld[x][y]))
 362         BorderElement = EL_BETON;
 363
 364       if (y != 0 && y != lev_fieldy - 1 && x != lev_fieldx - 1)
 365         x = lev_fieldx - 2;
 366     }
 367   }
 368 }
 369
 370 void GetOptions(char *argv[])
 371 {
 372   char **options_left = &argv[1];
 373
 374   /* initialize global program options */
 375   options.display_name = NULL;
 376   options.server_host = NULL;
 377   options.server_port = 0;
 378   options.base_directory = BASE_PATH;
 379   options.level_directory = BASE_PATH "/" LEVELS_DIRECTORY;
 380   options.serveronly = FALSE;
 381   options.network = FALSE;
 382   options.verbose = FALSE;
 383
 384   while (*options_left)
 385   {
 386     char option_str[MAX_OPTION_LEN];
 387     char *option = options_left[0];
 388     char *next_option = options_left[1];
 389     char *option_arg = NULL;
 390     int option_len = strlen(option);
 391
 392     if (option_len >= MAX_OPTION_LEN)
 393       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 394
 395     strcpy(option_str, option);                 /* copy argument into buffer */
 396     option = option_str;
 397
 398     if (strcmp(option, "--") == 0)              /* stop scanning arguments */
 399       break;
 400
 401     if (strncmp(option, "--", 2) == 0)          /* treat '--' like '-' */
 402       option++;
 403
 404     option_arg = strchr(option, '=');
 405     if (option_arg == NULL)                     /* no '=' in option */
 406       option_arg = next_option;
 407     else
 408     {
 409       *option_arg++ = '\0';                     /* cut argument from option */
 410       if (*option_arg == '\0')                  /* no argument after '=' */
 411         Error(ERR_EXIT_HELP, "option '%s' has invalid argument", option_str);
 412     }
 413
 414     option_len = strlen(option);
 415
 416     if (strcmp(option, "-") == 0)
 417       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
 418     else if (strncmp(option, "-help", option_len) == 0)
 419     {
 420       printf("Usage: %s [options] [server.name [port]]\n"
 421              "Options:\n"
 422              "  -d, --display machine:0       X server display\n"
 423              "  -b, --basepath directory      alternative base directory\n"
 424              "  -l, --levels directory        alternative level directory\n"
 425              "  -s, --serveronly              only start network server\n"
 426              "  -n, --network                 network multiplayer game\n"
 427              "  -v, --verbose                 verbose mode\n",
 428              program_name);
 429       exit(0);
 430     }
 431     else if (strncmp(option, "-display", option_len) == 0)
 432     {
 433       if (option_arg == NULL)
 434         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 435
 436       options.display_name = option_arg;
 437       if (option_arg == next_option)
 438         options_left++;
 439     }
 440     else if (strncmp(option, "-basepath", option_len) == 0)
 441     {
 442       if (option_arg == NULL)
 443         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 444
 445       options.base_directory = option_arg;
 446       if (option_arg == next_option)
 447         options_left++;
 448
 449       /* adjust path for level directory accordingly */
 450       options.level_directory =
 451         getPath2(options.base_directory, LEVELS_DIRECTORY);
 452     }
 453     else if (strncmp(option, "-levels", option_len) == 0)
 454     {
 455       if (option_arg == NULL)
 456         Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 457
 458       options.level_directory = option_arg;
 459       if (option_arg == next_option)
 460         options_left++;
 461     }
 462     else if (strncmp(option, "-network", option_len) == 0)
 463     {
 464       options.network = TRUE;
 465     }
 466     else if (strncmp(option, "-serveronly", option_len) == 0)
 467     {
 468       options.serveronly = TRUE;
 469     }
 470     else if (strncmp(option, "-verbose", option_len) == 0)
 471     {
 472       options.verbose = TRUE;
 473     }
 474     else if (*option == '-')
 475     {
 476       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
 477     }
 478     else if (options.server_host == NULL)
 479     {
 480       options.server_host = *options_left;
 481     }
 482     else if (options.server_port == 0)
 483     {
 484       options.server_port = atoi(*options_left);
 485       if (options.server_port < 1024)
 486         Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
 487     }
 488     else
 489       Error(ERR_EXIT_HELP, "too many arguments");
 490
 491     options_left++;
 492   }
 493 }
 494
 495 void Error(int mode, char *format, ...)
 496 {
 497   char *process_name = "";
 498   FILE *error = stderr;
 499
 500   /* display warnings only when running in verbose mode */
 501   if (mode & ERR_WARN && !options.verbose)
 502     return;
 503
 504 #ifdef MSDOS
 505   if ((error = openErrorFile()) == NULL)
 506   {
 507     printf("Cannot write to error output file!\n");
 508     CloseAllAndExit(1);
 509   }
 510 #endif
 511
 512   if (mode & ERR_SOUND_SERVER)
 513     process_name = " sound server";
 514   else if (mode & ERR_NETWORK_SERVER)
 515     process_name = " network server";
 516   else if (mode & ERR_NETWORK_CLIENT)
 517     process_name = " network client **";
 518
 519   if (format)
 520   {
 521     va_list ap;
 522
 523     fprintf(error, "%s%s: ", program_name, process_name);
 524
 525     if (mode & ERR_WARN)
 526       fprintf(error, "warning: ");
 527
 528     va_start(ap, format);
 529     vfprintf(error, format, ap);
 530     va_end(ap);
 531
 532     fprintf(error, "\n");
 533   }
 534
 535   if (mode & ERR_HELP)
 536     fprintf(error, "%s: Try option '--help' for more information.\n",
 537             program_name);
 538
 539   if (mode & ERR_EXIT)
 540     fprintf(error, "%s%s: aborting\n", program_name, process_name);
 541
 542   if (error != stderr)
 543     fclose(error);
 544
 545   if (mode & ERR_EXIT)
 546   {
 547     if (mode & ERR_FROM_SERVER)
 548       exit(1);                          /* child process: normal exit */
 549     else
 550       CloseAllAndExit(1);               /* main process: clean up stuff */
 551   }
 552 }
 553
 554 void *checked_malloc(unsigned long size)
 555 {
 556   void *ptr;
 557
 558   ptr = malloc(size);
 559
 560   if (ptr == NULL)
 561     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 562
 563   return ptr;
 564 }
 565
 566 void *checked_calloc(unsigned long size)
 567 {
 568   void *ptr;
 569
 570   ptr = calloc(1, size);
 571
 572   if (ptr == NULL)
 573     Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
 574
 575   return ptr;
 576 }
 577
 578 #define TRANSLATE_KEYSYM_TO_KEYNAME     0
 579 #define TRANSLATE_KEYSYM_TO_X11KEYNAME  1
 580 #define TRANSLATE_X11KEYNAME_TO_KEYSYM  2
 581
 582 void translate_keyname(KeySym *keysym, char **x11name, char **name, int mode)
 583 {
 584   static struct
 585   {
 586     KeySym keysym;
 587     char *x11name;
 588     char *name;
 589   } translate_key[] =
 590   {
 591     /* normal cursor keys */
 592     { XK_Left,          "XK_Left",              "cursor left" },
 593     { XK_Right,         "XK_Right",             "cursor right" },
 594     { XK_Up,            "XK_Up",                "cursor up" },
 595     { XK_Down,          "XK_Down",              "cursor down" },
 596
 597     /* keypad cursor keys */
 598 #ifdef XK_KP_Left
 599     { XK_KP_Left,       "XK_KP_Left",           "keypad left" },
 600     { XK_KP_Right,      "XK_KP_Right",          "keypad right" },
 601     { XK_KP_Up,         "XK_KP_Up",             "keypad up" },
 602     { XK_KP_Down,       "XK_KP_Down",           "keypad down" },
 603 #endif
 604
 605     /* other keypad keys */
 606 #ifdef XK_KP_Enter
 607     { XK_KP_Enter,      "XK_KP_Enter",          "keypad enter" },
 608     { XK_KP_Add,        "XK_KP_Add",            "keypad +" },
 609     { XK_KP_Subtract,   "XK_KP_Subtract",       "keypad -" },
 610     { XK_KP_Multiply,   "XK_KP_Multiply",       "keypad mltply" },
 611     { XK_KP_Divide,     "XK_KP_Divide",         "keypad /" },
 612     { XK_KP_Separator,  "XK_KP_Separator",      "keypad ," },
 613 #endif
 614
 615     /* modifier keys */
 616     { XK_Shift_L,       "XK_Shift_L",           "left shift" },
 617     { XK_Shift_R,       "XK_Shift_R",           "right shift" },
 618     { XK_Control_L,     "XK_Control_L",         "left control" },
 619     { XK_Control_R,     "XK_Control_R",         "right control" },
 620     { XK_Meta_L,        "XK_Meta_L",            "left meta" },
 621     { XK_Meta_R,        "XK_Meta_R",            "right meta" },
 622     { XK_Alt_L,         "XK_Alt_L",             "left alt" },
 623     { XK_Alt_R,         "XK_Alt_R",             "right alt" },
 624     { XK_Mode_switch,   "XK_Mode_switch",       "mode switch" },
 625     { XK_Multi_key,     "XK_Multi_key",         "multi key" },
 626
 627     /* some special keys */
 628     { XK_BackSpace,     "XK_BackSpace",         "backspace" },
 629     { XK_Delete,        "XK_Delete",            "delete" },
 630     { XK_Insert,        "XK_Insert",            "insert" },
 631     { XK_Tab,           "XK_Tab",               "tab" },
 632     { XK_Home,          "XK_Home",              "home" },
 633     { XK_End,           "XK_End",               "end" },
 634     { XK_Page_Up,       "XK_Page_Up",           "page up" },
 635     { XK_Page_Down,     "XK_Page_Down",         "page down" },
 636
 637
 638     /* ASCII 0x20 to 0x40 keys (except numbers) */
 639     { XK_space,         "XK_space",             "space" },
 640     { XK_exclam,        "XK_exclam",            "!" },
 641     { XK_quotedbl,      "XK_quotedbl",          "\"" },
 642     { XK_numbersign,    "XK_numbersign",        "#" },
 643     { XK_dollar,        "XK_dollar",            "$" },
 644     { XK_percent,       "XK_percent",           "%" },
 645     { XK_ampersand,     "XK_ampersand",         "&" },
 646     { XK_apostrophe,    "XK_apostrophe",        "'" },
 647     { XK_parenleft,     "XK_parenleft",         "(" },
 648     { XK_parenright,    "XK_parenright",        ")" },
 649     { XK_asterisk,      "XK_asterisk",          "*" },
 650     { XK_plus,          "XK_plus",              "+" },
 651     { XK_comma,         "XK_comma",             "," },
 652     { XK_minus,         "XK_minus",             "-" },
 653     { XK_period,        "XK_period",            "." },
 654     { XK_slash,         "XK_slash",             "/" },
 655     { XK_colon,         "XK_colon",             ":" },
 656     { XK_semicolon,     "XK_semicolon",         ";" },
 657     { XK_less,          "XK_less",              "<" },
 658     { XK_equal,         "XK_equal",             "=" },
 659     { XK_greater,       "XK_greater",           ">" },
 660     { XK_question,      "XK_question",          "?" },
 661     { XK_at,            "XK_at",                "@" },
 662
 663     /* more ASCII keys */
 664     { XK_bracketleft,   "XK_bracketleft",       "[" },
 665     { XK_backslash,     "XK_backslash",         "backslash" },
 666     { XK_bracketright,  "XK_bracketright",      "]" },
 667     { XK_asciicircum,   "XK_asciicircum",       "circumflex" },
 668     { XK_underscore,    "XK_underscore",        "_" },
 669     { XK_grave,         "XK_grave",             "grave" },
 670     { XK_quoteleft,     "XK_quoteleft",         "quote left" },
 671     { XK_braceleft,     "XK_braceleft",         "brace left" },
 672     { XK_bar,           "XK_bar",               "bar" },
 673     { XK_braceright,    "XK_braceright",        "brace right" },
 674     { XK_asciitilde,    "XK_asciitilde",        "ascii tilde" },
 675
 676     /* special (non-ASCII) keys */
 677     { XK_Adiaeresis,    "XK_Adiaeresis",        "Ä" },
 678     { XK_Odiaeresis,    "XK_Odiaeresis",        "Ö" },
 679     { XK_Udiaeresis,    "XK_Udiaeresis",        "Ü" },
 680     { XK_adiaeresis,    "XK_adiaeresis",        "ä" },
 681     { XK_odiaeresis,    "XK_odiaeresis",        "ö" },
 682     { XK_udiaeresis,    "XK_udiaeresis",        "ü" },
 683     { XK_ssharp,        "XK_ssharp",            "sharp s" },
 684
 685     /* end-of-array identifier */
 686     { 0,                NULL,                   NULL }
 687   };
 688
 689   int i;
 690
 691   if (mode == TRANSLATE_KEYSYM_TO_KEYNAME)
 692   {
 693     static char name_buffer[30];
 694     KeySym key = *keysym;
 695
 696     if (key >= XK_A && key <= XK_Z)
 697       sprintf(name_buffer, "%c", 'A' + (char)(key - XK_A));
 698     else if (key >= XK_a && key <= XK_z)
 699       sprintf(name_buffer, "%c", 'a' + (char)(key - XK_a));
 700     else if (key >= XK_0 && key <= XK_9)
 701       sprintf(name_buffer, "%c", '0' + (char)(key - XK_0));
 702     else if (key >= XK_KP_0 && key <= XK_KP_9)
 703       sprintf(name_buffer, "keypad %c", '0' + (char)(key - XK_KP_0));
 704     else if (key >= XK_F1 && key <= XK_F24)
 705       sprintf(name_buffer, "function F%d", (int)(key - XK_F1 + 1));
 706     else if (key == KEY_UNDEFINDED)
 707       strcpy(name_buffer, "(undefined)");
 708     else
 709     {
 710       i = 0;
 711
 712       do
 713       {
 714         if (key == translate_key[i].keysym)
 715         {
 716           strcpy(name_buffer, translate_key[i].name);
 717           break;
 718         }
 719       }
 720       while (translate_key[++i].name);
 721
 722       if (!translate_key[i].name)
 723         strcpy(name_buffer, "(unknown)");
 724     }
 725
 726     *name = name_buffer;
 727   }
 728   else if (mode == TRANSLATE_KEYSYM_TO_X11KEYNAME)
 729   {
 730     static char name_buffer[30];
 731     KeySym key = *keysym;
 732
 733     if (key >= XK_A && key <= XK_Z)
 734       sprintf(name_buffer, "XK_%c", 'A' + (char)(key - XK_A));
 735     else if (key >= XK_a && key <= XK_z)
 736       sprintf(name_buffer, "XK_%c", 'a' + (char)(key - XK_a));
 737     else if (key >= XK_0 && key <= XK_9)
 738       sprintf(name_buffer, "XK_%c", '0' + (char)(key - XK_0));
 739     else if (key >= XK_KP_0 && key <= XK_KP_9)
 740       sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - XK_KP_0));
 741     else if (key >= XK_F1 && key <= XK_F24)
 742       sprintf(name_buffer, "XK_F%d", (int)(key - XK_F1 + 1));
 743     else if (key == KEY_UNDEFINDED)
 744       strcpy(name_buffer, "[undefined]");
 745     else
 746     {
 747       i = 0;
 748
 749       do
 750       {
 751         if (key == translate_key[i].keysym)
 752         {
 753           strcpy(name_buffer, translate_key[i].x11name);
 754           break;
 755         }
 756       }
 757       while (translate_key[++i].x11name);
 758
 759       if (!translate_key[i].x11name)
 760         sprintf(name_buffer, "0x%04lx", (unsigned long)key);
 761     }
 762
 763     *x11name = name_buffer;
 764   }
 765   else if (mode == TRANSLATE_X11KEYNAME_TO_KEYSYM)
 766   {
 767     KeySym key = XK_VoidSymbol;
 768     char *name_ptr = *x11name;
 769
 770     if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
 771     {
 772       char c = name_ptr[3];
 773
 774       if (c >= 'A' && c <= 'Z')
 775         key = XK_A + (KeySym)(c - 'A');
 776       else if (c >= 'a' && c <= 'z')
 777         key = XK_a + (KeySym)(c - 'a');
 778       else if (c >= '0' && c <= '9')
 779         key = XK_0 + (KeySym)(c - '0');
 780     }
 781     else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
 782     {
 783       char c = name_ptr[6];
 784
 785       if (c >= '0' && c <= '9')
 786         key = XK_0 + (KeySym)(c - '0');
 787     }
 788     else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
 789     {
 790       char c1 = name_ptr[4];
 791       char c2 = name_ptr[5];
 792       int d = 0;
 793
 794       if ((c1 >= '0' && c1 <= '9') &&
 795           ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
 796         d = atoi(&name_ptr[4]);
 797
 798       if (d >=1 && d <= 24)
 799         key = XK_F1 + (KeySym)(d - 1);
 800     }
 801     else if (strncmp(name_ptr, "XK_", 3) == 0)
 802     {
 803       i = 0;
 804
 805       do
 806       {
 807         if (strcmp(name_ptr, translate_key[i].x11name) == 0)
 808         {
 809           key = translate_key[i].keysym;
 810           break;
 811         }
 812       }
 813       while (translate_key[++i].x11name);
 814     }
 815     else if (strncmp(name_ptr, "0x", 2) == 0)
 816     {
 817       unsigned long value = 0;
 818
 819       name_ptr += 2;
 820
 821       while (name_ptr)
 822       {
 823         char c = *name_ptr++;
 824         int d = -1;
 825
 826         if (c >= '0' && c <= '9')
 827           d = (int)(c - '0');
 828         else if (c >= 'a' && c <= 'f')
 829           d = (int)(c - 'a' + 10);
 830         else if (c >= 'A' && c <= 'F')
 831           d = (int)(c - 'A' + 10);
 832
 833         if (d == -1)
 834         {
 835           value = -1;
 836           break;
 837         }
 838
 839         value = value * 16 + d;
 840       }
 841
 842       if (value != -1)
 843         key = (KeySym)value;
 844     }
 845
 846     *keysym = key;
 847   }
 848 }
 849
 850 char *getKeyNameFromKeySym(KeySym keysym)
 851 {
 852   char *name;
 853
 854   translate_keyname(&keysym, NULL, &name, TRANSLATE_KEYSYM_TO_KEYNAME);
 855   return name;
 856 }
 857
 858 char *getX11KeyNameFromKeySym(KeySym keysym)
 859 {
 860   char *x11name;
 861
 862   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_KEYSYM_TO_X11KEYNAME);
 863   return x11name;
 864 }
 865
 866 KeySym getKeySymFromX11KeyName(char *x11name)
 867 {
 868   KeySym keysym;
 869
 870   translate_keyname(&keysym, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEYSYM);
 871   return keysym;
 872 }
 873
 874 char getCharFromKeySym(KeySym keysym)
 875 {
 876   char *keyname = getKeyNameFromKeySym(keysym);
 877   char letter = 0;
 878
 879   if (strlen(keyname) == 1)
 880     letter = keyname[0];
 881   else if (strcmp(keyname, "space") == 0)
 882     letter = ' ';
 883   else if (strcmp(keyname, "circumflex") == 0)
 884     letter = '^';
 885
 886   return letter;
 887 }
 888
 889 #define TRANSLATE_JOYSYMBOL_TO_JOYNAME  0
 890 #define TRANSLATE_JOYNAME_TO_JOYSYMBOL  1
 891
 892 void translate_joyname(int *joysymbol, char **name, int mode)
 893 {
 894   static struct
 895   {
 896     int joysymbol;
 897     char *name;
 898   } translate_joy[] =
 899   {
 900     { JOY_LEFT,         "joystick_left" },
 901     { JOY_RIGHT,        "joystick_right" },
 902     { JOY_UP,           "joystick_up" },
 903     { JOY_DOWN,         "joystick_down" },
 904     { JOY_BUTTON_1,     "joystick_button_1" },
 905     { JOY_BUTTON_2,     "joystick_button_2" },
 906   };
 907
 908   int i;
 909
 910   if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
 911   {
 912     *name = "[undefined]";
 913
 914     for (i=0; i<6; i++)
 915     {
 916       if (*joysymbol == translate_joy[i].joysymbol)
 917       {
 918         *name = translate_joy[i].name;
 919         break;
 920       }
 921     }
 922   }
 923   else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
 924   {
 925     *joysymbol = 0;
 926
 927     for (i=0; i<6; i++)
 928     {
 929       if (strcmp(*name, translate_joy[i].name) == 0)
 930       {
 931         *joysymbol = translate_joy[i].joysymbol;
 932         break;
 933       }
 934     }
 935   }
 936 }
 937
 938 char *getJoyNameFromJoySymbol(int joysymbol)
 939 {
 940   char *name;
 941
 942   translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
 943   return name;
 944 }
 945
 946 int getJoySymbolFromJoyName(char *name)
 947 {
 948   int joysymbol;
 949
 950   translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
 951   return joysymbol;
 952 }
 953
 954 int getJoystickNrFromDeviceName(char *device_name)
 955 {
 956   char c;
 957   int joystick_nr = 0;
 958
 959   if (device_name == NULL || device_name[0] == '\0')
 960     return 0;
 961
 962   c = device_name[strlen(device_name) - 1];
 963
 964   if (c >= '0' && c <= '9')
 965     joystick_nr = (int)(c - '0');
 966
 967   if (joystick_nr < 0 || joystick_nr >= MAX_PLAYERS)
 968     joystick_nr = 0;
 969
 970   return joystick_nr;
 971 }
 972
 973 /* ----------------------------------------------------------------- */
 974 /* the following is only for debugging purpose and normally not used */
 975 /* ----------------------------------------------------------------- */
 976
 977 #define DEBUG_NUM_TIMESTAMPS    3
 978
 979 void debug_print_timestamp(int counter_nr, char *message)
 980 {
 981   static long counter[DEBUG_NUM_TIMESTAMPS][2];
 982
 983   if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
 984     Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
 985
 986   counter[counter_nr][0] = Counter();
 987
 988   if (message)
 989     printf("%s %.2f seconds\n", message,
 990            (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
 991
 992   counter[counter_nr][1] = Counter();
 993 }