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