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 the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 key up events are sent even if in console mode
29 #define MAXCMDLINE 256
30 char key_lines[32][MAXCMDLINE];
32 int shift_down = false;
33 int key_insert; // insert key toggle (for editing)
38 int key_consoleactive;
41 char *keybindings[256];
42 qboolean consolekeys[256]; // if true, can't be rebound while in console
43 qboolean menubound[256]; // if true, can't be rebound while in menu
44 int keyshift[256]; // key to map to if shift held down in console
45 int key_repeats[256]; // if > 1, it is autorepeating
46 qboolean keydown[256];
54 keyname_t keynames[] =
60 {"BACKSPACE", K_BACKSPACE},
61 {"UPARROW", K_UPARROW},
62 {"DOWNARROW", K_DOWNARROW},
63 {"LEFTARROW", K_LEFTARROW},
64 {"RIGHTARROW", K_RIGHTARROW},
132 {"KP_HOME", K_KP_HOME },
133 {"KP_UPARROW", K_KP_UPARROW },
134 {"KP_PGUP", K_KP_PGUP },
135 {"KP_LEFTARROW", K_KP_LEFTARROW },
137 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
138 {"KP_END", K_KP_END },
139 {"KP_DOWNARROW", K_KP_DOWNARROW },
140 {"KP_PGDN", K_KP_PGDN },
141 {"KP_ENTER", K_KP_ENTER },
142 {"KP_INS", K_KP_INS },
143 {"KP_DEL", K_KP_DEL },
144 {"KP_SLASH", K_KP_SLASH },
145 {"KP_MINUS", K_KP_MINUS },
146 {"KP_PLUS", K_KP_PLUS },
148 {"MWHEELUP", K_MWHEELUP },
149 {"MWHEELDOWN", K_MWHEELDOWN },
153 {"SEMICOLON", ';'}, // because a raw semicolon seperates commands
159 ==============================================================================
161 LINE TYPING INTO THE CONSOLE
163 ==============================================================================
171 Interactive line editing and console scrollback
174 void Key_Console (int key)
176 // LordHavoc: copied most of this from Q2 to improve keyboard handling
203 case K_KP_RIGHTARROW:
223 // LordHavoc: FIXME: implement this sometime
225 if ((toupper(key) == 'V' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
228 if ((cbd = Sys_GetClipboardData()) != 0)
231 strtok(cbd, "\n\r\b");
233 if (i + key_linepos >= MAXCMDLINE)
234 i= MAXCMDLINE - key_linepos;
238 strcat(key_lines[edit_line], cbd);
251 Cbuf_AddText ("clear\n");
256 if (key == K_ENTER || key == K_KP_ENTER)
258 Cbuf_AddText (key_lines[edit_line]+1); // skip the ]
260 Con_Printf ("%s\n",key_lines[edit_line]);
261 edit_line = (edit_line + 1) & 31;
262 history_line = edit_line;
263 key_lines[edit_line][0] = ']';
264 key_lines[edit_line][1] = 0; // EvilTypeGuy: null terminate
266 // force an update, because the command may take some time
267 if (cls.state == ca_disconnected)
277 // Enhanced command completion
278 // by EvilTypeGuy eviltypeguy@qeradiant.com
279 // Thanks to Fett, Taniwha
280 Con_CompleteCommandLine();
284 // Advanced Console Editing by Radix radix@planetquake.com
285 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
287 // left arrow will just move left one without erasing, backspace will
288 // actually erase charcter
289 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
296 // delete char before cursor
297 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
301 strcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos);
307 // delete char on cursor
308 if (key == K_DEL || key == K_KP_DEL)
310 if ((size_t)key_linepos < strlen(key_lines[edit_line]))
311 strcpy(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1);
316 // if we're at the end, get one character from previous line,
317 // otherwise just go right one
318 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
320 if (strlen(key_lines[edit_line]) == (size_t)key_linepos)
322 if (strlen(key_lines[(edit_line + 31) & 31]) <= (size_t)key_linepos)
323 return; // no character to get
325 key_lines[edit_line][key_linepos] = key_lines[(edit_line + 31) & 31][key_linepos];
327 key_lines[edit_line][key_linepos] = 0;
335 if (key == K_INS || key == K_KP_INS) // toggle insert mode
341 // End Advanced Console Editing
343 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
347 history_line = (history_line - 1) & 31;
348 } while (history_line != edit_line
349 && !key_lines[history_line][1]);
350 if (history_line == edit_line)
351 history_line = (edit_line+1)&31;
352 strcpy(key_lines[edit_line], key_lines[history_line]);
353 key_linepos = strlen(key_lines[edit_line]);
357 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
359 if (history_line == edit_line) return;
362 history_line = (history_line + 1) & 31;
364 while (history_line != edit_line
365 && !key_lines[history_line][1]);
366 if (history_line == edit_line)
368 key_lines[edit_line][0] = ']';
373 strcpy(key_lines[edit_line], key_lines[history_line]);
374 key_linepos = strlen(key_lines[edit_line]);
379 if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
381 con_backscroll += ((int) scr_conlines >> 4);
382 if (con_backscroll > con_totallines - (vid.conheight>>3) - 1)
383 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
387 if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
389 con_backscroll -= ((int) scr_conlines >> 4);
390 if (con_backscroll < 0)
395 if (key == K_HOME || key == K_KP_HOME)
397 con_backscroll = con_totallines - (vid.conheight>>3) - 1;
401 if (key == K_END || key == K_KP_END)
408 if (key < 32 || key > 127)
411 if (key_linepos < MAXCMDLINE-1)
415 if (key_insert) // check insert mode
417 // can't do strcpy to move string to right
418 i = strlen(key_lines[edit_line]) - 1;
423 for (; i >= key_linepos; i--)
424 key_lines[edit_line][i + 1] = key_lines[edit_line][i];
427 // only null terminate if at the end
428 i = key_lines[edit_line][key_linepos];
429 key_lines[edit_line][key_linepos] = key;
433 key_lines[edit_line][key_linepos] = 0;
437 //============================================================================
439 // LordHavoc: increased messagemode length (was 32)
440 qboolean chat_team = false;
441 char chat_buffer[256];
442 int chat_bufferlen = 0;
444 void Key_Message (int key)
446 if (key == K_ENTER || key == K_KP_ENTER)
449 Cbuf_AddText ("say_team \"");
451 Cbuf_AddText ("say \"");
452 Cbuf_AddText(chat_buffer);
453 Cbuf_AddText("\"\n");
470 if (key < 32 || key > 127)
473 if (key == K_BACKSPACE)
478 chat_buffer[chat_bufferlen] = 0;
483 if (chat_bufferlen == sizeof(chat_buffer) - 1)
486 chat_buffer[chat_bufferlen++] = key;
487 chat_buffer[chat_bufferlen] = 0;
490 //============================================================================
497 Returns a key number to be used to index keybindings[] by looking at
498 the given string. Single ascii characters return themselves, while
499 the K_* names are matched up.
502 int Key_StringToKeynum (const char *str)
511 for (kn=keynames ; kn->name ; kn++)
512 if (!strcasecmp(str,kn->name))
521 Returns a string (either a single ascii char, or a K_* name) for the
523 FIXME: handle quote special (general escape sequence?)
526 char *Key_KeynumToString (int keynum)
529 static char tinystr[2];
532 return "<KEY NOT FOUND>";
533 if (keynum > 32 && keynum < 127)
540 for (kn=keynames ; kn->name ; kn++)
541 if (keynum == kn->keynum)
544 return "<UNKNOWN KEYNUM>";
553 void Key_SetBinding (int keynum, char *binding)
558 if (keynum < 0 || keynum >= 256)
562 if (keybindings[keynum])
564 Z_Free (keybindings[keynum]);
565 keybindings[keynum] = NULL;
568 // allocate memory for new binding
569 l = strlen (binding);
570 new = Z_Malloc (l+1);
571 strcpy (new, binding);
573 keybindings[keynum] = new;
581 void Key_Unbind_f (void)
587 Con_Printf ("unbind <key> : remove commands from a key\n");
591 b = Key_StringToKeynum (Cmd_Argv(1));
594 Con_Printf ("\"%s\" isn't a valid key\n", Cmd_Argv(1));
598 Key_SetBinding (b, "");
601 void Key_Unbindall_f (void)
605 for (i = 0;i < 256;i++)
607 Key_SetBinding (i, "");
616 void Key_Bind_f (void)
623 if (c != 2 && c != 3)
625 Con_Printf ("bind <key> [command] : attach a command to a key\n");
628 b = Key_StringToKeynum (Cmd_Argv(1));
631 Con_Printf ("\"%s\" isn't a valid key\n", Cmd_Argv(1));
638 Con_Printf ("\"%s\" = \"%s\"\n", Cmd_Argv(1), keybindings[b] );
640 Con_Printf ("\"%s\" is not bound\n", Cmd_Argv(1) );
644 // copy the rest of the command line
645 // start out with a null string
647 for (i=2 ; i< c ; i++)
651 strcat (cmd, Cmd_Argv(i));
654 Key_SetBinding (b, cmd);
661 Writes lines containing "bind key value"
664 void Key_WriteBindings (qfile_t *f)
668 for (i = 0;i < 256;i++)
669 if (keybindings[i] && *keybindings[i])
670 FS_Printf (f, "bind \"%s\" \"%s\"\n", Key_KeynumToString(i), keybindings[i]);
680 void Key_Bindlist_f (void)
684 for (i = 0;i < 256;i++)
685 if (keybindings[i] && keybindings[i][0])
686 Con_Printf ("%s \"%s\"\n", Key_KeynumToString(i), keybindings[i]);
699 // LordHavoc: clear keybindings array so bounds checking won't freak
700 for (i = 0;i < 256;i++)
701 keybindings[i] = NULL;
703 for (i = 0;i < 32;i++)
705 key_lines[i][0] = ']';
711 // init ascii characters in console mode
713 for (i = 32;i < 128;i++)
714 consolekeys[i] = true;
715 consolekeys[K_ENTER] = true;consolekeys[K_KP_ENTER] = true;
716 consolekeys[K_TAB] = true;
717 consolekeys[K_LEFTARROW] = true;consolekeys[K_KP_LEFTARROW] = true;
718 consolekeys[K_RIGHTARROW] = true;consolekeys[K_KP_RIGHTARROW] = true;
719 consolekeys[K_UPARROW] = true;consolekeys[K_KP_UPARROW] = true;
720 consolekeys[K_DOWNARROW] = true;consolekeys[K_KP_DOWNARROW] = true;
721 consolekeys[K_BACKSPACE] = true;
722 consolekeys[K_HOME] = true;consolekeys[K_KP_HOME] = true;
723 consolekeys[K_END] = true;consolekeys[K_KP_END] = true;
724 consolekeys[K_PGUP] = true;consolekeys[K_KP_PGUP] = true;
725 consolekeys[K_PGDN] = true;consolekeys[K_KP_PGDN] = true;
726 consolekeys[K_SHIFT] = true;
727 consolekeys[K_INS] = true;consolekeys[K_KP_INS] = true;
728 consolekeys[K_DEL] = true;consolekeys[K_KP_DEL] = true;
729 consolekeys[K_KP_SLASH] = true;
730 consolekeys[K_KP_PLUS] = true;
731 consolekeys[K_KP_MINUS] = true;
732 consolekeys[K_KP_5] = true;
733 consolekeys[K_MWHEELUP] = true;
734 consolekeys[K_MWHEELDOWN] = true;
736 consolekeys['`'] = false;
737 consolekeys['~'] = false;
739 for (i = 0;i < 256;i++)
741 for (i = 'a';i <= 'z';i++)
742 keyshift[i] = i - 'a' + 'A';
759 keyshift['\''] = '"';
763 keyshift['\\'] = '|';
765 menubound[K_ESCAPE] = true;
766 for (i=0 ; i<12 ; i++)
767 menubound[K_F1+i] = true;
770 // register our functions
772 Cmd_AddCommand ("bind",Key_Bind_f);
773 Cmd_AddCommand ("unbind",Key_Unbind_f);
774 Cmd_AddCommand ("unbindall",Key_Unbindall_f);
775 Cmd_AddCommand ("bindlist",Key_Bindlist_f);
782 Called by the system between frames for both key up and key down events
783 Should NOT be called during an interrupt!
786 void Key_Event (int key, qboolean down)
793 // update auto-repeat status
797 if (key != K_BACKSPACE
803 && key_repeats[key] > 1)
804 return; // ignore most autorepeats
806 if (key >= 200 && !keybindings[key])
807 Con_Printf ("%s is unbound, hit F4 to set.\n", Key_KeynumToString (key));
810 key_repeats[key] = 0;
816 // handle escape specialy, so the user can never unbind it
834 Sys_Error ("Bad key_dest");
839 // console key is hardcoded, so the user can never unbind it
840 if (key == '`' || key == '~')
843 Con_ToggleConsole_f ();
849 kb = keybindings[key];
850 if (kb && !strncmp(kb, "toggleconsole", strlen("toggleconsole")))
858 if (key_consoleactive && consolekeys[key])
860 // console only wants key down events
864 // FIXME: this does not support non-QWERTY keyboards
873 // key up events only generate commands if the game key binding is
874 // a button command (leading + sign). These will occur even in console mode,
875 // to keep the character from continuing an action started before a console
876 // switch. Button commands include the keynum as a parameter, so multiple
877 // downs can be matched with ups
881 kb = keybindings[key];
882 if (kb && kb[0] == '+')
884 sprintf (cmd, "-%s %i\n", kb+1, key);
887 if (keyshift[key] != key)
889 kb = keybindings[keyshift[key]];
890 if (kb && kb[0] == '+')
892 sprintf (cmd, "-%s %i\n", kb+1, key);
900 // during demo playback, most keys bring up the main menu
902 if (cls.demoplayback && down && consolekeys[key] && key_dest == key_game)
906 // if not a consolekey, send to the interpreter no matter what mode is
908 if ((key_consoleactive && !consolekeys[key])
909 || (key_dest == key_menu && menubound[key])
910 || key_dest == key_game)
912 kb = keybindings[key];
917 // button commands add keynum as a parm
918 sprintf (cmd, "%s %i\n", kb, key);
931 return; // other systems only care about key down events
933 // FIXME: this does not support non-QWERTY keyboards
951 Sys_Error ("Bad key_dest");
962 void Key_ClearStates (void)
966 for (i = 0;i < 256;i++)