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.
14 * $Source: /cvs/cvsroot/d2x/input/ggi/include/key.h,v $
17 * $Date: 2001-01-22 15:42:15 $
19 * Header for keyboard functions
21 * $Log: not supported by cvs2svn $
22 * Revision 1.1.1.1 2001/01/19 03:29:59 bradleyb
25 * Revision 1.2 1999/07/10 02:59:06 donut
28 * Revision 1.19 1994/10/24 13:58:12 john
29 * Hacked in support for pause key onto code 0x61.
31 * Revision 1.18 1994/10/21 15:17:10 john
32 * Added KEY_PRINT_SCREEN
34 * Revision 1.17 1994/08/31 12:22:13 john
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.
41 * Revision 1.15 1994/08/18 14:56:16 john
42 * *** empty log message ***
44 * Revision 1.14 1994/08/08 10:43:24 john
45 * Recorded when a key was pressed for key_inkey_time.
47 * Revision 1.13 1994/06/17 17:17:28 john
48 * Added keyd_time_last_key_was_pressed or something like that.
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.
54 * Revision 1.11 1994/02/17 15:57:14 john
55 * Changed key libary to C.
57 * Revision 1.10 1994/01/31 08:34:09 john
58 * Fixed reversed lshift/rshift keys.
60 * Revision 1.9 1994/01/18 10:58:17 john
61 * *** empty log message ***
63 * Revision 1.8 1993/10/16 19:24:43 matt
64 * Added new function key_clear_times() & key_clear_counts()
66 * Revision 1.7 1993/10/15 10:17:09 john
67 * added keyd_last_key_pressed and released for use with recorder.
69 * Revision 1.6 1993/10/06 16:20:37 john
70 * fixed down arrow bug
72 * Revision 1.5 1993/10/04 13:26:42 john
73 * changed the #defines for scan codes.
75 * Revision 1.4 1993/09/28 11:35:20 john
78 * Revision 1.3 1993/09/20 18:36:43 john
79 * *** empty log message ***
81 * Revision 1.1 1993/07/10 13:10:39 matt
92 #include <ctype.h> // For 'toupper'
94 extern int giiKeyTranslate (int keylabel);
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();
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
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;
113 // Time in seconds when last key was pressed...
114 extern volatile int keyd_time_when_last_pressed;
116 //==========================================================================
117 // These are the "buffered" keypress routines. Use them by setting the
118 // "keyd_buffer_type" variable.
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.
128 extern unsigned char key_to_ascii(int keycode );
129 extern char *key_name(int keycode); // Convert keycode to the name of the key
131 extern void key_debug(); // Does an INT3
133 //==========================================================================
134 // These are the unbuffered routines. Index by the keyboard scancode.
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;
141 // Returns the seconds this key has been down since last call.
142 extern fix key_down_time(int scancode);
144 // Returns number of times key has went from up to down since last call.
145 extern unsigned int key_down_count(int scancode);
147 // Returns number of times key has went from down to up since last call.
148 extern unsigned int key_up_count(int scancode);
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();
155 extern char * key_text[256];
157 #define KEY_SHIFTED 0x100
158 #define KEY_ALTED 0x200
159 #define KEY_CTRLED 0x400
160 #define KEY_DEBUGGED 0x800
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
208 #define KEY_LBRACKET 0x1A
209 #define KEY_RBRACKET 0x1B
211 #define KEY_RAPOSTRO 0x28
212 #define KEY_LAPOSTRO 0x29
215 #define KEY_ENTER 0x1C
216 #define KEY_BACKSP 0x0E
218 #define KEY_SPACEBAR 0x39
220 #define KEY_NUMLOCK 0x45
221 #define KEY_SCROLLOCK 0x46
222 #define KEY_CAPSLOCK 0x3A
224 #define KEY_LSHIFT 0x2A
225 #define KEY_RSHIFT 0x36
227 #define KEY_LALT 0x38
228 #define KEY_RALT 0xB8
230 #define KEY_LCTRL 0x1D
231 #define KEY_RCTRL 0x9D
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
263 #define KEY_INSERT 0xD2
264 #define KEY_HOME 0xC7
265 #define KEY_PAGEUP 0xC9
266 #define KEY_DELETE 0xD3
268 #define KEY_PAGEDOWN 0xD1
270 #define KEY_DOWN 0xD0
271 #define KEY_LEFT 0xCB
272 #define KEY_RIGHT 0xCD
274 #define KEY_PRINT_SCREEN 0xB7
275 #define KEY_PAUSE 0x61