rnd-20000917-1-src
[rocksndiamonds.git] / src / misc.c
index 6cbd9655e60cd32ed28a514fef251691a8736932..aaad307ae05c1bdb65404f9f02062962bcae3d48 100644 (file)
 *  misc.c                                                  *
 ***********************************************************/
 
-#include <pwd.h>
-#include <unistd.h>
 #include <time.h>
 #include <sys/time.h>
-#include <sys/param.h>
 #include <sys/types.h>
 #include <stdarg.h>
+#include <ctype.h>
+
+#ifndef WIN32
+#include <pwd.h>
+#include <sys/param.h>
+#endif
 
 #include "misc.h"
 #include "init.h"
 #include "tools.h"
 #include "sound.h"
 #include "random.h"
+#include "joystick.h"
+#include "files.h"
+
+#ifdef MSDOS
+volatile unsigned long counter = 0;
+
+void increment_counter()
+{
+  counter++;
+}
+
+END_OF_FUNCTION(increment_counter);
+#endif
+
+
+/* maximal allowed length of a command line option */
+#define MAX_OPTION_LEN         256
+
+#ifdef USE_SDL_LIBRARY
+
+static unsigned long mainCounter(int mode)
+{
+  static unsigned long base_ms = 0;
+  unsigned long current_ms;
+  unsigned long counter_ms;
+
+  current_ms = SDL_GetTicks();
+
+  /* reset base time in case of counter initializing or wrap-around */
+  if (mode == INIT_COUNTER || current_ms < base_ms)
+    base_ms = current_ms;
+
+  counter_ms = current_ms - base_ms;
+
+  return counter_ms;           /* return milliseconds since last init */
+}
+
+#else /* !USE_SDL_LIBRARY */
+#ifndef MSDOS
 
 static unsigned long mainCounter(int mode)
 {
@@ -33,6 +75,7 @@ static unsigned long mainCounter(int mode)
 
   gettimeofday(&current_time, NULL);
 
+  /* reset base time in case of counter initializing or wrap-around */
   if (mode == INIT_COUNTER || current_time.tv_sec < base_time.tv_sec)
     base_time = current_time;
 
@@ -42,19 +85,40 @@ static unsigned long mainCounter(int mode)
   return counter_ms;           /* return milliseconds since last init */
 }
 
+#endif /* !MSDOS */
+#endif /* !USE_SDL_LIBRARY */
+
 void InitCounter()             /* set counter back to zero */
 {
+#ifndef MSDOS
   mainCounter(INIT_COUNTER);
+#else
+  LOCK_VARIABLE(counter);
+  LOCK_FUNCTION(increment_counter);
+  install_int_ex(increment_counter, BPS_TO_TIMER(100));
+#endif
 }
 
 unsigned long Counter()        /* get milliseconds since last call of InitCounter() */
 {
-  return(mainCounter(READ_COUNTER));
+#ifndef MSDOS
+  return mainCounter(READ_COUNTER);
+#else
+  return (counter * 10);
+#endif
 }
 
 static void sleep_milliseconds(unsigned long milliseconds_delay)
 {
-  if (milliseconds_delay < 5)
+  boolean do_busy_waiting = (milliseconds_delay < 5 ? TRUE : FALSE);
+
+#ifdef MSDOS
+  /* don't use select() to perform waiting operations under DOS/Windows
+     environment; always use a busy loop for waiting instead */
+  do_busy_waiting = TRUE;
+#endif
+
+  if (do_busy_waiting)
   {
     /* we want to wait only a few ms -- if we assume that we have a
        kernel timer resolution of 10 ms, we would wait far to long;
@@ -69,13 +133,17 @@ static void sleep_milliseconds(unsigned long milliseconds_delay)
   }
   else
   {
+#ifdef USE_SDL_LIBRARY
+    SDL_Delay(milliseconds_delay);
+#else /* !USE_SDL_LIBRARY */
     struct timeval delay;
 
     delay.tv_sec  = milliseconds_delay / 1000;
     delay.tv_usec = 1000 * (milliseconds_delay % 1000);
 
     if (select(0, NULL, NULL, NULL, &delay) != 0)
-      Error(ERR_RETURN, "sleep_milliseconds(): select() failed");
+      Error(ERR_WARN, "sleep_milliseconds(): select() failed");
+#endif /* !USE_SDL_LIBRARY */
   }
 }
 
@@ -128,54 +196,227 @@ void WaitUntilDelayReached(unsigned long *counter_var, unsigned long delay)
   *counter_var = actual_counter;
 }
 
-char *int2str(int ct, int nr)
+/* int2str() returns a number converted to a string;
+   the used memory is static, but will be overwritten by later calls,
+   so if you want to save the result, copy it to a private string buffer;
+   there can be 10 local calls of int2str() without buffering the result --
+   the 11th call will then destroy the result from the first call and so on.
+*/
+
+char *int2str(int number, int size)
 {
-  static char str[20];
+  static char shift_array[10][40];
+  static int shift_counter = 0;
+  char *s = shift_array[shift_counter];
+
+  shift_counter = (shift_counter + 1) % 10;
+
+  if (size > 20)
+    size = 20;
 
-  sprintf(str,"%09d",ct);
-  return(&str[strlen(str)-nr]);
+  if (size)
+  {
+    sprintf(s, "                    %09d", number);
+    return &s[strlen(s) - size];
+  }
+  else
+  {
+    sprintf(s, "%d", number);
+    return s;
+  }
 }
 
 unsigned int SimpleRND(unsigned int max)
 {
+#ifdef USE_SDL_LIBRARY
+
+  static unsigned long root = 654321;
+  unsigned long current_ms;
+
+  current_ms = SDL_GetTicks();
+  root = root * 4253261 + current_ms;
+  return (root % max);
+
+#else /* !USE_SDL_LIBRARY */
+
   static unsigned long root = 654321;
   struct timeval current_time;
 
-  gettimeofday(&current_time,NULL);
+  gettimeofday(&current_time, NULL);
   root = root * 4253261 + current_time.tv_sec + current_time.tv_usec;
-  return(root % max);
+  return (root % max);
+
+#endif /* !USE_SDL_LIBRARY */
+}
+
+#ifdef DEBUG
+static unsigned int last_RND_value = 0;
+
+unsigned int last_RND()
+{
+  return last_RND_value;
 }
+#endif
 
 unsigned int RND(unsigned int max)
 {
-  return(random_linux_libc() % max);
+#ifdef DEBUG
+  return (last_RND_value = random_linux_libc() % max);
+#else
+  return (random_linux_libc() % max);
+#endif
 }
 
 unsigned int InitRND(long seed)
 {
+#ifdef USE_SDL_LIBRARY
+  unsigned long current_ms;
+
+  if (seed == NEW_RANDOMIZE)
+  {
+    current_ms = SDL_GetTicks();
+    srandom_linux_libc((unsigned int) current_ms);
+    return (unsigned int) current_ms;
+  }
+  else
+  {
+    srandom_linux_libc((unsigned int) seed);
+    return (unsigned int) seed;
+  }
+#else /* !USE_SDL_LIBRARY */
   struct timeval current_time;
 
-  if (seed==NEW_RANDOMIZE)
+  if (seed == NEW_RANDOMIZE)
   {
-    gettimeofday(&current_time,NULL);
+    gettimeofday(&current_time, NULL);
     srandom_linux_libc((unsigned int) current_time.tv_usec);
-    return((unsigned int) current_time.tv_usec);
+    return (unsigned int) current_time.tv_usec;
   }
   else
   {
     srandom_linux_libc((unsigned int) seed);
-    return((unsigned int) seed);
+    return (unsigned int) seed;
   }
+#endif /* !USE_SDL_LIBRARY */
 }
 
-char *GetLoginName()
+char *getLoginName()
 {
+#ifdef WIN32
+  return ANONYMOUS_NAME;
+#else
   struct passwd *pwd;
 
-  if (!(pwd=getpwuid(getuid())))
-    return("ANONYMOUS");
+  if ((pwd = getpwuid(getuid())) == NULL)
+    return ANONYMOUS_NAME;
   else
-    return(pwd->pw_name);
+    return pwd->pw_name;
+#endif
+}
+
+char *getRealName()
+{
+#if defined(MSDOS) || defined(WIN32)
+  return ANONYMOUS_NAME;
+#else
+  struct passwd *pwd;
+
+  if ((pwd = getpwuid(getuid())) == NULL || strlen(pwd->pw_gecos) == 0)
+    return ANONYMOUS_NAME;
+  else
+  {
+    static char real_name[1024];
+    char *from_ptr = pwd->pw_gecos, *to_ptr = real_name;
+
+    if (strchr(pwd->pw_gecos, 'ß') == NULL)
+      return pwd->pw_gecos;
+
+    /* the user's real name contains a 'ß' character (german sharp s),
+       which has no equivalent in upper case letters (which our fonts use) */
+    while (*from_ptr != '\0' && (long)(to_ptr - real_name) < 1024 - 2)
+    {
+      if (*from_ptr != 'ß')
+       *to_ptr++ = *from_ptr++;
+      else
+      {
+       from_ptr++;
+       *to_ptr++ = 's';
+       *to_ptr++ = 's';
+      }
+    }
+    *to_ptr = '\0';
+
+    return real_name;
+  }
+#endif
+}
+
+char *getHomeDir()
+{
+#if defined(MSDOS) || defined(WIN32)
+  return ".";
+#else
+  static char *home_dir = NULL;
+
+  if (!home_dir)
+  {
+    if (!(home_dir = getenv("HOME")))
+    {
+      struct passwd *pwd;
+
+      if ((pwd = getpwuid(getuid())))
+       home_dir = pwd->pw_dir;
+      else
+       home_dir = ".";
+    }
+  }
+
+  return home_dir;
+#endif
+}
+
+char *getPath2(char *path1, char *path2)
+{
+  char *complete_path = checked_malloc(strlen(path1) + 1 +
+                                      strlen(path2) + 1);
+
+  sprintf(complete_path, "%s/%s", path1, path2);
+  return complete_path;
+}
+
+char *getPath3(char *path1, char *path2, char *path3)
+{
+  char *complete_path = checked_malloc(strlen(path1) + 1 +
+                                      strlen(path2) + 1 +
+                                      strlen(path3) + 1);
+
+  sprintf(complete_path, "%s/%s/%s", path1, path2, path3);
+  return complete_path;
+}
+
+char *getStringCopy(char *s)
+{
+  char *s_copy;
+
+  if (s == NULL)
+    return NULL;
+
+  s_copy = checked_malloc(strlen(s) + 1);
+
+  strcpy(s_copy, s);
+  return s_copy;
+}
+
+char *getStringToLower(char *s)
+{
+  char *s_copy = checked_malloc(strlen(s) + 1);
+  char *s_ptr = s_copy;
+
+  while (*s)
+    *s_ptr++ = tolower(*s++);
+  *s_ptr = '\0';
+
+  return s_copy;
 }
 
 void MarkTileDirty(int x, int y)
@@ -184,10 +425,28 @@ void MarkTileDirty(int x, int y)
   int yy = redraw_y1 + y;
 
   if (!redraw[xx][yy])
-  {
-    redraw[xx][yy] = TRUE;
     redraw_tiles++;
-    redraw_mask |= REDRAW_TILES;
+
+  redraw[xx][yy] = TRUE;
+  redraw_mask |= REDRAW_TILES;
+}
+
+void SetBorderElement()
+{
+  int x, y;
+
+  BorderElement = EL_LEERRAUM;
+
+  for(y=0; y<lev_fieldy && BorderElement == EL_LEERRAUM; y++)
+  {
+    for(x=0; x<lev_fieldx; x++)
+    {
+      if (!IS_MASSIVE(Feld[x][y]))
+       BorderElement = EL_BETON;
+
+      if (y != 0 && y != lev_fieldy - 1 && x != lev_fieldx - 1)
+       x = lev_fieldx - 2;
+    }
   }
 }
 
@@ -199,9 +458,18 @@ void GetOptions(char *argv[])
   options.display_name = NULL;
   options.server_host = NULL;
   options.server_port = 0;
+  options.ro_base_directory = RO_BASE_PATH;
+  options.rw_base_directory = RW_BASE_PATH;
+  options.level_directory = RO_BASE_PATH "/" LEVELS_DIRECTORY;
   options.serveronly = FALSE;
   options.network = FALSE;
   options.verbose = FALSE;
+  options.debug = FALSE;
+
+  /* initialize some more global variables */
+  global.frames_per_second = 0;
+  global.fps_slowdown = FALSE;
+  global.fps_slowdown_factor = 1;
 
   while (*options_left)
   {
@@ -211,15 +479,15 @@ void GetOptions(char *argv[])
     char *option_arg = NULL;
     int option_len = strlen(option);
 
+    if (option_len >= MAX_OPTION_LEN)
+      Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
+
     strcpy(option_str, option);                        /* copy argument into buffer */
     option = option_str;
 
     if (strcmp(option, "--") == 0)             /* stop scanning arguments */
       break;
 
-    if (option_len >= MAX_OPTION_LEN)
-      Error(ERR_EXIT_HELP, "unrecognized option '%s'", option);
-
     if (strncmp(option, "--", 2) == 0)         /* treat '--' like '-' */
       option++;
 
@@ -242,7 +510,8 @@ void GetOptions(char *argv[])
       printf("Usage: %s [options] [server.name [port]]\n"
             "Options:\n"
             "  -d, --display machine:0       X server display\n"
-            "  -l, --levels directory        alternative level directory\n"
+            "  -b, --basepath directory      alternative base directory\n"
+            "  -l, --level directory         alternative level directory\n"
             "  -s, --serveronly              only start network server\n"
             "  -n, --network                 network multiplayer game\n"
             "  -v, --verbose                 verbose mode\n",
@@ -257,53 +526,60 @@ void GetOptions(char *argv[])
       options.display_name = option_arg;
       if (option_arg == next_option)
        options_left++;
+    }
+    else if (strncmp(option, "-basepath", option_len) == 0)
+    {
+      if (option_arg == NULL)
+       Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
+
+      /* this should be extended to separate options for ro and rw data */
+      options.ro_base_directory = option_arg;
+      options.rw_base_directory = option_arg;
+      if (option_arg == next_option)
+       options_left++;
 
-      printf("--display == '%s'\n", options.display_name);
+      /* adjust path for level directory accordingly */
+      options.level_directory =
+       getPath2(options.ro_base_directory, LEVELS_DIRECTORY);
     }
     else if (strncmp(option, "-levels", option_len) == 0)
     {
       if (option_arg == NULL)
        Error(ERR_EXIT_HELP, "option '%s' requires an argument", option_str);
 
-      level_directory = option_arg;
+      options.level_directory = option_arg;
       if (option_arg == next_option)
        options_left++;
-
-      printf("--levels == '%s'\n", level_directory);
     }
     else if (strncmp(option, "-network", option_len) == 0)
     {
-      printf("--network\n");
-
       options.network = TRUE;
     }
     else if (strncmp(option, "-serveronly", option_len) == 0)
     {
-      printf("--serveronly\n");
-
       options.serveronly = TRUE;
     }
     else if (strncmp(option, "-verbose", option_len) == 0)
     {
-      printf("--verbose\n");
-
       options.verbose = TRUE;
     }
+    else if (strncmp(option, "-debug", option_len) == 0)
+    {
+      options.debug = TRUE;
+    }
     else if (*option == '-')
+    {
       Error(ERR_EXIT_HELP, "unrecognized option '%s'", option_str);
+    }
     else if (options.server_host == NULL)
     {
       options.server_host = *options_left;
-
-      printf("server.name == '%s'\n", options.server_host);
     }
     else if (options.server_port == 0)
     {
       options.server_port = atoi(*options_left);
       if (options.server_port < 1024)
        Error(ERR_EXIT_HELP, "bad port number '%d'", options.server_port);
-
-      printf("port == %d\n", options.server_port);
     }
     else
       Error(ERR_EXIT_HELP, "too many arguments");
@@ -312,71 +588,62 @@ void GetOptions(char *argv[])
   }
 }
 
-void Error(int mode, char *format_str, ...)
+void Error(int mode, char *format, ...)
 {
-  FILE *output_stream = stderr;
   char *process_name = "";
+  FILE *error = stderr;
 
-  if (mode == ERR_EXIT_SOUNDSERVER)
+  /* display warnings only when running in verbose mode */
+  if (mode & ERR_WARN && !options.verbose)
+    return;
+
+#if defined(MSDOS) || defined(WIN32)
+  if ((error = openErrorFile()) == NULL)
+  {
+    printf("Cannot write to error output file!\n");
+    CloseAllAndExit(1);
+  }
+#endif
+
+  if (mode & ERR_SOUND_SERVER)
     process_name = " sound server";
+  else if (mode & ERR_NETWORK_SERVER)
+    process_name = " network server";
+  else if (mode & ERR_NETWORK_CLIENT)
+    process_name = " network client **";
 
-  if (format_str)
+  if (format)
   {
     va_list ap;
-    char *format_ptr;
-    char *s_value;
-    int i_value;
-    double d_value;
 
-    fprintf(output_stream, "%s%s: ", program_name, process_name);
+    fprintf(error, "%s%s: ", program_name, process_name);
 
-    va_start(ap, format_str);  /* ap points to first unnamed argument */
-  
-    for(format_ptr=format_str; *format_ptr; format_ptr++)
-    {
-      if (*format_ptr != '%')
-      {
-       fprintf(output_stream, "%c", *format_ptr);
-       continue;
-      }
-  
-      switch(*++format_ptr)
-      {
-       case 'd':
-         i_value = va_arg(ap, int);
-         fprintf(output_stream, "%d", i_value);
-         break;
-  
-       case 'f':
-         d_value = va_arg(ap, double);
-         fprintf(output_stream, "%f", d_value);
-         break;
-  
-       case 's':
-         s_value = va_arg(ap, char *);
-         fprintf(output_stream, "%s", s_value);
-         break;
-  
-       default:
-         fprintf(stderr, "\n%s: Error(): invalid format string: %s\n",
-                 program_name, format_str);
-         CloseAllAndExit(10);
-      }
-    }
+    if (mode & ERR_WARN)
+      fprintf(error, "warning: ");
 
+    va_start(ap, format);
+    vfprintf(error, format, ap);
     va_end(ap);
   
-    fprintf(output_stream, "\n");
+    fprintf(error, "\n");
   }
   
-  if (mode == ERR_EXIT_HELP)
-    fprintf(output_stream, "%s: Try option '--help' for more information.\n",
+  if (mode & ERR_HELP)
+    fprintf(error, "%s: Try option '--help' for more information.\n",
            program_name);
 
-  if (mode != ERR_RETURN)
+  if (mode & ERR_EXIT)
+    fprintf(error, "%s%s: aborting\n", program_name, process_name);
+
+  if (error != stderr)
+    fclose(error);
+
+  if (mode & ERR_EXIT)
   {
-    fprintf(output_stream, "%s%s: aborting\n", program_name, process_name);
-    CloseAllAndExit(1);
+    if (mode & ERR_FROM_SERVER)
+      exit(1);                         /* child process: normal exit */
+    else
+      CloseAllAndExit(1);              /* main process: clean up stuff */
   }
 }
 
@@ -391,3 +658,739 @@ void *checked_malloc(unsigned long size)
 
   return ptr;
 }
+
+void *checked_calloc(unsigned long size)
+{
+  void *ptr;
+
+  ptr = calloc(1, size);
+
+  if (ptr == NULL)
+    Error(ERR_EXIT, "cannot allocate %d bytes -- out of memory", size);
+
+  return ptr;
+}
+
+short getFile16BitInteger(FILE *file, int byte_order)
+{
+  if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+    return ((fgetc(file) <<  8) |
+           (fgetc(file) <<  0));
+  else          /* BYTE_ORDER_LITTLE_ENDIAN */
+    return ((fgetc(file) <<  0) |
+           (fgetc(file) <<  8));
+}
+
+void putFile16BitInteger(FILE *file, short value, int byte_order)
+{
+  if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+  {
+    fputc((value >>  8) & 0xff, file);
+    fputc((value >>  0) & 0xff, file);
+  }
+  else          /* BYTE_ORDER_LITTLE_ENDIAN */
+  {
+    fputc((value >>  0) & 0xff, file);
+    fputc((value >>  8) & 0xff, file);
+  }
+}
+
+int getFile32BitInteger(FILE *file, int byte_order)
+{
+  if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+    return ((fgetc(file) << 24) |
+           (fgetc(file) << 16) |
+           (fgetc(file) <<  8) |
+           (fgetc(file) <<  0));
+  else          /* BYTE_ORDER_LITTLE_ENDIAN */
+    return ((fgetc(file) <<  0) |
+           (fgetc(file) <<  8) |
+           (fgetc(file) << 16) |
+           (fgetc(file) << 24));
+}
+
+void putFile32BitInteger(FILE *file, int value, int byte_order)
+{
+  if (byte_order == BYTE_ORDER_BIG_ENDIAN)
+  {
+    fputc((value >> 24) & 0xff, file);
+    fputc((value >> 16) & 0xff, file);
+    fputc((value >>  8) & 0xff, file);
+    fputc((value >>  0) & 0xff, file);
+  }
+  else          /* BYTE_ORDER_LITTLE_ENDIAN */
+  {
+    fputc((value >>  0) & 0xff, file);
+    fputc((value >>  8) & 0xff, file);
+    fputc((value >> 16) & 0xff, file);
+    fputc((value >> 24) & 0xff, file);
+  }
+}
+
+void getFileChunk(FILE *file, char *chunk_buffer, int *chunk_length,
+                 int byte_order)
+{
+  const int chunk_identifier_length = 4;
+
+  /* read chunk identifier */
+  fgets(chunk_buffer, chunk_identifier_length + 1, file);
+
+  /* read chunk length */
+  *chunk_length = getFile32BitInteger(file, byte_order);
+}
+
+void putFileChunk(FILE *file, char *chunk_name, int chunk_length,
+                 int byte_order)
+{
+  /* write chunk identifier */
+  fputs(chunk_name, file);
+
+  /* write chunk length */
+  putFile32BitInteger(file, chunk_length, byte_order);
+}
+
+#define TRANSLATE_KEY_TO_KEYNAME       0
+#define TRANSLATE_KEY_TO_X11KEYNAME    1
+#define TRANSLATE_X11KEYNAME_TO_KEY    2
+
+void translate_keyname(Key *keysym, char **x11name, char **name, int mode)
+{
+  static struct
+  {
+    Key key;
+    char *x11name;
+    char *name;
+  } translate_key[] =
+  {
+    /* normal cursor keys */
+    { KEY_Left,                "XK_Left",              "cursor left" },
+    { KEY_Right,       "XK_Right",             "cursor right" },
+    { KEY_Up,          "XK_Up",                "cursor up" },
+    { KEY_Down,                "XK_Down",              "cursor down" },
+
+    /* keypad cursor keys */
+#ifdef KEY_KP_Left
+    { KEY_KP_Left,     "XK_KP_Left",           "keypad left" },
+    { KEY_KP_Right,    "XK_KP_Right",          "keypad right" },
+    { KEY_KP_Up,       "XK_KP_Up",             "keypad up" },
+    { KEY_KP_Down,     "XK_KP_Down",           "keypad down" },
+#endif
+
+    /* other keypad keys */
+#ifdef KEY_KP_Enter
+    { KEY_KP_Enter,    "XK_KP_Enter",          "keypad enter" },
+    { KEY_KP_Add,      "XK_KP_Add",            "keypad +" },
+    { KEY_KP_Subtract, "XK_KP_Subtract",       "keypad -" },
+    { KEY_KP_Multiply, "XK_KP_Multiply",       "keypad mltply" },
+    { KEY_KP_Divide,   "XK_KP_Divide",         "keypad /" },
+    { KEY_KP_Separator,        "XK_KP_Separator",      "keypad ," },
+#endif
+
+    /* modifier keys */
+    { KEY_Shift_L,     "XK_Shift_L",           "left shift" },
+    { KEY_Shift_R,     "XK_Shift_R",           "right shift" },
+    { KEY_Control_L,   "XK_Control_L",         "left control" },
+    { KEY_Control_R,   "XK_Control_R",         "right control" },
+    { KEY_Meta_L,      "XK_Meta_L",            "left meta" },
+    { KEY_Meta_R,      "XK_Meta_R",            "right meta" },
+    { KEY_Alt_L,       "XK_Alt_L",             "left alt" },
+    { KEY_Alt_R,       "XK_Alt_R",             "right alt" },
+    { KEY_Super_L,     "XK_Super_L",           "left super" },  /* Win-L */
+    { KEY_Super_R,     "XK_Super_R",           "right super" }, /* Win-R */
+    { KEY_Mode_switch, "XK_Mode_switch",       "mode switch" }, /* Alt-R */
+    { KEY_Multi_key,   "XK_Multi_key",         "multi key" },   /* Ctrl-R */
+
+    /* some special keys */
+    { KEY_BackSpace,   "XK_BackSpace",         "backspace" },
+    { KEY_Delete,      "XK_Delete",            "delete" },
+    { KEY_Insert,      "XK_Insert",            "insert" },
+    { KEY_Tab,         "XK_Tab",               "tab" },
+    { KEY_Home,                "XK_Home",              "home" },
+    { KEY_End,         "XK_End",               "end" },
+    { KEY_Page_Up,     "XK_Page_Up",           "page up" },
+    { KEY_Page_Down,   "XK_Page_Down",         "page down" },
+    { KEY_Menu,                "XK_Menu",              "menu" },        /* Win-Menu */
+
+    /* ASCII 0x20 to 0x40 keys (except numbers) */
+    { KEY_space,       "XK_space",             "space" },
+    { KEY_exclam,      "XK_exclam",            "!" },
+    { KEY_quotedbl,    "XK_quotedbl",          "\"" },
+    { KEY_numbersign,  "XK_numbersign",        "#" },
+    { KEY_dollar,      "XK_dollar",            "$" },
+    { KEY_percent,     "XK_percent",           "%" },
+    { KEY_ampersand,   "XK_ampersand",         "&" },
+    { KEY_apostrophe,  "XK_apostrophe",        "'" },
+    { KEY_parenleft,   "XK_parenleft",         "(" },
+    { KEY_parenright,  "XK_parenright",        ")" },
+    { KEY_asterisk,    "XK_asterisk",          "*" },
+    { KEY_plus,                "XK_plus",              "+" },
+    { KEY_comma,       "XK_comma",             "," },
+    { KEY_minus,       "XK_minus",             "-" },
+    { KEY_period,      "XK_period",            "." },
+    { KEY_slash,       "XK_slash",             "/" },
+    { KEY_colon,       "XK_colon",             ":" },
+    { KEY_semicolon,   "XK_semicolon",         ";" },
+    { KEY_less,                "XK_less",              "<" },
+    { KEY_equal,       "XK_equal",             "=" },
+    { KEY_greater,     "XK_greater",           ">" },
+    { KEY_question,    "XK_question",          "?" },
+    { KEY_at,          "XK_at",                "@" },
+
+    /* more ASCII keys */
+    { KEY_bracketleft, "XK_bracketleft",       "[" },
+    { KEY_backslash,   "XK_backslash",         "backslash" },
+    { KEY_bracketright,        "XK_bracketright",      "]" },
+    { KEY_asciicircum, "XK_asciicircum",       "circumflex" },
+    { KEY_underscore,  "XK_underscore",        "_" },
+    { KEY_grave,       "XK_grave",             "grave" },
+    { KEY_quoteleft,   "XK_quoteleft",         "quote left" },
+    { KEY_braceleft,   "XK_braceleft",         "brace left" },
+    { KEY_bar,         "XK_bar",               "bar" },
+    { KEY_braceright,  "XK_braceright",        "brace right" },
+    { KEY_asciitilde,  "XK_asciitilde",        "ascii tilde" },
+
+    /* special (non-ASCII) keys */
+    { KEY_Adiaeresis,  "XK_Adiaeresis",        "Ä" },
+    { KEY_Odiaeresis,  "XK_Odiaeresis",        "Ö" },
+    { KEY_Udiaeresis,  "XK_Udiaeresis",        "Ü" },
+    { KEY_adiaeresis,  "XK_adiaeresis",        "ä" },
+    { KEY_odiaeresis,  "XK_odiaeresis",        "ö" },
+    { KEY_udiaeresis,  "XK_udiaeresis",        "ü" },
+    { KEY_ssharp,      "XK_ssharp",            "sharp s" },
+
+    /* end-of-array identifier */
+    { 0,                NULL,                  NULL }
+  };
+
+  int i;
+
+  if (mode == TRANSLATE_KEY_TO_KEYNAME)
+  {
+    static char name_buffer[30];
+    Key key = *keysym;
+
+    if (key >= KEY_A && key <= KEY_Z)
+      sprintf(name_buffer, "%c", 'A' + (char)(key - KEY_A));
+    else if (key >= KEY_a && key <= KEY_z)
+      sprintf(name_buffer, "%c", 'a' + (char)(key - KEY_a));
+    else if (key >= KEY_0 && key <= KEY_9)
+      sprintf(name_buffer, "%c", '0' + (char)(key - KEY_0));
+    else if (key >= KEY_KP_0 && key <= KEY_KP_9)
+      sprintf(name_buffer, "keypad %c", '0' + (char)(key - KEY_KP_0));
+    else if (key >= KEY_F1 && key <= KEY_F24)
+      sprintf(name_buffer, "function F%d", (int)(key - KEY_F1 + 1));
+    else if (key == KEY_UNDEFINED)
+      strcpy(name_buffer, "(undefined)");
+    else
+    {
+      i = 0;
+
+      do
+      {
+       if (key == translate_key[i].key)
+       {
+         strcpy(name_buffer, translate_key[i].name);
+         break;
+       }
+      }
+      while (translate_key[++i].name);
+
+      if (!translate_key[i].name)
+       strcpy(name_buffer, "(unknown)");
+    }
+
+    *name = name_buffer;
+  }
+  else if (mode == TRANSLATE_KEY_TO_X11KEYNAME)
+  {
+    static char name_buffer[30];
+    Key key = *keysym;
+
+    if (key >= KEY_A && key <= KEY_Z)
+      sprintf(name_buffer, "XK_%c", 'A' + (char)(key - KEY_A));
+    else if (key >= KEY_a && key <= KEY_z)
+      sprintf(name_buffer, "XK_%c", 'a' + (char)(key - KEY_a));
+    else if (key >= KEY_0 && key <= KEY_9)
+      sprintf(name_buffer, "XK_%c", '0' + (char)(key - KEY_0));
+    else if (key >= KEY_KP_0 && key <= KEY_KP_9)
+      sprintf(name_buffer, "XK_KP_%c", '0' + (char)(key - KEY_KP_0));
+    else if (key >= KEY_F1 && key <= KEY_F24)
+      sprintf(name_buffer, "XK_F%d", (int)(key - KEY_F1 + 1));
+    else if (key == KEY_UNDEFINED)
+      strcpy(name_buffer, "[undefined]");
+    else
+    {
+      i = 0;
+
+      do
+      {
+       if (key == translate_key[i].key)
+       {
+         strcpy(name_buffer, translate_key[i].x11name);
+         break;
+       }
+      }
+      while (translate_key[++i].x11name);
+
+      if (!translate_key[i].x11name)
+       sprintf(name_buffer, "0x%04lx", (unsigned long)key);
+    }
+
+    *x11name = name_buffer;
+  }
+  else if (mode == TRANSLATE_X11KEYNAME_TO_KEY)
+  {
+    Key key = KEY_UNDEFINED;
+    char *name_ptr = *x11name;
+
+    if (strncmp(name_ptr, "XK_", 3) == 0 && strlen(name_ptr) == 4)
+    {
+      char c = name_ptr[3];
+
+      if (c >= 'A' && c <= 'Z')
+       key = KEY_A + (Key)(c - 'A');
+      else if (c >= 'a' && c <= 'z')
+       key = KEY_a + (Key)(c - 'a');
+      else if (c >= '0' && c <= '9')
+       key = KEY_0 + (Key)(c - '0');
+    }
+    else if (strncmp(name_ptr, "XK_KP_", 6) == 0 && strlen(name_ptr) == 7)
+    {
+      char c = name_ptr[6];
+
+      if (c >= '0' && c <= '9')
+       key = KEY_0 + (Key)(c - '0');
+    }
+    else if (strncmp(name_ptr, "XK_F", 4) == 0 && strlen(name_ptr) <= 6)
+    {
+      char c1 = name_ptr[4];
+      char c2 = name_ptr[5];
+      int d = 0;
+
+      if ((c1 >= '0' && c1 <= '9') &&
+         ((c2 >= '0' && c1 <= '9') || c2 == '\0'))
+       d = atoi(&name_ptr[4]);
+
+      if (d >=1 && d <= 24)
+       key = KEY_F1 + (Key)(d - 1);
+    }
+    else if (strncmp(name_ptr, "XK_", 3) == 0)
+    {
+      i = 0;
+
+      do
+      {
+       if (strcmp(name_ptr, translate_key[i].x11name) == 0)
+       {
+         key = translate_key[i].key;
+         break;
+       }
+      }
+      while (translate_key[++i].x11name);
+    }
+    else if (strncmp(name_ptr, "0x", 2) == 0)
+    {
+      unsigned long value = 0;
+
+      name_ptr += 2;
+
+      while (name_ptr)
+      {
+       char c = *name_ptr++;
+       int d = -1;
+
+       if (c >= '0' && c <= '9')
+         d = (int)(c - '0');
+       else if (c >= 'a' && c <= 'f')
+         d = (int)(c - 'a' + 10);
+       else if (c >= 'A' && c <= 'F')
+         d = (int)(c - 'A' + 10);
+
+       if (d == -1)
+       {
+         value = -1;
+         break;
+       }
+
+       value = value * 16 + d;
+      }
+
+      if (value != -1)
+       key = (Key)value;
+    }
+
+    *keysym = key;
+  }
+}
+
+char *getKeyNameFromKey(Key key)
+{
+  char *name;
+
+  translate_keyname(&key, NULL, &name, TRANSLATE_KEY_TO_KEYNAME);
+  return name;
+}
+
+char *getX11KeyNameFromKey(Key key)
+{
+  char *x11name;
+
+  translate_keyname(&key, &x11name, NULL, TRANSLATE_KEY_TO_X11KEYNAME);
+  return x11name;
+}
+
+Key getKeyFromX11KeyName(char *x11name)
+{
+  Key key;
+
+  translate_keyname(&key, &x11name, NULL, TRANSLATE_X11KEYNAME_TO_KEY);
+  return key;
+}
+
+char getCharFromKey(Key key)
+{
+  char *keyname = getKeyNameFromKey(key);
+  char letter = 0;
+
+  if (strlen(keyname) == 1)
+    letter = keyname[0];
+  else if (strcmp(keyname, "space") == 0)
+    letter = ' ';
+  else if (strcmp(keyname, "circumflex") == 0)
+    letter = '^';
+
+  return letter;
+}
+
+#define TRANSLATE_JOYSYMBOL_TO_JOYNAME 0
+#define TRANSLATE_JOYNAME_TO_JOYSYMBOL 1
+
+void translate_joyname(int *joysymbol, char **name, int mode)
+{
+  static struct
+  {
+    int joysymbol;
+    char *name;
+  } translate_joy[] =
+  {
+    { JOY_LEFT,                "joystick_left" },
+    { JOY_RIGHT,       "joystick_right" },
+    { JOY_UP,          "joystick_up" },
+    { JOY_DOWN,                "joystick_down" },
+    { JOY_BUTTON_1,    "joystick_button_1" },
+    { JOY_BUTTON_2,    "joystick_button_2" },
+  };
+
+  int i;
+
+  if (mode == TRANSLATE_JOYSYMBOL_TO_JOYNAME)
+  {
+    *name = "[undefined]";
+
+    for (i=0; i<6; i++)
+    {
+      if (*joysymbol == translate_joy[i].joysymbol)
+      {
+       *name = translate_joy[i].name;
+       break;
+      }
+    }
+  }
+  else if (mode == TRANSLATE_JOYNAME_TO_JOYSYMBOL)
+  {
+    *joysymbol = 0;
+
+    for (i=0; i<6; i++)
+    {
+      if (strcmp(*name, translate_joy[i].name) == 0)
+      {
+       *joysymbol = translate_joy[i].joysymbol;
+       break;
+      }
+    }
+  }
+}
+
+char *getJoyNameFromJoySymbol(int joysymbol)
+{
+  char *name;
+
+  translate_joyname(&joysymbol, &name, TRANSLATE_JOYSYMBOL_TO_JOYNAME);
+  return name;
+}
+
+int getJoySymbolFromJoyName(char *name)
+{
+  int joysymbol;
+
+  translate_joyname(&joysymbol, &name, TRANSLATE_JOYNAME_TO_JOYSYMBOL);
+  return joysymbol;
+}
+
+int getJoystickNrFromDeviceName(char *device_name)
+{
+  char c;
+  int joystick_nr = 0;
+
+  if (device_name == NULL || device_name[0] == '\0')
+    return 0;
+
+  c = device_name[strlen(device_name) - 1];
+
+  if (c >= '0' && c <= '9')
+    joystick_nr = (int)(c - '0');
+
+  if (joystick_nr < 0 || joystick_nr >= MAX_PLAYERS)
+    joystick_nr = 0;
+
+  return joystick_nr;
+}
+
+/* ------------------------------------------------------------------------- */
+/* some functions to handle lists of level directories                       */
+/* ------------------------------------------------------------------------- */
+
+struct LevelDirInfo *newLevelDirInfo()
+{
+  return checked_calloc(sizeof(struct LevelDirInfo));
+}
+
+void pushLevelDirInfo(struct LevelDirInfo **node_first,
+                     struct LevelDirInfo *node_new)
+{
+  node_new->next = *node_first;
+  *node_first = node_new;
+}
+
+int numLevelDirInfo(struct LevelDirInfo *node)
+{
+  int num = 0;
+
+  while (node)
+  {
+    num++;
+    node = node->next;
+  }
+
+  return num;
+}
+
+boolean validLevelSeries(struct LevelDirInfo *node)
+{
+  return (node != NULL && !node->node_group && !node->parent_link);
+}
+
+struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *node)
+{
+  if (node == NULL)
+  {
+    if (leveldir_first)                /* start with first level directory entry */
+      return getFirstValidLevelSeries(leveldir_first);
+    else
+      return NULL;
+  }
+  else if (node->node_group)   /* enter level group (step down into tree) */
+    return getFirstValidLevelSeries(node->node_group);
+  else if (node->parent_link)  /* skip start entry of level group */
+  {
+    if (node->next)            /* get first real level series entry */
+      return getFirstValidLevelSeries(node->next);
+    else                       /* leave empty level group and go on */
+      return getFirstValidLevelSeries(node->node_parent->next);
+  }
+  else                         /* this seems to be a regular level series */
+    return node;
+}
+
+struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *node)
+{
+  if (node == NULL)
+    return NULL;
+
+  if (node->node_parent == NULL)               /* top level group */
+    return leveldir_first;
+  else                                         /* sub level group */
+    return node->node_parent->node_group;
+}
+
+int numLevelDirInfoInGroup(struct LevelDirInfo *node)
+{
+  return numLevelDirInfo(getLevelDirInfoFirstGroupEntry(node));
+}
+
+int posLevelDirInfo(struct LevelDirInfo *node)
+{
+  struct LevelDirInfo *node_cmp = getLevelDirInfoFirstGroupEntry(node);
+  int pos = 0;
+
+  while (node_cmp)
+  {
+    if (node_cmp == node)
+      return pos;
+
+    pos++;
+    node_cmp = node_cmp->next;
+  }
+
+  return 0;
+}
+
+struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *node, int pos)
+{
+  struct LevelDirInfo *node_default = node;
+  int pos_cmp = 0;
+
+  while (node)
+  {
+    if (pos_cmp == pos)
+      return node;
+
+    pos_cmp++;
+    node = node->next;
+  }
+
+  return node_default;
+}
+
+struct LevelDirInfo *getLevelDirInfoFromFilenameExt(struct LevelDirInfo *node,
+                                                   char *filename)
+{
+  if (filename == NULL)
+    return NULL;
+
+  while (node)
+  {
+    if (node->node_group)
+    {
+      struct LevelDirInfo *node_group;
+
+      node_group = getLevelDirInfoFromFilenameExt(node->node_group, filename);
+
+      if (node_group)
+       return node_group;
+    }
+    else if (!node->parent_link)
+    {
+      if (strcmp(filename, node->filename) == 0)
+       return node;
+    }
+
+    node = node->next;
+  }
+
+  return NULL;
+}
+
+struct LevelDirInfo *getLevelDirInfoFromFilename(char *filename)
+{
+  return getLevelDirInfoFromFilenameExt(leveldir_first, filename);
+}
+
+void dumpLevelDirInfo(struct LevelDirInfo *node, int depth)
+{
+  int i;
+
+  while (node)
+  {
+    for (i=0; i<depth * 3; i++)
+      printf(" ");
+
+    printf("filename == '%s'\n", node->filename);
+
+    if (node->node_group != NULL)
+      dumpLevelDirInfo(node->node_group, depth + 1);
+
+    node = node->next;
+  }
+}
+
+void sortLevelDirInfo(struct LevelDirInfo **node_first,
+                     int (*compare_function)(const void *, const void *))
+{
+  int num_nodes = numLevelDirInfo(*node_first);
+  struct LevelDirInfo **sort_array;
+  struct LevelDirInfo *node = *node_first;
+  int i = 0;
+
+  if (num_nodes == 0)
+    return;
+
+  /* allocate array for sorting structure pointers */
+  sort_array = checked_calloc(num_nodes * sizeof(struct LevelDirInfo *));
+
+  /* writing structure pointers to sorting array */
+  while (i < num_nodes && node)                /* double boundary check... */
+  {
+    sort_array[i] = node;
+
+    i++;
+    node = node->next;
+  }
+
+  /* sorting the structure pointers in the sorting array */
+  qsort(sort_array, num_nodes, sizeof(struct LevelDirInfo *),
+       compare_function);
+
+  /* update the linkage of list elements with the sorted node array */
+  for (i=0; i<num_nodes - 1; i++)
+    sort_array[i]->next = sort_array[i + 1];
+  sort_array[num_nodes - 1]->next = NULL;
+
+  /* update the linkage of the main list anchor pointer */
+  *node_first = sort_array[0];
+
+  free(sort_array);
+
+  /* now recursively sort the level group structures */
+  node = *node_first;
+  while (node)
+  {
+    if (node->node_group != NULL)
+      sortLevelDirInfo(&node->node_group, compare_function);
+
+    node = node->next;
+  }
+}
+
+inline void swap_numbers(int *i1, int *i2)
+{
+  int help = *i1;
+
+  *i1 = *i2;
+  *i2 = help;
+}
+
+inline void swap_number_pairs(int *x1, int *y1, int *x2, int *y2)
+{
+  int help_x = *x1;
+  int help_y = *y1;
+
+  *x1 = *x2;
+  *x2 = help_x;
+
+  *y1 = *y2;
+  *y2 = help_y;
+}
+
+
+/* ------------------------------------------------------------------------- */
+/* the following is only for debugging purpose and normally not used         */
+/* ------------------------------------------------------------------------- */
+
+#define DEBUG_NUM_TIMESTAMPS   3
+
+void debug_print_timestamp(int counter_nr, char *message)
+{
+  static long counter[DEBUG_NUM_TIMESTAMPS][2];
+
+  if (counter_nr >= DEBUG_NUM_TIMESTAMPS)
+    Error(ERR_EXIT, "debugging: increase DEBUG_NUM_TIMESTAMPS in misc.c");
+
+  counter[counter_nr][0] = Counter();
+
+  if (message)
+    printf("%s %.2f seconds\n", message,
+          (float)(counter[counter_nr][0] - counter[counter_nr][1]) / 1000);
+
+  counter[counter_nr][1] = Counter();
+}