]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - keys.c
eliminated qbyte type, now uses unsigned char throughout the engine for this purpose
[xonotic/darkplaces.git] / keys.c
diff --git a/keys.c b/keys.c
index e11ea703591f95b14ae091354acc4a2224d7f43f..3df1d01e5873c0a15510d2b06039d654f0d6b328 100644 (file)
--- a/keys.c
+++ b/keys.c
 key up events are sent even if in console mode
 */
 
-#define MAX_INPUTLINE 256
-int                    edit_line = 31;
-int                    history_line = 31;
-char           key_lines[32][MAX_INPUTLINE];
+int                    edit_line = MAX_INPUTLINES-1;
+int                    history_line = MAX_INPUTLINES-1;
+char           key_lines[MAX_INPUTLINES][MAX_INPUTLINE];
 int                    key_linepos;
-static int     ctrl_down = false;
-static int     key_lastpress;
-int                    key_insert = true;      // insert key toggle (for editing)
-
+qboolean       key_insert = true;      // insert key toggle (for editing)
 keydest_t      key_dest;
 int                    key_consoleactive;
+char           *keybindings[MAX_BINDMAPS][MAX_KEYS];
 
-static int     key_count;                                      // incremented every key event
 static int     key_bmap, key_bmap2;
+static unsigned char keydown[MAX_KEYS];        // 0 = up, 1 = down, 2 = repeating
 
-char                           *keybindings[8][1024];
-static qboolean                consolekeys[1024];      // if true, can't be rebound while in
-                                                                               // console
-static qboolean                menubound[1024];                // if true, can't be rebound while in
-                                                                               // menu
-static unsigned int    key_repeats[1024];      // if > 1, it is autorepeating
-static qboolean                keydown[1024];
-
-typedef struct {
+typedef struct keyname_s
+{
        const char      *name;
        int                     keynum;
-} keyname_t;
+}
+keyname_t;
 
 static const keyname_t   keynames[] = {
        {"TAB", K_TAB},
@@ -216,7 +207,7 @@ static const keyname_t   keynames[] = {
 void
 Key_ClearEditLine (int edit_line)
 {
-       memset (key_lines[edit_line], '\0', MAX_INPUTLINE);
+       memset (key_lines[edit_line], '\0', sizeof(key_lines[edit_line]));
        key_lines[edit_line][0] = ']';
        key_linepos = 1;
 }
@@ -283,7 +274,7 @@ Key_Console (int key, char ascii)
                {
                        int i;
                        strtok(cbd, "\n\r\b");
-                       i = strlen(cbd);
+                       i = (int)strlen(cbd);
                        if (i + key_linepos >= MAX_INPUTLINE)
                                i= MAX_INPUTLINE - key_linepos;
                        if (i > 0)
@@ -359,7 +350,7 @@ Key_Console (int key, char ascii)
        // delete char on cursor
        if (key == K_DEL || key == K_KP_DEL)
        {
-               if ((size_t)key_linepos < strlen(key_lines[edit_line]))
+               if (key_linepos < (int)strlen(key_lines[edit_line]))
                        strcpy(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1);
                return;
        }
@@ -369,7 +360,7 @@ Key_Console (int key, char ascii)
        // otherwise just go right one
        if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
        {
-               if ((size_t)key_linepos < strlen(key_lines[edit_line]))
+               if (key_linepos < (int)strlen(key_lines[edit_line]))
                        key_linepos++;
 
                return;
@@ -389,7 +380,7 @@ Key_Console (int key, char ascii)
                {
                        history_line--;
                        strcpy(key_lines[edit_line], key_lines[history_line]);
-                       key_linepos = strlen(key_lines[edit_line]);
+                       key_linepos = (int)strlen(key_lines[edit_line]);
                }
                return;
        }
@@ -407,7 +398,7 @@ Key_Console (int key, char ascii)
                else
                {
                        strcpy(key_lines[edit_line], key_lines[history_line]);
-                       key_linepos = strlen(key_lines[edit_line]);
+                       key_linepos = (int)strlen(key_lines[edit_line]);
                }
                return;
        }
@@ -447,7 +438,7 @@ Key_Console (int key, char ascii)
        if (key_linepos < MAX_INPUTLINE-1)
        {
                int len;
-               len = strlen(&key_lines[edit_line][key_linepos]);
+               len = (int)strlen(&key_lines[edit_line][key_linepos]);
                // check insert mode, or always insert if at end of line
                if (key_insert || len == 0)
                {
@@ -564,8 +555,8 @@ Key_KeynumToString (int keynum)
 void
 Key_SetBinding (int keynum, int bindmap, const char *binding)
 {
-       char       *new;
-       int         l;
+       char *newbinding;
+       size_t l;
 
        if (keynum == -1)
                return;
@@ -577,10 +568,10 @@ Key_SetBinding (int keynum, int bindmap, const char *binding)
        }
 // allocate memory for new binding
        l = strlen (binding);
-       new = Z_Malloc (l + 1);
-       strcpy (new, binding);
-       new[l] = 0;
-       keybindings[bindmap][keynum] = new;
+       newbinding = (char *)Z_Malloc (l + 1);
+       strcpy (newbinding, binding);
+       newbinding[l] = 0;
+       keybindings[bindmap][keynum] = newbinding;
 }
 
 static void
@@ -779,38 +770,6 @@ Key_Init (void)
        }
        key_linepos = 1;
 
-//
-// init ascii characters in console mode
-//
-       for (i = 32; i < 128; i++)
-               consolekeys[i] = true;
-       consolekeys[K_ENTER] = true; consolekeys[K_KP_ENTER] = true;
-       consolekeys[K_TAB] = true;
-       consolekeys[K_LEFTARROW] = true; consolekeys[K_KP_LEFTARROW] = true;
-       consolekeys[K_RIGHTARROW] = true; consolekeys[K_KP_RIGHTARROW] = true;
-       consolekeys[K_UPARROW] = true; consolekeys[K_KP_UPARROW] = true;
-       consolekeys[K_DOWNARROW] = true; consolekeys[K_KP_DOWNARROW] = true;
-       consolekeys[K_BACKSPACE] = true;
-       consolekeys[K_DEL] = true; consolekeys[K_KP_DEL] = true;
-       consolekeys[K_INS] = true; consolekeys[K_KP_INS] = true;
-       consolekeys[K_HOME] = true; consolekeys[K_KP_HOME] = true;
-       consolekeys[K_END] = true; consolekeys[K_KP_END] = true;
-       consolekeys[K_PGUP] = true; consolekeys[K_KP_PGUP] = true;
-       consolekeys[K_PGDN] = true; consolekeys[K_KP_PGDN] = true;
-       consolekeys[K_SHIFT] = true;
-       consolekeys[K_MWHEELUP] = true;
-       consolekeys[K_MWHEELDOWN] = true;
-       consolekeys[K_KP_PLUS] = true;
-       consolekeys[K_KP_MINUS] = true;
-       consolekeys[K_KP_DIVIDE] = true;
-       consolekeys[K_KP_MULTIPLY] = true;
-       consolekeys['`'] = true;
-       consolekeys['~'] = true;
-
-       menubound[K_ESCAPE] = true;
-       for (i = 0; i < 12; i++)
-               menubound[K_F1 + i] = true;
-
 //
 // register our functions
 //
@@ -833,150 +792,62 @@ Should NOT be called during an interrupt!
 void
 Key_Event (int key, char ascii, qboolean down)
 {
-#if 0
-#define USERPLAYING()  ( !key_consoleactive && key_dest == key_game && (cls.state == ca_connected && cls.signon == SIGNONS) )
        const char *bind;
-       static qboolean shift_down = false;
 
        // get key binding
-       bind = keybindings[ key_bmap ][ key ];
-       if( !bind ) {
-               bind = keybindings[ key_bmap2 ][ key ];
-       }
-
-       // set key state
-       keydown[ key ] = down;
-
-       // update key repeats
-       if( down ) {
-               key_repeats[ key ]++;
-               if( key_repeats[ key ] > 1 ) {
-                       if( (key_consoleactive && !consolekeys[key]) || USERPLAYING() )
-                               return;                                         // ignore most autorepeats
-               }
-       } else {
-               key_repeats[ key ] = 0;
-       }
-
-       if( key == K_SHIFT ) {
-               shift_down = down;
-       }
-
-       if( !down ) {
-               if( bind && bind[ 0 ] == '+') {
-                       Cbuf_AddText( va( "-%s %i\n", bind + 1, key) ); 
-               }
-       } else {
-               // handle ESCAPE specially, so unbinding wont help
-               if( key == K_ESCAPE ) {
-                       // ctrl-escape is a safety measure for users who cant toggle the console otherwise
-                       if( shift_down || key_consoleactive ) {
-                               Con_ToggleConsole_f();
-                               return;
-                       }
-                       switch( key_dest ) {
-                               case key_message:
-                                       Key_Message( key, ascii );
-                                       break;
-                               case key_menu:
-                                       MR_Keydown( key, ascii );
-                                       break;
-                               case key_game:
-                                       MR_ToggleMenu_f();
-                                       break;
-                               default:
-                                       Sys_Error( "Bad key_dest" );
-                       }
-                       return;
-               }
-
-               if( key_consoleactive ) {
-                               Key_Console( key, ascii );
-                               return;
-               }
-
-               if (bind && !strncmp( bind, "toggleconsole", strlen( "toggleconsole" ) ) )
-               {
-                       Cbuf_AddText( bind );
-                       Cbuf_AddText( "\n" );
-               } else {
-                       // during demo playback, all keys ingame bring up the main menu
-                       if( cls.demoplayback && !key_consoleactive && key_dest == key_game ) {
-                               MR_ToggleMenu_f ();
-                               return;
-                       }
-
-                       // menu bind/function keys or normal binds
-                       if( (key_dest == key_menu && menubound[key]) || USERPLAYING() ) {
-                               if( bind ) {
-                                       if( bind[0] == '+' ) {                  // button commands add keynum as a parm
-                                               Cbuf_AddText( va( "%s %i\n", bind, key ) );
-                                       } else {
-                                               Cbuf_AddText( bind );
-                                               Cbuf_AddText( "\n" );
-                                       }
-                               }
-                               return;
-                       }
-               }
-
-               // either console or game state key functions
-               switch (key_dest) {
-                       case key_message:
-                               Key_Message( key, ascii );
-                               break;
-                       case key_menu:
-                               MR_Keydown( key, ascii );
-                               break;
-                       case key_game:
-                               // unbound key
-                               break;
-                       default:
-                               Sys_Error( "Bad key_dest" );
-               }
-       }
-#else
-       const char      *kb;
-       char            cmd[1024];
-
-       keydown[key] = down;
+       bind = keybindings[key_bmap][key];
+       if (!bind)
+               bind = keybindings[key_bmap2][key];
 
        if (!down)
-               key_repeats[key] = 0;
-
-       key_lastpress = key;
-       key_count++;
-       if (key_count <= 0) {
-               return;                                                 // just catching keys for Con_NotifyBox
+       {
+               // clear repeat count now that the key is released
+               keydown[key] = 0;
+               // key up events only generate commands if the game key binding is a button
+               // command (leading + sign).  These will occur even in console mode, to
+               // keep the character from continuing an action started before a console
+               // switch.  Button commands include the kenum as a parameter, so multiple
+               // downs can be matched with ups
+               if (bind && bind[0] == '+')
+                       Cbuf_AddText(va("-%s %i\n", bind + 1, key));
+               return;
        }
 
-       // update auto-repeat status
-       if (down) {
-               key_repeats[key]++;
-               if (key_repeats[key] > 1) {
-                       if ((key_consoleactive && !consolekeys[key]) ||
-                                       (!key_consoleactive && key_dest == key_game &&
-                                        (cls.state == ca_connected && cls.signon == SIGNONS)))
-                               return;                                         // ignore most autorepeats
-               }
-       }
+       // from here on we know this is a down event
 
-       if (key == K_CTRL)
-               ctrl_down = down;
+       // increment key repeat count each time a down is received so that things
+       // which want to ignore key repeat can ignore it
+       keydown[key] = min(keydown[key] + 1, 2);
 
+       // key_consoleactive is a flag not a key_dest because the console is a
+       // high priority overlay ontop of the normal screen (designed as a safety
+       // feature so that developers and users can rescue themselves from a bad
+       // situation).
        //
-       // handle escape specially, so the user can never unbind it
-       //
-       if (key == K_ESCAPE) {
-               if (!down)
+       // this also means that toggling the console on/off does not lose the old
+       // key_dest state
+
+       // specially handle escape (togglemenu) and shift-escape (toggleconsole)
+       // engine bindings, these are not handled as normal binds so that the user
+       // can recover from a completely empty bindmap
+       if (key == K_ESCAPE)
+       {
+               // ignore key repeats on escape
+               if (keydown[key] > 1)
                        return;
-               // ctrl-escape is a safety measure
-               if (ctrl_down)
+               // escape does these things:
+               // key_consoleactive - close console
+               // key_message - abort messagemode
+               // key_menu - go to parent menu (or key_game)
+               // key_game - open menu
+               // in all modes shift-escape toggles console
+               if ((key_consoleactive & KEY_CONSOLEACTIVE_USER) || keydown[K_SHIFT])
                {
                        Con_ToggleConsole_f ();
                        return;
                }
-               switch (key_dest) {
+               switch (key_dest)
+               {
                        case key_message:
                                Key_Message (key, ascii);
                                break;
@@ -990,96 +861,73 @@ Key_Event (int key, char ascii, qboolean down)
                                if(UI_Callback_IsSlotUsed(key_dest - 3))
                                        UI_Callback_KeyDown (key, ascii);
                                else
-                                       Sys_Error ("Bad key_dest");
+                                       Con_Printf ("Key_Event: Bad key_dest");
                }
                return;
        }
 
-       if (down)
+       // send function keydowns to interpreter no matter what mode is
+       if (key >= K_F1 && key <= K_F12)
        {
-               if (!(kb = keybindings[key_bmap][key]))
-                       kb = keybindings[key_bmap2][key];
-               if (kb && !strncmp(kb, "toggleconsole", strlen("toggleconsole")))
-               {
-                       Cbuf_AddText (kb);
-                       Cbuf_AddText ("\n");
+               // ignore key repeats on F1-F12 binds
+               if (keydown[key] > 1)
                        return;
+               if (bind)
+               {
+                       // button commands add keynum as a parm
+                       if (bind[0] == '+')
+                               Cbuf_AddText (va("%s %i\n", bind, key));
+                       else
+                       {
+                               Cbuf_AddText (bind);
+                               Cbuf_AddText ("\n");
+                       }
                }
+               return;
        }
 
-       if (key_consoleactive && consolekeys[key] && down)
-               Key_Console (key, ascii);
-       else
+#if 1
+       // ignore binds (other than the above escape/F1-F12 keys) while in console
+       if (key_consoleactive)
+#else
+       // respond to toggleconsole binds while in console unless the pressed key
+       // happens to be the color prefix character (such as on German keyboards)
+       if (key_consoleactive && (strncmp(bind, "toggleconsole", strlen("toggleconsole")) || ascii == STRING_COLOR_TAG))
+#endif
        {
-               //
-               // key up events only generate commands if the game key binding is a button
-               // command (leading + sign).  These will occur even in console mode, to
-               // keep the character from continuing an action started before a console
-               // switch.  Button commands include the kenum as a parameter, so multiple
-               // downs can be matched with ups
-               //
-               if (!down) {
-                       if (!(kb = keybindings[key_bmap][key]))
-                               kb = keybindings[key_bmap2][key];
-
-                       if (kb && kb[0] == '+') {
-                               dpsnprintf (cmd, sizeof(cmd), "-%s %i\n", kb + 1, key);
-                               Cbuf_AddText (cmd);
-                       }
-                       return;
-               }
-
-               //
-               // during demo playback, most keys bring up the main menu
-               //
-               if (cls.demoplayback && down && consolekeys[key] && key_dest == key_game) {
-                       MR_ToggleMenu_f ();
-                       return;
-               }
+               Key_Console (key, ascii);
+               return;
+       }
 
-               //
-               // if not a consolekey, send to the interpreter no matter what mode is
-               //
-               if ((key_dest == key_menu && menubound[key])
-                               || (key_consoleactive && !consolekeys[key])
-                               || (key_dest == key_game &&
-                                       ((cls.state == ca_connected) || !consolekeys[key]))) {
-                       if (!(kb = keybindings[key_bmap][key]))
-                               kb = keybindings[key_bmap2][key];
-                       if (kb) {
-                               if (kb[0] == '+') {                     // button commands add keynum as a parm
-                                       dpsnprintf (cmd, sizeof(cmd), "%s %i\n", kb, key);
-                                       Cbuf_AddText (cmd);
-                               } else {
-                                       Cbuf_AddText (kb);
+       // anything else is a key press into the game, chat line, or menu
+       switch (key_dest)
+       {
+               case key_message:
+                       Key_Message (key, ascii);
+                       break;
+               case key_menu:
+                       MR_Keydown (key, ascii);
+                       break;
+               case key_game:
+                       // ignore key repeats on binds
+                       if (bind && keydown[key] == 1)
+                       {
+                               // button commands add keynum as a parm
+                               if (bind[0] == '+')
+                                       Cbuf_AddText (va("%s %i\n", bind, key));
+                               else
+                               {
+                                       Cbuf_AddText (bind);
                                        Cbuf_AddText ("\n");
                                }
                        }
-                       return;
-               }
-
-               if (!down)
-                       return;                                                 // other systems only care about key
-               // down events
-
-               switch (key_dest) {
-                       case key_message:
-                               Key_Message (key, ascii);
-                               break;
-                       case key_menu:
-                               MR_Keydown (key, ascii);
-                               break;
-                       case key_game:
-                               Key_Console (key, ascii);
-                               break;
-                       default:
-                               if(UI_Callback_IsSlotUsed(key_dest - 3))
-                                       UI_Callback_KeyDown (key, ascii);
-                               else
-                                       Sys_Error ("Bad key_dest");
-               }
+                       break;
+               default:
+                       if(UI_Callback_IsSlotUsed(key_dest - 3))
+                               UI_Callback_KeyDown (key, ascii);
+                       else
+                               Con_Printf ("Key_Event: Bad key_dest");
        }
-#endif
 }
 
 /*
@@ -1090,11 +938,5 @@ Key_ClearStates
 void
 Key_ClearStates (void)
 {
-       int i;
-
-       for (i = 0; i < (int)(sizeof(keydown)/sizeof(keydown[0])); i++)
-       {
-               keydown[i] = false;
-               key_repeats[i] = 0;
-       }
+       memset(keydown, 0, sizeof(keydown));
 }