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)
291 strtok(cbd, "\n\r\b");
292 i = (int)strlen(cbd);
293 if (i + key_linepos >= MAX_INPUTLINE)
294 i= MAX_INPUTLINE - key_linepos;
298 strlcat(key_lines[edit_line], cbd, sizeof(key_lines[edit_line]));
310 Cbuf_AddText ("clear\n");
315 if (key == K_ENTER || key == K_KP_ENTER)
317 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
319 Con_Printf("%s\n",key_lines[edit_line]);
320 if(key_lines[edit_line][1] == 0) // empty line (just a ])?
321 return; // no, no, you can't submit empty lines to the history...
322 // LordHavoc: redesigned edit_line/history_line
324 history_line = edit_line;
325 memmove(key_lines[0], key_lines[1], sizeof(key_lines[0]) * edit_line);
326 key_lines[edit_line][0] = ']';
327 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
329 // force an update, because the command may take some time
330 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
348 // left arrow will just move left one without erasing, backspace will
349 // actually erase character
350 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
362 k = key_lines[edit_line][pos];
363 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
366 key_linepos = pos + 1;
373 // delete char before cursor
374 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
378 strlcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos, sizeof(key_lines[edit_line]) + 1 - key_linepos);
384 // delete char on cursor
385 if (key == K_DEL || key == K_KP_DEL)
388 linelen = strlen(key_lines[edit_line]);
389 if (key_linepos < (int)linelen)
390 memmove(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1, linelen - key_linepos);
395 // if we're at the end, get one character from previous line,
396 // otherwise just go right one
397 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
399 if (key_linepos >= (int)strlen(key_lines[edit_line]))
405 len = (int)strlen(key_lines[edit_line]);
409 k = key_lines[edit_line][pos];
410 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
420 if (key == K_INS || key == K_KP_INS) // toggle insert mode
426 // End Advanced Console Editing
428 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
430 if (history_line > 0 && key_lines[history_line-1][1])
434 linelen = strlen(key_lines[history_line]);
435 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
436 key_linepos = (int)linelen;
441 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
444 if (history_line >= edit_line)
446 history_line = edit_line;
447 key_lines[edit_line][0] = ']';
448 key_lines[edit_line][1] = 0;
454 linelen = strlen(key_lines[history_line]);
455 memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
456 key_linepos = (int)linelen;
461 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
463 con_backscroll += ((int) vid_conheight.integer >> 5);
467 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
469 con_backscroll -= ((int) vid_conheight.integer >> 5);
473 if (key == K_HOME || key == K_KP_HOME)
476 con_backscroll = INT_MAX;
482 if (key == K_END || key == K_KP_END)
487 key_linepos = (int)strlen(key_lines[edit_line]);
495 if (key_linepos < MAX_INPUTLINE-1)
498 len = (int)strlen(&key_lines[edit_line][key_linepos]);
499 // check insert mode, or always insert if at end of line
500 if (key_insert || len == 0)
502 // can't use strcpy to move string to right
504 memmove(&key_lines[edit_line][key_linepos + 1], &key_lines[edit_line][key_linepos], len);
506 key_lines[edit_line][key_linepos] = ascii;
511 //============================================================================
514 char chat_buffer[MAX_INPUTLINE];
515 unsigned int chat_bufferlen = 0;
517 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
520 Key_Message (int key, char ascii)
523 if (key == K_ENTER || ascii == 10 || ascii == 13)
525 Cmd_ForwardStringToServer(va("%s %s", chat_team ? "say_team" : "say ", chat_buffer));
533 if (key == K_ESCAPE) {
540 if (key == K_BACKSPACE) {
541 if (chat_bufferlen) {
543 chat_buffer[chat_bufferlen] = 0;
549 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
553 if (chat_bufferlen == sizeof (chat_buffer) - 1)
557 return; // non printable
559 chat_buffer[chat_bufferlen++] = ascii;
560 chat_buffer[chat_bufferlen] = 0;
563 //============================================================================
568 Returns a key number to be used to index keybindings[] by looking at
569 the given string. Single ascii characters return themselves, while
570 the K_* names are matched up.
574 Key_StringToKeynum (const char *str)
581 return tolower(str[0]);
583 for (kn = keynames; kn->name; kn++) {
584 if (!strcasecmp (str, kn->name))
592 Returns a string (either a single ascii char, or a K_* name) for the
594 FIXME: handle quote special (general escape sequence?)
598 Key_KeynumToString (int keynum)
601 static char tinystr[2];
603 // -1 is an invalid code
605 return "<KEY NOT FOUND>";
607 // search overrides first, because some characters are special
608 for (kn = keynames; kn->name; kn++)
609 if (keynum == kn->keynum)
612 // if it is printable, output it as a single character
613 if (keynum > 32 && keynum < 256)
620 // if it is not overridden and not printable, we don't know what to do with it
621 return "<UNKNOWN KEYNUM>";
626 Key_SetBinding (int keynum, int bindmap, const char *binding)
631 if (keynum == -1 || keynum >= MAX_KEYS)
635 if (keybindings[bindmap][keynum]) {
636 Z_Free (keybindings[bindmap][keynum]);
637 keybindings[bindmap][keynum] = NULL;
639 if(!binding[0]) // make "" binds be removed --blub
641 // allocate memory for new binding
642 l = strlen (binding);
643 newbinding = (char *)Z_Malloc (l + 1);
644 memcpy (newbinding, binding, l + 1);
646 keybindings[bindmap][keynum] = newbinding;
650 Key_In_Unbind_f (void)
654 if (Cmd_Argc () != 3) {
655 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
659 m = strtol(Cmd_Argv (1), NULL, 0);
660 if ((m < 0) || (m >= 8)) {
661 Con_Printf("%d isn't a valid bindmap\n", m);
665 b = Key_StringToKeynum (Cmd_Argv (2));
667 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
671 Key_SetBinding (b, m, "");
678 char cmd[MAX_INPUTLINE];
682 if (c != 3 && c != 4) {
683 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
687 m = strtol(Cmd_Argv (1), NULL, 0);
688 if ((m < 0) || (m >= 8)) {
689 Con_Printf("%d isn't a valid bindmap\n", m);
693 b = Key_StringToKeynum (Cmd_Argv (2));
694 if (b == -1 || b >= MAX_KEYS) {
695 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
700 if (keybindings[m][b])
701 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
703 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
706 // copy the rest of the command line
707 cmd[0] = 0; // start out with a null string
708 for (i = 3; i < c; i++) {
709 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
711 strlcat (cmd, " ", sizeof (cmd));
714 Key_SetBinding (b, m, cmd);
718 Key_In_Bindmap_f (void)
725 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
729 m1 = strtol(Cmd_Argv (1), NULL, 0);
730 if ((m1 < 0) || (m1 >= 8)) {
731 Con_Printf("%d isn't a valid bindmap\n", m1);
735 m2 = strtol(Cmd_Argv (2), NULL, 0);
736 if ((m2 < 0) || (m2 >= 8)) {
737 Con_Printf("%d isn't a valid bindmap\n", m2);
750 if (Cmd_Argc () != 2) {
751 Con_Print("unbind <key> : remove commands from a key\n");
755 b = Key_StringToKeynum (Cmd_Argv (1));
757 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
761 Key_SetBinding (b, 0, "");
765 Key_Unbindall_f (void)
769 for (j = 0; j < 8; j++)
770 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
771 if (keybindings[j][i])
772 Key_SetBinding (i, j, "");
780 char cmd[MAX_INPUTLINE];
784 if (c != 2 && c != 3) {
785 Con_Print("bind <key> [command] : attach a command to a key\n");
788 b = Key_StringToKeynum (Cmd_Argv (1));
789 if (b == -1 || b >= MAX_KEYS) {
790 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
795 if (keybindings[0][b])
796 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
798 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
801 // copy the rest of the command line
802 cmd[0] = 0; // start out with a null string
803 for (i = 2; i < c; i++) {
804 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
806 strlcat (cmd, " ", sizeof (cmd));
809 Key_SetBinding (b, 0, cmd);
814 Writes lines containing "bind key value"
818 Key_WriteBindings (qfile_t *f)
821 char bindbuf[MAX_INPUTLINE];
824 for (j = 0; j < MAX_BINDMAPS; j++)
826 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
828 p = keybindings[j][i];
831 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
833 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
835 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
847 for (i = 0; i < 32; i++) {
848 key_lines[i][0] = ']';
854 // register our functions
856 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
857 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
858 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");
860 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
861 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
862 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
864 Cvar_RegisterVariable (&con_closeontoggleconsole);
867 const char *Key_GetBind (int key)
870 if (key < 0 || key >= MAX_KEYS)
872 bind = keybindings[key_bmap][key];
874 bind = keybindings[key_bmap2][key];
878 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
882 Called by the system between frames for both key up and key down events
883 Should NOT be called during an interrupt!
887 Key_Event (int key, char ascii, qboolean down)
892 if (key < 0 || key >= MAX_KEYS)
896 bind = keybindings[key_bmap][key];
898 bind = keybindings[key_bmap2][key];
900 if (developer.integer >= 1000)
901 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
904 if(key_dest == key_game)
906 q = CL_VM_InputEvent(down, key);
910 keydown[key] = min(keydown[key] + 1, 2);
920 // increment key repeat count each time a down is received so that things
921 // which want to ignore key repeat can ignore it
922 keydown[key] = min(keydown[key] + 1, 2);
926 // clear repeat count now that the key is released
930 // key_consoleactive is a flag not a key_dest because the console is a
931 // high priority overlay ontop of the normal screen (designed as a safety
932 // feature so that developers and users can rescue themselves from a bad
935 // this also means that toggling the console on/off does not lose the old
938 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
939 // engine bindings, these are not handled as normal binds so that the user
940 // can recover from a completely empty bindmap
943 // ignore key repeats on escape
944 if (keydown[key] > 1)
946 // escape does these things:
947 // key_consoleactive - close console
948 // key_message - abort messagemode
949 // key_menu - go to parent menu (or key_game)
950 // key_game - open menu
951 // in all modes shift-escape toggles console
952 if (((key_consoleactive & KEY_CONSOLEACTIVE_USER) || keydown[K_SHIFT]) && down)
954 Con_ToggleConsole_f ();
961 Key_Message (key, ascii);
964 case key_menu_grabbed:
965 MR_KeyEvent (key, ascii, down);
968 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
969 q = CL_VM_InputEvent(down, key, ascii);
974 Con_Printf ("Key_Event: Bad key_dest\n");
979 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
980 if (key_dest != key_menu_grabbed)
981 if (key >= K_F1 && key <= K_F12 && down)
983 // ignore key repeats on F1-F12 binds
984 if (keydown[key] > 1)
988 // button commands add keynum as a parm
990 Cbuf_AddText (va("%s %i\n", bind, key));
1001 // ignore binds (other than the above escape/F1-F12 keys) while in console
1002 if (key_consoleactive && down)
1004 // respond to toggleconsole binds while in console unless the pressed key
1005 // happens to be the color prefix character (such as on German keyboards)
1006 if (key_consoleactive && down && (!con_closeontoggleconsole.integer || !bind || strncmp(bind, "toggleconsole", strlen("toggleconsole")) || ascii == STRING_COLOR_TAG))
1009 Key_Console (key, ascii);
1014 // FIXME: actually the up-bind should only be called if the button was actually pressed while key_dest == key_game [12/17/2007 Black]
1015 // especially CL_VM_InputEvent should be able to prevent it from being called (to intercept the binds)
1016 // key up events only generate commands if the game key binding is a button
1017 // command (leading + sign). These will occur even in console mode, to
1018 // keep the character from continuing an action started before a console
1019 // switch. Button commands include the kenum as a parameter, so multiple
1020 // downs can be matched with ups
1021 if (!down && bind && bind[0] == '+')
1022 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1024 // ignore binds while a video is played, let the video system handle the key event
1025 if (cl_videoplaying)
1027 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1031 // anything else is a key press into the game, chat line, or menu
1036 Key_Message (key, ascii);
1039 case key_menu_grabbed:
1040 MR_KeyEvent (key, ascii, down);
1043 q = CL_VM_InputEvent(down, key, ascii);
1044 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1045 if (!q && bind && keydown[key] == 1 && down)
1047 // button commands add keynum as a parm
1049 Cbuf_AddText (va("%s %i\n", bind, key));
1052 Cbuf_AddText (bind);
1053 Cbuf_AddText ("\n");
1058 Con_Printf ("Key_Event: Bad key_dest\n");
1068 Key_ClearStates (void)
1070 memset(keydown, 0, sizeof(keydown));