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},
235 {"PRINTSCREEN", K_PRINTSCREEN},
239 {"MOUSE1", K_MOUSE1},
241 {"MOUSE2", K_MOUSE2},
242 {"MOUSE3", K_MOUSE3},
243 {"MWHEELUP", K_MWHEELUP},
244 {"MWHEELDOWN", K_MWHEELDOWN},
245 {"MOUSE4", K_MOUSE4},
246 {"MOUSE5", K_MOUSE5},
247 {"MOUSE6", K_MOUSE6},
248 {"MOUSE7", K_MOUSE7},
249 {"MOUSE8", K_MOUSE8},
250 {"MOUSE9", K_MOUSE9},
251 {"MOUSE10", K_MOUSE10},
252 {"MOUSE11", K_MOUSE11},
253 {"MOUSE12", K_MOUSE12},
254 {"MOUSE13", K_MOUSE13},
255 {"MOUSE14", K_MOUSE14},
256 {"MOUSE15", K_MOUSE15},
257 {"MOUSE16", K_MOUSE16},
317 {"SEMICOLON", ';'}, // because a raw semicolon separates commands
321 {"APOSTROPHE", '\''},
322 {"BACKSLASH", '\\'}, // because a raw backslash is used for special characters
324 {"MIDINOTE0", K_MIDINOTE0},
325 {"MIDINOTE1", K_MIDINOTE1},
326 {"MIDINOTE2", K_MIDINOTE2},
327 {"MIDINOTE3", K_MIDINOTE3},
328 {"MIDINOTE4", K_MIDINOTE4},
329 {"MIDINOTE5", K_MIDINOTE5},
330 {"MIDINOTE6", K_MIDINOTE6},
331 {"MIDINOTE7", K_MIDINOTE7},
332 {"MIDINOTE8", K_MIDINOTE8},
333 {"MIDINOTE9", K_MIDINOTE9},
334 {"MIDINOTE10", K_MIDINOTE10},
335 {"MIDINOTE11", K_MIDINOTE11},
336 {"MIDINOTE12", K_MIDINOTE12},
337 {"MIDINOTE13", K_MIDINOTE13},
338 {"MIDINOTE14", K_MIDINOTE14},
339 {"MIDINOTE15", K_MIDINOTE15},
340 {"MIDINOTE16", K_MIDINOTE16},
341 {"MIDINOTE17", K_MIDINOTE17},
342 {"MIDINOTE18", K_MIDINOTE18},
343 {"MIDINOTE19", K_MIDINOTE19},
344 {"MIDINOTE20", K_MIDINOTE20},
345 {"MIDINOTE21", K_MIDINOTE21},
346 {"MIDINOTE22", K_MIDINOTE22},
347 {"MIDINOTE23", K_MIDINOTE23},
348 {"MIDINOTE24", K_MIDINOTE24},
349 {"MIDINOTE25", K_MIDINOTE25},
350 {"MIDINOTE26", K_MIDINOTE26},
351 {"MIDINOTE27", K_MIDINOTE27},
352 {"MIDINOTE28", K_MIDINOTE28},
353 {"MIDINOTE29", K_MIDINOTE29},
354 {"MIDINOTE30", K_MIDINOTE30},
355 {"MIDINOTE31", K_MIDINOTE31},
356 {"MIDINOTE32", K_MIDINOTE32},
357 {"MIDINOTE33", K_MIDINOTE33},
358 {"MIDINOTE34", K_MIDINOTE34},
359 {"MIDINOTE35", K_MIDINOTE35},
360 {"MIDINOTE36", K_MIDINOTE36},
361 {"MIDINOTE37", K_MIDINOTE37},
362 {"MIDINOTE38", K_MIDINOTE38},
363 {"MIDINOTE39", K_MIDINOTE39},
364 {"MIDINOTE40", K_MIDINOTE40},
365 {"MIDINOTE41", K_MIDINOTE41},
366 {"MIDINOTE42", K_MIDINOTE42},
367 {"MIDINOTE43", K_MIDINOTE43},
368 {"MIDINOTE44", K_MIDINOTE44},
369 {"MIDINOTE45", K_MIDINOTE45},
370 {"MIDINOTE46", K_MIDINOTE46},
371 {"MIDINOTE47", K_MIDINOTE47},
372 {"MIDINOTE48", K_MIDINOTE48},
373 {"MIDINOTE49", K_MIDINOTE49},
374 {"MIDINOTE50", K_MIDINOTE50},
375 {"MIDINOTE51", K_MIDINOTE51},
376 {"MIDINOTE52", K_MIDINOTE52},
377 {"MIDINOTE53", K_MIDINOTE53},
378 {"MIDINOTE54", K_MIDINOTE54},
379 {"MIDINOTE55", K_MIDINOTE55},
380 {"MIDINOTE56", K_MIDINOTE56},
381 {"MIDINOTE57", K_MIDINOTE57},
382 {"MIDINOTE58", K_MIDINOTE58},
383 {"MIDINOTE59", K_MIDINOTE59},
384 {"MIDINOTE60", K_MIDINOTE60},
385 {"MIDINOTE61", K_MIDINOTE61},
386 {"MIDINOTE62", K_MIDINOTE62},
387 {"MIDINOTE63", K_MIDINOTE63},
388 {"MIDINOTE64", K_MIDINOTE64},
389 {"MIDINOTE65", K_MIDINOTE65},
390 {"MIDINOTE66", K_MIDINOTE66},
391 {"MIDINOTE67", K_MIDINOTE67},
392 {"MIDINOTE68", K_MIDINOTE68},
393 {"MIDINOTE69", K_MIDINOTE69},
394 {"MIDINOTE70", K_MIDINOTE70},
395 {"MIDINOTE71", K_MIDINOTE71},
396 {"MIDINOTE72", K_MIDINOTE72},
397 {"MIDINOTE73", K_MIDINOTE73},
398 {"MIDINOTE74", K_MIDINOTE74},
399 {"MIDINOTE75", K_MIDINOTE75},
400 {"MIDINOTE76", K_MIDINOTE76},
401 {"MIDINOTE77", K_MIDINOTE77},
402 {"MIDINOTE78", K_MIDINOTE78},
403 {"MIDINOTE79", K_MIDINOTE79},
404 {"MIDINOTE80", K_MIDINOTE80},
405 {"MIDINOTE81", K_MIDINOTE81},
406 {"MIDINOTE82", K_MIDINOTE82},
407 {"MIDINOTE83", K_MIDINOTE83},
408 {"MIDINOTE84", K_MIDINOTE84},
409 {"MIDINOTE85", K_MIDINOTE85},
410 {"MIDINOTE86", K_MIDINOTE86},
411 {"MIDINOTE87", K_MIDINOTE87},
412 {"MIDINOTE88", K_MIDINOTE88},
413 {"MIDINOTE89", K_MIDINOTE89},
414 {"MIDINOTE90", K_MIDINOTE90},
415 {"MIDINOTE91", K_MIDINOTE91},
416 {"MIDINOTE92", K_MIDINOTE92},
417 {"MIDINOTE93", K_MIDINOTE93},
418 {"MIDINOTE94", K_MIDINOTE94},
419 {"MIDINOTE95", K_MIDINOTE95},
420 {"MIDINOTE96", K_MIDINOTE96},
421 {"MIDINOTE97", K_MIDINOTE97},
422 {"MIDINOTE98", K_MIDINOTE98},
423 {"MIDINOTE99", K_MIDINOTE99},
424 {"MIDINOTE100", K_MIDINOTE100},
425 {"MIDINOTE101", K_MIDINOTE101},
426 {"MIDINOTE102", K_MIDINOTE102},
427 {"MIDINOTE103", K_MIDINOTE103},
428 {"MIDINOTE104", K_MIDINOTE104},
429 {"MIDINOTE105", K_MIDINOTE105},
430 {"MIDINOTE106", K_MIDINOTE106},
431 {"MIDINOTE107", K_MIDINOTE107},
432 {"MIDINOTE108", K_MIDINOTE108},
433 {"MIDINOTE109", K_MIDINOTE109},
434 {"MIDINOTE110", K_MIDINOTE110},
435 {"MIDINOTE111", K_MIDINOTE111},
436 {"MIDINOTE112", K_MIDINOTE112},
437 {"MIDINOTE113", K_MIDINOTE113},
438 {"MIDINOTE114", K_MIDINOTE114},
439 {"MIDINOTE115", K_MIDINOTE115},
440 {"MIDINOTE116", K_MIDINOTE116},
441 {"MIDINOTE117", K_MIDINOTE117},
442 {"MIDINOTE118", K_MIDINOTE118},
443 {"MIDINOTE119", K_MIDINOTE119},
444 {"MIDINOTE120", K_MIDINOTE120},
445 {"MIDINOTE121", K_MIDINOTE121},
446 {"MIDINOTE122", K_MIDINOTE122},
447 {"MIDINOTE123", K_MIDINOTE123},
448 {"MIDINOTE124", K_MIDINOTE124},
449 {"MIDINOTE125", K_MIDINOTE125},
450 {"MIDINOTE126", K_MIDINOTE126},
451 {"MIDINOTE127", K_MIDINOTE127},
457 ==============================================================================
459 LINE TYPING INTO THE CONSOLE
461 ==============================================================================
465 Key_ClearEditLine (int edit_line)
467 memset (key_line, '\0', sizeof(key_line));
474 Interactive line editing and console scrollback
478 Key_Console (int key, int ascii)
480 // LordHavoc: copied most of this from Q2 to improve keyboard handling
507 case K_KP_RIGHTARROW:
527 if ((key == 'v' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
530 if ((cbd = Sys_GetClipboardData()) != 0)
537 if (*p == '\r' && *(p+1) == '\n')
542 else if (*p == '\n' || *p == '\r' || *p == '\b')
547 strtok(cbd, "\n\r\b");
549 i = (int)strlen(cbd);
550 if (i + key_linepos >= MAX_INPUTLINE)
551 i= MAX_INPUTLINE - key_linepos - 1;
554 // terencehill: insert the clipboard text between the characters of the line
555 char *temp = (char *) Z_Malloc(MAX_INPUTLINE);
558 if ( key_linepos < (int)strlen(key_line) )
559 strlcpy(temp, key_line + key_linepos, (int)strlen(key_line) - key_linepos +1);
560 key_line[key_linepos] = 0;
561 strlcat(key_line, cbd, sizeof(key_line));
563 strlcat(key_line, temp, sizeof(key_line));
572 if (key == 'l' && keydown[K_CTRL])
574 Cbuf_AddText ("clear\n");
578 if (key == 'u' && keydown[K_CTRL]) // like vi/readline ^u: delete currently edited line
587 if (key == 'q' && keydown[K_CTRL]) // like zsh ^q: push line to history, don't execute, and clear
597 if (key == K_ENTER || key == K_KP_ENTER)
599 Cbuf_AddText (key_line+1); // skip the ]
603 key_line[1] = 0; // EvilTypeGuy: null terminate
605 // force an update, because the command may take some time
606 if (cls.state == ca_disconnected)
613 if(keydown[K_CTRL]) // append to the cvar its value
615 int cvar_len, cvar_str_len, chars_to_move;
617 char cvar[MAX_INPUTLINE];
618 const char *cvar_str;
620 // go to the start of the variable
623 k = key_line[key_linepos];
624 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
629 // save the variable name in cvar
630 for(cvar_len=0; (k = key_line[key_linepos + cvar_len]) != 0; cvar_len++)
632 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
640 // go to the end of the cvar
641 key_linepos += cvar_len;
643 // save the content of the variable in cvar_str
644 cvar_str = Cvar_VariableString(cvar);
645 cvar_str_len = strlen(cvar_str);
649 // insert space and cvar_str in key_line
650 chars_to_move = strlen(&key_line[key_linepos]);
651 if (key_linepos + 1 + cvar_str_len + chars_to_move < MAX_INPUTLINE)
654 memmove(&key_line[key_linepos + 1 + cvar_str_len], &key_line[key_linepos], chars_to_move);
655 key_line[key_linepos++] = ' ';
656 memcpy(&key_line[key_linepos], cvar_str, cvar_str_len);
657 key_linepos += cvar_str_len;
658 key_line[key_linepos + chars_to_move] = 0;
661 Con_Printf("Couldn't append cvar value, edit line too long.\n");
664 // Enhanced command completion
665 // by EvilTypeGuy eviltypeguy@qeradiant.com
666 // Thanks to Fett, Taniwha
667 Con_CompleteCommandLine();
671 // Advanced Console Editing by Radix radix@planetquake.com
672 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
674 // Enhanced by terencehill
676 // move cursor to the previous character
677 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
681 if(keydown[K_CTRL]) // move cursor to the previous word
687 if(pos) // skip all "; ' after the word
691 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
699 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
702 key_linepos = pos + 1;
704 else if(keydown[K_SHIFT]) // move cursor to the previous character ignoring colors
709 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && isdigit(key_line[pos]))
711 else if(pos-4 > 0 && key_line[pos-4] == STRING_COLOR_TAG && key_line[pos-3] == STRING_COLOR_RGB_TAG_CHAR
712 && isxdigit(key_line[pos-2]) && isxdigit(key_line[pos-1]) && isxdigit(key_line[pos]))
716 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && key_line[pos] == STRING_COLOR_TAG) // consider ^^ as a character
721 key_linepos = pos + 1;
728 // delete char before cursor
729 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
733 strlcpy(key_line + key_linepos - 1, key_line + key_linepos, sizeof(key_line) + 1 - key_linepos);
739 // delete char on cursor
740 if (key == K_DEL || key == K_KP_DEL)
743 linelen = strlen(key_line);
744 if (key_linepos < (int)linelen)
745 memmove(key_line + key_linepos, key_line + key_linepos + 1, linelen - key_linepos);
750 // move cursor to the next character
751 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
753 if (key_linepos >= (int)strlen(key_line))
755 if(keydown[K_CTRL]) // move cursor to the next word
759 len = (int)strlen(key_line);
765 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
769 if (pos < len) // skip all "; ' after the word
773 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
778 else if(keydown[K_SHIFT]) // move cursor to the next character ignoring colors
781 len = (int)strlen(key_line);
784 // go beyond all initial consecutive color tags, if any
786 while (key_line[pos] == STRING_COLOR_TAG)
788 if(isdigit(key_line[pos+1]))
790 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]))
797 if (key_line[pos] == STRING_COLOR_TAG && key_line[pos+1] == STRING_COLOR_TAG) // consider ^^ as a character
801 // now go beyond all next consecutive color tags, if any
803 while (key_line[pos] == STRING_COLOR_TAG)
805 if(isdigit(key_line[pos+1]))
807 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]))
819 if (key == K_INS || key == K_KP_INS) // toggle insert mode
825 // End Advanced Console Editing
827 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
833 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
838 // ~1.0795 = 82/76 using con_textsize 64 76 is height of the char, 6 is the distance between 2 lines
839 if (key == K_PGUP || key == K_KP_PGUP)
843 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
846 con_backscroll += ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
850 if (key == K_PGDN || key == K_KP_PGDN)
854 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
857 con_backscroll -= ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
861 if (key == K_MWHEELUP)
865 else if(keydown[K_SHIFT])
866 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
872 if (key == K_MWHEELDOWN)
876 else if(keydown[K_SHIFT])
877 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
886 if (key == '+' || key == K_KP_PLUS)
888 if (con_textsize.integer < 128)
889 Cvar_SetValueQuick(&con_textsize, con_textsize.integer + 1);
893 if (key == '-' || key == K_KP_MINUS)
895 if (con_textsize.integer > 1)
896 Cvar_SetValueQuick(&con_textsize, con_textsize.integer - 1);
900 if (key == '0' || key == K_KP_INS)
902 Cvar_SetValueQuick(&con_textsize, atoi(Cvar_VariableDefString("con_textsize")));
907 if (key == K_HOME || key == K_KP_HOME)
910 con_backscroll = INT_MAX;
916 if (key == K_END || key == K_KP_END)
921 key_linepos = (int)strlen(key_line);
929 if (key_linepos < MAX_INPUTLINE-1)
932 len = (int)strlen(&key_line[key_linepos]);
933 // check insert mode, or always insert if at end of line
934 if (key_insert || len == 0)
936 // can't use strcpy to move string to right
938 memmove(&key_line[key_linepos + 1], &key_line[key_linepos], len);
940 key_line[key_linepos] = ascii;
945 //============================================================================
948 char chat_buffer[MAX_INPUTLINE];
949 unsigned int chat_bufferlen = 0;
951 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
954 Key_Message (int key, int ascii)
957 if (key == K_ENTER || ascii == 10 || ascii == 13)
960 Cmd_ExecuteString(chat_buffer, src_command); // not Cbuf_AddText to allow semiclons in args; however, this allows no variables then. Use aliases!
962 Cmd_ForwardStringToServer(va("%s %s", chat_mode ? "say_team" : "say ", chat_buffer));
970 // TODO add support for arrow keys and simple editing
972 if (key == K_ESCAPE) {
979 if (key == K_BACKSPACE) {
980 if (chat_bufferlen) {
982 chat_buffer[chat_bufferlen] = 0;
988 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
992 if (chat_bufferlen == sizeof (chat_buffer) - 1)
996 return; // non printable
998 chat_buffer[chat_bufferlen++] = ascii;
999 chat_buffer[chat_bufferlen] = 0;
1002 //============================================================================
1007 Returns a key number to be used to index keybindings[] by looking at
1008 the given string. Single ascii characters return themselves, while
1009 the K_* names are matched up.
1013 Key_StringToKeynum (const char *str)
1015 const keyname_t *kn;
1017 if (!str || !str[0])
1020 return tolower(str[0]);
1022 for (kn = keynames; kn->name; kn++) {
1023 if (!strcasecmp (str, kn->name))
1031 Returns a string (either a single ascii char, or a K_* name) for the
1033 FIXME: handle quote special (general escape sequence?)
1037 Key_KeynumToString (int keynum)
1039 const keyname_t *kn;
1040 static char tinystr[2];
1042 // -1 is an invalid code
1044 return "<KEY NOT FOUND>";
1046 // search overrides first, because some characters are special
1047 for (kn = keynames; kn->name; kn++)
1048 if (keynum == kn->keynum)
1051 // if it is printable, output it as a single character
1052 if (keynum > 32 && keynum < 256)
1054 tinystr[0] = keynum;
1059 // if it is not overridden and not printable, we don't know what to do with it
1060 return "<UNKNOWN KEYNUM>";
1065 Key_SetBinding (int keynum, int bindmap, const char *binding)
1070 if (keynum == -1 || keynum >= MAX_KEYS)
1073 // free old bindings
1074 if (keybindings[bindmap][keynum]) {
1075 Z_Free (keybindings[bindmap][keynum]);
1076 keybindings[bindmap][keynum] = NULL;
1078 if(!binding[0]) // make "" binds be removed --blub
1080 // allocate memory for new binding
1081 l = strlen (binding);
1082 newbinding = (char *)Z_Malloc (l + 1);
1083 memcpy (newbinding, binding, l + 1);
1085 keybindings[bindmap][keynum] = newbinding;
1089 Key_In_Unbind_f (void)
1092 char *errchar = NULL;
1094 if (Cmd_Argc () != 3) {
1095 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
1099 m = strtol(Cmd_Argv (1), &errchar, 0);
1100 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1101 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1105 b = Key_StringToKeynum (Cmd_Argv (2));
1107 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1111 Key_SetBinding (b, m, "");
1115 Key_In_Bind_f (void)
1118 char cmd[MAX_INPUTLINE];
1119 char *errchar = NULL;
1123 if (c != 3 && c != 4) {
1124 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
1128 m = strtol(Cmd_Argv (1), &errchar, 0);
1129 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1130 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1134 b = Key_StringToKeynum (Cmd_Argv (2));
1135 if (b == -1 || b >= MAX_KEYS) {
1136 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1141 if (keybindings[m][b])
1142 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
1144 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
1147 // copy the rest of the command line
1148 cmd[0] = 0; // start out with a null string
1149 for (i = 3; i < c; i++) {
1150 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1152 strlcat (cmd, " ", sizeof (cmd));
1155 Key_SetBinding (b, m, cmd);
1159 Key_In_Bindmap_f (void)
1162 char *errchar = NULL;
1167 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
1171 m1 = strtol(Cmd_Argv (1), &errchar, 0);
1172 if ((m1 < 0) || (m1 >= 8) || (errchar && *errchar)) {
1173 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1177 m2 = strtol(Cmd_Argv (2), &errchar, 0);
1178 if ((m2 < 0) || (m2 >= 8) || (errchar && *errchar)) {
1179 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(2));
1192 if (Cmd_Argc () != 2) {
1193 Con_Print("unbind <key> : remove commands from a key\n");
1197 b = Key_StringToKeynum (Cmd_Argv (1));
1199 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1203 Key_SetBinding (b, 0, "");
1207 Key_Unbindall_f (void)
1211 for (j = 0; j < 8; j++)
1212 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1213 if (keybindings[j][i])
1214 Key_SetBinding (i, j, "");
1218 Key_PrintBindList(int j)
1220 char bindbuf[MAX_INPUTLINE];
1224 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1226 p = keybindings[j][i];
1229 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
1231 Con_Printf("^2%s ^7= \"%s\"\n", Key_KeynumToString (i), bindbuf);
1233 Con_Printf("^3bindmap %d: ^2%s ^7= \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1239 Key_In_BindList_f (void)
1242 char *errchar = NULL;
1246 m = strtol(Cmd_Argv(1), &errchar, 0);
1247 if ((m < 0) || (m >= 8) || (errchar && *errchar)) {
1248 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1251 Key_PrintBindList(m);
1255 for (m = 0; m < MAX_BINDMAPS; m++)
1256 Key_PrintBindList(m);
1261 Key_BindList_f (void)
1263 Key_PrintBindList(0);
1270 char cmd[MAX_INPUTLINE];
1274 if (c != 2 && c != 3) {
1275 Con_Print("bind <key> [command] : attach a command to a key\n");
1278 b = Key_StringToKeynum (Cmd_Argv (1));
1279 if (b == -1 || b >= MAX_KEYS) {
1280 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1285 if (keybindings[0][b])
1286 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
1288 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
1291 // copy the rest of the command line
1292 cmd[0] = 0; // start out with a null string
1293 for (i = 2; i < c; i++) {
1294 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1296 strlcat (cmd, " ", sizeof (cmd));
1299 Key_SetBinding (b, 0, cmd);
1304 Writes lines containing "bind key value"
1308 Key_WriteBindings (qfile_t *f)
1311 char bindbuf[MAX_INPUTLINE];
1314 for (j = 0; j < MAX_BINDMAPS; j++)
1316 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1318 p = keybindings[j][i];
1321 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\"); // don't need to escape $ because cvars are not expanded inside bind
1323 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
1325 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1341 // register our functions
1343 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
1344 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
1345 Cmd_AddCommand ("in_bindlist", Key_In_BindList_f, "bindlist: displays bound keys for all bindmaps, or the given bindmap");
1346 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");
1348 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
1349 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
1350 Cmd_AddCommand ("bindlist", Key_BindList_f, "bindlist: displays bound keys for bindmap 0 bindmaps");
1351 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
1353 Cvar_RegisterVariable (&con_closeontoggleconsole);
1359 Key_History_Shutdown();
1362 const char *Key_GetBind (int key)
1365 if (key < 0 || key >= MAX_KEYS)
1367 bind = keybindings[key_bmap][key];
1369 bind = keybindings[key_bmap2][key];
1373 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
1377 Called by the system between frames for both key up and key down events
1378 Should NOT be called during an interrupt!
1381 static char tbl_keyascii[MAX_KEYS];
1382 static keydest_t tbl_keydest[MAX_KEYS];
1385 Key_Event (int key, int ascii, qboolean down)
1389 keydest_t keydest = key_dest;
1391 if (key < 0 || key >= MAX_KEYS)
1395 bind = keybindings[key_bmap][key];
1397 bind = keybindings[key_bmap2][key];
1399 if (developer.integer >= 1000)
1400 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
1402 if(key_consoleactive)
1403 keydest = key_console;
1407 // increment key repeat count each time a down is received so that things
1408 // which want to ignore key repeat can ignore it
1409 keydown[key] = min(keydown[key] + 1, 2);
1410 if(keydown[key] == 1) {
1411 tbl_keyascii[key] = ascii;
1412 tbl_keydest[key] = keydest;
1414 ascii = tbl_keyascii[key];
1415 keydest = tbl_keydest[key];
1420 // clear repeat count now that the key is released
1422 keydest = tbl_keydest[key];
1423 ascii = tbl_keyascii[key];
1426 if(keydest == key_void)
1429 // key_consoleactive is a flag not a key_dest because the console is a
1430 // high priority overlay ontop of the normal screen (designed as a safety
1431 // feature so that developers and users can rescue themselves from a bad
1434 // this also means that toggling the console on/off does not lose the old
1437 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
1438 // engine bindings, these are not handled as normal binds so that the user
1439 // can recover from a completely empty bindmap
1440 if (key == K_ESCAPE)
1442 // ignore key repeats on escape
1443 if (keydown[key] > 1)
1446 // escape does these things:
1447 // key_consoleactive - close console
1448 // key_message - abort messagemode
1449 // key_menu - go to parent menu (or key_game)
1450 // key_game - open menu
1452 // in all modes shift-escape toggles console
1453 if (keydown[K_SHIFT])
1457 Con_ToggleConsole_f ();
1458 tbl_keydest[key] = key_void; // esc release should go nowhere (especially not to key_menu or key_game)
1468 if(key_consoleactive & KEY_CONSOLEACTIVE_FORCED)
1470 key_consoleactive &= ~KEY_CONSOLEACTIVE_USER;
1474 Con_ToggleConsole_f();
1480 Key_Message (key, ascii); // that'll close the message input
1484 case key_menu_grabbed:
1485 MR_KeyEvent (key, ascii, down);
1489 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
1490 q = CL_VM_InputEvent(down, key, ascii);
1496 Con_Printf ("Key_Event: Bad key_dest\n");
1501 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
1502 if (keydest != key_menu_grabbed)
1503 if (key >= K_F1 && key <= K_F12)
1507 if(keydown[key] == 1 && down)
1509 // button commands add keynum as a parm
1511 Cbuf_AddText (va("%s %i\n", bind, key));
1514 Cbuf_AddText (bind);
1515 Cbuf_AddText ("\n");
1517 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1518 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1523 // send input to console if it wants it
1524 if (keydest == key_console)
1528 // con_closeontoggleconsole enables toggleconsole keys to close the
1529 // console, as long as they are not the color prefix character
1530 // (special exemption for german keyboard layouts)
1531 if (con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && (key_consoleactive & KEY_CONSOLEACTIVE_USER) && ascii != STRING_COLOR_TAG)
1533 Con_ToggleConsole_f ();
1536 Key_Console (key, ascii);
1540 // handle toggleconsole in menu too
1541 if (keydest == key_menu)
1543 if (down && con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && ascii != STRING_COLOR_TAG)
1545 Con_ToggleConsole_f ();
1546 tbl_keydest[key] = key_void; // key release should go nowhere (especially not to key_menu or key_game)
1551 // ignore binds while a video is played, let the video system handle the key event
1552 if (cl_videoplaying)
1554 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1558 // anything else is a key press into the game, chat line, or menu
1563 Key_Message (key, ascii);
1566 case key_menu_grabbed:
1567 MR_KeyEvent (key, ascii, down);
1570 q = CL_VM_InputEvent(down, key, ascii);
1571 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1574 if(keydown[key] == 1 && down)
1576 // button commands add keynum as a parm
1578 Cbuf_AddText (va("%s %i\n", bind, key));
1581 Cbuf_AddText (bind);
1582 Cbuf_AddText ("\n");
1584 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1585 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1589 Con_Printf ("Key_Event: Bad key_dest\n");
1599 Key_ClearStates (void)
1601 memset(keydown, 0, sizeof(keydown));