fixed a major memory leak and removed a bit of redundancy (d1x r1.5)
[btb/d2x.git] / arch / 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-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
12 */
13
14 /*
15  * $Source: /cvs/cvsroot/d2x/arch/include/key.h,v $
16  * $Revision: 1.2 $
17  * $Author: bradleyb $
18  * $Date: 2001-01-28 16:21:54 $
19  *
20  * Header for keyboard functions
21  *
22  * $Log: not supported by cvs2svn $
23  * Revision 1.1  2001/01/28 05:46:33  bradleyb
24  * Unified arch headers
25  *
26  */
27
28 #ifndef _KEY_H
29 #define _KEY_H 
30
31 #include "pstypes.h"
32 #include "fix.h"
33
34 //==========================================================================
35 // This installs the int9 vector and initializes the keyboard in buffered
36 // ASCII mode. key_close simply undoes that.
37 extern void key_init();
38 extern void key_close();
39
40 //==========================================================================
41 // These are configuration parameters to setup how the buffer works.
42 // set keyd_buffer_type to 0 for no key buffering.
43 // set it to 1 and it will buffer scancodes.
44 extern unsigned char keyd_buffer_type;
45 extern unsigned char keyd_repeat;     // 1=allow repeating, 0=dont allow repeat
46
47 // keyd_editor_mode... 0=game mode, 1=editor mode.
48 // Editor mode makes key_down_time always return 0 if modifiers are down.
49 extern unsigned char keyd_editor_mode;          
50
51 // Time in seconds when last key was pressed...
52 extern volatile int keyd_time_when_last_pressed;
53
54 //==========================================================================
55 // These are the "buffered" keypress routines.  Use them by setting the
56 // "keyd_buffer_type" variable.
57
58 extern void key_putkey (unsigned short); // simulates a keystroke
59 extern void key_flush();    // Clears the 256 char buffer
60 extern int key_checkch();   // Returns 1 if a char is waiting
61 extern int key_getch();     // Gets key if one waiting other waits for one.
62 extern int key_inkey();     // Gets key if one, other returns 0.
63 extern int key_inkey_time(fix *time);     // Same as inkey, but returns the time the key was pressed down.
64 extern int key_peekkey();   // Same as inkey, but doesn't remove key from buffer.
65
66 extern unsigned char key_to_ascii(int keycode );
67
68 extern void key_debug();    // Does an INT3
69
70 //==========================================================================
71 // These are the unbuffered routines. Index by the keyboard scancode.
72
73 // Set to 1 if the key is currently down, else 0
74 extern volatile unsigned char keyd_pressed[];
75 extern volatile unsigned char keyd_last_pressed;
76 extern volatile unsigned char keyd_last_released;
77
78 // Returns the seconds this key has been down since last call.
79 extern fix key_down_time(int scancode);
80
81 // Returns number of times key has went from up to down since last call.
82 extern unsigned int key_down_count(int scancode);
83
84 // Returns number of times key has went from down to up since last call.
85 extern unsigned int key_up_count(int scancode);
86
87 // Clears the times & counts used by the above functions
88 // Took out... use key_flush();
89 //void key_clear_times();
90 //void key_clear_counts();
91
92 extern char * key_text[256];
93
94 #define KEY_SHIFTED     0x100
95 #define KEY_ALTED       0x200
96 #define KEY_CTRLED      0x400
97 #define KEY_DEBUGGED            0x800
98
99 #define KEY_0           0x0B
100 #define KEY_1           0x02
101 #define KEY_2           0x03
102 #define KEY_3           0x04
103 #define KEY_4           0x05
104 #define KEY_5           0x06
105 #define KEY_6           0x07
106 #define KEY_7           0x08
107 #define KEY_8           0x09
108 #define KEY_9           0x0A
109
110 #define KEY_A           0x1E
111 #define KEY_B           0x30
112 #define KEY_C           0x2E
113 #define KEY_D           0x20
114 #define KEY_E           0x12
115 #define KEY_F           0x21
116 #define KEY_G           0x22
117 #define KEY_H           0x23
118 #define KEY_I           0x17
119 #define KEY_J           0x24
120 #define KEY_K           0x25
121 #define KEY_L           0x26
122 #define KEY_M           0x32
123 #define KEY_N           0x31
124 #define KEY_O           0x18
125 #define KEY_P           0x19
126 #define KEY_Q           0x10
127 #define KEY_R           0x13
128 #define KEY_S           0x1F
129 #define KEY_T           0x14
130 #define KEY_U           0x16
131 #define KEY_V           0x2F
132 #define KEY_W           0x11
133 #define KEY_X           0x2D
134 #define KEY_Y           0x15
135 #define KEY_Z           0x2C
136
137 #define KEY_MINUS       0x0C
138 #define KEY_EQUAL       0x0D
139 //Note: this is what we normally think of as slash:
140 #define KEY_DIVIDE      0x35
141 //Note: this is BACKslash:
142 #define KEY_SLASH       0x2B
143 #define KEY_COMMA       0x33
144 #define KEY_PERIOD      0x34
145 #define KEY_SEMICOL     0x27
146
147 #define KEY_LBRACKET    0x1A
148 #define KEY_RBRACKET    0x1B
149
150 #define KEY_RAPOSTRO    0x28
151 #define KEY_LAPOSTRO    0x29
152
153 #define KEY_ESC         0x01
154 #define KEY_ENTER       0x1C
155 #define KEY_BACKSP      0x0E
156 #define KEY_TAB         0x0F
157 #define KEY_SPACEBAR    0x39
158
159 #define KEY_NUMLOCK     0x45
160 #define KEY_SCROLLOCK   0x46
161 #define KEY_CAPSLOCK    0x3A
162
163 #define KEY_LSHIFT      0x2A
164 #define KEY_RSHIFT      0x36
165
166 #define KEY_LALT        0x38
167 #define KEY_RALT        0xB8
168
169 #define KEY_LCTRL       0x1D
170 #define KEY_RCTRL       0x9D
171
172 #define KEY_F1          0x3B
173 #define KEY_F2          0x3C
174 #define KEY_F3          0x3D
175 #define KEY_F4          0x3E
176 #define KEY_F5          0x3F
177 #define KEY_F6          0x40
178 #define KEY_F7          0x41
179 #define KEY_F8          0x42
180 #define KEY_F9          0x43
181 #define KEY_F10         0x44
182 #define KEY_F11         0x57
183 #define KEY_F12         0x58
184
185 #define KEY_PAD0        0x52
186 #define KEY_PAD1        0x4F
187 #define KEY_PAD2        0x50
188 #define KEY_PAD3        0x51
189 #define KEY_PAD4        0x4B
190 #define KEY_PAD5        0x4C
191 #define KEY_PAD6        0x4D
192 #define KEY_PAD7        0x47
193 #define KEY_PAD8        0x48
194 #define KEY_PAD9        0x49
195 #define KEY_PADMINUS    0x4A
196 #define KEY_PADPLUS     0x4E
197 #define KEY_PADPERIOD   0x53
198 #define KEY_PADDIVIDE   0xB5
199 #define KEY_PADMULTIPLY 0x37
200 #define KEY_PADENTER    0x9C
201
202 #define KEY_INSERT      0xD2
203 #define KEY_HOME        0xC7
204 #define KEY_PAGEUP      0xC9
205 #define KEY_DELETE      0xD3
206 #define KEY_END         0xCF
207 #define KEY_PAGEDOWN    0xD1
208 #define KEY_UP          0xC8
209 #define KEY_DOWN        0xD0
210 #define KEY_LEFT        0xCB
211 #define KEY_RIGHT       0xCD
212
213 #define KEY_PRINT_SCREEN        0xB7
214 #define KEY_PAUSE                       0x61
215
216 #endif