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
28 key up events are sent even if in console mode
31 #define MAX_INPUTLINE 256
32 char key_lines[32][MAX_INPUTLINE];
34 static int ctrl_down = false;
35 static int key_lastpress;
36 int key_insert; // insert key toggle (for editing)
42 int key_consoleactive;
44 static int key_count; // incremented every key event
45 static int key_bmap, key_bmap2;
47 char *keybindings[8][1024];
48 static qboolean consolekeys[1024]; // if true, can't be rebound while in
50 static qboolean menubound[1024]; // if true, can't be rebound while in
52 static unsigned int key_repeats[1024]; // if > 1, it is autorepeating
53 static qboolean keydown[1024];
60 static const keyname_t keynames[] = {
65 {"BACKSPACE", K_BACKSPACE},
66 {"UPARROW", K_UPARROW},
67 {"DOWNARROW", K_DOWNARROW},
68 {"LEFTARROW", K_LEFTARROW},
69 {"RIGHTARROW", K_RIGHTARROW},
97 {"MWHEELUP", K_MWHEELUP},
98 {"MWHEELDOWN", K_MWHEELDOWN},
100 {"MOUSE1", K_MOUSE1},
101 {"MOUSE2", K_MOUSE2},
102 {"MOUSE3", K_MOUSE3},
103 {"MOUSE4", K_MOUSE4},
104 {"MOUSE5", K_MOUSE5},
105 {"MOUSE6", K_MOUSE6},
106 {"MOUSE7", K_MOUSE7},
107 {"MOUSE8", K_MOUSE8},
108 {"MOUSE9", K_MOUSE9},
109 {"MOUSE10", K_MOUSE10},
110 {"MOUSE11", K_MOUSE11},
111 {"MOUSE12", K_MOUSE12},
112 {"MOUSE13", K_MOUSE13},
113 {"MOUSE14", K_MOUSE14},
114 {"MOUSE15", K_MOUSE15},
115 {"MOUSE16", K_MOUSE16},
117 {"NUMLOCK", K_NUMLOCK},
118 {"CAPSLOCK", K_CAPSLOCK},
119 {"SCROLLOCK", K_SCROLLOCK},
121 {"KP_HOME", K_KP_HOME },
122 {"KP_UPARROW", K_KP_UPARROW },
123 {"KP_PGUP", K_KP_PGUP },
124 {"KP_LEFTARROW", K_KP_LEFTARROW },
125 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
126 {"KP_END", K_KP_END },
127 {"KP_DOWNARROW", K_KP_DOWNARROW },
128 {"KP_PGDN", K_KP_PGDN },
129 {"KP_INS", K_KP_INS },
130 {"KP_DEL", K_KP_DEL },
131 {"KP_SLASH", K_KP_SLASH },
143 {"KP_PERIOD", K_KP_PERIOD},
144 {"KP_DIVIDE", K_KP_DIVIDE},
145 {"KP_MULTIPLY", K_KP_MULTIPLY},
146 {"KP_MINUS", K_KP_MINUS},
147 {"KP_PLUS", K_KP_PLUS},
148 {"KP_ENTER", K_KP_ENTER},
149 {"KP_EQUALS", K_KP_EQUALS},
201 {"SEMICOLON", ';'}, // because a raw semicolon seperates commands
205 {"APOSTROPHE", '\''},
211 ==============================================================================
213 LINE TYPING INTO THE CONSOLE
215 ==============================================================================
219 Key_ClearEditLine (int edit_line)
221 memset (key_lines[edit_line], '\0', MAX_INPUTLINE);
222 key_lines[edit_line][0] = ']';
228 Interactive line editing and console scrollback
232 Key_Console (int key, char ascii)
234 // LordHavoc: copied most of this from Q2 to improve keyboard handling
261 case K_KP_RIGHTARROW:
281 if ((toupper(key) == 'V' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
284 if ((cbd = Sys_GetClipboardData()) != 0)
287 strtok(cbd, "\n\r\b");
289 if (i + key_linepos >= MAX_INPUTLINE)
290 i= MAX_INPUTLINE - key_linepos;
294 strcat(key_lines[edit_line], cbd);
306 Cbuf_AddText ("clear\n");
311 if (key == K_ENTER || key == K_KP_ENTER)
313 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
315 Con_Printf("%s\n",key_lines[edit_line]);
316 edit_line = (edit_line + 1) & 31;
317 history_line = edit_line;
318 key_lines[edit_line][0] = ']';
319 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
321 // force an update, because the command may take some time
322 if (cls.state == ca_disconnected)
332 // Enhanced command completion
333 // by EvilTypeGuy eviltypeguy@qeradiant.com
334 // Thanks to Fett, Taniwha
335 Con_CompleteCommandLine();
339 // Advanced Console Editing by Radix radix@planetquake.com
340 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
342 // left arrow will just move left one without erasing, backspace will
343 // actually erase charcter
344 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
351 // delete char before cursor
352 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
356 strcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos);
362 // delete char on cursor
363 if (key == K_DEL || key == K_KP_DEL)
365 if ((size_t)key_linepos < strlen(key_lines[edit_line]))
366 strcpy(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1);
371 // if we're at the end, get one character from previous line,
372 // otherwise just go right one
373 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
375 if (strlen(key_lines[edit_line]) == (size_t)key_linepos)
377 if (strlen(key_lines[(edit_line + 31) & 31]) <= (size_t)key_linepos)
378 return; // no character to get
380 key_lines[edit_line][key_linepos] = key_lines[(edit_line + 31) & 31][key_linepos];
382 key_lines[edit_line][key_linepos] = 0;
390 if (key == K_INS || key == K_KP_INS) // toggle insert mode
396 // End Advanced Console Editing
398 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
402 history_line = (history_line - 1) & 31;
403 } while (history_line != edit_line
404 && !key_lines[history_line][1]);
405 if (history_line == edit_line)
406 history_line = (edit_line+1)&31;
407 strcpy(key_lines[edit_line], key_lines[history_line]);
408 key_linepos = strlen(key_lines[edit_line]);
412 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
414 if (history_line == edit_line) return;
417 history_line = (history_line + 1) & 31;
419 while (history_line != edit_line
420 && !key_lines[history_line][1]);
421 if (history_line == edit_line)
423 key_lines[edit_line][0] = ']';
428 strcpy(key_lines[edit_line], key_lines[history_line]);
429 key_linepos = strlen(key_lines[edit_line]);
434 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
436 con_backscroll += ((int) scr_conlines >> 4);
437 if (con_backscroll > con_totallines - (vid.conheight>>3) - 1)
438 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
442 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
444 con_backscroll -= ((int) scr_conlines >> 4);
445 if (con_backscroll < 0)
450 if (key == K_HOME || key == K_KP_HOME)
452 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
456 if (key == K_END || key == K_KP_END)
463 if (ascii < 32 || ascii > 126)
466 if (key_linepos < MAX_INPUTLINE-1)
470 if (key_insert) // check insert mode
472 // can't do strcpy to move string to right
473 i = strlen(key_lines[edit_line]) - 1;
478 for (; i >= key_linepos; i--)
479 key_lines[edit_line][i + 1] = key_lines[edit_line][i];
482 // only null terminate if at the end
483 i = key_lines[edit_line][key_linepos];
484 key_lines[edit_line][key_linepos] = ascii;
488 key_lines[edit_line][key_linepos] = 0;
492 //============================================================================
495 char chat_buffer[MAX_INPUTLINE];
496 unsigned int chat_bufferlen = 0;
499 Key_Message (int key, char ascii)
504 Cmd_ForwardStringToServer(va("%s %s", chat_team ? "say_team" : "say ", chat_buffer));
512 if (key == K_ESCAPE) {
519 if (key == K_BACKSPACE) {
520 if (chat_bufferlen) {
522 chat_buffer[chat_bufferlen] = 0;
527 if (chat_bufferlen == sizeof (chat_buffer) - 1)
531 return; // non printable
533 chat_buffer[chat_bufferlen++] = ascii;
534 chat_buffer[chat_bufferlen] = 0;
537 //============================================================================
542 Returns a key number to be used to index keybindings[] by looking at
543 the given string. Single ascii characters return themselves, while
544 the K_* names are matched up.
548 Key_StringToKeynum (const char *str)
555 return tolower(str[0]);
557 for (kn = keynames; kn->name; kn++) {
558 if (!strcasecmp (str, kn->name))
566 Returns a string (either a single ascii char, or a K_* name) for the
568 FIXME: handle quote special (general escape sequence?)
572 Key_KeynumToString (int keynum)
575 static char tinystr[2];
578 return "<KEY NOT FOUND>";
579 if (keynum > 32 && keynum < 127) { // printable ascii
585 for (kn = keynames; kn->name; kn++)
586 if (keynum == kn->keynum)
589 return "<UNKNOWN KEYNUM>";
594 Key_SetBinding (int keynum, int bindmap, const char *binding)
603 if (keybindings[bindmap][keynum]) {
604 Z_Free (keybindings[bindmap][keynum]);
605 keybindings[bindmap][keynum] = NULL;
607 // allocate memory for new binding
608 l = strlen (binding);
609 new = Z_Malloc (l + 1);
610 strcpy (new, binding);
612 keybindings[bindmap][keynum] = new;
616 Key_In_Unbind_f (void)
620 if (Cmd_Argc () != 3) {
621 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
625 m = strtol(Cmd_Argv (1), NULL, 0);
626 if ((m < 0) || (m >= 8)) {
627 Con_Printf("%d isn't a valid bindmap\n", m);
631 b = Key_StringToKeynum (Cmd_Argv (2));
633 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
637 Key_SetBinding (b, m, "");
648 if (c != 3 && c != 4) {
649 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
653 m = strtol(Cmd_Argv (1), NULL, 0);
654 if ((m < 0) || (m >= 8)) {
655 Con_Printf("%d isn't a valid bindmap\n", m);
659 b = Key_StringToKeynum (Cmd_Argv (2));
661 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
666 if (keybindings[m][b])
667 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
669 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
672 // copy the rest of the command line
673 cmd[0] = 0; // start out with a null string
674 for (i = 3; i < c; i++) {
675 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
677 strlcat (cmd, " ", sizeof (cmd));
680 Key_SetBinding (b, m, cmd);
684 Key_In_Bindmap_f (void)
691 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
695 m1 = strtol(Cmd_Argv (1), NULL, 0);
696 if ((m1 < 0) || (m1 >= 8)) {
697 Con_Printf("%d isn't a valid bindmap\n", m1);
701 m2 = strtol(Cmd_Argv (2), NULL, 0);
702 if ((m2 < 0) || (m2 >= 8)) {
703 Con_Printf("%d isn't a valid bindmap\n", m2);
716 if (Cmd_Argc () != 2) {
717 Con_Print("unbind <key> : remove commands from a key\n");
721 b = Key_StringToKeynum (Cmd_Argv (1));
723 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
727 Key_SetBinding (b, 0, "");
731 Key_Unbindall_f (void)
735 for (j = 0; j < 8; j++)
736 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
737 if (keybindings[j][i])
738 Key_SetBinding (i, j, "");
750 if (c != 2 && c != 3) {
751 Con_Print("bind <key> [command] : attach a command to a key\n");
754 b = Key_StringToKeynum (Cmd_Argv (1));
756 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
761 if (keybindings[0][b])
762 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
764 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
767 // copy the rest of the command line
768 cmd[0] = 0; // start out with a null string
769 for (i = 2; i < c; i++) {
770 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
772 strlcat (cmd, " ", sizeof (cmd));
775 Key_SetBinding (b, 0, cmd);
780 Writes lines containing "bind key value"
784 Key_WriteBindings (qfile_t *f)
788 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
789 if (keybindings[0][i])
790 FS_Printf(f, "bind \"%s\" \"%s\"\n",
791 Key_KeynumToString (i), keybindings[0][i]);
792 for (j = 1; j < 8; j++)
793 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
794 if (keybindings[j][i])
795 FS_Printf(f, "in_bind %d \"%s\" \"%s\"\n",
796 j, Key_KeynumToString (i), keybindings[j][i]);
805 for (i = 0; i < 32; i++) {
806 key_lines[i][0] = ']';
812 // init ascii characters in console mode
814 for (i = 32; i < 128; i++)
815 consolekeys[i] = true;
816 consolekeys[K_ENTER] = true; consolekeys[K_KP_ENTER] = true;
817 consolekeys[K_TAB] = true;
818 consolekeys[K_LEFTARROW] = true; consolekeys[K_KP_LEFTARROW] = true;
819 consolekeys[K_RIGHTARROW] = true; consolekeys[K_KP_RIGHTARROW] = true;
820 consolekeys[K_UPARROW] = true; consolekeys[K_KP_UPARROW] = true;
821 consolekeys[K_DOWNARROW] = true; consolekeys[K_KP_DOWNARROW] = true;
822 consolekeys[K_BACKSPACE] = true;
823 consolekeys[K_DEL] = true; consolekeys[K_KP_DEL] = true;
824 consolekeys[K_INS] = true; consolekeys[K_KP_INS] = true;
825 consolekeys[K_HOME] = true; consolekeys[K_KP_HOME] = true;
826 consolekeys[K_END] = true; consolekeys[K_KP_END] = true;
827 consolekeys[K_PGUP] = true; consolekeys[K_KP_PGUP] = true;
828 consolekeys[K_PGDN] = true; consolekeys[K_KP_PGDN] = true;
829 consolekeys[K_SHIFT] = true;
830 consolekeys[K_MWHEELUP] = true;
831 consolekeys[K_MWHEELDOWN] = true;
832 consolekeys[K_KP_PLUS] = true;
833 consolekeys[K_KP_MINUS] = true;
834 consolekeys[K_KP_DIVIDE] = true;
835 consolekeys[K_KP_MULTIPLY] = true;
836 consolekeys['`'] = false;
837 consolekeys['~'] = false;
839 menubound[K_ESCAPE] = true;
840 for (i = 0; i < 12; i++)
841 menubound[K_F1 + i] = true;
844 // register our functions
846 Cmd_AddCommand ("in_bind", Key_In_Bind_f);
847 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f);
848 Cmd_AddCommand ("in_bindmap", Key_In_Bindmap_f);
850 Cmd_AddCommand ("bind", Key_Bind_f);
851 Cmd_AddCommand ("unbind", Key_Unbind_f);
852 Cmd_AddCommand ("unbindall", Key_Unbindall_f);
858 Called by the system between frames for both key up and key down events
859 Should NOT be called during an interrupt!
863 Key_Event (int key, char ascii, qboolean down)
871 key_repeats[key] = 0;
875 if (key_count <= 0) {
876 return; // just catching keys for Con_NotifyBox
879 // update auto-repeat status
882 if (key_repeats[key] > 1) {
883 if ((key_consoleactive && !consolekeys[key]) ||
884 (!key_consoleactive && key_dest == key_game &&
885 (cls.state == ca_connected && cls.signon == SIGNONS)))
886 return; // ignore most autorepeats
894 // handle escape specially, so the user can never unbind it
896 if (key == K_ESCAPE) {
901 Key_Message (key, ascii);
904 MR_Keydown (key, ascii);
910 if(UI_Callback_IsSlotUsed(key_dest - 3))
911 UI_Callback_KeyDown (key, ascii);
913 Sys_Error ("Bad key_dest");
918 // console key is hardcoded, so the user can never unbind it
919 if (key == '`' || key == '~')
922 Con_ToggleConsole_f ();
928 if (!(kb = keybindings[key_bmap][key]))
929 kb = keybindings[key_bmap2][key];
930 if (kb && !strncmp(kb, "toggleconsole", strlen("toggleconsole")))
938 if (key_consoleactive && consolekeys[key] && down)
939 Key_Console (key, ascii);
943 // key up events only generate commands if the game key binding is a button
944 // command (leading + sign). These will occur even in console mode, to
945 // keep the character from continuing an action started before a console
946 // switch. Button commands include the kenum as a parameter, so multiple
947 // downs can be matched with ups
950 if (!(kb = keybindings[key_bmap][key]))
951 kb = keybindings[key_bmap2][key];
953 if (kb && kb[0] == '+') {
954 snprintf (cmd, sizeof(cmd), "-%s %i\n", kb + 1, key);
961 // during demo playback, most keys bring up the main menu
963 if (cls.demoplayback && down && consolekeys[key] && key_dest == key_game) {
969 // if not a consolekey, send to the interpreter no matter what mode is
971 if ((key_dest == key_menu && menubound[key])
972 || (key_consoleactive && !consolekeys[key])
973 || (key_dest == key_game &&
974 ((cls.state == ca_connected) || !consolekeys[key]))) {
975 if (!(kb = keybindings[key_bmap][key]))
976 kb = keybindings[key_bmap2][key];
978 if (kb[0] == '+') { // button commands add keynum as a parm
979 snprintf (cmd, sizeof(cmd), "%s %i\n", kb, key);
990 return; // other systems only care about key
995 Key_Message (key, ascii);
998 MR_Keydown (key, ascii);
1001 Key_Console (key, ascii);
1004 if(UI_Callback_IsSlotUsed(key_dest - 3))
1005 UI_Callback_KeyDown (key, ascii);
1007 Sys_Error ("Bad key_dest");
1018 Key_ClearStates (void)
1022 for (i = 0; i < (int)(sizeof(keydown)/sizeof(keydown[0])); i++)