arch/win32/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/win32/include/key.h,v $
  15  * $Revision: 1.1.1.1 $
  16  * $Author: bradleyb $
  17  * $Date: 2001-01-19 03:30:15 $
  18  *
  19  * Header for keyboard functions
  20  *
  21  * $Log: not supported by cvs2svn $
  22  * Revision 1.1.1.1  1999/06/14 22:01:23  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 "types.h"
  89 #include <ctype.h> // For 'toupper'
  90
  91 //==========================================================================
  92 // This installs the int9 vector and initializes the keyboard in buffered
  93 // ASCII mode. key_close simply undoes that.
  94 extern void key_init();
  95 extern void key_close();
  96
  97 //==========================================================================
  98 // These are configuration parameters to setup how the buffer works.
  99 // set keyd_buffer_type to 0 for no key buffering.
 100 // set it to 1 and it will buffer scancodes.
 101 extern unsigned char keyd_buffer_type;
 102 extern unsigned char keyd_repeat;        // 1=allow repeating, 0=dont allow repeat
 103
 104 // keyd_editor_mode... 0=game mode, 1=editor mode.
 105 // Editor mode makes key_down_time always return 0 if modifiers are down.
 106 extern unsigned char keyd_editor_mode;
 107
 108 // Time in seconds when last key was pressed...
 109 extern volatile int keyd_time_when_last_pressed;
 110
 111 //==========================================================================
 112 // These are the "buffered" keypress routines.  Use them by setting the
 113 // "keyd_buffer_type" variable.
 114
 115 extern void key_flush();    // Clears the 256 char buffer
 116 extern int key_checkch();   // Returns 1 if a char is waiting
 117 extern int key_getch();     // Gets key if one waiting other waits for one.
 118 extern int key_inkey();     // Gets key if one, other returns 0.
 119 extern int key_inkey_time(fix *time);     // Same as inkey, but returns the time the key was pressed down.
 120 extern int key_peekkey();   // Same as inkey, but doesn't remove key from buffer.
 121
 122 extern unsigned char key_to_ascii(int keycode );
 123 extern char *key_name(int keycode); // Convert keycode to the name of the key
 124
 125 extern void key_debug();    // Does an INT3
 126
 127 //==========================================================================
 128 // These are the unbuffered routines. Index by the keyboard scancode.
 129
 130 // Set to 1 if the key is currently down, else 0
 131 extern volatile unsigned char keyd_pressed[];
 132 extern volatile unsigned char keyd_last_pressed;
 133 extern volatile unsigned char keyd_last_released;
 134
 135 // Returns the seconds this key has been down since last call.
 136 extern fix key_down_time(int scancode);
 137
 138 // Returns number of times key has went from up to down since last call.
 139 extern unsigned int key_down_count(int scancode);
 140
 141 // Returns number of times key has went from down to up since last call.
 142 extern unsigned int key_up_count(int scancode);
 143
 144 // Clears the times & counts used by the above functions
 145 // Took out... use key_flush();
 146 //void key_clear_times();
 147 //void key_clear_counts();
 148
 149 extern char * key_text[256];
 150
 151 #define KEY_SHIFTED     0x100
 152 #define KEY_ALTED       0x200
 153 #define KEY_CTRLED      0x400
 154 #define KEY_DEBUGGED    0x800
 155
 156 #define KEY_0           11
 157 #define KEY_1           2
 158 #define KEY_2           3
 159 #define KEY_3           4
 160 #define KEY_4           5
 161 #define KEY_5           6
 162 #define KEY_6           7
 163 #define KEY_7           8
 164 #define KEY_8           9
 165 #define KEY_9           10
 166
 167 #define KEY_A           30
 168 #define KEY_B           48
 169 #define KEY_C           46
 170 #define KEY_D           32
 171 #define KEY_E           18
 172 #define KEY_F           33
 173 #define KEY_G           34
 174 #define KEY_H           35
 175 #define KEY_I           23
 176 #define KEY_J           36
 177 #define KEY_K           37
 178 #define KEY_L           38
 179 #define KEY_M           50
 180 #define KEY_N           49
 181 #define KEY_O           24
 182 #define KEY_P           25
 183 #define KEY_Q           16
 184 #define KEY_R           19
 185 #define KEY_S           31
 186 #define KEY_T           20
 187 #define KEY_U           22
 188 #define KEY_V           47
 189 #define KEY_W           17
 190 #define KEY_X           45
 191 #define KEY_Y           21
 192 #define KEY_Z           44
 193
 194 #define KEY_MINUS       12
 195 #define KEY_EQUAL       13
 196 #define KEY_DIVIDE      43
 197 #define KEY_SLASH       28
 198 #define KEY_COMMA       51
 199 #define KEY_PERIOD      52
 200 #define KEY_SEMICOL     39
 201
 202 #define KEY_LBRACKET    26
 203 #define KEY_RBRACKET    27
 204
 205 #define KEY_RAPOSTRO    40
 206 #define KEY_LAPOSTRO    41
 207
 208 #define KEY_ESC         1
 209 #define KEY_ENTER       28
 210 #define KEY_BACKSP      14
 211 #define KEY_TAB         15
 212 #define KEY_SPACEBAR    57
 213
 214 #define KEY_NUMLOCK     69
 215 #define KEY_SCROLLOCK   70
 216 #define KEY_CAPSLOCK    58
 217
 218 #define KEY_LSHIFT      42
 219 #define KEY_RSHIFT      54
 220
 221 #define KEY_LALT        56
 222 #define KEY_RALT        194
 223
 224 #define KEY_LCTRL       29
 225 #define KEY_RCTRL       157
 226
 227 #define KEY_F1          59
 228 #define KEY_F2          60
 229 #define KEY_F3          61
 230 #define KEY_F4          62
 231 #define KEY_F5          63
 232 #define KEY_F6          64
 233 #define KEY_F7          65
 234 #define KEY_F8          66
 235 #define KEY_F9          67
 236 #define KEY_F10         68
 237 #define KEY_F11         87
 238 #define KEY_F12         88
 239
 240 #define KEY_PAD0        82
 241 #define KEY_PAD1        79
 242 #define KEY_PAD2        80
 243 #define KEY_PAD3        81
 244 #define KEY_PAD4        75
 245 #define KEY_PAD5        76
 246 #define KEY_PAD6        77
 247 #define KEY_PAD7        71
 248 #define KEY_PAD8        72
 249 #define KEY_PAD9        73
 250 #define KEY_PADMINUS    74
 251 #define KEY_PADPLUS     78
 252 #define KEY_PADPERIOD   83
 253 #define KEY_PADDIVIDE   81
 254 #define KEY_PADMULTIPLY 55
 255 #define KEY_PADENTER    156
 256
 257 #define KEY_INSERT      210
 258 #define KEY_HOME        209
 259 #define KEY_PAGEUP      221
 260 #define KEY_DELETE      211
 261 #define KEY_END         217
 262 #define KEY_PAGEDOWN    219
 263 #define KEY_UP          200
 264 #define KEY_DOWN        208
 265 #define KEY_LEFT        203
 266 #define KEY_RIGHT       205
 267
 268 #define KEY_PRINT_SCREEN        165
 269 #define KEY_PAUSE               143
 270
 271 #endif