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