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