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 char key_line[MAX_INPUTLINE];
34 qboolean key_insert = true; // insert key toggle (for editing)
36 int key_consoleactive;
37 char *keybindings[MAX_BINDMAPS][MAX_KEYS];
39 char history_savedline[MAX_INPUTLINE];
42 extern cvar_t con_textsize;
45 static void Key_History_Init(void)
48 ConBuffer_Init(&history, HIST_TEXTSIZE, HIST_MAXLINES, zonemempool);
50 historyfile = FS_OpenRealFile("darkplaces_history.txt", "rb", false); // rb to handle unix line endings on windows too
53 char buf[MAX_INPUTLINE];
60 c = FS_Getc(historyfile);
61 if(c < 0 || c == 0 || c == '\r' || c == '\n')
66 ConBuffer_AddLine(&history, buf, bufpos, 0);
74 if(bufpos < MAX_INPUTLINE - 1)
79 FS_Close(historyfile);
85 static void Key_History_Shutdown(void)
87 // TODO write history to a file
89 qfile_t *historyfile = FS_OpenRealFile("darkplaces_history.txt", "w", false);
93 for(i = 0; i < CONBUFFER_LINES_COUNT(&history); ++i)
94 FS_Printf(historyfile, "%s\n", ConBuffer_GetLine(&history, i));
95 FS_Close(historyfile);
98 ConBuffer_Shutdown(&history);
101 static void Key_History_Push(void)
103 if(key_line[1]) // empty?
104 if(strcmp(key_line, "]quit")) // putting these into the history just sucks
105 if(strncmp(key_line, "]quit ", 6)) // putting these into the history just sucks
106 ConBuffer_AddLine(&history, key_line + 1, strlen(key_line) - 1, 0);
107 Con_Printf("%s\n", key_line); // don't mark empty lines as history
111 static void Key_History_Up(void)
113 if(history_line == -1) // editing the "new" line
114 strlcpy(history_savedline, key_line + 1, sizeof(history_savedline));
116 if(history_line == -1)
118 history_line = CONBUFFER_LINES_COUNT(&history) - 1;
119 if(history_line != -1)
121 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
122 key_linepos = strlen(key_line);
125 else if(history_line > 0)
127 --history_line; // this also does -1 -> 0, so it is good
128 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
129 key_linepos = strlen(key_line);
133 static void Key_History_Down(void)
135 if(history_line == -1) // editing the "new" line
138 if(history_line < CONBUFFER_LINES_COUNT(&history) - 1)
141 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
146 strlcpy(key_line + 1, history_savedline, sizeof(key_line) - 1);
149 key_linepos = strlen(key_line);
152 static int key_bmap, key_bmap2;
153 static unsigned char keydown[MAX_KEYS]; // 0 = up, 1 = down, 2 = repeating
155 typedef struct keyname_s
162 static const keyname_t keynames[] = {
165 {"ESCAPE", K_ESCAPE},
168 // spacer so it lines up with keys.h
170 {"BACKSPACE", K_BACKSPACE},
171 {"UPARROW", K_UPARROW},
172 {"DOWNARROW", K_DOWNARROW},
173 {"LEFTARROW", K_LEFTARROW},
174 {"RIGHTARROW", K_RIGHTARROW},
202 {"NUMLOCK", K_NUMLOCK},
203 {"CAPSLOCK", K_CAPSLOCK},
204 {"SCROLLOCK", K_SCROLLOCK},
206 {"KP_INS", K_KP_INS },
208 {"KP_END", K_KP_END },
210 {"KP_DOWNARROW", K_KP_DOWNARROW },
212 {"KP_PGDN", K_KP_PGDN },
214 {"KP_LEFTARROW", K_KP_LEFTARROW },
217 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
219 {"KP_HOME", K_KP_HOME },
221 {"KP_UPARROW", K_KP_UPARROW },
223 {"KP_PGUP", K_KP_PGUP },
225 {"KP_DEL", K_KP_DEL },
226 {"KP_PERIOD", K_KP_PERIOD},
227 {"KP_SLASH", K_KP_SLASH },
228 {"KP_DIVIDE", K_KP_DIVIDE},
229 {"KP_MULTIPLY", K_KP_MULTIPLY},
230 {"KP_MINUS", K_KP_MINUS},
231 {"KP_PLUS", K_KP_PLUS},
232 {"KP_ENTER", K_KP_ENTER},
233 {"KP_EQUALS", K_KP_EQUALS},
237 {"MOUSE1", K_MOUSE1},
239 {"MOUSE2", K_MOUSE2},
240 {"MOUSE3", K_MOUSE3},
241 {"MWHEELUP", K_MWHEELUP},
242 {"MWHEELDOWN", K_MWHEELDOWN},
243 {"MOUSE4", K_MOUSE4},
244 {"MOUSE5", K_MOUSE5},
245 {"MOUSE6", K_MOUSE6},
246 {"MOUSE7", K_MOUSE7},
247 {"MOUSE8", K_MOUSE8},
248 {"MOUSE9", K_MOUSE9},
249 {"MOUSE10", K_MOUSE10},
250 {"MOUSE11", K_MOUSE11},
251 {"MOUSE12", K_MOUSE12},
252 {"MOUSE13", K_MOUSE13},
253 {"MOUSE14", K_MOUSE14},
254 {"MOUSE15", K_MOUSE15},
255 {"MOUSE16", K_MOUSE16},
315 {"SEMICOLON", ';'}, // because a raw semicolon separates commands
319 {"APOSTROPHE", '\''},
320 {"BACKSLASH", '\\'}, // because a raw backslash is used for special characters
322 {"MIDINOTE0", K_MIDINOTE0},
323 {"MIDINOTE1", K_MIDINOTE1},
324 {"MIDINOTE2", K_MIDINOTE2},
325 {"MIDINOTE3", K_MIDINOTE3},
326 {"MIDINOTE4", K_MIDINOTE4},
327 {"MIDINOTE5", K_MIDINOTE5},
328 {"MIDINOTE6", K_MIDINOTE6},
329 {"MIDINOTE7", K_MIDINOTE7},
330 {"MIDINOTE8", K_MIDINOTE8},
331 {"MIDINOTE9", K_MIDINOTE9},
332 {"MIDINOTE10", K_MIDINOTE10},
333 {"MIDINOTE11", K_MIDINOTE11},
334 {"MIDINOTE12", K_MIDINOTE12},
335 {"MIDINOTE13", K_MIDINOTE13},
336 {"MIDINOTE14", K_MIDINOTE14},
337 {"MIDINOTE15", K_MIDINOTE15},
338 {"MIDINOTE16", K_MIDINOTE16},
339 {"MIDINOTE17", K_MIDINOTE17},
340 {"MIDINOTE18", K_MIDINOTE18},
341 {"MIDINOTE19", K_MIDINOTE19},
342 {"MIDINOTE20", K_MIDINOTE20},
343 {"MIDINOTE21", K_MIDINOTE21},
344 {"MIDINOTE22", K_MIDINOTE22},
345 {"MIDINOTE23", K_MIDINOTE23},
346 {"MIDINOTE24", K_MIDINOTE24},
347 {"MIDINOTE25", K_MIDINOTE25},
348 {"MIDINOTE26", K_MIDINOTE26},
349 {"MIDINOTE27", K_MIDINOTE27},
350 {"MIDINOTE28", K_MIDINOTE28},
351 {"MIDINOTE29", K_MIDINOTE29},
352 {"MIDINOTE30", K_MIDINOTE30},
353 {"MIDINOTE31", K_MIDINOTE31},
354 {"MIDINOTE32", K_MIDINOTE32},
355 {"MIDINOTE33", K_MIDINOTE33},
356 {"MIDINOTE34", K_MIDINOTE34},
357 {"MIDINOTE35", K_MIDINOTE35},
358 {"MIDINOTE36", K_MIDINOTE36},
359 {"MIDINOTE37", K_MIDINOTE37},
360 {"MIDINOTE38", K_MIDINOTE38},
361 {"MIDINOTE39", K_MIDINOTE39},
362 {"MIDINOTE40", K_MIDINOTE40},
363 {"MIDINOTE41", K_MIDINOTE41},
364 {"MIDINOTE42", K_MIDINOTE42},
365 {"MIDINOTE43", K_MIDINOTE43},
366 {"MIDINOTE44", K_MIDINOTE44},
367 {"MIDINOTE45", K_MIDINOTE45},
368 {"MIDINOTE46", K_MIDINOTE46},
369 {"MIDINOTE47", K_MIDINOTE47},
370 {"MIDINOTE48", K_MIDINOTE48},
371 {"MIDINOTE49", K_MIDINOTE49},
372 {"MIDINOTE50", K_MIDINOTE50},
373 {"MIDINOTE51", K_MIDINOTE51},
374 {"MIDINOTE52", K_MIDINOTE52},
375 {"MIDINOTE53", K_MIDINOTE53},
376 {"MIDINOTE54", K_MIDINOTE54},
377 {"MIDINOTE55", K_MIDINOTE55},
378 {"MIDINOTE56", K_MIDINOTE56},
379 {"MIDINOTE57", K_MIDINOTE57},
380 {"MIDINOTE58", K_MIDINOTE58},
381 {"MIDINOTE59", K_MIDINOTE59},
382 {"MIDINOTE60", K_MIDINOTE60},
383 {"MIDINOTE61", K_MIDINOTE61},
384 {"MIDINOTE62", K_MIDINOTE62},
385 {"MIDINOTE63", K_MIDINOTE63},
386 {"MIDINOTE64", K_MIDINOTE64},
387 {"MIDINOTE65", K_MIDINOTE65},
388 {"MIDINOTE66", K_MIDINOTE66},
389 {"MIDINOTE67", K_MIDINOTE67},
390 {"MIDINOTE68", K_MIDINOTE68},
391 {"MIDINOTE69", K_MIDINOTE69},
392 {"MIDINOTE70", K_MIDINOTE70},
393 {"MIDINOTE71", K_MIDINOTE71},
394 {"MIDINOTE72", K_MIDINOTE72},
395 {"MIDINOTE73", K_MIDINOTE73},
396 {"MIDINOTE74", K_MIDINOTE74},
397 {"MIDINOTE75", K_MIDINOTE75},
398 {"MIDINOTE76", K_MIDINOTE76},
399 {"MIDINOTE77", K_MIDINOTE77},
400 {"MIDINOTE78", K_MIDINOTE78},
401 {"MIDINOTE79", K_MIDINOTE79},
402 {"MIDINOTE80", K_MIDINOTE80},
403 {"MIDINOTE81", K_MIDINOTE81},
404 {"MIDINOTE82", K_MIDINOTE82},
405 {"MIDINOTE83", K_MIDINOTE83},
406 {"MIDINOTE84", K_MIDINOTE84},
407 {"MIDINOTE85", K_MIDINOTE85},
408 {"MIDINOTE86", K_MIDINOTE86},
409 {"MIDINOTE87", K_MIDINOTE87},
410 {"MIDINOTE88", K_MIDINOTE88},
411 {"MIDINOTE89", K_MIDINOTE89},
412 {"MIDINOTE90", K_MIDINOTE90},
413 {"MIDINOTE91", K_MIDINOTE91},
414 {"MIDINOTE92", K_MIDINOTE92},
415 {"MIDINOTE93", K_MIDINOTE93},
416 {"MIDINOTE94", K_MIDINOTE94},
417 {"MIDINOTE95", K_MIDINOTE95},
418 {"MIDINOTE96", K_MIDINOTE96},
419 {"MIDINOTE97", K_MIDINOTE97},
420 {"MIDINOTE98", K_MIDINOTE98},
421 {"MIDINOTE99", K_MIDINOTE99},
422 {"MIDINOTE100", K_MIDINOTE100},
423 {"MIDINOTE101", K_MIDINOTE101},
424 {"MIDINOTE102", K_MIDINOTE102},
425 {"MIDINOTE103", K_MIDINOTE103},
426 {"MIDINOTE104", K_MIDINOTE104},
427 {"MIDINOTE105", K_MIDINOTE105},
428 {"MIDINOTE106", K_MIDINOTE106},
429 {"MIDINOTE107", K_MIDINOTE107},
430 {"MIDINOTE108", K_MIDINOTE108},
431 {"MIDINOTE109", K_MIDINOTE109},
432 {"MIDINOTE110", K_MIDINOTE110},
433 {"MIDINOTE111", K_MIDINOTE111},
434 {"MIDINOTE112", K_MIDINOTE112},
435 {"MIDINOTE113", K_MIDINOTE113},
436 {"MIDINOTE114", K_MIDINOTE114},
437 {"MIDINOTE115", K_MIDINOTE115},
438 {"MIDINOTE116", K_MIDINOTE116},
439 {"MIDINOTE117", K_MIDINOTE117},
440 {"MIDINOTE118", K_MIDINOTE118},
441 {"MIDINOTE119", K_MIDINOTE119},
442 {"MIDINOTE120", K_MIDINOTE120},
443 {"MIDINOTE121", K_MIDINOTE121},
444 {"MIDINOTE122", K_MIDINOTE122},
445 {"MIDINOTE123", K_MIDINOTE123},
446 {"MIDINOTE124", K_MIDINOTE124},
447 {"MIDINOTE125", K_MIDINOTE125},
448 {"MIDINOTE126", K_MIDINOTE126},
449 {"MIDINOTE127", K_MIDINOTE127},
455 ==============================================================================
457 LINE TYPING INTO THE CONSOLE
459 ==============================================================================
463 Key_ClearEditLine (int edit_line)
465 memset (key_line, '\0', sizeof(key_line));
472 Interactive line editing and console scrollback
476 Key_Console (int key, int ascii)
478 // LordHavoc: copied most of this from Q2 to improve keyboard handling
505 case K_KP_RIGHTARROW:
525 if ((key == 'v' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
528 if ((cbd = Sys_GetClipboardData()) != 0)
535 if (*p == '\r' && *(p+1) == '\n')
540 else if (*p == '\n' || *p == '\r' || *p == '\b')
545 strtok(cbd, "\n\r\b");
547 i = (int)strlen(cbd);
548 if (i + key_linepos >= MAX_INPUTLINE)
549 i= MAX_INPUTLINE - key_linepos - 1;
552 // terencehill: insert the clipboard text between the characters of the line
553 char *temp = (char *) Z_Malloc(MAX_INPUTLINE);
556 if ( key_linepos < (int)strlen(key_line) )
557 strlcpy(temp, key_line + key_linepos, (int)strlen(key_line) - key_linepos +1);
558 key_line[key_linepos] = 0;
559 strlcat(key_line, cbd, sizeof(key_line));
561 strlcat(key_line, temp, sizeof(key_line));
570 if (key == 'l' && keydown[K_CTRL])
572 Cbuf_AddText ("clear\n");
576 if (key == 'u' && keydown[K_CTRL]) // like vi/readline ^u: delete currently edited line
585 if (key == 'q' && keydown[K_CTRL]) // like zsh ^q: push line to history, don't execute, and clear
595 if (key == K_ENTER || key == K_KP_ENTER)
597 Cbuf_AddText (key_line+1); // skip the ]
601 key_line[1] = 0; // EvilTypeGuy: null terminate
603 // force an update, because the command may take some time
604 if (cls.state == ca_disconnected)
611 if(keydown[K_CTRL]) // append to the cvar its value
613 int cvar_len, cvar_str_len, chars_to_move;
615 char cvar[MAX_INPUTLINE];
616 const char *cvar_str;
618 // go to the start of the variable
621 k = key_line[key_linepos];
622 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
627 // save the variable name in cvar
628 for(cvar_len=0; (k = key_line[key_linepos + cvar_len]) != 0; cvar_len++)
630 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
638 // go to the end of the cvar
639 key_linepos += cvar_len;
641 // save the content of the variable in cvar_str
642 cvar_str = Cvar_VariableString(cvar);
643 cvar_str_len = strlen(cvar_str);
647 // insert space and cvar_str in key_line
648 chars_to_move = strlen(&key_line[key_linepos]);
649 if (key_linepos + 1 + cvar_str_len + chars_to_move < MAX_INPUTLINE)
652 memmove(&key_line[key_linepos + 1 + cvar_str_len], &key_line[key_linepos], chars_to_move);
653 key_line[key_linepos++] = ' ';
654 memcpy(&key_line[key_linepos], cvar_str, cvar_str_len);
655 key_linepos += cvar_str_len;
656 key_line[key_linepos + chars_to_move] = 0;
659 Con_Printf("Couldn't append cvar value, edit line too long.\n");
662 // Enhanced command completion
663 // by EvilTypeGuy eviltypeguy@qeradiant.com
664 // Thanks to Fett, Taniwha
665 Con_CompleteCommandLine();
669 // Advanced Console Editing by Radix radix@planetquake.com
670 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
672 // Enhanced by terencehill
674 // move cursor to the previous character
675 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
679 if(keydown[K_CTRL]) // move cursor to the previous word
685 if(pos) // skip all "; ' after the word
689 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
697 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
700 key_linepos = pos + 1;
702 else if(keydown[K_SHIFT]) // move cursor to the previous character ignoring colors
707 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && isdigit(key_line[pos]))
709 else if(pos-4 > 0 && key_line[pos-4] == STRING_COLOR_TAG && key_line[pos-3] == STRING_COLOR_RGB_TAG_CHAR
710 && isxdigit(key_line[pos-2]) && isxdigit(key_line[pos-1]) && isxdigit(key_line[pos]))
714 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && key_line[pos] == STRING_COLOR_TAG) // consider ^^ as a character
719 key_linepos = pos + 1;
726 // delete char before cursor
727 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
731 strlcpy(key_line + key_linepos - 1, key_line + key_linepos, sizeof(key_line) + 1 - key_linepos);
737 // delete char on cursor
738 if (key == K_DEL || key == K_KP_DEL)
741 linelen = strlen(key_line);
742 if (key_linepos < (int)linelen)
743 memmove(key_line + key_linepos, key_line + key_linepos + 1, linelen - key_linepos);
748 // move cursor to the next character
749 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
751 if (key_linepos >= (int)strlen(key_line))
753 if(keydown[K_CTRL]) // move cursor to the next word
757 len = (int)strlen(key_line);
763 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
767 if (pos < len) // skip all "; ' after the word
771 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
776 else if(keydown[K_SHIFT]) // move cursor to the next character ignoring colors
779 len = (int)strlen(key_line);
782 // go beyond all initial consecutive color tags, if any
784 while (key_line[pos] == STRING_COLOR_TAG)
786 if(isdigit(key_line[pos+1]))
788 else if(key_line[pos+1] == STRING_COLOR_RGB_TAG_CHAR && isxdigit(key_line[pos+2]) && isxdigit(key_line[pos+3]) && isxdigit(key_line[pos+4]))
795 if (key_line[pos] == STRING_COLOR_TAG && key_line[pos+1] == STRING_COLOR_TAG) // consider ^^ as a character
799 // now go beyond all next consecutive color tags, if any
801 while (key_line[pos] == STRING_COLOR_TAG)
803 if(isdigit(key_line[pos+1]))
805 else if(key_line[pos+1] == STRING_COLOR_RGB_TAG_CHAR && isxdigit(key_line[pos+2]) && isxdigit(key_line[pos+3]) && isxdigit(key_line[pos+4]))
817 if (key == K_INS || key == K_KP_INS) // toggle insert mode
823 // End Advanced Console Editing
825 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
831 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
836 // ~1.0795 = 82/76 using con_textsize 64 76 is height of the char, 6 is the distance between 2 lines
837 if (key == K_PGUP || key == K_KP_PGUP)
841 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
844 con_backscroll += ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
848 if (key == K_PGDN || key == K_KP_PGDN)
852 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
855 con_backscroll -= ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
859 if (key == K_MWHEELUP)
863 else if(keydown[K_SHIFT])
864 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
870 if (key == K_MWHEELDOWN)
874 else if(keydown[K_SHIFT])
875 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
884 if (key == '+' || key == K_KP_PLUS)
886 if (con_textsize.integer < 128)
887 Cvar_SetValueQuick(&con_textsize, con_textsize.integer + 1);
891 if (key == '-' || key == K_KP_MINUS)
893 if (con_textsize.integer > 1)
894 Cvar_SetValueQuick(&con_textsize, con_textsize.integer - 1);
898 if (key == '0' || key == K_KP_INS)
900 Cvar_SetValueQuick(&con_textsize, atoi(Cvar_VariableDefString("con_textsize")));
905 if (key == K_HOME || key == K_KP_HOME)
908 con_backscroll = INT_MAX;
914 if (key == K_END || key == K_KP_END)
919 key_linepos = (int)strlen(key_line);
927 if (key_linepos < MAX_INPUTLINE-1)
930 len = (int)strlen(&key_line[key_linepos]);
931 // check insert mode, or always insert if at end of line
932 if (key_insert || len == 0)
934 // can't use strcpy to move string to right
936 memmove(&key_line[key_linepos + 1], &key_line[key_linepos], len);
938 key_line[key_linepos] = ascii;
943 //============================================================================
946 char chat_buffer[MAX_INPUTLINE];
947 unsigned int chat_bufferlen = 0;
949 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
952 Key_Message (int key, int ascii)
955 if (key == K_ENTER || ascii == 10 || ascii == 13)
958 Cmd_ExecuteString(chat_buffer, src_command); // not Cbuf_AddText to allow semiclons in args; however, this allows no variables then. Use aliases!
960 Cmd_ForwardStringToServer(va("%s %s", chat_mode ? "say_team" : "say ", chat_buffer));
968 // TODO add support for arrow keys and simple editing
970 if (key == K_ESCAPE) {
977 if (key == K_BACKSPACE) {
978 if (chat_bufferlen) {
980 chat_buffer[chat_bufferlen] = 0;
986 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
990 if (chat_bufferlen == sizeof (chat_buffer) - 1)
994 return; // non printable
996 chat_buffer[chat_bufferlen++] = ascii;
997 chat_buffer[chat_bufferlen] = 0;
1000 //============================================================================
1005 Returns a key number to be used to index keybindings[] by looking at
1006 the given string. Single ascii characters return themselves, while
1007 the K_* names are matched up.
1011 Key_StringToKeynum (const char *str)
1013 const keyname_t *kn;
1015 if (!str || !str[0])
1018 return tolower(str[0]);
1020 for (kn = keynames; kn->name; kn++) {
1021 if (!strcasecmp (str, kn->name))
1029 Returns a string (either a single ascii char, or a K_* name) for the
1031 FIXME: handle quote special (general escape sequence?)
1035 Key_KeynumToString (int keynum)
1037 const keyname_t *kn;
1038 static char tinystr[2];
1040 // -1 is an invalid code
1042 return "<KEY NOT FOUND>";
1044 // search overrides first, because some characters are special
1045 for (kn = keynames; kn->name; kn++)
1046 if (keynum == kn->keynum)
1049 // if it is printable, output it as a single character
1050 if (keynum > 32 && keynum < 256)
1052 tinystr[0] = keynum;
1057 // if it is not overridden and not printable, we don't know what to do with it
1058 return "<UNKNOWN KEYNUM>";
1063 Key_SetBinding (int keynum, int bindmap, const char *binding)
1068 if (keynum == -1 || keynum >= MAX_KEYS)
1071 // free old bindings
1072 if (keybindings[bindmap][keynum]) {
1073 Z_Free (keybindings[bindmap][keynum]);
1074 keybindings[bindmap][keynum] = NULL;
1076 if(!binding[0]) // make "" binds be removed --blub
1078 // allocate memory for new binding
1079 l = strlen (binding);
1080 newbinding = (char *)Z_Malloc (l + 1);
1081 memcpy (newbinding, binding, l + 1);
1083 keybindings[bindmap][keynum] = newbinding;
1087 Key_In_Unbind_f (void)
1090 char *errchar = NULL;
1092 if (Cmd_Argc () != 3) {
1093 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
1097 m = strtol(Cmd_Argv (1), &errchar, 0);
1098 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1099 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1103 b = Key_StringToKeynum (Cmd_Argv (2));
1105 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1109 Key_SetBinding (b, m, "");
1113 Key_In_Bind_f (void)
1116 char cmd[MAX_INPUTLINE];
1117 char *errchar = NULL;
1121 if (c != 3 && c != 4) {
1122 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
1126 m = strtol(Cmd_Argv (1), &errchar, 0);
1127 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1128 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1132 b = Key_StringToKeynum (Cmd_Argv (2));
1133 if (b == -1 || b >= MAX_KEYS) {
1134 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1139 if (keybindings[m][b])
1140 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
1142 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
1145 // copy the rest of the command line
1146 cmd[0] = 0; // start out with a null string
1147 for (i = 3; i < c; i++) {
1148 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1150 strlcat (cmd, " ", sizeof (cmd));
1153 Key_SetBinding (b, m, cmd);
1157 Key_In_Bindmap_f (void)
1160 char *errchar = NULL;
1165 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
1169 m1 = strtol(Cmd_Argv (1), &errchar, 0);
1170 if ((m1 < 0) || (m1 >= 8) || (errchar && *errchar)) {
1171 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1175 m2 = strtol(Cmd_Argv (2), &errchar, 0);
1176 if ((m2 < 0) || (m2 >= 8) || (errchar && *errchar)) {
1177 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(2));
1190 if (Cmd_Argc () != 2) {
1191 Con_Print("unbind <key> : remove commands from a key\n");
1195 b = Key_StringToKeynum (Cmd_Argv (1));
1197 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1201 Key_SetBinding (b, 0, "");
1205 Key_Unbindall_f (void)
1209 for (j = 0; j < 8; j++)
1210 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1211 if (keybindings[j][i])
1212 Key_SetBinding (i, j, "");
1216 Key_PrintBindList(int j)
1218 char bindbuf[MAX_INPUTLINE];
1222 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1224 p = keybindings[j][i];
1227 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
1229 Con_Printf("^2%s ^7= \"%s\"\n", Key_KeynumToString (i), bindbuf);
1231 Con_Printf("^3bindmap %d: ^2%s ^7= \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1237 Key_In_BindList_f (void)
1240 char *errchar = NULL;
1244 m = strtol(Cmd_Argv(1), &errchar, 0);
1245 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1246 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1249 Key_PrintBindList(m);
1253 for (m = 0; m < MAX_BINDMAPS; m++)
1254 Key_PrintBindList(m);
1259 Key_BindList_f (void)
1261 Key_PrintBindList(0);
1268 char cmd[MAX_INPUTLINE];
1272 if (c != 2 && c != 3) {
1273 Con_Print("bind <key> [command] : attach a command to a key\n");
1276 b = Key_StringToKeynum (Cmd_Argv (1));
1277 if (b == -1 || b >= MAX_KEYS) {
1278 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1283 if (keybindings[0][b])
1284 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
1286 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
1289 // copy the rest of the command line
1290 cmd[0] = 0; // start out with a null string
1291 for (i = 2; i < c; i++) {
1292 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1294 strlcat (cmd, " ", sizeof (cmd));
1297 Key_SetBinding (b, 0, cmd);
1302 Writes lines containing "bind key value"
1306 Key_WriteBindings (qfile_t *f)
1309 char bindbuf[MAX_INPUTLINE];
1312 for (j = 0; j < MAX_BINDMAPS; j++)
1314 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1316 p = keybindings[j][i];
1319 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\"); // don't need to escape $ because cvars are not expanded inside bind
1321 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
1323 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1339 // register our functions
1341 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
1342 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
1343 Cmd_AddCommand ("in_bindlist", Key_In_BindList_f, "bindlist: displays bound keys for all bindmaps, or the given bindmap");
1344 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");
1346 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
1347 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
1348 Cmd_AddCommand ("bindlist", Key_BindList_f, "bindlist: displays bound keys for bindmap 0 bindmaps");
1349 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
1351 Cvar_RegisterVariable (&con_closeontoggleconsole);
1357 Key_History_Shutdown();
1360 const char *Key_GetBind (int key)
1363 if (key < 0 || key >= MAX_KEYS)
1365 bind = keybindings[key_bmap][key];
1367 bind = keybindings[key_bmap2][key];
1371 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
1375 Called by the system between frames for both key up and key down events
1376 Should NOT be called during an interrupt!
1379 static char tbl_keyascii[MAX_KEYS];
1380 static keydest_t tbl_keydest[MAX_KEYS];
1383 Key_Event (int key, int ascii, qboolean down)
1387 keydest_t keydest = key_dest;
1389 if (key < 0 || key >= MAX_KEYS)
1393 bind = keybindings[key_bmap][key];
1395 bind = keybindings[key_bmap2][key];
1397 if (developer.integer >= 1000)
1398 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
1400 if(key_consoleactive)
1401 keydest = key_console;
1405 // increment key repeat count each time a down is received so that things
1406 // which want to ignore key repeat can ignore it
1407 keydown[key] = min(keydown[key] + 1, 2);
1408 if(keydown[key] == 1) {
1409 tbl_keyascii[key] = ascii;
1410 tbl_keydest[key] = keydest;
1412 ascii = tbl_keyascii[key];
1413 keydest = tbl_keydest[key];
1418 // clear repeat count now that the key is released
1420 keydest = tbl_keydest[key];
1421 ascii = tbl_keyascii[key];
1424 if(keydest == key_void)
1427 // key_consoleactive is a flag not a key_dest because the console is a
1428 // high priority overlay ontop of the normal screen (designed as a safety
1429 // feature so that developers and users can rescue themselves from a bad
1432 // this also means that toggling the console on/off does not lose the old
1435 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
1436 // engine bindings, these are not handled as normal binds so that the user
1437 // can recover from a completely empty bindmap
1438 if (key == K_ESCAPE)
1440 // ignore key repeats on escape
1441 if (keydown[key] > 1)
1444 // escape does these things:
1445 // key_consoleactive - close console
1446 // key_message - abort messagemode
1447 // key_menu - go to parent menu (or key_game)
1448 // key_game - open menu
1450 // in all modes shift-escape toggles console
1451 if (keydown[K_SHIFT])
1455 Con_ToggleConsole_f ();
1456 tbl_keydest[key] = key_void; // esc release should go nowhere (especially not to key_menu or key_game)
1466 if(key_consoleactive & KEY_CONSOLEACTIVE_FORCED)
1468 key_consoleactive &= ~KEY_CONSOLEACTIVE_USER;
1472 Con_ToggleConsole_f();
1478 Key_Message (key, ascii); // that'll close the message input
1482 case key_menu_grabbed:
1483 MR_KeyEvent (key, ascii, down);
1487 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
1488 q = CL_VM_InputEvent(down, key, ascii);
1494 Con_Printf ("Key_Event: Bad key_dest\n");
1499 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
1500 if (keydest != key_menu_grabbed)
1501 if (key >= K_F1 && key <= K_F12)
1505 if(keydown[key] == 1 && down)
1507 // button commands add keynum as a parm
1509 Cbuf_AddText (va("%s %i\n", bind, key));
1512 Cbuf_AddText (bind);
1513 Cbuf_AddText ("\n");
1515 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1516 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1521 // send input to console if it wants it
1522 if (keydest == key_console)
1526 // con_closeontoggleconsole enables toggleconsole keys to close the
1527 // console, as long as they are not the color prefix character
1528 // (special exemption for german keyboard layouts)
1529 if (con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && (key_consoleactive & KEY_CONSOLEACTIVE_USER) && ascii != STRING_COLOR_TAG)
1531 Con_ToggleConsole_f ();
1534 Key_Console (key, ascii);
1538 // handle toggleconsole in menu too
1539 if (keydest == key_menu)
1541 if (down && con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && ascii != STRING_COLOR_TAG)
1543 Con_ToggleConsole_f ();
1544 tbl_keydest[key] = key_void; // key release should go nowhere (especially not to key_menu or key_game)
1549 // ignore binds while a video is played, let the video system handle the key event
1550 if (cl_videoplaying)
1552 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1556 // anything else is a key press into the game, chat line, or menu
1561 Key_Message (key, ascii);
1564 case key_menu_grabbed:
1565 MR_KeyEvent (key, ascii, down);
1568 q = CL_VM_InputEvent(down, key, ascii);
1569 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1572 if(keydown[key] == 1 && down)
1574 // button commands add keynum as a parm
1576 Cbuf_AddText (va("%s %i\n", bind, key));
1579 Cbuf_AddText (bind);
1580 Cbuf_AddText ("\n");
1582 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1583 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1587 Con_Printf ("Key_Event: Bad key_dest\n");
1597 Key_ClearStates (void)
1599 memset(keydown, 0, sizeof(keydown));