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
27 cvar_t con_closeontoggleconsole = {CVAR_SAVE, "con_closeontoggleconsole","1", "allows toggleconsole binds to close the console as well"};
30 key up events are sent even if in console mode
33 char key_line[MAX_INPUTLINE];
35 qboolean key_insert = true; // insert key toggle (for editing)
37 int key_consoleactive;
38 char *keybindings[MAX_BINDMAPS][MAX_KEYS];
40 char history_savedline[MAX_INPUTLINE];
43 extern cvar_t con_textsize;
46 static void Key_History_Init(void)
49 ConBuffer_Init(&history, HIST_TEXTSIZE, HIST_MAXLINES, zonemempool);
51 historyfile = FS_OpenRealFile("darkplaces_history.txt", "rb", false); // rb to handle unix line endings on windows too
54 char buf[MAX_INPUTLINE];
61 c = FS_Getc(historyfile);
62 if(c < 0 || c == 0 || c == '\r' || c == '\n')
67 ConBuffer_AddLine(&history, buf, bufpos, 0);
75 if(bufpos < MAX_INPUTLINE - 1)
80 FS_Close(historyfile);
86 static void Key_History_Shutdown(void)
88 // TODO write history to a file
90 qfile_t *historyfile = FS_OpenRealFile("darkplaces_history.txt", "w", false);
94 for(i = 0; i < CONBUFFER_LINES_COUNT(&history); ++i)
95 FS_Printf(historyfile, "%s\n", ConBuffer_GetLine(&history, i));
96 FS_Close(historyfile);
99 ConBuffer_Shutdown(&history);
102 static void Key_History_Push(void)
104 if(key_line[1]) // empty?
105 if(strcmp(key_line, "]quit")) // putting these into the history just sucks
106 if(strncmp(key_line, "]quit ", 6)) // putting these into the history just sucks
107 ConBuffer_AddLine(&history, key_line + 1, strlen(key_line) - 1, 0);
108 Con_Printf("%s\n", key_line); // don't mark empty lines as history
112 static void Key_History_Up(void)
114 if(history_line == -1) // editing the "new" line
115 strlcpy(history_savedline, key_line + 1, sizeof(history_savedline));
117 if(history_line == -1)
119 history_line = CONBUFFER_LINES_COUNT(&history) - 1;
120 if(history_line != -1)
122 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
123 key_linepos = strlen(key_line);
126 else if(history_line > 0)
128 --history_line; // this also does -1 -> 0, so it is good
129 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
130 key_linepos = strlen(key_line);
134 static void Key_History_Down(void)
136 if(history_line == -1) // editing the "new" line
139 if(history_line < CONBUFFER_LINES_COUNT(&history) - 1)
142 strlcpy(key_line + 1, ConBuffer_GetLine(&history, history_line), sizeof(key_line) - 1);
147 strlcpy(key_line + 1, history_savedline, sizeof(key_line) - 1);
150 key_linepos = strlen(key_line);
153 static int key_bmap, key_bmap2;
154 static unsigned char keydown[MAX_KEYS]; // 0 = up, 1 = down, 2 = repeating
156 typedef struct keyname_s
163 static const keyname_t keynames[] = {
166 {"ESCAPE", K_ESCAPE},
169 // spacer so it lines up with keys.h
171 {"BACKSPACE", K_BACKSPACE},
172 {"UPARROW", K_UPARROW},
173 {"DOWNARROW", K_DOWNARROW},
174 {"LEFTARROW", K_LEFTARROW},
175 {"RIGHTARROW", K_RIGHTARROW},
203 {"NUMLOCK", K_NUMLOCK},
204 {"CAPSLOCK", K_CAPSLOCK},
205 {"SCROLLOCK", K_SCROLLOCK},
207 {"KP_INS", K_KP_INS },
209 {"KP_END", K_KP_END },
211 {"KP_DOWNARROW", K_KP_DOWNARROW },
213 {"KP_PGDN", K_KP_PGDN },
215 {"KP_LEFTARROW", K_KP_LEFTARROW },
218 {"KP_RIGHTARROW", K_KP_RIGHTARROW },
220 {"KP_HOME", K_KP_HOME },
222 {"KP_UPARROW", K_KP_UPARROW },
224 {"KP_PGUP", K_KP_PGUP },
226 {"KP_DEL", K_KP_DEL },
227 {"KP_PERIOD", K_KP_PERIOD},
228 {"KP_SLASH", K_KP_SLASH },
229 {"KP_DIVIDE", K_KP_DIVIDE},
230 {"KP_MULTIPLY", K_KP_MULTIPLY},
231 {"KP_MINUS", K_KP_MINUS},
232 {"KP_PLUS", K_KP_PLUS},
233 {"KP_ENTER", K_KP_ENTER},
234 {"KP_EQUALS", K_KP_EQUALS},
236 {"PRINTSCREEN", K_PRINTSCREEN},
240 {"MOUSE1", K_MOUSE1},
242 {"MOUSE2", K_MOUSE2},
243 {"MOUSE3", K_MOUSE3},
244 {"MWHEELUP", K_MWHEELUP},
245 {"MWHEELDOWN", K_MWHEELDOWN},
246 {"MOUSE4", K_MOUSE4},
247 {"MOUSE5", K_MOUSE5},
248 {"MOUSE6", K_MOUSE6},
249 {"MOUSE7", K_MOUSE7},
250 {"MOUSE8", K_MOUSE8},
251 {"MOUSE9", K_MOUSE9},
252 {"MOUSE10", K_MOUSE10},
253 {"MOUSE11", K_MOUSE11},
254 {"MOUSE12", K_MOUSE12},
255 {"MOUSE13", K_MOUSE13},
256 {"MOUSE14", K_MOUSE14},
257 {"MOUSE15", K_MOUSE15},
258 {"MOUSE16", K_MOUSE16},
318 {"SEMICOLON", ';'}, // because a raw semicolon separates commands
322 {"APOSTROPHE", '\''},
323 {"BACKSLASH", '\\'}, // because a raw backslash is used for special characters
325 {"MIDINOTE0", K_MIDINOTE0},
326 {"MIDINOTE1", K_MIDINOTE1},
327 {"MIDINOTE2", K_MIDINOTE2},
328 {"MIDINOTE3", K_MIDINOTE3},
329 {"MIDINOTE4", K_MIDINOTE4},
330 {"MIDINOTE5", K_MIDINOTE5},
331 {"MIDINOTE6", K_MIDINOTE6},
332 {"MIDINOTE7", K_MIDINOTE7},
333 {"MIDINOTE8", K_MIDINOTE8},
334 {"MIDINOTE9", K_MIDINOTE9},
335 {"MIDINOTE10", K_MIDINOTE10},
336 {"MIDINOTE11", K_MIDINOTE11},
337 {"MIDINOTE12", K_MIDINOTE12},
338 {"MIDINOTE13", K_MIDINOTE13},
339 {"MIDINOTE14", K_MIDINOTE14},
340 {"MIDINOTE15", K_MIDINOTE15},
341 {"MIDINOTE16", K_MIDINOTE16},
342 {"MIDINOTE17", K_MIDINOTE17},
343 {"MIDINOTE18", K_MIDINOTE18},
344 {"MIDINOTE19", K_MIDINOTE19},
345 {"MIDINOTE20", K_MIDINOTE20},
346 {"MIDINOTE21", K_MIDINOTE21},
347 {"MIDINOTE22", K_MIDINOTE22},
348 {"MIDINOTE23", K_MIDINOTE23},
349 {"MIDINOTE24", K_MIDINOTE24},
350 {"MIDINOTE25", K_MIDINOTE25},
351 {"MIDINOTE26", K_MIDINOTE26},
352 {"MIDINOTE27", K_MIDINOTE27},
353 {"MIDINOTE28", K_MIDINOTE28},
354 {"MIDINOTE29", K_MIDINOTE29},
355 {"MIDINOTE30", K_MIDINOTE30},
356 {"MIDINOTE31", K_MIDINOTE31},
357 {"MIDINOTE32", K_MIDINOTE32},
358 {"MIDINOTE33", K_MIDINOTE33},
359 {"MIDINOTE34", K_MIDINOTE34},
360 {"MIDINOTE35", K_MIDINOTE35},
361 {"MIDINOTE36", K_MIDINOTE36},
362 {"MIDINOTE37", K_MIDINOTE37},
363 {"MIDINOTE38", K_MIDINOTE38},
364 {"MIDINOTE39", K_MIDINOTE39},
365 {"MIDINOTE40", K_MIDINOTE40},
366 {"MIDINOTE41", K_MIDINOTE41},
367 {"MIDINOTE42", K_MIDINOTE42},
368 {"MIDINOTE43", K_MIDINOTE43},
369 {"MIDINOTE44", K_MIDINOTE44},
370 {"MIDINOTE45", K_MIDINOTE45},
371 {"MIDINOTE46", K_MIDINOTE46},
372 {"MIDINOTE47", K_MIDINOTE47},
373 {"MIDINOTE48", K_MIDINOTE48},
374 {"MIDINOTE49", K_MIDINOTE49},
375 {"MIDINOTE50", K_MIDINOTE50},
376 {"MIDINOTE51", K_MIDINOTE51},
377 {"MIDINOTE52", K_MIDINOTE52},
378 {"MIDINOTE53", K_MIDINOTE53},
379 {"MIDINOTE54", K_MIDINOTE54},
380 {"MIDINOTE55", K_MIDINOTE55},
381 {"MIDINOTE56", K_MIDINOTE56},
382 {"MIDINOTE57", K_MIDINOTE57},
383 {"MIDINOTE58", K_MIDINOTE58},
384 {"MIDINOTE59", K_MIDINOTE59},
385 {"MIDINOTE60", K_MIDINOTE60},
386 {"MIDINOTE61", K_MIDINOTE61},
387 {"MIDINOTE62", K_MIDINOTE62},
388 {"MIDINOTE63", K_MIDINOTE63},
389 {"MIDINOTE64", K_MIDINOTE64},
390 {"MIDINOTE65", K_MIDINOTE65},
391 {"MIDINOTE66", K_MIDINOTE66},
392 {"MIDINOTE67", K_MIDINOTE67},
393 {"MIDINOTE68", K_MIDINOTE68},
394 {"MIDINOTE69", K_MIDINOTE69},
395 {"MIDINOTE70", K_MIDINOTE70},
396 {"MIDINOTE71", K_MIDINOTE71},
397 {"MIDINOTE72", K_MIDINOTE72},
398 {"MIDINOTE73", K_MIDINOTE73},
399 {"MIDINOTE74", K_MIDINOTE74},
400 {"MIDINOTE75", K_MIDINOTE75},
401 {"MIDINOTE76", K_MIDINOTE76},
402 {"MIDINOTE77", K_MIDINOTE77},
403 {"MIDINOTE78", K_MIDINOTE78},
404 {"MIDINOTE79", K_MIDINOTE79},
405 {"MIDINOTE80", K_MIDINOTE80},
406 {"MIDINOTE81", K_MIDINOTE81},
407 {"MIDINOTE82", K_MIDINOTE82},
408 {"MIDINOTE83", K_MIDINOTE83},
409 {"MIDINOTE84", K_MIDINOTE84},
410 {"MIDINOTE85", K_MIDINOTE85},
411 {"MIDINOTE86", K_MIDINOTE86},
412 {"MIDINOTE87", K_MIDINOTE87},
413 {"MIDINOTE88", K_MIDINOTE88},
414 {"MIDINOTE89", K_MIDINOTE89},
415 {"MIDINOTE90", K_MIDINOTE90},
416 {"MIDINOTE91", K_MIDINOTE91},
417 {"MIDINOTE92", K_MIDINOTE92},
418 {"MIDINOTE93", K_MIDINOTE93},
419 {"MIDINOTE94", K_MIDINOTE94},
420 {"MIDINOTE95", K_MIDINOTE95},
421 {"MIDINOTE96", K_MIDINOTE96},
422 {"MIDINOTE97", K_MIDINOTE97},
423 {"MIDINOTE98", K_MIDINOTE98},
424 {"MIDINOTE99", K_MIDINOTE99},
425 {"MIDINOTE100", K_MIDINOTE100},
426 {"MIDINOTE101", K_MIDINOTE101},
427 {"MIDINOTE102", K_MIDINOTE102},
428 {"MIDINOTE103", K_MIDINOTE103},
429 {"MIDINOTE104", K_MIDINOTE104},
430 {"MIDINOTE105", K_MIDINOTE105},
431 {"MIDINOTE106", K_MIDINOTE106},
432 {"MIDINOTE107", K_MIDINOTE107},
433 {"MIDINOTE108", K_MIDINOTE108},
434 {"MIDINOTE109", K_MIDINOTE109},
435 {"MIDINOTE110", K_MIDINOTE110},
436 {"MIDINOTE111", K_MIDINOTE111},
437 {"MIDINOTE112", K_MIDINOTE112},
438 {"MIDINOTE113", K_MIDINOTE113},
439 {"MIDINOTE114", K_MIDINOTE114},
440 {"MIDINOTE115", K_MIDINOTE115},
441 {"MIDINOTE116", K_MIDINOTE116},
442 {"MIDINOTE117", K_MIDINOTE117},
443 {"MIDINOTE118", K_MIDINOTE118},
444 {"MIDINOTE119", K_MIDINOTE119},
445 {"MIDINOTE120", K_MIDINOTE120},
446 {"MIDINOTE121", K_MIDINOTE121},
447 {"MIDINOTE122", K_MIDINOTE122},
448 {"MIDINOTE123", K_MIDINOTE123},
449 {"MIDINOTE124", K_MIDINOTE124},
450 {"MIDINOTE125", K_MIDINOTE125},
451 {"MIDINOTE126", K_MIDINOTE126},
452 {"MIDINOTE127", K_MIDINOTE127},
458 ==============================================================================
460 LINE TYPING INTO THE CONSOLE
462 ==============================================================================
466 Key_ClearEditLine (int edit_line)
468 memset (key_line, '\0', sizeof(key_line));
475 Interactive line editing and console scrollback
479 Key_Console (int key, int unicode)
481 // LordHavoc: copied most of this from Q2 to improve keyboard handling
508 case K_KP_RIGHTARROW:
528 if ((key == 'v' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
531 if ((cbd = Sys_GetClipboardData()) != 0)
538 if (*p == '\r' && *(p+1) == '\n')
543 else if (*p == '\n' || *p == '\r' || *p == '\b')
548 strtok(cbd, "\n\r\b");
550 i = (int)strlen(cbd);
551 if (i + key_linepos >= MAX_INPUTLINE)
552 i= MAX_INPUTLINE - key_linepos - 1;
555 // terencehill: insert the clipboard text between the characters of the line
557 char *temp = (char *) Z_Malloc(MAX_INPUTLINE);
560 if ( key_linepos < (int)strlen(key_line) )
561 strlcpy(temp, key_line + key_linepos, (int)strlen(key_line) - key_linepos +1);
562 key_line[key_linepos] = 0;
563 strlcat(key_line, cbd, sizeof(key_line));
565 strlcat(key_line, temp, sizeof(key_line));
569 // blub: I'm changing this to use memmove() like the rest of the code does.
571 memmove(key_line + key_linepos + i, key_line + key_linepos, sizeof(key_line) - key_linepos - i);
572 memcpy(key_line + key_linepos, cbd, i);
580 if (key == 'l' && keydown[K_CTRL])
582 Cbuf_AddText ("clear\n");
586 if (key == 'u' && keydown[K_CTRL]) // like vi/readline ^u: delete currently edited line
595 if (key == 'q' && keydown[K_CTRL]) // like zsh ^q: push line to history, don't execute, and clear
605 if (key == K_ENTER || key == K_KP_ENTER)
607 Cbuf_AddText (key_line+1); // skip the ]
611 key_line[1] = 0; // EvilTypeGuy: null terminate
613 // force an update, because the command may take some time
614 if (cls.state == ca_disconnected)
621 if(keydown[K_CTRL]) // append to the cvar its value
623 int cvar_len, cvar_str_len, chars_to_move;
625 char cvar[MAX_INPUTLINE];
626 const char *cvar_str;
628 // go to the start of the variable
631 k = key_line[key_linepos];
632 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
637 // save the variable name in cvar
638 for(cvar_len=0; (k = key_line[key_linepos + cvar_len]) != 0; cvar_len++)
640 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
648 // go to the end of the cvar
649 key_linepos += cvar_len;
651 // save the content of the variable in cvar_str
652 cvar_str = Cvar_VariableString(cvar);
653 cvar_str_len = strlen(cvar_str);
657 // insert space and cvar_str in key_line
658 chars_to_move = strlen(&key_line[key_linepos]);
659 if (key_linepos + 1 + cvar_str_len + chars_to_move < MAX_INPUTLINE)
662 memmove(&key_line[key_linepos + 1 + cvar_str_len], &key_line[key_linepos], chars_to_move);
663 key_line[key_linepos++] = ' ';
664 memcpy(&key_line[key_linepos], cvar_str, cvar_str_len);
665 key_linepos += cvar_str_len;
666 key_line[key_linepos + chars_to_move] = 0;
669 Con_Printf("Couldn't append cvar value, edit line too long.\n");
672 // Enhanced command completion
673 // by EvilTypeGuy eviltypeguy@qeradiant.com
674 // Thanks to Fett, Taniwha
675 Con_CompleteCommandLine();
679 // Advanced Console Editing by Radix radix@planetquake.com
680 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
682 // Enhanced by terencehill
684 // move cursor to the previous character
685 if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
689 if(keydown[K_CTRL]) // move cursor to the previous word
695 if(pos) // skip all "; ' after the word
699 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
707 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
710 key_linepos = pos + 1;
712 else if(keydown[K_SHIFT]) // move cursor to the previous character ignoring colors
716 pos = u8_prevbyte(key_line+1, key_linepos-1) + 1; // do NOT give the ']' to u8_prevbyte
718 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && isdigit(key_line[pos]))
720 else if(pos-4 > 0 && key_line[pos-4] == STRING_COLOR_TAG && key_line[pos-3] == STRING_COLOR_RGB_TAG_CHAR
721 && isxdigit(key_line[pos-2]) && isxdigit(key_line[pos-1]) && isxdigit(key_line[pos]))
725 if(pos-1 > 0 && key_line[pos-1] == STRING_COLOR_TAG && key_line[pos] == STRING_COLOR_TAG) // consider ^^ as a character
730 // we need to move to the beginning of the character when in a wide character:
731 u8_charidx(key_line, pos + 1, &inchar);
732 key_linepos = pos + 1 - inchar;
736 key_linepos = u8_prevbyte(key_line+1, key_linepos-1) + 1; // do NOT give the ']' to u8_prevbyte
741 // delete char before cursor
742 if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
746 int newpos = u8_prevbyte(key_line+1, key_linepos-1) + 1; // do NOT give the ']' to u8_prevbyte
747 strlcpy(key_line + newpos, key_line + key_linepos, sizeof(key_line) + 1 - key_linepos);
748 key_linepos = newpos;
753 // delete char on cursor
754 if (key == K_DEL || key == K_KP_DEL)
757 linelen = strlen(key_line);
758 if (key_linepos < (int)linelen)
759 memmove(key_line + key_linepos, key_line + key_linepos + u8_bytelen(key_line + key_linepos, 1), linelen - key_linepos);
764 // move cursor to the next character
765 if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
767 if (key_linepos >= (int)strlen(key_line))
769 if(keydown[K_CTRL]) // move cursor to the next word
773 len = (int)strlen(key_line);
779 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
783 if (pos < len) // skip all "; ' after the word
787 if (!(k == '\"' || k == ';' || k == ' ' || k == '\''))
792 else if(keydown[K_SHIFT]) // move cursor to the next character ignoring colors
795 len = (int)strlen(key_line);
798 // go beyond all initial consecutive color tags, if any
800 while (key_line[pos] == STRING_COLOR_TAG)
802 if(isdigit(key_line[pos+1]))
804 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]))
811 if (key_line[pos] == STRING_COLOR_TAG && key_line[pos+1] == STRING_COLOR_TAG) // consider ^^ as a character
813 pos += u8_bytelen(key_line + pos, 1);
815 // now go beyond all next consecutive color tags, if any
817 while (key_line[pos] == STRING_COLOR_TAG)
819 if(isdigit(key_line[pos+1]))
821 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]))
829 key_linepos += u8_bytelen(key_line + key_linepos, 1);
833 if (key == K_INS || key == K_KP_INS) // toggle insert mode
839 // End Advanced Console Editing
841 if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
847 if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
852 // ~1.0795 = 82/76 using con_textsize 64 76 is height of the char, 6 is the distance between 2 lines
853 if (key == K_PGUP || key == K_KP_PGUP)
857 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
860 con_backscroll += ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
864 if (key == K_PGDN || key == K_KP_PGDN)
868 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
871 con_backscroll -= ((vid_conheight.integer >> 1) / con_textsize.integer)-3;
875 if (key == K_MWHEELUP)
879 else if(keydown[K_SHIFT])
880 con_backscroll += ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
886 if (key == K_MWHEELDOWN)
890 else if(keydown[K_SHIFT])
891 con_backscroll -= ((vid_conheight.integer >> 2) / con_textsize.integer)-1;
900 if (key == '+' || key == K_KP_PLUS)
902 if (con_textsize.integer < 128)
903 Cvar_SetValueQuick(&con_textsize, con_textsize.integer + 1);
907 if (key == '-' || key == K_KP_MINUS)
909 if (con_textsize.integer > 1)
910 Cvar_SetValueQuick(&con_textsize, con_textsize.integer - 1);
914 if (key == '0' || key == K_KP_INS)
916 Cvar_SetValueQuick(&con_textsize, atoi(Cvar_VariableDefString("con_textsize")));
921 if (key == K_HOME || key == K_KP_HOME)
924 con_backscroll = CON_TEXTSIZE;
930 if (key == K_END || key == K_KP_END)
935 key_linepos = (int)strlen(key_line);
943 if (key_linepos < MAX_INPUTLINE-1)
948 blen = u8_fromchar(unicode, buf, sizeof(buf));
951 len = (int)strlen(&key_line[key_linepos]);
952 // check insert mode, or always insert if at end of line
953 if (key_insert || len == 0)
955 // can't use strcpy to move string to right
957 //memmove(&key_line[key_linepos + u8_bytelen(key_line + key_linepos, 1)], &key_line[key_linepos], len);
958 memmove(&key_line[key_linepos + blen], &key_line[key_linepos], len);
960 memcpy(key_line + key_linepos, buf, blen);
962 //key_linepos += u8_fromchar(unicode, key_line + key_linepos, sizeof(key_line) - key_linepos - 1);
963 //key_line[key_linepos] = ascii;
968 //============================================================================
971 char chat_buffer[MAX_INPUTLINE];
972 unsigned int chat_bufferlen = 0;
974 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
977 Key_Message (int key, int ascii)
979 if (key == K_ENTER || ascii == 10 || ascii == 13)
982 Cmd_ExecuteString(chat_buffer, src_command); // not Cbuf_AddText to allow semiclons in args; however, this allows no variables then. Use aliases!
984 Cmd_ForwardStringToServer(va("%s %s", chat_mode ? "say_team" : "say ", chat_buffer));
992 // TODO add support for arrow keys and simple editing
994 if (key == K_ESCAPE) {
1001 if (key == K_BACKSPACE) {
1002 if (chat_bufferlen) {
1003 chat_bufferlen = u8_prevbyte(chat_buffer, chat_bufferlen);
1004 chat_buffer[chat_bufferlen] = 0;
1010 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
1014 // ctrl+key generates an ascii value < 32 and shows a char from the charmap
1015 if (ascii < 32 && utf8_enable.integer)
1016 ascii = 0xE000 + ascii;
1018 if (chat_bufferlen == sizeof (chat_buffer) - 1)
1022 return; // non printable
1024 chat_bufferlen += u8_fromchar(ascii, chat_buffer+chat_bufferlen, sizeof(chat_buffer) - chat_bufferlen - 1);
1026 //chat_buffer[chat_bufferlen++] = ascii;
1027 //chat_buffer[chat_bufferlen] = 0;
1030 //============================================================================
1035 Returns a key number to be used to index keybindings[] by looking at
1036 the given string. Single ascii characters return themselves, while
1037 the K_* names are matched up.
1041 Key_StringToKeynum (const char *str)
1043 const keyname_t *kn;
1045 if (!str || !str[0])
1048 return tolower(str[0]);
1050 for (kn = keynames; kn->name; kn++) {
1051 if (!strcasecmp (str, kn->name))
1059 Returns a string (either a single ascii char, or a K_* name) for the
1061 FIXME: handle quote special (general escape sequence?)
1065 Key_KeynumToString (int keynum)
1067 const keyname_t *kn;
1068 static char tinystr[2];
1070 // -1 is an invalid code
1072 return "<KEY NOT FOUND>";
1074 // search overrides first, because some characters are special
1075 for (kn = keynames; kn->name; kn++)
1076 if (keynum == kn->keynum)
1079 // if it is printable, output it as a single character
1080 if (keynum > 32 && keynum < 256)
1082 tinystr[0] = keynum;
1087 // if it is not overridden and not printable, we don't know what to do with it
1088 return "<UNKNOWN KEYNUM>";
1093 Key_SetBinding (int keynum, int bindmap, const char *binding)
1098 if (keynum == -1 || keynum >= MAX_KEYS)
1100 if ((bindmap < 0) || (bindmap >= MAX_BINDMAPS))
1103 // free old bindings
1104 if (keybindings[bindmap][keynum]) {
1105 Z_Free (keybindings[bindmap][keynum]);
1106 keybindings[bindmap][keynum] = NULL;
1108 if(!binding[0]) // make "" binds be removed --blub
1110 // allocate memory for new binding
1111 l = strlen (binding);
1112 newbinding = (char *)Z_Malloc (l + 1);
1113 memcpy (newbinding, binding, l + 1);
1115 keybindings[bindmap][keynum] = newbinding;
1119 void Key_GetBindMap(int *fg, int *bg)
1127 qboolean Key_SetBindMap(int fg, int bg)
1129 if(fg >= MAX_BINDMAPS)
1131 if(bg >= MAX_BINDMAPS)
1141 Key_In_Unbind_f (void)
1144 char *errchar = NULL;
1146 if (Cmd_Argc () != 3) {
1147 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
1151 m = strtol(Cmd_Argv (1), &errchar, 0);
1152 if ((m < 0) || (m >= MAX_BINDMAPS) || (errchar && *errchar)) {
1153 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1157 b = Key_StringToKeynum (Cmd_Argv (2));
1159 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1163 if(!Key_SetBinding (b, m, ""))
1164 Con_Printf("Key_SetBinding failed for unknown reason\n");
1168 Key_In_Bind_f (void)
1171 char cmd[MAX_INPUTLINE];
1172 char *errchar = NULL;
1176 if (c != 3 && c != 4) {
1177 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
1181 m = strtol(Cmd_Argv (1), &errchar, 0);
1182 if ((m < 0) || (m >= MAX_BINDMAPS) || (errchar && *errchar)) {
1183 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1187 b = Key_StringToKeynum (Cmd_Argv (2));
1188 if (b == -1 || b >= MAX_KEYS) {
1189 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
1194 if (keybindings[m][b])
1195 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
1197 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
1200 // copy the rest of the command line
1201 cmd[0] = 0; // start out with a null string
1202 for (i = 3; i < c; i++) {
1203 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1205 strlcat (cmd, " ", sizeof (cmd));
1208 if(!Key_SetBinding (b, m, cmd))
1209 Con_Printf("Key_SetBinding failed for unknown reason\n");
1213 Key_In_Bindmap_f (void)
1216 char *errchar = NULL;
1221 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
1225 m1 = strtol(Cmd_Argv (1), &errchar, 0);
1226 if ((m1 < 0) || (m1 >= MAX_BINDMAPS) || (errchar && *errchar)) {
1227 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1231 m2 = strtol(Cmd_Argv (2), &errchar, 0);
1232 if ((m2 < 0) || (m2 >= MAX_BINDMAPS) || (errchar && *errchar)) {
1233 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(2));
1246 if (Cmd_Argc () != 2) {
1247 Con_Print("unbind <key> : remove commands from a key\n");
1251 b = Key_StringToKeynum (Cmd_Argv (1));
1253 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1257 if(!Key_SetBinding (b, 0, ""))
1258 Con_Printf("Key_SetBinding failed for unknown reason\n");
1262 Key_Unbindall_f (void)
1266 for (j = 0; j < MAX_BINDMAPS; j++)
1267 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1268 if (keybindings[j][i])
1269 Key_SetBinding (i, j, "");
1273 Key_PrintBindList(int j)
1275 char bindbuf[MAX_INPUTLINE];
1279 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1281 p = keybindings[j][i];
1284 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
1286 Con_Printf("^2%s ^7= \"%s\"\n", Key_KeynumToString (i), bindbuf);
1288 Con_Printf("^3bindmap %d: ^2%s ^7= \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1294 Key_In_BindList_f (void)
1297 char *errchar = NULL;
1301 m = strtol(Cmd_Argv(1), &errchar, 0);
1302 if ((m < 0) || (m >= MAX_BINDMAPS) || (errchar && *errchar)) {
1303 Con_Printf("%s isn't a valid bindmap\n", Cmd_Argv(1));
1306 Key_PrintBindList(m);
1310 for (m = 0; m < MAX_BINDMAPS; m++)
1311 Key_PrintBindList(m);
1316 Key_BindList_f (void)
1318 Key_PrintBindList(0);
1325 char cmd[MAX_INPUTLINE];
1329 if (c != 2 && c != 3) {
1330 Con_Print("bind <key> [command] : attach a command to a key\n");
1333 b = Key_StringToKeynum (Cmd_Argv (1));
1334 if (b == -1 || b >= MAX_KEYS) {
1335 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
1340 if (keybindings[0][b])
1341 Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
1343 Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
1346 // copy the rest of the command line
1347 cmd[0] = 0; // start out with a null string
1348 for (i = 2; i < c; i++) {
1349 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
1351 strlcat (cmd, " ", sizeof (cmd));
1354 if(!Key_SetBinding (b, 0, cmd))
1355 Con_Printf("Key_SetBinding failed for unknown reason\n");
1360 Writes lines containing "bind key value"
1364 Key_WriteBindings (qfile_t *f)
1367 char bindbuf[MAX_INPUTLINE];
1370 for (j = 0; j < MAX_BINDMAPS; j++)
1372 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
1374 p = keybindings[j][i];
1377 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\"); // don't need to escape $ because cvars are not expanded inside bind
1379 FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
1381 FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
1397 // register our functions
1399 Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
1400 Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
1401 Cmd_AddCommand ("in_bindlist", Key_In_BindList_f, "bindlist: displays bound keys for all bindmaps, or the given bindmap");
1402 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");
1404 Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
1405 Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
1406 Cmd_AddCommand ("bindlist", Key_BindList_f, "bindlist: displays bound keys for bindmap 0 bindmaps");
1407 Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
1409 Cvar_RegisterVariable (&con_closeontoggleconsole);
1415 Key_History_Shutdown();
1418 const char *Key_GetBind (int key, int bindmap)
1421 if (key < 0 || key >= MAX_KEYS)
1423 if(bindmap >= MAX_BINDMAPS)
1427 bind = keybindings[bindmap][key];
1431 bind = keybindings[key_bmap][key];
1433 bind = keybindings[key_bmap2][key];
1438 void Key_FindKeysForCommand (const char *command, int *keys, int numkeys, int bindmap)
1444 for (j = 0;j < numkeys;j++)
1447 if(bindmap >= MAX_BINDMAPS)
1452 for (j = 0; j < MAX_KEYS; ++j)
1454 b = Key_GetBind(j, bindmap);
1457 if (!strcmp (b, command) )
1460 if (count == numkeys)
1466 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
1470 Called by the system between frames for both key up and key down events
1471 Should NOT be called during an interrupt!
1474 static char tbl_keyascii[MAX_KEYS];
1475 static keydest_t tbl_keydest[MAX_KEYS];
1477 typedef struct eventqueueitem_s
1484 static int events_blocked = 0;
1485 static eventqueueitem_t eventqueue[32];
1486 static unsigned eventqueue_idx = 0;
1488 static void Key_EventQueue_Add(int key, int ascii, qboolean down)
1490 if(eventqueue_idx < sizeof(eventqueue) / sizeof(*eventqueue))
1492 eventqueue[eventqueue_idx].key = key;
1493 eventqueue[eventqueue_idx].ascii = ascii;
1494 eventqueue[eventqueue_idx].down = down;
1499 void Key_EventQueue_Block(void)
1501 // block key events until call to Unblock
1502 events_blocked = true;
1505 void Key_EventQueue_Unblock(void)
1507 // unblocks key events again
1509 events_blocked = false;
1510 for(i = 0; i < eventqueue_idx; ++i)
1511 Key_Event(eventqueue[i].key, eventqueue[i].ascii, eventqueue[i].down);
1516 Key_Event (int key, int ascii, qboolean down)
1520 keydest_t keydest = key_dest;
1522 if (key < 0 || key >= MAX_KEYS)
1527 Key_EventQueue_Add(key, ascii, down);
1531 if (ascii == 0x80 && utf8_enable.integer) // pressing AltGr-5 (or AltGr-e) and for some reason we get windows-1252 encoding?
1532 ascii = 0x20AC; // we want the Euro currency sign
1533 // TODO find out which vid_ drivers do it and fix it there
1534 // but catching U+0080 here is no loss as that char is not useful anyway
1537 bind = keybindings[key_bmap][key];
1539 bind = keybindings[key_bmap2][key];
1541 if (developer_insane.integer)
1542 Con_DPrintf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii ? ascii : '?', down ? "down" : "up", keydown[key], bind ? bind : "");
1544 if(key_consoleactive)
1545 keydest = key_console;
1549 // increment key repeat count each time a down is received so that things
1550 // which want to ignore key repeat can ignore it
1551 keydown[key] = min(keydown[key] + 1, 2);
1552 if(keydown[key] == 1) {
1553 tbl_keyascii[key] = ascii;
1554 tbl_keydest[key] = keydest;
1556 ascii = tbl_keyascii[key];
1557 keydest = tbl_keydest[key];
1562 // clear repeat count now that the key is released
1564 keydest = tbl_keydest[key];
1565 ascii = tbl_keyascii[key];
1568 if(keydest == key_void)
1571 // key_consoleactive is a flag not a key_dest because the console is a
1572 // high priority overlay ontop of the normal screen (designed as a safety
1573 // feature so that developers and users can rescue themselves from a bad
1576 // this also means that toggling the console on/off does not lose the old
1579 // specially handle escape (togglemenu) and shift-escape (toggleconsole)
1580 // engine bindings, these are not handled as normal binds so that the user
1581 // can recover from a completely empty bindmap
1582 if (key == K_ESCAPE)
1584 // ignore key repeats on escape
1585 if (keydown[key] > 1)
1588 // escape does these things:
1589 // key_consoleactive - close console
1590 // key_message - abort messagemode
1591 // key_menu - go to parent menu (or key_game)
1592 // key_game - open menu
1594 // in all modes shift-escape toggles console
1595 if (keydown[K_SHIFT])
1599 Con_ToggleConsole_f ();
1600 tbl_keydest[key] = key_void; // esc release should go nowhere (especially not to key_menu or key_game)
1610 if(key_consoleactive & KEY_CONSOLEACTIVE_FORCED)
1612 key_consoleactive &= ~KEY_CONSOLEACTIVE_USER;
1616 Con_ToggleConsole_f();
1622 Key_Message (key, ascii); // that'll close the message input
1626 case key_menu_grabbed:
1627 MR_KeyEvent (key, ascii, down);
1631 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
1632 q = CL_VM_InputEvent(down, key, ascii);
1638 Con_Printf ("Key_Event: Bad key_dest\n");
1643 // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
1644 // VorteX: Omnicide does bind F* keys
1645 if (keydest != key_menu_grabbed)
1646 if (key >= K_F1 && key <= K_F12 && gamemode != GAME_BLOODOMNICIDE)
1650 if(keydown[key] == 1 && down)
1652 // button commands add keynum as a parm
1654 Cbuf_AddText (va("%s %i\n", bind, key));
1657 Cbuf_AddText (bind);
1658 Cbuf_AddText ("\n");
1660 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1661 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1666 // send input to console if it wants it
1667 if (keydest == key_console)
1671 // con_closeontoggleconsole enables toggleconsole keys to close the
1672 // console, as long as they are not the color prefix character
1673 // (special exemption for german keyboard layouts)
1674 if (con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && (key_consoleactive & KEY_CONSOLEACTIVE_USER) && ascii != STRING_COLOR_TAG)
1676 Con_ToggleConsole_f ();
1679 Key_Console (key, ascii);
1683 // handle toggleconsole in menu too
1684 if (keydest == key_menu)
1686 if (down && con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && ascii != STRING_COLOR_TAG)
1688 Con_ToggleConsole_f ();
1689 tbl_keydest[key] = key_void; // key release should go nowhere (especially not to key_menu or key_game)
1694 // ignore binds while a video is played, let the video system handle the key event
1695 if (cl_videoplaying)
1697 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1701 // anything else is a key press into the game, chat line, or menu
1706 Key_Message (key, ascii);
1709 case key_menu_grabbed:
1710 MR_KeyEvent (key, ascii, down);
1713 q = CL_VM_InputEvent(down, key, ascii);
1714 // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1717 if(keydown[key] == 1 && down)
1719 // button commands add keynum as a parm
1721 Cbuf_AddText (va("%s %i\n", bind, key));
1724 Cbuf_AddText (bind);
1725 Cbuf_AddText ("\n");
1727 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1728 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1732 Con_Printf ("Key_Event: Bad key_dest\n");
1742 Key_ClearStates (void)
1744 memset(keydown, 0, sizeof(keydown));