4 Copyright (C) 1996-1997 Id Software, Inc.
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 as published by the Free Software Foundation; either version 2
9 of the License, or (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 See the GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to:
20 Free Software Foundation, Inc.
21 59 Temple Place - Suite 330
22 Boston, MA 02111-1307, USA
25 static const char rcsid[] =
33 key up events are sent even if in console mode
36 #define MAX_INPUTLINE 256
37 char key_lines[32][MAX_INPUTLINE];
39 static int ctrl_down = false;
40 static int key_lastpress;
41 int key_insert; // insert key toggle (for editing)
47 int key_consoleactive;
49 static int key_count; // incremented every key event
50 static int key_bmap, key_bmap2;
52 char *keybindings[8][1024];
53 static qboolean consolekeys[1024]; // if true, can't be rebound while in
55 static qboolean menubound[1024]; // if true, can't be rebound while in
57 static unsigned int key_repeats[1024]; // if > 1, it is autorepeating
58 static qboolean keydown[1024];
65 static const keyname_t keynames[] = {
70 {"BACKSPACE", K_BACKSPACE},
71 {"UPARROW", K_UPARROW},
72 {"DOWNARROW", K_DOWNARROW},
73 {"LEFTARROW", K_LEFTARROW},
74 {"RIGHTARROW", K_RIGHTARROW},
102 {"MWHEELUP", K_MWHEELUP},
103 {"MWHEELDOWN", K_MWHEELDOWN},
105 {"MOUSE1", K_MOUSE1},
106 {"MOUSE2", K_MOUSE2},
107 {"MOUSE3", K_MOUSE3},
108 {"MOUSE4", K_MOUSE4},
109 {"MOUSE5", K_MOUSE5},
110 {"MOUSE6", K_MOUSE6},
111 {"MOUSE7", K_MOUSE7},
112 {"MOUSE8", K_MOUSE8},
113 {"MOUSE9", K_MOUSE9},
114 {"MOUSE10", K_MOUSE10},
115 {"MOUSE11", K_MOUSE11},
116 {"MOUSE12", K_MOUSE12},
117 {"MOUSE13", K_MOUSE13},
118 {"MOUSE14", K_MOUSE14},
119 {"MOUSE15", K_MOUSE15},
120 {"MOUSE16", K_MOUSE16},
122 {"NUMLOCK", K_NUMLOCK},
123 {"CAPSLOCK", K_CAPSLOCK},
124 {"SCROLLOCK", K_SCROLLOCK},
126 {"KP_HOME", K_KP_HOME },
127 {"KP_UPARROW", K_KP_UPARROW },
128 {"KP_PGUP", K_KP_PGUP },
129 {"KP_LEFTARROW", K_KP_LEFTARROW },
130 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
131 {"KP_END", K_KP_END },
132 {"KP_DOWNARROW", K_KP_DOWNARROW },
133 {"KP_PGDN", K_KP_PGDN },
134 {"KP_INS", K_KP_INS },
135 {"KP_DEL", K_KP_DEL },
136 {"KP_SLASH", K_KP_SLASH },
148 {"KP_PERIOD", K_KP_PERIOD},
149 {"KP_DIVIDE", K_KP_DIVIDE},
150 {"KP_MULTIPLY", K_KP_MULTIPLY},
151 {"KP_MINUS", K_KP_MINUS},
152 {"KP_PLUS", K_KP_PLUS},
153 {"KP_ENTER", K_KP_ENTER},
154 {"KP_EQUALS", K_KP_EQUALS},
206 {"SEMICOLON", ';'}, // because a raw semicolon seperates commands
210 {"APOSTROPHE", '\''},
216 ==============================================================================
218 LINE TYPING INTO THE CONSOLE
220 ==============================================================================
224 Key_ClearEditLine (int edit_line)
226 memset (key_lines[edit_line], '\0', MAX_INPUTLINE);
227 key_lines[edit_line][0] = ']';
233 Interactive line editing and console scrollback
237 Key_Console (int key, char ascii)
239 // LordHavoc: copied most of this from Q2 to improve keyboard handling
266 case K_KP_RIGHTARROW:
286 if ((toupper(key) == 'V' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
289 if ((cbd = Sys_GetClipboardData()) != 0)
292 strtok(cbd, "\n\r\b");
294 if (i + key_linepos >= MAX_INPUTLINE)
295 i= MAX_INPUTLINE - key_linepos;
299 strcat(key_lines[edit_line], cbd);
311 Cbuf_AddText ("clear\n");
316 if (key == K_ENTER || key == K_KP_ENTER)
318 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
320 Con_Printf("%s\n",key_lines[edit_line]);
321 edit_line = (edit_line + 1) & 31;
322 history_line = edit_line;
323 key_lines[edit_line][0] = ']';
324 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
326 // force an update, because the command may take some time
327 if (cls.state == ca_disconnected)
337 // Enhanced command completion
338 // by EvilTypeGuy eviltypeguy@qeradiant.com
339 // Thanks to Fett, Taniwha
340 Con_CompleteCommandLine();
344 // Advanced Console Editing by Radix radix@planetquake.com
345 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
347 // left arrow will just move left one without erasing, backspace will
348 // actually erase charcter
349 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
356 // delete char before cursor
357 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
361 strcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos);
367 // delete char on cursor
368 if (key == K_DEL || key == K_KP_DEL)
370 if ((size_t)key_linepos < strlen(key_lines[edit_line]))
371 strcpy(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1);
376 // if we're at the end, get one character from previous line,
377 // otherwise just go right one
378 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
380 if (strlen(key_lines[edit_line]) == (size_t)key_linepos)
382 if (strlen(key_lines[(edit_line + 31) & 31]) <= (size_t)key_linepos)
383 return; // no character to get
385 key_lines[edit_line][key_linepos] = key_lines[(edit_line + 31) & 31][key_linepos];
387 key_lines[edit_line][key_linepos] = 0;
395 if (key == K_INS || key == K_KP_INS) // toggle insert mode
401 // End Advanced Console Editing
403 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
407 history_line = (history_line - 1) & 31;
408 } while (history_line != edit_line
409 && !key_lines[history_line][1]);
410 if (history_line == edit_line)
411 history_line = (edit_line+1)&31;
412 strcpy(key_lines[edit_line], key_lines[history_line]);
413 key_linepos = strlen(key_lines[edit_line]);
417 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
419 if (history_line == edit_line) return;
422 history_line = (history_line + 1) & 31;
424 while (history_line != edit_line
425 && !key_lines[history_line][1]);
426 if (history_line == edit_line)
428 key_lines[edit_line][0] = ']';
433 strcpy(key_lines[edit_line], key_lines[history_line]);
434 key_linepos = strlen(key_lines[edit_line]);
439 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
441 con_backscroll += ((int) scr_conlines >> 4);
442 if (con_backscroll > con_totallines - (vid.conheight>>3) - 1)
443 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
447 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
449 con_backscroll -= ((int) scr_conlines >> 4);
450 if (con_backscroll < 0)
455 if (key == K_HOME || key == K_KP_HOME)
457 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
461 if (key == K_END || key == K_KP_END)
468 if (ascii < 32 || ascii > 126)
471 if (key_linepos < MAX_INPUTLINE-1)
475 if (key_insert) // check insert mode
477 // can't do strcpy to move string to right
478 i = strlen(key_lines[edit_line]) - 1;
483 for (; i >= key_linepos; i--)
484 key_lines[edit_line][i + 1] = key_lines[edit_line][i];
487 // only null terminate if at the end
488 i = key_lines[edit_line][key_linepos];
489 key_lines[edit_line][key_linepos] = ascii;
493 key_lines[edit_line][key_linepos] = 0;
497 //============================================================================
500 char chat_buffer[MAX_INPUTLINE];
501 unsigned int chat_bufferlen = 0;
504 Key_Message (int key, char ascii)
509 Cmd_ForwardStringToServer(va("%s %s", chat_team ? "say_team" : "say ", chat_buffer));
517 if (key == K_ESCAPE) {
524 if (key == K_BACKSPACE) {
525 if (chat_bufferlen) {
527 chat_buffer[chat_bufferlen] = 0;
532 if (chat_bufferlen == sizeof (chat_buffer) - 1)
536 return; // non printable
538 chat_buffer[chat_bufferlen++] = ascii;
539 chat_buffer[chat_bufferlen] = 0;
542 //============================================================================
547 Returns a key number to be used to index keybindings[] by looking at
548 the given string. Single ascii characters return themselves, while
549 the K_* names are matched up.
553 Key_StringToKeynum (const char *str)
560 return tolower(str[0]);
562 for (kn = keynames; kn->name; kn++) {
563 if (!strcasecmp (str, kn->name))
571 Returns a string (either a single ascii char, or a K_* name) for the
573 FIXME: handle quote special (general escape sequence?)
577 Key_KeynumToString (int keynum)
580 static char tinystr[2];
583 return "<KEY NOT FOUND>";
584 if (keynum > 32 && keynum < 127) { // printable ascii
590 for (kn = keynames; kn->name; kn++)
591 if (keynum == kn->keynum)
594 return "<UNKNOWN KEYNUM>";
599 Key_SetBinding (int keynum, int bindmap, const char *binding)
608 if (keybindings[bindmap][keynum]) {
609 Z_Free (keybindings[bindmap][keynum]);
610 keybindings[bindmap][keynum] = NULL;
612 // allocate memory for new binding
613 l = strlen (binding);
614 new = Z_Malloc (l + 1);
615 strcpy (new, binding);
617 keybindings[bindmap][keynum] = new;
621 Key_In_Unbind_f (void)
625 if (Cmd_Argc () != 3) {
626 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
630 m = strtol(Cmd_Argv (1), NULL, 0);
631 if ((m < 0) || (m >= 8)) {
632 Con_Printf("%d isn't a valid bindmap\n", m);
636 b = Key_StringToKeynum (Cmd_Argv (2));
638 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
642 Key_SetBinding (b, m, "");
653 if (c != 3 && c != 4) {
654 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
658 m = strtol(Cmd_Argv (1), NULL, 0);
659 if ((m < 0) || (m >= 8)) {
660 Con_Printf("%d isn't a valid bindmap\n", m);
664 b = Key_StringToKeynum (Cmd_Argv (2));
666 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
671 if (keybindings[m][b])
672 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
674 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
677 // copy the rest of the command line
678 cmd[0] = 0; // start out with a null string
679 for (i = 3; i < c; i++) {
680 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
682 strlcat (cmd, " ", sizeof (cmd));
685 Key_SetBinding (b, m, cmd);
689 Key_In_Bindmap_f (void)
696 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
700 m1 = strtol(Cmd_Argv (1), NULL, 0);
701 if ((m1 < 0) || (m1 >= 8)) {
702 Con_Printf("%d isn't a valid bindmap\n", m1);
706 m2 = strtol(Cmd_Argv (2), NULL, 0);
707 if ((m2 < 0) || (m2 >= 8)) {
708 Con_Printf("%d isn't a valid bindmap\n", m2);
721 if (Cmd_Argc () != 2) {
722 Con_Print("unbind <key> : remove commands from a key\n");
726 b = Key_StringToKeynum (Cmd_Argv (1));
728 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
732 Key_SetBinding (b, 0, "");
736 Key_Unbindall_f (void)
740 for (j = 0; j < 8; j++)
741 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
742 if (keybindings[j][i])
743 Key_SetBinding (i, j, "");
755 if (c != 2 && c != 3) {
756 Con_Print("bind <key> [command] : attach a command to a key\n");
759 b = Key_StringToKeynum (Cmd_Argv (1));
761 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
766 if (keybindings[0][b])
767 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
769 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
772 // copy the rest of the command line
773 cmd[0] = 0; // start out with a null string
774 for (i = 2; i < c; i++) {
775 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
777 strlcat (cmd, " ", sizeof (cmd));
780 Key_SetBinding (b, 0, cmd);
785 Writes lines containing "bind key value"
789 Key_WriteBindings (qfile_t *f)
793 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
794 if (keybindings[0][i])
795 FS_Printf(f, "bind %s \"%s\"\n",
796 Key_KeynumToString (i), keybindings[0][i]);
797 for (j = 1; j < 8; j++)
798 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
799 if (keybindings[j][i])
800 FS_Printf(f, "in_bind %d %s \"%s\"\n",
801 j, Key_KeynumToString (i), keybindings[j][i]);
810 for (i = 0; i < 32; i++) {
811 key_lines[i][0] = ']';
817 // init ascii characters in console mode
819 for (i = 32; i < 128; i++)
820 consolekeys[i] = true;
821 consolekeys[K_ENTER] = true; consolekeys[K_KP_ENTER] = true;
822 consolekeys[K_TAB] = true;
823 consolekeys[K_LEFTARROW] = true; consolekeys[K_KP_LEFTARROW] = true;
824 consolekeys[K_RIGHTARROW] = true; consolekeys[K_KP_RIGHTARROW] = true;
825 consolekeys[K_UPARROW] = true; consolekeys[K_KP_UPARROW] = true;
826 consolekeys[K_DOWNARROW] = true; consolekeys[K_KP_DOWNARROW] = true;
827 consolekeys[K_BACKSPACE] = true;
828 consolekeys[K_DEL] = true; consolekeys[K_KP_DEL] = true;
829 consolekeys[K_INS] = true; consolekeys[K_KP_INS] = true;
830 consolekeys[K_HOME] = true; consolekeys[K_KP_HOME] = true;
831 consolekeys[K_END] = true; consolekeys[K_KP_END] = true;
832 consolekeys[K_PGUP] = true; consolekeys[K_KP_PGUP] = true;
833 consolekeys[K_PGDN] = true; consolekeys[K_KP_PGDN] = true;
834 consolekeys[K_SHIFT] = true;
835 consolekeys[K_MWHEELUP] = true;
836 consolekeys[K_MWHEELDOWN] = true;
837 consolekeys[K_KP_PLUS] = true;
838 consolekeys[K_KP_MINUS] = true;
839 consolekeys[K_KP_DIVIDE] = true;
840 consolekeys[K_KP_MULTIPLY] = true;
841 consolekeys['`'] = false;
842 consolekeys['~'] = false;
844 menubound[K_ESCAPE] = true;
845 for (i = 0; i < 12; i++)
846 menubound[K_F1 + i] = true;
849 // register our functions
851 Cmd_AddCommand ("in_bind", Key_In_Bind_f);
852 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f);
853 Cmd_AddCommand ("in_bindmap", Key_In_Bindmap_f);
855 Cmd_AddCommand ("bind", Key_Bind_f);
856 Cmd_AddCommand ("unbind", Key_Unbind_f);
857 Cmd_AddCommand ("unbindall", Key_Unbindall_f);
863 Called by the system between frames for both key up and key down events
864 Should NOT be called during an interrupt!
868 Key_Event (int key, char ascii, qboolean down)
876 key_repeats[key] = 0;
880 if (key_count <= 0) {
881 return; // just catching keys for Con_NotifyBox
884 // update auto-repeat status
887 if (key_repeats[key] > 1) {
888 if ((key_consoleactive && !consolekeys[key]) ||
889 (!key_consoleactive && key_dest == key_game &&
890 (cls.state == ca_connected && cls.signon == SIGNONS)))
891 return; // ignore most autorepeats
899 // handle escape specially, so the user can never unbind it
901 if (key == K_ESCAPE) {
906 Key_Message (key, ascii);
909 MR_Keydown (key, ascii);
915 if(UI_Callback_IsSlotUsed(key_dest - 3))
916 UI_Callback_KeyDown (key, ascii);
918 Sys_Error ("Bad key_dest");
923 // console key is hardcoded, so the user can never unbind it
924 if (key == '`' || key == '~')
927 Con_ToggleConsole_f ();
933 if (!(kb = keybindings[key_bmap][key]))
934 kb = keybindings[key_bmap2][key];
935 if (kb && !strncmp(kb, "toggleconsole", strlen("toggleconsole")))
943 if (key_consoleactive && consolekeys[key] && down)
944 Key_Console (key, ascii);
948 // key up events only generate commands if the game key binding is a button
949 // command (leading + sign). These will occur even in console mode, to
950 // keep the character from continuing an action started before a console
951 // switch. Button commands include the kenum as a parameter, so multiple
952 // downs can be matched with ups
955 if (!(kb = keybindings[key_bmap][key]))
956 kb = keybindings[key_bmap2][key];
958 if (kb && kb[0] == '+') {
959 snprintf (cmd, sizeof(cmd), "-%s %i\n", kb + 1, key);
966 // during demo playback, most keys bring up the main menu
968 if (cls.demoplayback && down && consolekeys[key] && key_dest == key_game) {
974 // if not a consolekey, send to the interpreter no matter what mode is
976 if ((key_dest == key_menu && menubound[key])
977 || (key_consoleactive && !consolekeys[key])
978 || (key_dest == key_game &&
979 ((cls.state == ca_connected) || !consolekeys[key]))) {
980 if (!(kb = keybindings[key_bmap][key]))
981 kb = keybindings[key_bmap2][key];
983 if (kb[0] == '+') { // button commands add keynum as a parm
984 snprintf (cmd, sizeof(cmd), "%s %i\n", kb, key);
995 return; // other systems only care about key
1000 Key_Message (key, ascii);
1003 MR_Keydown (key, ascii);
1007 Key_Console (key, ascii);
1010 if(UI_Callback_IsSlotUsed(key_dest - 3))
1011 UI_Callback_KeyDown (key, ascii);
1013 Sys_Error ("Bad key_dest");
1024 Key_ClearStates (void)
1028 for (i = 0; i < (int)(sizeof(keydown)/sizeof(keydown[0])); i++)