ggi support
[btb/d2x.git] / input / ggi / include / key.h
1 /*
2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
11 COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
12 */
13 /*
14  * $Source: /cvs/cvsroot/d2x/input/ggi/include/key.h,v $
15  * $Revision: 1.2 $
16  * $Author: bradleyb $
17  * $Date: 2001-01-22 15:42:15 $
18  *
19  * Header for keyboard functions
20  *
21  * $Log: not supported by cvs2svn $
22  * Revision 1.1.1.1  2001/01/19 03:29:59  bradleyb
23  * Import of d2x-0.0.8
24  *
25  * Revision 1.2  1999/07/10 02:59:06  donut
26  * more from orulz
27  *
28  * Revision 1.19  1994/10/24  13:58:12  john
29  * Hacked in support for pause key onto code 0x61.
30  * 
31  * Revision 1.18  1994/10/21  15:17:10  john
32  * Added KEY_PRINT_SCREEN
33  * 
34  * Revision 1.17  1994/08/31  12:22:13  john
35  * Added KEY_DEBUGGED
36  * 
37  * Revision 1.16  1994/08/24  18:53:50  john
38  * Made Cyberman read like normal mouse; added dpmi module; moved
39  * mouse from assembly to c. Made mouse buttons return time_down.
40  * 
41  * Revision 1.15  1994/08/18  14:56:16  john
42  * *** empty log message ***
43  * 
44  * Revision 1.14  1994/08/08  10:43:24  john
45  * Recorded when a key was pressed for key_inkey_time.
46  * 
47  * Revision 1.13  1994/06/17  17:17:28  john
48  * Added keyd_time_last_key_was_pressed or something like that.
49  * 
50  * Revision 1.12  1994/04/29  12:14:19  john
51  * Locked all memory used during interrupts so that program
52  * won't hang when using virtual memory.
53  * 
54  * Revision 1.11  1994/02/17  15:57:14  john
55  * Changed key libary to C.
56  * 
57  * Revision 1.10  1994/01/31  08:34:09  john
58  * Fixed reversed lshift/rshift keys.
59  * 
60  * Revision 1.9  1994/01/18  10:58:17  john
61  * *** empty log message ***
62  * 
63  * Revision 1.8  1993/10/16  19:24:43  matt
64  * Added new function key_clear_times() & key_clear_counts()
65  * 
66  * Revision 1.7  1993/10/15  10:17:09  john
67  * added keyd_last_key_pressed and released for use with recorder.
68  * 
69  * Revision 1.6  1993/10/06  16:20:37  john
70  * fixed down arrow bug
71  * 
72  * Revision 1.5  1993/10/04  13:26:42  john
73  * changed the #defines for scan codes.
74  * 
75  * Revision 1.4  1993/09/28  11:35:20  john
76  * added key_peekkey
77  * 
78  * Revision 1.3  1993/09/20  18:36:43  john
79  * *** empty log message ***
80  * 
81  * Revision 1.1  1993/07/10  13:10:39  matt
82  * Initial revision
83  * 
84  *
85  */
86
87 #ifndef _KEY_H
88 #define _KEY_H 
89
90 #include "fix.h"
91 #include "pstypes.h"
92 #include <ctype.h> // For 'toupper'
93
94 extern int giiKeyTranslate (int keylabel);
95
96 //==========================================================================
97 // This installs the int9 vector and initializes the keyboard in buffered
98 // ASCII mode. key_close simply undoes that.
99 extern void key_init();
100 extern void key_close();
101
102 //==========================================================================
103 // These are configuration parameters to setup how the buffer works.
104 // set keyd_buffer_type to 0 for no key buffering.
105 // set it to 1 and it will buffer scancodes.
106 extern unsigned char keyd_buffer_type;
107 extern unsigned char keyd_repeat;        // 1=allow repeating, 0=dont allow repeat
108
109 // keyd_editor_mode... 0=game mode, 1=editor mode.
110 // Editor mode makes key_down_time always return 0 if modifiers are down.
111 extern unsigned char keyd_editor_mode;
112
113 // Time in seconds when last key was pressed...
114 extern volatile int keyd_time_when_last_pressed;
115
116 //==========================================================================
117 // These are the "buffered" keypress routines.  Use them by setting the
118 // "keyd_buffer_type" variable.
119
120 extern void key_putkey (unsigned short); // simulates a keystroke
121 extern void key_flush();    // Clears the 256 char buffer
122 extern int key_checkch();   // Returns 1 if a char is waiting
123 extern int key_getch();     // Gets key if one waiting other waits for one.
124 extern int key_inkey();     // Gets key if one, other returns 0.
125 extern int key_inkey_time(fix *time);     // Same as inkey, but returns the time the key was pressed down.
126 extern int key_peekkey();   // Same as inkey, but doesn't remove key from buffer.
127
128 extern unsigned char key_to_ascii(int keycode );
129 extern char *key_name(int keycode); // Convert keycode to the name of the key
130
131 extern void key_debug();    // Does an INT3
132
133 //==========================================================================
134 // These are the unbuffered routines. Index by the keyboard scancode.
135
136 // Set to 1 if the key is currently down, else 0
137 extern volatile unsigned char keyd_pressed[];
138 extern volatile unsigned char keyd_last_pressed;
139 extern volatile unsigned char keyd_last_released;
140
141 // Returns the seconds this key has been down since last call.
142 extern fix key_down_time(int scancode);
143
144 // Returns number of times key has went from up to down since last call.
145 extern unsigned int key_down_count(int scancode);
146
147 // Returns number of times key has went from down to up since last call.
148 extern unsigned int key_up_count(int scancode);
149
150 // Clears the times & counts used by the above functions
151 // Took out... use key_flush();
152 //void key_clear_times();
153 //void key_clear_counts();
154
155 extern char * key_text[256];
156
157 #define KEY_SHIFTED     0x100
158 #define KEY_ALTED       0x200
159 #define KEY_CTRLED      0x400
160 #define KEY_DEBUGGED    0x800
161
162 #define KEY_0           0x0B
163 #define KEY_1           0x02
164 #define KEY_2           0x03
165 #define KEY_3           0x04
166 #define KEY_4           0x05
167 #define KEY_5           0x06
168 #define KEY_6           0x07
169 #define KEY_7           0x08
170 #define KEY_8           0x09
171 #define KEY_9           0x0A
172
173 #define KEY_A           0x1E
174 #define KEY_B           0x30
175 #define KEY_C           0x2E
176 #define KEY_D           0x20
177 #define KEY_E           0x12
178 #define KEY_F           0x21
179 #define KEY_G           0x22
180 #define KEY_H           0x23
181 #define KEY_I           0x17
182 #define KEY_J           0x24
183 #define KEY_K           0x25
184 #define KEY_L           0x26
185 #define KEY_M           0x32
186 #define KEY_N           0x31
187 #define KEY_O           0x18
188 #define KEY_P           0x19
189 #define KEY_Q           0x10
190 #define KEY_R           0x13
191 #define KEY_S           0x1F
192 #define KEY_T           0x14
193 #define KEY_U           0x16
194 #define KEY_V           0x2F
195 #define KEY_W           0x11
196 #define KEY_X           0x2D
197 #define KEY_Y           0x15
198 #define KEY_Z           0x2C
199
200 #define KEY_MINUS       0x0C
201 #define KEY_EQUAL       0x0D
202 #define KEY_DIVIDE      0x35
203 #define KEY_SLASH       0x2B
204 #define KEY_COMMA       0x33
205 #define KEY_PERIOD      0x34
206 #define KEY_SEMICOL     0x27
207
208 #define KEY_LBRACKET    0x1A
209 #define KEY_RBRACKET    0x1B
210
211 #define KEY_RAPOSTRO    0x28
212 #define KEY_LAPOSTRO    0x29
213
214 #define KEY_ESC         0x01
215 #define KEY_ENTER       0x1C
216 #define KEY_BACKSP      0x0E
217 #define KEY_TAB         0x0F
218 #define KEY_SPACEBAR    0x39
219
220 #define KEY_NUMLOCK     0x45
221 #define KEY_SCROLLOCK   0x46
222 #define KEY_CAPSLOCK    0x3A
223
224 #define KEY_LSHIFT      0x2A
225 #define KEY_RSHIFT      0x36
226
227 #define KEY_LALT        0x38
228 #define KEY_RALT        0xB8
229
230 #define KEY_LCTRL       0x1D
231 #define KEY_RCTRL       0x9D
232
233 #define KEY_F1          0x3B
234 #define KEY_F2          0x3C
235 #define KEY_F3          0x3D
236 #define KEY_F4          0x3E
237 #define KEY_F5          0x3F
238 #define KEY_F6          0x40
239 #define KEY_F7          0x41
240 #define KEY_F8          0x42
241 #define KEY_F9          0x43
242 #define KEY_F10         0x44
243 #define KEY_F11         0x57
244 #define KEY_F12         0x58
245
246 #define KEY_PAD0        0x52
247 #define KEY_PAD1        0x4F
248 #define KEY_PAD2        0x50
249 #define KEY_PAD3        0x51
250 #define KEY_PAD4        0x4B
251 #define KEY_PAD5        0x4C
252 #define KEY_PAD6        0x4D
253 #define KEY_PAD7        0x47
254 #define KEY_PAD8        0x48
255 #define KEY_PAD9        0x49
256 #define KEY_PADMINUS    0x4A
257 #define KEY_PADPLUS     0x4E
258 #define KEY_PADPERIOD   0x53
259 #define KEY_PADDIVIDE   0xB5
260 #define KEY_PADMULTIPLY 0x37
261 #define KEY_PADENTER    0x9C
262
263 #define KEY_INSERT      0xD2
264 #define KEY_HOME        0xC7
265 #define KEY_PAGEUP      0xC9
266 #define KEY_DELETE      0xD3
267 #define KEY_END         0xCF
268 #define KEY_PAGEDOWN    0xD1
269 #define KEY_UP          0xC8
270 #define KEY_DOWN        0xD0
271 #define KEY_LEFT        0xCB
272 #define KEY_RIGHT       0xCD
273
274 #define KEY_PRINT_SCREEN        0xB7
275 #define KEY_PAUSE                       0x61
276
277 #endif