if in menu, make con_closeontoggleconsole.integer also enable the toggleconsole key
[xonotic/darkplaces.git] / keys.c
1 /*
2         Copyright (C) 1996-1997  Id Software, Inc.
3
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.
8
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.
12
13         See the GNU General Public License for more details.
14
15         You should have received a copy of the GNU General Public License
16         along with this program; if not, write to:
17
18                 Free Software Foundation, Inc.
19                 59 Temple Place - Suite 330
20                 Boston, MA  02111-1307, USA
21 */
22
23 #include "quakedef.h"
24 #include "cl_video.h"
25
26 cvar_t con_closeontoggleconsole = {CVAR_SAVE, "con_closeontoggleconsole","1", "allows toggleconsole binds to close the console as well"};
27
28 /*
29 key up events are sent even if in console mode
30 */
31
32 int                     edit_line = MAX_INPUTLINES-1;
33 int                     history_line = MAX_INPUTLINES-1;
34 char            key_lines[MAX_INPUTLINES][MAX_INPUTLINE];
35 int                     key_linepos;
36 qboolean        key_insert = true;      // insert key toggle (for editing)
37 keydest_t       key_dest;
38 int                     key_consoleactive;
39 char            *keybindings[MAX_BINDMAPS][MAX_KEYS];
40
41 static int      key_bmap, key_bmap2;
42 static unsigned char keydown[MAX_KEYS]; // 0 = up, 1 = down, 2 = repeating
43
44 typedef struct keyname_s
45 {
46         const char      *name;
47         int                     keynum;
48 }
49 keyname_t;
50
51 static const keyname_t   keynames[] = {
52         {"TAB", K_TAB},
53         {"ENTER", K_ENTER},
54         {"ESCAPE", K_ESCAPE},
55         {"SPACE", K_SPACE},
56
57         // spacer so it lines up with keys.h
58
59         {"BACKSPACE", K_BACKSPACE},
60         {"UPARROW", K_UPARROW},
61         {"DOWNARROW", K_DOWNARROW},
62         {"LEFTARROW", K_LEFTARROW},
63         {"RIGHTARROW", K_RIGHTARROW},
64
65         {"ALT", K_ALT},
66         {"CTRL", K_CTRL},
67         {"SHIFT", K_SHIFT},
68
69         {"F1", K_F1},
70         {"F2", K_F2},
71         {"F3", K_F3},
72         {"F4", K_F4},
73         {"F5", K_F5},
74         {"F6", K_F6},
75         {"F7", K_F7},
76         {"F8", K_F8},
77         {"F9", K_F9},
78         {"F10", K_F10},
79         {"F11", K_F11},
80         {"F12", K_F12},
81
82         {"INS", K_INS},
83         {"DEL", K_DEL},
84         {"PGDN", K_PGDN},
85         {"PGUP", K_PGUP},
86         {"HOME", K_HOME},
87         {"END", K_END},
88
89         {"PAUSE", K_PAUSE},
90
91         {"NUMLOCK", K_NUMLOCK},
92         {"CAPSLOCK", K_CAPSLOCK},
93         {"SCROLLOCK", K_SCROLLOCK},
94
95         {"KP_INS",                      K_KP_INS },
96         {"KP_0", K_KP_0},
97         {"KP_END",                      K_KP_END },
98         {"KP_1", K_KP_1},
99         {"KP_DOWNARROW",        K_KP_DOWNARROW },
100         {"KP_2", K_KP_2},
101         {"KP_PGDN",                     K_KP_PGDN },
102         {"KP_3", K_KP_3},
103         {"KP_LEFTARROW",        K_KP_LEFTARROW },
104         {"KP_4", K_KP_4},
105         {"KP_5", K_KP_5},
106         {"KP_RIGHTARROW",       K_KP_RIGHTARROW },
107         {"KP_6", K_KP_6},
108         {"KP_HOME",                     K_KP_HOME },
109         {"KP_7", K_KP_7},
110         {"KP_UPARROW",          K_KP_UPARROW },
111         {"KP_8", K_KP_8},
112         {"KP_PGUP",                     K_KP_PGUP },
113         {"KP_9", K_KP_9},
114         {"KP_DEL",                      K_KP_DEL },
115         {"KP_PERIOD", K_KP_PERIOD},
116         {"KP_SLASH",            K_KP_SLASH },
117         {"KP_DIVIDE", K_KP_DIVIDE},
118         {"KP_MULTIPLY", K_KP_MULTIPLY},
119         {"KP_MINUS", K_KP_MINUS},
120         {"KP_PLUS", K_KP_PLUS},
121         {"KP_ENTER", K_KP_ENTER},
122         {"KP_EQUALS", K_KP_EQUALS},
123
124
125
126         {"MOUSE1", K_MOUSE1},
127
128         {"MOUSE2", K_MOUSE2},
129         {"MOUSE3", K_MOUSE3},
130         {"MWHEELUP", K_MWHEELUP},
131         {"MWHEELDOWN", K_MWHEELDOWN},
132         {"MOUSE4", K_MOUSE4},
133         {"MOUSE5", K_MOUSE5},
134         {"MOUSE6", K_MOUSE6},
135         {"MOUSE7", K_MOUSE7},
136         {"MOUSE8", K_MOUSE8},
137         {"MOUSE9", K_MOUSE9},
138         {"MOUSE10", K_MOUSE10},
139         {"MOUSE11", K_MOUSE11},
140         {"MOUSE12", K_MOUSE12},
141         {"MOUSE13", K_MOUSE13},
142         {"MOUSE14", K_MOUSE14},
143         {"MOUSE15", K_MOUSE15},
144         {"MOUSE16", K_MOUSE16},
145
146
147
148
149         {"JOY1",  K_JOY1},
150         {"JOY2",  K_JOY2},
151         {"JOY3",  K_JOY3},
152         {"JOY4",  K_JOY4},
153         {"JOY5",  K_JOY5},
154         {"JOY6",  K_JOY6},
155         {"JOY7",  K_JOY7},
156         {"JOY8",  K_JOY8},
157         {"JOY9",  K_JOY9},
158         {"JOY10", K_JOY10},
159         {"JOY11", K_JOY11},
160         {"JOY12", K_JOY12},
161         {"JOY13", K_JOY13},
162         {"JOY14", K_JOY14},
163         {"JOY15", K_JOY15},
164         {"JOY16", K_JOY16},
165
166
167
168
169
170
171         {"AUX1", K_AUX1},
172         {"AUX2", K_AUX2},
173         {"AUX3", K_AUX3},
174         {"AUX4", K_AUX4},
175         {"AUX5", K_AUX5},
176         {"AUX6", K_AUX6},
177         {"AUX7", K_AUX7},
178         {"AUX8", K_AUX8},
179         {"AUX9", K_AUX9},
180         {"AUX10", K_AUX10},
181         {"AUX11", K_AUX11},
182         {"AUX12", K_AUX12},
183         {"AUX13", K_AUX13},
184         {"AUX14", K_AUX14},
185         {"AUX15", K_AUX15},
186         {"AUX16", K_AUX16},
187         {"AUX17", K_AUX17},
188         {"AUX18", K_AUX18},
189         {"AUX19", K_AUX19},
190         {"AUX20", K_AUX20},
191         {"AUX21", K_AUX21},
192         {"AUX22", K_AUX22},
193         {"AUX23", K_AUX23},
194         {"AUX24", K_AUX24},
195         {"AUX25", K_AUX25},
196         {"AUX26", K_AUX26},
197         {"AUX27", K_AUX27},
198         {"AUX28", K_AUX28},
199         {"AUX29", K_AUX29},
200         {"AUX30", K_AUX30},
201         {"AUX31", K_AUX31},
202         {"AUX32", K_AUX32},
203
204         {"SEMICOLON", ';'},                     // because a raw semicolon separates commands
205         {"TILDE", '~'},
206         {"BACKQUOTE", '`'},
207         {"QUOTE", '"'},
208         {"APOSTROPHE", '\''},
209         {"BACKSLASH", '\\'},            // because a raw backslash is used for special characters
210
211         {NULL, 0}
212 };
213
214 /*
215 ==============================================================================
216
217                         LINE TYPING INTO THE CONSOLE
218
219 ==============================================================================
220 */
221
222 void
223 Key_ClearEditLine (int edit_line)
224 {
225         memset (key_lines[edit_line], '\0', sizeof(key_lines[edit_line]));
226         key_lines[edit_line][0] = ']';
227         key_linepos = 1;
228 }
229
230 /*
231 ====================
232 Interactive line editing and console scrollback
233 ====================
234 */
235 static void
236 Key_Console (int key, char ascii)
237 {
238         // LordHavoc: copied most of this from Q2 to improve keyboard handling
239         switch (key)
240         {
241         case K_KP_SLASH:
242                 key = '/';
243                 break;
244         case K_KP_MINUS:
245                 key = '-';
246                 break;
247         case K_KP_PLUS:
248                 key = '+';
249                 break;
250         case K_KP_HOME:
251                 key = '7';
252                 break;
253         case K_KP_UPARROW:
254                 key = '8';
255                 break;
256         case K_KP_PGUP:
257                 key = '9';
258                 break;
259         case K_KP_LEFTARROW:
260                 key = '4';
261                 break;
262         case K_KP_5:
263                 key = '5';
264                 break;
265         case K_KP_RIGHTARROW:
266                 key = '6';
267                 break;
268         case K_KP_END:
269                 key = '1';
270                 break;
271         case K_KP_DOWNARROW:
272                 key = '2';
273                 break;
274         case K_KP_PGDN:
275                 key = '3';
276                 break;
277         case K_KP_INS:
278                 key = '0';
279                 break;
280         case K_KP_DEL:
281                 key = '.';
282                 break;
283         }
284
285         if ((toupper(key) == 'V' && keydown[K_CTRL]) || ((key == K_INS || key == K_KP_INS) && keydown[K_SHIFT]))
286         {
287                 char *cbd, *p;
288                 if ((cbd = Sys_GetClipboardData()) != 0)
289                 {
290                         int i;
291 #if 1
292                         p = cbd;
293                         while (*p)
294                         {
295                                 if (*p == '\n' || *p == '\r' || *p == '\b')
296                                 {
297                                         *p++ = 0;
298                                         break;
299                                 }
300                                 p++;
301                         }
302 #else
303                         strtok(cbd, "\n\r\b");
304 #endif
305                         i = (int)strlen(cbd);
306                         if (i + key_linepos >= MAX_INPUTLINE)
307                                 i= MAX_INPUTLINE - key_linepos;
308                         if (i > 0)
309                         {
310                                 cbd[i]=0;
311                                 strlcat(key_lines[edit_line], cbd, sizeof(key_lines[edit_line]));
312                                 key_linepos += i;
313                         }
314                         Z_Free(cbd);
315                 }
316                 return;
317         }
318
319         if (key == 'l')
320         {
321                 if (keydown[K_CTRL])
322                 {
323                         Cbuf_AddText ("clear\n");
324                         return;
325                 }
326         }
327
328         if (key == K_ENTER || key == K_KP_ENTER)
329         {
330                 Cbuf_AddText (key_lines[edit_line]+1);  // skip the ]
331                 Cbuf_AddText ("\n");
332                 Con_Printf("%s\n",key_lines[edit_line]);
333                 if(key_lines[edit_line][1] == 0) // empty line (just a ])?
334                         return; // no, no, you can't submit empty lines to the history...
335                 // LordHavoc: redesigned edit_line/history_line
336                 edit_line = 31;
337                 history_line = edit_line;
338                 memmove(key_lines[0], key_lines[1], sizeof(key_lines[0]) * edit_line);
339                 key_lines[edit_line][0] = ']';
340                 key_lines[edit_line][1] = 0;    // EvilTypeGuy: null terminate
341                 key_linepos = 1;
342                 // force an update, because the command may take some time
343                 if (cls.state == ca_disconnected)
344                         CL_UpdateScreen ();
345                 return;
346         }
347
348         if (key == K_TAB)
349         {
350                 // Enhanced command completion
351                 // by EvilTypeGuy eviltypeguy@qeradiant.com
352                 // Thanks to Fett, Taniwha
353                 Con_CompleteCommandLine();
354                 return;
355         }
356
357         // Advanced Console Editing by Radix radix@planetquake.com
358         // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
359         // Enhanced by [515]
360
361         // left arrow will just move left one without erasing, backspace will
362         // actually erase character
363         if (key == K_LEFTARROW || key == K_KP_LEFTARROW)
364         {
365                 if (key_linepos < 2)
366                         return;
367                 if(keydown[K_CTRL])
368                 {
369                         int             pos;
370                         char    k;
371                         pos = key_linepos-1;
372                         if(pos)
373                                 while(--pos)
374                                 {
375                                         k = key_lines[edit_line][pos];
376                                         if(k == '\"' || k == ';' || k == ' ' || k == '\'')
377                                                 break;
378                                 }
379                         key_linepos = pos + 1;
380                 }
381                 else
382                         key_linepos--;
383                 return;
384         }
385
386         // delete char before cursor
387         if (key == K_BACKSPACE || (key == 'h' && keydown[K_CTRL]))
388         {
389                 if (key_linepos > 1)
390                 {
391                         strlcpy(key_lines[edit_line] + key_linepos - 1, key_lines[edit_line] + key_linepos, sizeof(key_lines[edit_line]) + 1 - key_linepos);
392                         key_linepos--;
393                 }
394                 return;
395         }
396
397         // delete char on cursor
398         if (key == K_DEL || key == K_KP_DEL)
399         {
400                 size_t linelen;
401                 linelen = strlen(key_lines[edit_line]);
402                 if (key_linepos < (int)linelen)
403                         memmove(key_lines[edit_line] + key_linepos, key_lines[edit_line] + key_linepos + 1, linelen - key_linepos);
404                 return;
405         }
406
407
408         // if we're at the end, get one character from previous line,
409         // otherwise just go right one
410         if (key == K_RIGHTARROW || key == K_KP_RIGHTARROW)
411         {
412                 if (key_linepos >= (int)strlen(key_lines[edit_line]))
413                         return;
414                 if(keydown[K_CTRL])
415                 {
416                         int             pos, len;
417                         char    k;
418                         len = (int)strlen(key_lines[edit_line]);
419                         pos = key_linepos;
420                         while(++pos < len)
421                         {
422                                 k = key_lines[edit_line][pos];
423                                 if(k == '\"' || k == ';' || k == ' ' || k == '\'')
424                                         break;
425                         }
426                         key_linepos = pos;
427                 }
428                 else
429                         key_linepos++;
430                 return;
431         }
432
433         if (key == K_INS || key == K_KP_INS) // toggle insert mode
434         {
435                 key_insert ^= 1;
436                 return;
437         }
438
439         // End Advanced Console Editing
440
441         if (key == K_UPARROW || key == K_KP_UPARROW || (key == 'p' && keydown[K_CTRL]))
442         {
443                 if (history_line > 0 && key_lines[history_line-1][1])
444                 {
445                         size_t linelen;
446                         history_line--;
447                         linelen = strlen(key_lines[history_line]);
448                         memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
449                         key_linepos = (int)linelen;
450                 }
451                 return;
452         }
453
454         if (key == K_DOWNARROW || key == K_KP_DOWNARROW || (key == 'n' && keydown[K_CTRL]))
455         {
456                 history_line++;
457                 if (history_line >= edit_line)
458                 {
459                         history_line = edit_line;
460                         key_lines[edit_line][0] = ']';
461                         key_lines[edit_line][1] = 0;
462                         key_linepos = 1;
463                 }
464                 else
465                 {
466                         size_t linelen;
467                         linelen = strlen(key_lines[history_line]);
468                         memcpy(key_lines[edit_line], key_lines[history_line], linelen + 1);
469                         key_linepos = (int)linelen;
470                 }
471                 return;
472         }
473
474         if (key == K_PGUP || key == K_KP_PGUP || key == K_MWHEELUP)
475         {
476                 con_backscroll += ((int) vid_conheight.integer >> 5);
477                 return;
478         }
479
480         if (key == K_PGDN || key == K_KP_PGDN || key == K_MWHEELDOWN)
481         {
482                 con_backscroll -= ((int) vid_conheight.integer >> 5);
483                 return;
484         }
485
486         if (key == K_HOME || key == K_KP_HOME)
487         {
488                 if (keydown[K_CTRL])
489                         con_backscroll = INT_MAX;
490                 else
491                         key_linepos = 1;
492                 return;
493         }
494
495         if (key == K_END || key == K_KP_END)
496         {
497                 if (keydown[K_CTRL])
498                         con_backscroll = 0;
499                 else
500                         key_linepos = (int)strlen(key_lines[edit_line]);
501                 return;
502         }
503
504         // non printable
505         if (ascii < 32)
506                 return;
507
508         if (key_linepos < MAX_INPUTLINE-1)
509         {
510                 int len;
511                 len = (int)strlen(&key_lines[edit_line][key_linepos]);
512                 // check insert mode, or always insert if at end of line
513                 if (key_insert || len == 0)
514                 {
515                         // can't use strcpy to move string to right
516                         len++;
517                         memmove(&key_lines[edit_line][key_linepos + 1], &key_lines[edit_line][key_linepos], len);
518                 }
519                 key_lines[edit_line][key_linepos] = ascii;
520                 key_linepos++;
521         }
522 }
523
524 //============================================================================
525
526 int chat_mode;
527 char            chat_buffer[MAX_INPUTLINE];
528 unsigned int    chat_bufferlen = 0;
529
530 extern int Nicks_CompleteChatLine(char *buffer, size_t size, unsigned int pos);
531
532 static void
533 Key_Message (int key, char ascii)
534 {
535
536         if (key == K_ENTER || ascii == 10 || ascii == 13)
537         {
538                 if(chat_mode < 0)
539                         Cbuf_AddText(va("%s\n", chat_buffer));
540                 else
541                         Cmd_ForwardStringToServer(va("%s %s", chat_mode ? "say_team" : "say ", chat_buffer));
542
543                 key_dest = key_game;
544                 chat_bufferlen = 0;
545                 chat_buffer[0] = 0;
546                 return;
547         }
548
549         // TODO add support for arrow keys and simple editing
550
551         if (key == K_ESCAPE) {
552                 key_dest = key_game;
553                 chat_bufferlen = 0;
554                 chat_buffer[0] = 0;
555                 return;
556         }
557
558         if (key == K_BACKSPACE) {
559                 if (chat_bufferlen) {
560                         chat_bufferlen--;
561                         chat_buffer[chat_bufferlen] = 0;
562                 }
563                 return;
564         }
565
566         if(key == K_TAB) {
567                 chat_bufferlen = Nicks_CompleteChatLine(chat_buffer, sizeof(chat_buffer), chat_bufferlen);
568                 return;
569         }
570
571         if (chat_bufferlen == sizeof (chat_buffer) - 1)
572                 return;                                                 // all full
573
574         if (!ascii)
575                 return;                                                 // non printable
576
577         chat_buffer[chat_bufferlen++] = ascii;
578         chat_buffer[chat_bufferlen] = 0;
579 }
580
581 //============================================================================
582
583
584 /*
585 ===================
586 Returns a key number to be used to index keybindings[] by looking at
587 the given string.  Single ascii characters return themselves, while
588 the K_* names are matched up.
589 ===================
590 */
591 int
592 Key_StringToKeynum (const char *str)
593 {
594         const keyname_t  *kn;
595
596         if (!str || !str[0])
597                 return -1;
598         if (!str[1])
599                 return tolower(str[0]);
600
601         for (kn = keynames; kn->name; kn++) {
602                 if (!strcasecmp (str, kn->name))
603                         return kn->keynum;
604         }
605         return -1;
606 }
607
608 /*
609 ===================
610 Returns a string (either a single ascii char, or a K_* name) for the
611 given keynum.
612 FIXME: handle quote special (general escape sequence?)
613 ===================
614 */
615 const char *
616 Key_KeynumToString (int keynum)
617 {
618         const keyname_t  *kn;
619         static char tinystr[2];
620
621         // -1 is an invalid code
622         if (keynum < 0)
623                 return "<KEY NOT FOUND>";
624
625         // search overrides first, because some characters are special
626         for (kn = keynames; kn->name; kn++)
627                 if (keynum == kn->keynum)
628                         return kn->name;
629
630         // if it is printable, output it as a single character
631         if (keynum > 32 && keynum < 256)
632         {
633                 tinystr[0] = keynum;
634                 tinystr[1] = 0;
635                 return tinystr;
636         }
637
638         // if it is not overridden and not printable, we don't know what to do with it
639         return "<UNKNOWN KEYNUM>";
640 }
641
642
643 void
644 Key_SetBinding (int keynum, int bindmap, const char *binding)
645 {
646         char *newbinding;
647         size_t l;
648
649         if (keynum == -1 || keynum >= MAX_KEYS)
650                 return;
651
652 // free old bindings
653         if (keybindings[bindmap][keynum]) {
654                 Z_Free (keybindings[bindmap][keynum]);
655                 keybindings[bindmap][keynum] = NULL;
656         }
657         if(!binding[0]) // make "" binds be removed --blub
658                 return;
659 // allocate memory for new binding
660         l = strlen (binding);
661         newbinding = (char *)Z_Malloc (l + 1);
662         memcpy (newbinding, binding, l + 1);
663         newbinding[l] = 0;
664         keybindings[bindmap][keynum] = newbinding;
665 }
666
667 static void
668 Key_In_Unbind_f (void)
669 {
670         int         b, m;
671
672         if (Cmd_Argc () != 3) {
673                 Con_Print("in_unbind <bindmap> <key> : remove commands from a key\n");
674                 return;
675         }
676
677         m = strtol(Cmd_Argv (1), NULL, 0);
678         if ((m < 0) || (m >= 8)) {
679                 Con_Printf("%d isn't a valid bindmap\n", m);
680                 return;
681         }
682
683         b = Key_StringToKeynum (Cmd_Argv (2));
684         if (b == -1) {
685                 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
686                 return;
687         }
688
689         Key_SetBinding (b, m, "");
690 }
691
692 static void
693 Key_In_Bind_f (void)
694 {
695         int         i, c, b, m;
696         char        cmd[MAX_INPUTLINE];
697
698         c = Cmd_Argc ();
699
700         if (c != 3 && c != 4) {
701                 Con_Print("in_bind <bindmap> <key> [command] : attach a command to a key\n");
702                 return;
703         }
704
705         m = strtol(Cmd_Argv (1), NULL, 0);
706         if ((m < 0) || (m >= 8)) {
707                 Con_Printf("%d isn't a valid bindmap\n", m);
708                 return;
709         }
710
711         b = Key_StringToKeynum (Cmd_Argv (2));
712         if (b == -1 || b >= MAX_KEYS) {
713                 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (2));
714                 return;
715         }
716
717         if (c == 3) {
718                 if (keybindings[m][b])
719                         Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (2), keybindings[m][b]);
720                 else
721                         Con_Printf("\"%s\" is not bound\n", Cmd_Argv (2));
722                 return;
723         }
724 // copy the rest of the command line
725         cmd[0] = 0;                                                     // start out with a null string
726         for (i = 3; i < c; i++) {
727                 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
728                 if (i != (c - 1))
729                         strlcat (cmd, " ", sizeof (cmd));
730         }
731
732         Key_SetBinding (b, m, cmd);
733 }
734
735 static void
736 Key_In_Bindmap_f (void)
737 {
738         int         m1, m2, c;
739
740         c = Cmd_Argc ();
741
742         if (c != 3) {
743                 Con_Print("in_bindmap <bindmap> <fallback>: set current bindmap and fallback\n");
744                 return;
745         }
746
747         m1 = strtol(Cmd_Argv (1), NULL, 0);
748         if ((m1 < 0) || (m1 >= 8)) {
749                 Con_Printf("%d isn't a valid bindmap\n", m1);
750                 return;
751         }
752
753         m2 = strtol(Cmd_Argv (2), NULL, 0);
754         if ((m2 < 0) || (m2 >= 8)) {
755                 Con_Printf("%d isn't a valid bindmap\n", m2);
756                 return;
757         }
758
759         key_bmap = m1;
760         key_bmap2 = m2;
761 }
762
763 static void
764 Key_Unbind_f (void)
765 {
766         int         b;
767
768         if (Cmd_Argc () != 2) {
769                 Con_Print("unbind <key> : remove commands from a key\n");
770                 return;
771         }
772
773         b = Key_StringToKeynum (Cmd_Argv (1));
774         if (b == -1) {
775                 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
776                 return;
777         }
778
779         Key_SetBinding (b, 0, "");
780 }
781
782 static void
783 Key_Unbindall_f (void)
784 {
785         int         i, j;
786
787         for (j = 0; j < 8; j++)
788                 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
789                         if (keybindings[j][i])
790                                 Key_SetBinding (i, j, "");
791 }
792
793
794 static void
795 Key_Bind_f (void)
796 {
797         int         i, c, b;
798         char        cmd[MAX_INPUTLINE];
799
800         c = Cmd_Argc ();
801
802         if (c != 2 && c != 3) {
803                 Con_Print("bind <key> [command] : attach a command to a key\n");
804                 return;
805         }
806         b = Key_StringToKeynum (Cmd_Argv (1));
807         if (b == -1 || b >= MAX_KEYS) {
808                 Con_Printf("\"%s\" isn't a valid key\n", Cmd_Argv (1));
809                 return;
810         }
811
812         if (c == 2) {
813                 if (keybindings[0][b])
814                         Con_Printf("\"%s\" = \"%s\"\n", Cmd_Argv (1), keybindings[0][b]);
815                 else
816                         Con_Printf("\"%s\" is not bound\n", Cmd_Argv (1));
817                 return;
818         }
819 // copy the rest of the command line
820         cmd[0] = 0;                                                     // start out with a null string
821         for (i = 2; i < c; i++) {
822                 strlcat (cmd, Cmd_Argv (i), sizeof (cmd));
823                 if (i != (c - 1))
824                         strlcat (cmd, " ", sizeof (cmd));
825         }
826
827         Key_SetBinding (b, 0, cmd);
828 }
829
830 /*
831 ============
832 Writes lines containing "bind key value"
833 ============
834 */
835 void
836 Key_WriteBindings (qfile_t *f)
837 {
838         int         i, j;
839         char bindbuf[MAX_INPUTLINE];
840         const char *p;
841
842         for (j = 0; j < MAX_BINDMAPS; j++)
843         {
844                 for (i = 0; i < (int)(sizeof(keybindings[0])/sizeof(keybindings[0][0])); i++)
845                 {
846                         p = keybindings[j][i];
847                         if (p)
848                         {
849                                 Cmd_QuoteString(bindbuf, sizeof(bindbuf), p, "\"\\");
850                                 if (j == 0)
851                                         FS_Printf(f, "bind %s \"%s\"\n", Key_KeynumToString (i), bindbuf);
852                                 else
853                                         FS_Printf(f, "in_bind %d %s \"%s\"\n", j, Key_KeynumToString (i), bindbuf);
854                         }
855                 }
856         }
857 }
858
859
860 void
861 Key_Init (void)
862 {
863         int         i;
864
865         for (i = 0; i < 32; i++) {
866                 key_lines[i][0] = ']';
867                 key_lines[i][1] = 0;
868         }
869         key_linepos = 1;
870
871 //
872 // register our functions
873 //
874         Cmd_AddCommand ("in_bind", Key_In_Bind_f, "binds a command to the specified key in the selected bindmap");
875         Cmd_AddCommand ("in_unbind", Key_In_Unbind_f, "removes command on the specified key in the selected bindmap");
876         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");
877
878         Cmd_AddCommand ("bind", Key_Bind_f, "binds a command to the specified key in bindmap 0");
879         Cmd_AddCommand ("unbind", Key_Unbind_f, "removes a command on the specified key in bindmap 0");
880         Cmd_AddCommand ("unbindall", Key_Unbindall_f, "removes all commands from all keys in all bindmaps (leaving only shift-escape and escape)");
881
882         Cvar_RegisterVariable (&con_closeontoggleconsole);
883 }
884
885 const char *Key_GetBind (int key)
886 {
887         const char *bind;
888         if (key < 0 || key >= MAX_KEYS)
889                 return NULL;
890         bind = keybindings[key_bmap][key];
891         if (!bind)
892                 bind = keybindings[key_bmap2][key];
893         return bind;
894 }
895
896 qboolean CL_VM_InputEvent (qboolean down, int key, int ascii);
897
898 /*
899 ===================
900 Called by the system between frames for both key up and key down events
901 Should NOT be called during an interrupt!
902 ===================
903 */
904 static char tbl_keyascii[MAX_KEYS];
905 static keydest_t tbl_keydest[MAX_KEYS];
906
907 void
908 Key_Event (int key, char ascii, qboolean down)
909 {
910         const char *bind;
911         qboolean q;
912         keydest_t keydest = key_dest;
913
914         if (key < 0 || key >= MAX_KEYS)
915                 return;
916
917         // get key binding
918         bind = keybindings[key_bmap][key];
919         if (!bind)
920                 bind = keybindings[key_bmap2][key];
921
922         if (developer.integer >= 1000)
923                 Con_Printf("Key_Event(%i, '%c', %s) keydown %i bind \"%s\"\n", key, ascii, down ? "down" : "up", keydown[key], bind ? bind : "");
924
925         if(key_consoleactive)
926                 keydest = key_console;
927         
928         if (down)
929         {
930                 // increment key repeat count each time a down is received so that things
931                 // which want to ignore key repeat can ignore it
932                 keydown[key] = min(keydown[key] + 1, 2);
933                 if(keydown[key] == 1) {
934                         tbl_keyascii[key] = ascii;
935                         tbl_keydest[key] = keydest;
936                 } else {
937                         ascii = tbl_keyascii[key];
938                         keydest = tbl_keydest[key];
939                 }
940         }
941         else
942         {
943                 // clear repeat count now that the key is released
944                 keydown[key] = 0;
945                 keydest = tbl_keydest[key];
946                 ascii = tbl_keyascii[key];
947         }
948
949         if(keydest == key_void)
950                 return;
951         
952         // key_consoleactive is a flag not a key_dest because the console is a
953         // high priority overlay ontop of the normal screen (designed as a safety
954         // feature so that developers and users can rescue themselves from a bad
955         // situation).
956         //
957         // this also means that toggling the console on/off does not lose the old
958         // key_dest state
959
960         // specially handle escape (togglemenu) and shift-escape (toggleconsole)
961         // engine bindings, these are not handled as normal binds so that the user
962         // can recover from a completely empty bindmap
963         if (key == K_ESCAPE)
964         {
965                 // ignore key repeats on escape
966                 if (keydown[key] > 1)
967                         return;
968
969                 // escape does these things:
970                 // key_consoleactive - close console
971                 // key_message - abort messagemode
972                 // key_menu - go to parent menu (or key_game)
973                 // key_game - open menu
974
975                 // in all modes shift-escape toggles console
976                 if (keydown[K_SHIFT])
977                 {
978                         if(down)
979                         {
980                                 Con_ToggleConsole_f ();
981                                 tbl_keydest[key] = key_void; // esc release should go nowhere (especially not to key_menu or key_game)
982                         }
983                         return;
984                 }
985
986                 switch (keydest)
987                 {
988                         case key_console:
989                                 if(down)
990                                 {
991                                         if(key_consoleactive & KEY_CONSOLEACTIVE_FORCED)
992                                         {
993                                                 key_consoleactive &= ~KEY_CONSOLEACTIVE_USER;
994                                                 MR_ToggleMenu_f ();
995                                         }
996                                         else
997                                                 Con_ToggleConsole_f();
998                                 }
999                                 break;
1000
1001                         case key_message:
1002                                 if (down)
1003                                         Key_Message (key, ascii); // that'll close the message input
1004                                 break;
1005
1006                         case key_menu:
1007                         case key_menu_grabbed:
1008                                 MR_KeyEvent (key, ascii, down);
1009                                 break;
1010
1011                         case key_game:
1012                                 // csqc has priority over toggle menu if it wants to (e.g. handling escape for UI stuff in-game.. :sick:)
1013                                 q = CL_VM_InputEvent(down, key, ascii);
1014                                 if (!q && down)
1015                                         MR_ToggleMenu_f ();
1016                                 break;
1017
1018                         default:
1019                                 Con_Printf ("Key_Event: Bad key_dest\n");
1020                 }
1021                 return;
1022         }
1023
1024         // send function keydowns to interpreter no matter what mode is (unless the menu has specifically grabbed the keyboard, for rebinding keys)
1025         if (keydest != key_menu_grabbed)
1026         if (key >= K_F1 && key <= K_F12)
1027         {
1028                 if (bind)
1029                 {
1030                         if(keydown[key] == 1 && down)
1031                         {
1032                                 // button commands add keynum as a parm
1033                                 if (bind[0] == '+')
1034                                         Cbuf_AddText (va("%s %i\n", bind, key));
1035                                 else
1036                                 {
1037                                         Cbuf_AddText (bind);
1038                                         Cbuf_AddText ("\n");
1039                                 }
1040                         } else if(bind[0] == '+' && !down && keydown[key] == 0)
1041                                 Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1042                 }
1043                 return;
1044         }
1045
1046         // send input to console if it wants it
1047         if (keydest == key_console)
1048         {
1049                 if (!down)
1050                         return;
1051                 // con_closeontoggleconsole enables toggleconsole keys to close the
1052                 // console, as long as they are not the color prefix character
1053                 // (special exemption for german keyboard layouts)
1054                 if (con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && (key_consoleactive & KEY_CONSOLEACTIVE_USER) && ascii != STRING_COLOR_TAG)
1055                 {
1056                         Con_ToggleConsole_f ();
1057                         return;
1058                 }
1059                 Key_Console (key, ascii);
1060                 return;
1061         }
1062
1063         // handle toggleconsole in menu too
1064         if (keydest == key_menu)
1065         {
1066                 if (down && con_closeontoggleconsole.integer && bind && !strncmp(bind, "toggleconsole", strlen("toggleconsole")) && ascii != STRING_COLOR_TAG)
1067                 {
1068                         Con_ToggleConsole_f ();
1069                         tbl_keydest[key] = key_void; // key release should go nowhere (especially not to key_menu or key_game)
1070                         return;
1071                 }
1072         }
1073
1074         // ignore binds while a video is played, let the video system handle the key event
1075         if (cl_videoplaying)
1076         {
1077                 CL_Video_KeyEvent (key, ascii, keydown[key] != 0);
1078                 return;
1079         }
1080
1081         // anything else is a key press into the game, chat line, or menu
1082         switch (keydest)
1083         {
1084                 case key_message:
1085                         if (down)
1086                                 Key_Message (key, ascii);
1087                         break;
1088                 case key_menu:
1089                 case key_menu_grabbed:
1090                         MR_KeyEvent (key, ascii, down);
1091                         break;
1092                 case key_game:
1093                         q = CL_VM_InputEvent(down, key, ascii);
1094                         // ignore key repeats on binds and only send the bind if the event hasnt been already processed by csqc
1095                         if (!q && bind)
1096                         {
1097                                 if(keydown[key] == 1 && down)
1098                                 {
1099                                         // button commands add keynum as a parm
1100                                         if (bind[0] == '+')
1101                                                 Cbuf_AddText (va("%s %i\n", bind, key));
1102                                         else
1103                                         {
1104                                                 Cbuf_AddText (bind);
1105                                                 Cbuf_AddText ("\n");
1106                                         }
1107                                 } else if(bind[0] == '+' && !down && keydown[key] == 0)
1108                                         Cbuf_AddText(va("-%s %i\n", bind + 1, key));
1109                         }
1110                         break;
1111                 default:
1112                         Con_Printf ("Key_Event: Bad key_dest\n");
1113         }
1114 }
1115
1116 /*
1117 ===================
1118 Key_ClearStates
1119 ===================
1120 */
1121 void
1122 Key_ClearStates (void)
1123 {
1124         memset(keydown, 0, sizeof(keydown));
1125 }