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)
294 if (*cbd == '\n' || *cbd == '\r' || *cbd == '\b')
302 strtok(cbd, "\n\r\b");
304 i = (int)strlen(cbd);
305 if (i + key_linepos >= MAX_INPUTLINE)
306 i= MAX_INPUTLINE - key_linepos;
310 strlcat(key_lines[edit_line], cbd, sizeof(key_lines[edit_line]));
322 Cbuf_AddText ("clear\n");
327 if (key == K_ENTER || key == K_KP_ENTER)
329 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
331 Con_Printf("%s\n",key_lines[edit_line]);
332 if(key_lines[edit_line][1] == 0) // empty line (just a ])?
333 return; // no, no, you can't submit empty lines to the history...
334 // LordHavoc: redesigned edit_line/history_line
336 history_line = edit_line;
337 memmove(key_lines[0], key_lines[1], sizeof(key_lines[0]) * edit_line);
338 key_lines[edit_line][0] = ']';
339 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
341 // force an update, because the command may take some time
342 if (cls.state == ca_disconnected)
349 // Enhanced command completion
350 // by EvilTypeGuy eviltypeguy@qeradiant.com
351 // Thanks to Fett, Taniwha
352 Con_CompleteCommandLine();
356 // Advanced Console Editing by Radix radix@planetquake.com
357 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
360 // left arrow will just move left one without erasing, backspace will
361 // actually erase character
362 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
374 k = key_lines[edit_line][pos];
375 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
378 key_linepos = pos + 1;
385 // delete char before cursor
386 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
390 strlcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos, sizeof(key_lines[edit_line]) + 1 - key_linepos);
396 // delete char on cursor
397 if (key == K_DEL || key == K_KP_DEL)
400 linelen = strlen(key_lines[edit_line]);
401 if (key_linepos < (int)linelen)
402 memmove(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1, linelen - key_linepos);
407 // if we're at the end, get one character from previous line,
408 // otherwise just go right one
409 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
411 if (key_linepos >= (int)strlen(key_lines[edit_line]))
417 len = (int)strlen(key_lines[edit_line]);
421 k = key_lines[edit_line][pos];
422 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
432 if (key == K_INS || key == K_KP_INS) // toggle insert mode
438 // End Advanced Console Editing
440 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
442 if (history_line > 0 && key_lines[history_line-1][1])
446 linelen = strlen(key_lines[history_line]);
447 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
448 key_linepos = (int)linelen;
453 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
456 if (history_line >= edit_line)
458 history_line = edit_line;
459 key_lines[edit_line][0] = ']';
460 key_lines[edit_line][1] = 0;
466 linelen = strlen(key_lines[history_line]);
467 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
468 key_linepos = (int)linelen;
473 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
475 con_backscroll += ((int) vid_conheight.integer >> 5);
479 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
481 con_backscroll -= ((int) vid_conheight.integer >> 5);
485 if (key == K_HOME || key == K_KP_HOME)
488 con_backscroll = INT_MAX;
494 if (key == K_END || key == K_KP_END)
499 key_linepos = (int)strlen(key_lines[edit_line]);
507 if (key_linepos < MAX_INPUTLINE-1)
510 len = (int)strlen(&key_lines[edit_line][key_linepos]);
511 // check insert mode, or always insert if at end of line
512 if (key_insert || len == 0)
514 // can't use strcpy to move string to right
516 memmove(&key_lines[edit_line][key_linepos + 1], &key_lines[edit_line][key_linepos], len);
518 key_lines[edit_line][key_linepos] = ascii;
523 //============================================================================
526 char chat_buffer[MAX_INPUTLINE];
527 unsigned int chat_bufferlen = 0;
529 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
532 Key_Message (int key, char ascii)
535 if (key == K_ENTER || ascii == 10 || ascii == 13)
537 Cmd_ForwardStringToServer(va("%s %s", chat_team ? "say_team" : "say ", chat_buffer));
545 if (key == K_ESCAPE) {
552 if (key == K_BACKSPACE) {
553 if (chat_bufferlen) {
555 chat_buffer[chat_bufferlen] = 0;
561 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
565 if (chat_bufferlen == sizeof (chat_buffer) - 1)
569 return; // non printable
571 chat_buffer[chat_bufferlen++] = ascii;
572 chat_buffer[chat_bufferlen] = 0;
575 //============================================================================
580 Returns a key number to be used to index keybindings[] by looking at
581 the given string. Single ascii characters return themselves, while
582 the K_* names are matched up.
586 Key_StringToKeynum (const char *str)
593 return tolower(str[0]);
595 for (kn = keynames; kn->name; kn++) {
596 if (!strcasecmp (str, kn->name))
604 Returns a string (either a single ascii char, or a K_* name) for the
606 FIXME: handle quote special (general escape sequence?)
610 Key_KeynumToString (int keynum)
613 static char tinystr[2];
615 // -1 is an invalid code
617 return "<KEY NOT FOUND>";
619 // search overrides first, because some characters are special
620 for (kn = keynames; kn->name; kn++)
621 if (keynum == kn->keynum)
624 // if it is printable, output it as a single character
625 if (keynum > 32 && keynum < 256)
632 // if it is not overridden and not printable, we don't know what to do with it
633 return "<UNKNOWN KEYNUM>";
638 Key_SetBinding (int keynum, int bindmap, const char *binding)
643 if (keynum == -1 || keynum >= MAX_KEYS)
647 if (keybindings[bindmap][keynum]) {
648 Z_Free (keybindings[bindmap][keynum]);
649 keybindings[bindmap][keynum] = NULL;
651 if(!binding[0]) // make "" binds be removed --blub
653 // allocate memory for new binding
654 l = strlen (binding);
655 newbinding = (char *)Z_Malloc (l + 1);
656 memcpy (newbinding, binding, l + 1);
658 keybindings[bindmap][keynum] = newbinding;
662 Key_In_Unbind_f (void)
666 if (Cmd_Argc () != 3) {
667 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
671 m = strtol(Cmd_Argv (1), NULL, 0);
672 if ((m < 0) || (m >= 8)) {
673 Con_Printf("%d isn't a valid bindmap\n", m);
677 b = Key_StringToKeynum (Cmd_Argv (2));
679 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
683 Key_SetBinding (b, m, "");
690 char cmd[MAX_INPUTLINE];
694 if (c != 3 && c != 4) {
695 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
699 m = strtol(Cmd_Argv (1), NULL, 0);
700 if ((m < 0) || (m >= 8)) {
701 Con_Printf("%d isn't a valid bindmap\n", m);
705 b = Key_StringToKeynum (Cmd_Argv (2));
706 if (b == -1 || b >= MAX_KEYS) {
707 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
712 if (keybindings[m][b])
713 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
715 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
718 // copy the rest of the command line
719 cmd[0] = 0; // start out with a null string
720 for (i = 3; i < c; i++) {
721 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
723 strlcat (cmd, " ", sizeof (cmd));
726 Key_SetBinding (b, m, cmd);
730 Key_In_Bindmap_f (void)
737 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
741 m1 = strtol(Cmd_Argv (1), NULL, 0);
742 if ((m1 < 0) || (m1 >= 8)) {
743 Con_Printf("%d isn't a valid bindmap\n", m1);
747 m2 = strtol(Cmd_Argv (2), NULL, 0);
748 if ((m2 < 0) || (m2 >= 8)) {
749 Con_Printf("%d isn't a valid bindmap\n", m2);
762 if (Cmd_Argc () != 2) {
763 Con_Print("unbind <key> : remove commands from a key\n");
767 b = Key_StringToKeynum (Cmd_Argv (1));
769 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
773 Key_SetBinding (b, 0, "");
777 Key_Unbindall_f (void)
781 for (j = 0; j < 8; j++)
782 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
783 if (keybindings[j][i])
784 Key_SetBinding (i, j, "");
792 char cmd[MAX_INPUTLINE];
796 if (c != 2 && c != 3) {
797 Con_Print("bind <key> [command] : attach a command to a key\n");
800 b = Key_StringToKeynum (Cmd_Argv (1));
801 if (b == -1 || b >= MAX_KEYS) {
802 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
807 if (keybindings[0][b])
808 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
810 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
813 // copy the rest of the command line
814 cmd[0] = 0; // start out with a null string
815 for (i = 2; i < c; i++) {
816 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
818 strlcat (cmd, " ", sizeof (cmd));
821 Key_SetBinding (b, 0, cmd);
826 Writes lines containing "bind key value"
830 Key_WriteBindings (qfile_t *f)
833 char bindbuf[MAX_INPUTLINE];
836 for (j = 0; j < MAX_BINDMAPS; j++)
838 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
840 p = keybindings[j][i];
843 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
845 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
847 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
859 for (i = 0; i < 32; i++) {
860 key_lines[i][0] = ']';
866 // register our functions
868 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
869 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
870 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");
872 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
873 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
874 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
876 Cvar_RegisterVariable (&con_closeontoggleconsole);
879 const char *Key_GetBind (int key)
882 if (key < 0 || key >= MAX_KEYS)
884 bind = keybindings[key_bmap][key];
886 bind = keybindings[key_bmap2][key];
890 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
894 Called by the system between frames for both key up and key down events
895 Should NOT be called during an interrupt!
899 Key_Event (int key, char ascii, qboolean down)
904 if (key < 0 || key >= MAX_KEYS)
908 bind = keybindings[key_bmap][key];
910 bind = keybindings[key_bmap2][key];
912 if (developer.integer >= 1000)
913 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
916 if(key_dest == key_game)
918 q = CL_VM_InputEvent(down, key);
922 keydown[key] = min(keydown[key] + 1, 2);
932 // increment key repeat count each time a down is received so that things
933 // which want to ignore key repeat can ignore it
934 keydown[key] = min(keydown[key] + 1, 2);
938 // clear repeat count now that the key is released
942 // key_consoleactive is a flag not a key_dest because the console is a
943 // high priority overlay ontop of the normal screen (designed as a safety
944 // feature so that developers and users can rescue themselves from a bad
947 // this also means that toggling the console on/off does not lose the old
950 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
951 // engine bindings, these are not handled as normal binds so that the user
952 // can recover from a completely empty bindmap
955 // ignore key repeats on escape
956 if (keydown[key] > 1)
958 // escape does these things:
959 // key_consoleactive - close console
960 // key_message - abort messagemode
961 // key_menu - go to parent menu (or key_game)
962 // key_game - open menu
963 // in all modes shift-escape toggles console
964 if (((key_consoleactive & KEY_CONSOLEACTIVE_USER) || keydown[K_SHIFT]) && down)
966 Con_ToggleConsole_f ();
973 Key_Message (key, ascii);
976 case key_menu_grabbed:
977 MR_KeyEvent (key, ascii, down);
980 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
981 q = CL_VM_InputEvent(down, key, ascii);
986 Con_Printf ("Key_Event: Bad key_dest\n");
991 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
992 if (key_dest != key_menu_grabbed)
993 if (key >= K_F1 && key <= K_F12 && down)
995 // ignore key repeats on F1-F12 binds
996 if (keydown[key] > 1)
1000 // button commands add keynum as a parm
1002 Cbuf_AddText (va("%s %i\n", bind, key));
1005 Cbuf_AddText (bind);
1006 Cbuf_AddText ("\n");
1013 // ignore binds (other than the above escape/F1-F12 keys) while in console
1014 if (key_consoleactive && down)
1016 // respond to toggleconsole binds while in console unless the pressed key
1017 // happens to be the color prefix character (such as on German keyboards)
1018 if (key_consoleactive && down && (!con_closeontoggleconsole.integer || !bind || strncmp(bind, "toggleconsole", strlen("toggleconsole")) || ascii == STRING_COLOR_TAG))
1021 Key_Console (key, ascii);
1026 // FIXME: actually the up-bind should only be called if the button was actually pressed while key_dest == key_game [12/17/2007 Black]
1027 // especially CL_VM_InputEvent should be able to prevent it from being called (to intercept the binds)
1028 // key up events only generate commands if the game key binding is a button
1029 // command (leading + sign). These will occur even in console mode, to
1030 // keep the character from continuing an action started before a console
1031 // switch. Button commands include the kenum as a parameter, so multiple
1032 // downs can be matched with ups
1033 if (!down && bind && bind[0] == '+')
1034 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1036 // ignore binds while a video is played, let the video system handle the key event
1037 if (cl_videoplaying)
1039 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1043 // anything else is a key press into the game, chat line, or menu
1048 Key_Message (key, ascii);
1051 case key_menu_grabbed:
1052 MR_KeyEvent (key, ascii, down);
1055 q = CL_VM_InputEvent(down, key, ascii);
1056 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1057 if (!q && bind && keydown[key] == 1 && down)
1059 // button commands add keynum as a parm
1061 Cbuf_AddText (va("%s %i\n", bind, key));
1064 Cbuf_AddText (bind);
1065 Cbuf_AddText ("\n");
1070 Con_Printf ("Key_Event: Bad key_dest\n");
1080 Key_ClearStates (void)
1082 memset(keydown, 0, sizeof(keydown));