beb5df69734769c3e7012c3ff269fc136ef4c8fb
[divverent/darkplaces.git] / keys.h
1 /*
2         $RCSfile$
3
4         Copyright (C) 1996-1997  Id Software, Inc.
5
6         This program is free software; you can redistribute it and/or
7         modify it under the terms of the GNU General Public License
8         as published by the Free Software Foundation; either version 2
9         of the License, or (at your option) any later version.
10
11         This program is distributed in the hope that it will be useful,
12         but WITHOUT ANY WARRANTY; without even the implied warranty of
13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14
15         See the GNU General Public License for more details.
16
17         You should have received a copy of the GNU General Public License
18         along with this program; if not, write to:
19
20                 Free Software Foundation, Inc.
21                 59 Temple Place - Suite 330
22                 Boston, MA  02111-1307, USA
23
24         $Id$
25 */
26
27 #ifndef __KEYS_H
28 #define __KEYS_H
29
30 #include "qtypes.h"
31
32 //
33 // these are the key numbers that should be passed to Key_Event
34 //
35 typedef enum keynum_e
36 {
37         K_TAB                   = 9,
38         K_ENTER                 = 13,
39         K_ESCAPE                = 27,
40         K_SPACE                 = 32,
41
42         // normal keys should be passed as lowercased ascii
43
44         K_BACKSPACE             = 127,
45         K_UPARROW,
46         K_DOWNARROW,
47         K_LEFTARROW,
48         K_RIGHTARROW,
49
50         K_ALT,
51         K_CTRL,
52         K_SHIFT,
53
54         K_F1,
55         K_F2,
56         K_F3,
57         K_F4,
58         K_F5,
59         K_F6,
60         K_F7,
61         K_F8,
62         K_F9,
63         K_F10,
64         K_F11,
65         K_F12,
66
67         K_INS,
68         K_DEL,
69         K_PGDN,
70         K_PGUP,
71         K_HOME,
72         K_END,
73
74         K_PAUSE,
75
76         K_NUMLOCK,
77         K_CAPSLOCK,
78         K_SCROLLOCK,
79
80         K_KP_0,
81         K_KP_INS = K_KP_0,
82         K_KP_1,
83         K_KP_END = K_KP_1,
84         K_KP_2,
85         K_KP_DOWNARROW = K_KP_2,
86         K_KP_3,
87         K_KP_PGDN = K_KP_3,
88         K_KP_4,
89         K_KP_LEFTARROW = K_KP_4,
90         K_KP_5,
91         K_KP_6,
92         K_KP_RIGHTARROW = K_KP_6,
93         K_KP_7,
94         K_KP_HOME = K_KP_7,
95         K_KP_8,
96         K_KP_UPARROW = K_KP_8,
97         K_KP_9,
98         K_KP_PGUP = K_KP_9,
99         K_KP_PERIOD,
100         K_KP_DEL = K_KP_PERIOD,
101         K_KP_DIVIDE,
102         K_KP_SLASH = K_KP_DIVIDE,
103         K_KP_MULTIPLY,
104         K_KP_MINUS,
105         K_KP_PLUS,
106         K_KP_ENTER,
107         K_KP_EQUALS,
108
109         // mouse buttons generate virtual keys
110
111         K_MOUSE1 = 512,
112         K_OTHERDEVICESBEGIN = K_MOUSE1,
113         K_MOUSE2,
114         K_MOUSE3,
115         K_MWHEELUP,
116         K_MWHEELDOWN,
117         K_MOUSE4,
118         K_MOUSE5,
119         K_MOUSE6,
120         K_MOUSE7,
121         K_MOUSE8,
122         K_MOUSE9,
123         K_MOUSE10,
124         K_MOUSE11,
125         K_MOUSE12,
126         K_MOUSE13,
127         K_MOUSE14,
128         K_MOUSE15,
129         K_MOUSE16,
130
131 //
132 // joystick buttons
133 //
134         K_JOY1 = 768,
135         K_JOY2,
136         K_JOY3,
137         K_JOY4,
138         K_JOY5,
139         K_JOY6,
140         K_JOY7,
141         K_JOY8,
142         K_JOY9,
143         K_JOY10,
144         K_JOY11,
145         K_JOY12,
146         K_JOY13,
147         K_JOY14,
148         K_JOY15,
149         K_JOY16,
150
151 //
152 // aux keys are for multi-buttoned joysticks to generate so they can use
153 // the normal binding process
154 //
155         K_AUX1,
156         K_AUX2,
157         K_AUX3,
158         K_AUX4,
159         K_AUX5,
160         K_AUX6,
161         K_AUX7,
162         K_AUX8,
163         K_AUX9,
164         K_AUX10,
165         K_AUX11,
166         K_AUX12,
167         K_AUX13,
168         K_AUX14,
169         K_AUX15,
170         K_AUX16,
171         K_AUX17,
172         K_AUX18,
173         K_AUX19,
174         K_AUX20,
175         K_AUX21,
176         K_AUX22,
177         K_AUX23,
178         K_AUX24,
179         K_AUX25,
180         K_AUX26,
181         K_AUX27,
182         K_AUX28,
183         K_AUX29,
184         K_AUX30,
185         K_AUX31,
186         K_AUX32,
187
188 }
189 keynum_t;
190
191 typedef enum keydest_e { key_game, key_message, key_menu, key_menu_grabbed, key_console, key_void } keydest_t;
192
193 #define MAX_BINDMAPS 8
194 #define MAX_KEYS 1024
195 extern  char            key_line[MAX_INPUTLINE];
196 extern  int                     key_linepos;
197 extern  qboolean        key_insert;     // insert key toggle (for editing)
198 extern  keydest_t       key_dest;
199 // key_consoleactive bits
200 // user wants console (halfscreen)
201 #define KEY_CONSOLEACTIVE_USER 1
202 // console forced because there's nothing else active (fullscreen)
203 #define KEY_CONSOLEACTIVE_FORCED 4
204 extern  int                     key_consoleactive;
205 extern  char            *keybindings[MAX_BINDMAPS][MAX_KEYS];
206
207 extern void Key_ClearEditLine(int edit_line);
208 extern int chat_mode; // 0 for say, 1 for say_team, -1 for command
209 extern char chat_buffer[MAX_INPUTLINE];
210 extern unsigned int chat_bufferlen;
211
212 void Key_WriteBindings(qfile_t *f);
213 void Key_Init(void);
214 void Key_Shutdown(void);
215 void Key_Init_Cvars(void);
216 void Key_Event(int key, int ascii, qboolean down);
217 void Key_ClearStates (void);
218 void Key_SetBinding (int keynum, int bindmap, const char *binding);
219
220 #endif // __KEYS_H
221