2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to:
18 Free Software Foundation, Inc.
19 59 Temple Place - Suite 330
20 Boston, MA 02111-1307, USA
26 cvar_t con_closeontoggleconsole = {CVAR_SAVE, "con_closeontoggleconsole","1", "allows toggleconsole binds to close the console as well"};
29 key up events are sent even if in console mode
32 int edit_line = MAX_INPUTLINES-1;
33 int history_line = MAX_INPUTLINES-1;
34 char key_lines[MAX_INPUTLINES][MAX_INPUTLINE];
36 qboolean key_insert = true; // insert key toggle (for editing)
38 int key_consoleactive;
39 char *keybindings[MAX_BINDMAPS][MAX_KEYS];
41 static int key_bmap, key_bmap2;
42 static unsigned char keydown[MAX_KEYS]; // 0 = up, 1 = down, 2 = repeating
44 typedef struct keyname_s
51 static const keyname_t keynames[] = {
57 // spacer so it lines up with keys.h
59 {"BACKSPACE", K_BACKSPACE},
60 {"UPARROW", K_UPARROW},
61 {"DOWNARROW", K_DOWNARROW},
62 {"LEFTARROW", K_LEFTARROW},
63 {"RIGHTARROW", K_RIGHTARROW},
91 {"NUMLOCK", K_NUMLOCK},
92 {"CAPSLOCK", K_CAPSLOCK},
93 {"SCROLLOCK", K_SCROLLOCK},
95 {"KP_INS", K_KP_INS },
97 {"KP_END", K_KP_END },
99 {"KP_DOWNARROW", K_KP_DOWNARROW },
101 {"KP_PGDN", K_KP_PGDN },
103 {"KP_LEFTARROW", K_KP_LEFTARROW },
106 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
108 {"KP_HOME", K_KP_HOME },
110 {"KP_UPARROW", K_KP_UPARROW },
112 {"KP_PGUP", K_KP_PGUP },
114 {"KP_DEL", K_KP_DEL },
115 {"KP_PERIOD", K_KP_PERIOD},
116 {"KP_SLASH", K_KP_SLASH },
117 {"KP_DIVIDE", K_KP_DIVIDE},
118 {"KP_MULTIPLY", K_KP_MULTIPLY},
119 {"KP_MINUS", K_KP_MINUS},
120 {"KP_PLUS", K_KP_PLUS},
121 {"KP_ENTER", K_KP_ENTER},
122 {"KP_EQUALS", K_KP_EQUALS},
126 {"MOUSE1", K_MOUSE1},
128 {"MOUSE2", K_MOUSE2},
129 {"MOUSE3", K_MOUSE3},
130 {"MWHEELUP", K_MWHEELUP},
131 {"MWHEELDOWN", K_MWHEELDOWN},
132 {"MOUSE4", K_MOUSE4},
133 {"MOUSE5", K_MOUSE5},
134 {"MOUSE6", K_MOUSE6},
135 {"MOUSE7", K_MOUSE7},
136 {"MOUSE8", K_MOUSE8},
137 {"MOUSE9", K_MOUSE9},
138 {"MOUSE10", K_MOUSE10},
139 {"MOUSE11", K_MOUSE11},
140 {"MOUSE12", K_MOUSE12},
141 {"MOUSE13", K_MOUSE13},
142 {"MOUSE14", K_MOUSE14},
143 {"MOUSE15", K_MOUSE15},
144 {"MOUSE16", K_MOUSE16},
204 {"SEMICOLON", ';'}, // because a raw semicolon separates commands
208 {"APOSTROPHE", '\''},
209 {"BACKSLASH", '\\'}, // because a raw backslash is used for special characters
215 ==============================================================================
217 LINE TYPING INTO THE CONSOLE
219 ==============================================================================
223 Key_ClearEditLine (int edit_line)
225 memset (key_lines[edit_line], '\0', sizeof(key_lines[edit_line]));
226 key_lines[edit_line][0] = ']';
232 Interactive line editing and console scrollback
236 Key_Console (int key, char ascii)
238 // LordHavoc: copied most of this from Q2 to improve keyboard handling
265 case K_KP_RIGHTARROW:
285 if ((toupper(key) == 'V' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
288 if ((cbd = Sys_GetClipboardData()) != 0)
295 if (*p == '\n' || *p == '\r' || *p == '\b')
303 strtok(cbd, "\n\r\b");
305 i = (int)strlen(cbd);
306 if (i + key_linepos >= MAX_INPUTLINE)
307 i= MAX_INPUTLINE - key_linepos;
311 strlcat(key_lines[edit_line], cbd, sizeof(key_lines[edit_line]));
323 Cbuf_AddText ("clear\n");
328 if (key == K_ENTER || key == K_KP_ENTER)
330 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
332 Con_Printf("%s\n",key_lines[edit_line]);
333 if(key_lines[edit_line][1] == 0) // empty line (just a ])?
334 return; // no, no, you can't submit empty lines to the history...
335 // LordHavoc: redesigned edit_line/history_line
337 history_line = edit_line;
338 memmove(key_lines[0], key_lines[1], sizeof(key_lines[0]) * edit_line);
339 key_lines[edit_line][0] = ']';
340 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
342 // force an update, because the command may take some time
343 if (cls.state == ca_disconnected)
350 // Enhanced command completion
351 // by EvilTypeGuy eviltypeguy@qeradiant.com
352 // Thanks to Fett, Taniwha
353 Con_CompleteCommandLine();
357 // Advanced Console Editing by Radix radix@planetquake.com
358 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
361 // left arrow will just move left one without erasing, backspace will
362 // actually erase character
363 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
375 k = key_lines[edit_line][pos];
376 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
379 key_linepos = pos + 1;
386 // delete char before cursor
387 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
391 strlcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos, sizeof(key_lines[edit_line]) + 1 - key_linepos);
397 // delete char on cursor
398 if (key == K_DEL || key == K_KP_DEL)
401 linelen = strlen(key_lines[edit_line]);
402 if (key_linepos < (int)linelen)
403 memmove(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1, linelen - key_linepos);
408 // if we're at the end, get one character from previous line,
409 // otherwise just go right one
410 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
412 if (key_linepos >= (int)strlen(key_lines[edit_line]))
418 len = (int)strlen(key_lines[edit_line]);
422 k = key_lines[edit_line][pos];
423 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
433 if (key == K_INS || key == K_KP_INS) // toggle insert mode
439 // End Advanced Console Editing
441 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
443 if (history_line > 0 && key_lines[history_line-1][1])
447 linelen = strlen(key_lines[history_line]);
448 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
449 key_linepos = (int)linelen;
454 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
457 if (history_line >= edit_line)
459 history_line = edit_line;
460 key_lines[edit_line][0] = ']';
461 key_lines[edit_line][1] = 0;
467 linelen = strlen(key_lines[history_line]);
468 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
469 key_linepos = (int)linelen;
474 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
476 con_backscroll += ((int) vid_conheight.integer >> 5);
480 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
482 con_backscroll -= ((int) vid_conheight.integer >> 5);
486 if (key == K_HOME || key == K_KP_HOME)
489 con_backscroll = INT_MAX;
495 if (key == K_END || key == K_KP_END)
500 key_linepos = (int)strlen(key_lines[edit_line]);
508 if (key_linepos < MAX_INPUTLINE-1)
511 len = (int)strlen(&key_lines[edit_line][key_linepos]);
512 // check insert mode, or always insert if at end of line
513 if (key_insert || len == 0)
515 // can't use strcpy to move string to right
517 memmove(&key_lines[edit_line][key_linepos + 1], &key_lines[edit_line][key_linepos], len);
519 key_lines[edit_line][key_linepos] = ascii;
524 //============================================================================
527 char chat_buffer[MAX_INPUTLINE];
528 unsigned int chat_bufferlen = 0;
530 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
533 Key_Message (int key, char ascii)
536 if (key == K_ENTER || ascii == 10 || ascii == 13)
538 Cmd_ForwardStringToServer(va("%s %s", chat_team ? "say_team" : "say ", chat_buffer));
546 if (key == K_ESCAPE) {
553 if (key == K_BACKSPACE) {
554 if (chat_bufferlen) {
556 chat_buffer[chat_bufferlen] = 0;
562 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
566 if (chat_bufferlen == sizeof (chat_buffer) - 1)
570 return; // non printable
572 chat_buffer[chat_bufferlen++] = ascii;
573 chat_buffer[chat_bufferlen] = 0;
576 //============================================================================
581 Returns a key number to be used to index keybindings[] by looking at
582 the given string. Single ascii characters return themselves, while
583 the K_* names are matched up.
587 Key_StringToKeynum (const char *str)
594 return tolower(str[0]);
596 for (kn = keynames; kn->name; kn++) {
597 if (!strcasecmp (str, kn->name))
605 Returns a string (either a single ascii char, or a K_* name) for the
607 FIXME: handle quote special (general escape sequence?)
611 Key_KeynumToString (int keynum)
614 static char tinystr[2];
616 // -1 is an invalid code
618 return "<KEY NOT FOUND>";
620 // search overrides first, because some characters are special
621 for (kn = keynames; kn->name; kn++)
622 if (keynum == kn->keynum)
625 // if it is printable, output it as a single character
626 if (keynum > 32 && keynum < 256)
633 // if it is not overridden and not printable, we don't know what to do with it
634 return "<UNKNOWN KEYNUM>";
639 Key_SetBinding (int keynum, int bindmap, const char *binding)
644 if (keynum == -1 || keynum >= MAX_KEYS)
648 if (keybindings[bindmap][keynum]) {
649 Z_Free (keybindings[bindmap][keynum]);
650 keybindings[bindmap][keynum] = NULL;
652 if(!binding[0]) // make "" binds be removed --blub
654 // allocate memory for new binding
655 l = strlen (binding);
656 newbinding = (char *)Z_Malloc (l + 1);
657 memcpy (newbinding, binding, l + 1);
659 keybindings[bindmap][keynum] = newbinding;
663 Key_In_Unbind_f (void)
667 if (Cmd_Argc () != 3) {
668 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
672 m = strtol(Cmd_Argv (1), NULL, 0);
673 if ((m < 0) || (m >= 8)) {
674 Con_Printf("%d isn't a valid bindmap\n", m);
678 b = Key_StringToKeynum (Cmd_Argv (2));
680 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
684 Key_SetBinding (b, m, "");
691 char cmd[MAX_INPUTLINE];
695 if (c != 3 && c != 4) {
696 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
700 m = strtol(Cmd_Argv (1), NULL, 0);
701 if ((m < 0) || (m >= 8)) {
702 Con_Printf("%d isn't a valid bindmap\n", m);
706 b = Key_StringToKeynum (Cmd_Argv (2));
707 if (b == -1 || b >= MAX_KEYS) {
708 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
713 if (keybindings[m][b])
714 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
716 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
719 // copy the rest of the command line
720 cmd[0] = 0; // start out with a null string
721 for (i = 3; i < c; i++) {
722 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
724 strlcat (cmd, " ", sizeof (cmd));
727 Key_SetBinding (b, m, cmd);
731 Key_In_Bindmap_f (void)
738 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
742 m1 = strtol(Cmd_Argv (1), NULL, 0);
743 if ((m1 < 0) || (m1 >= 8)) {
744 Con_Printf("%d isn't a valid bindmap\n", m1);
748 m2 = strtol(Cmd_Argv (2), NULL, 0);
749 if ((m2 < 0) || (m2 >= 8)) {
750 Con_Printf("%d isn't a valid bindmap\n", m2);
763 if (Cmd_Argc () != 2) {
764 Con_Print("unbind <key> : remove commands from a key\n");
768 b = Key_StringToKeynum (Cmd_Argv (1));
770 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
774 Key_SetBinding (b, 0, "");
778 Key_Unbindall_f (void)
782 for (j = 0; j < 8; j++)
783 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
784 if (keybindings[j][i])
785 Key_SetBinding (i, j, "");
793 char cmd[MAX_INPUTLINE];
797 if (c != 2 && c != 3) {
798 Con_Print("bind <key> [command] : attach a command to a key\n");
801 b = Key_StringToKeynum (Cmd_Argv (1));
802 if (b == -1 || b >= MAX_KEYS) {
803 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
808 if (keybindings[0][b])
809 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
811 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
814 // copy the rest of the command line
815 cmd[0] = 0; // start out with a null string
816 for (i = 2; i < c; i++) {
817 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
819 strlcat (cmd, " ", sizeof (cmd));
822 Key_SetBinding (b, 0, cmd);
827 Writes lines containing "bind key value"
831 Key_WriteBindings (qfile_t *f)
834 char bindbuf[MAX_INPUTLINE];
837 for (j = 0; j < MAX_BINDMAPS; j++)
839 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
841 p = keybindings[j][i];
844 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
846 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
848 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
860 for (i = 0; i < 32; i++) {
861 key_lines[i][0] = ']';
867 // register our functions
869 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
870 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
871 Cmd_AddCommand ("in_bindmap", Key_In_Bindmap_f, "selects active foreground and background (used only if a key is not bound in the foreground) bindmaps for typing");
873 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
874 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
875 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
877 Cvar_RegisterVariable (&con_closeontoggleconsole);
880 const char *Key_GetBind (int key)
883 if (key < 0 || key >= MAX_KEYS)
885 bind = keybindings[key_bmap][key];
887 bind = keybindings[key_bmap2][key];
891 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
895 Called by the system between frames for both key up and key down events
896 Should NOT be called during an interrupt!
899 static char tbl_keyascii[MAX_KEYS];
900 static keydest_t tbl_keydest[MAX_KEYS];
903 Key_Event (int key, char ascii, qboolean down)
907 keydest_t keydest = key_dest;
909 if (key < 0 || key >= MAX_KEYS)
913 bind = keybindings[key_bmap][key];
915 bind = keybindings[key_bmap2][key];
917 if (developer.integer >= 1000)
918 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
920 if(key_consoleactive)
921 keydest = key_console;
925 // increment key repeat count each time a down is received so that things
926 // which want to ignore key repeat can ignore it
927 keydown[key] = min(keydown[key] + 1, 2);
928 if(keydown[key] == 1) {
929 tbl_keyascii[key] = ascii;
930 tbl_keydest[key] = keydest;
932 ascii = tbl_keyascii[key];
933 keydest = tbl_keydest[key];
938 // clear repeat count now that the key is released
940 keydest = tbl_keydest[key];
941 ascii = tbl_keyascii[key];
944 if(keydest == key_void)
947 // key_consoleactive is a flag not a key_dest because the console is a
948 // high priority overlay ontop of the normal screen (designed as a safety
949 // feature so that developers and users can rescue themselves from a bad
952 // this also means that toggling the console on/off does not lose the old
955 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
956 // engine bindings, these are not handled as normal binds so that the user
957 // can recover from a completely empty bindmap
960 // ignore key repeats on escape
961 if (keydown[key] > 1)
964 // escape does these things:
965 // key_consoleactive - close console
966 // key_message - abort messagemode
967 // key_menu - go to parent menu (or key_game)
968 // key_game - open menu
970 // in all modes shift-escape toggles console
971 if (keydown[K_SHIFT])
975 Con_ToggleConsole_f ();
976 tbl_keydest[key] = key_void; // esc release should go nowhere (especially not to key_menu or key_game)
986 if(key_consoleactive & KEY_CONSOLEACTIVE_FORCED)
988 key_consoleactive &= ~KEY_CONSOLEACTIVE_USER;
992 Con_ToggleConsole_f();
998 Key_Message (key, ascii); // that'll close the message input
1002 case key_menu_grabbed:
1003 MR_KeyEvent (key, ascii, down);
1007 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
1008 q = CL_VM_InputEvent(down, key, ascii);
1014 Con_Printf ("Key_Event: Bad key_dest\n");
1019 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
1020 if (keydest != key_menu_grabbed)
1021 if (key >= K_F1 && key <= K_F12)
1025 if(keydown[key] == 1 && down)
1027 // button commands add keynum as a parm
1029 Cbuf_AddText (va("%s %i\n", bind, key));
1032 Cbuf_AddText (bind);
1033 Cbuf_AddText ("\n");
1035 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1036 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1041 // send input to console if it wants it
1042 if (keydest == key_console)
1046 // con_closeontoggleconsole enables toggleconsole keys to close the
1047 // console, as long as they are not the color prefix character
1048 // (special exemption for german keyboard layouts)
1049 if (con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && (key_consoleactive & KEY_CONSOLEACTIVE_USER) && ascii != STRING_COLOR_TAG)
1051 Con_ToggleConsole_f ();
1054 Key_Console (key, ascii);
1059 // ignore binds while a video is played, let the video system handle the key event
1060 if (cl_videoplaying)
1062 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1066 // anything else is a key press into the game, chat line, or menu
1071 Key_Message (key, ascii);
1074 case key_menu_grabbed:
1075 MR_KeyEvent (key, ascii, down);
1078 q = CL_VM_InputEvent(down, key, ascii);
1079 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1082 if(keydown[key] == 1 && down)
1084 // button commands add keynum as a parm
1086 Cbuf_AddText (va("%s %i\n", bind, key));
1089 Cbuf_AddText (bind);
1090 Cbuf_AddText ("\n");
1092 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1093 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1097 Con_Printf ("Key_Event: Bad key_dest\n");
1107 Key_ClearStates (void)
1109 memset(keydown, 0, sizeof(keydown));