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  *
  16  * Header for keyboard functions
  17  *
  18  *
  19  */
  20
  21 #ifndef _KEY_H
  22 #define _KEY_H
  23
  24 #include "pstypes.h"
  25 #include "fix.h"
  26 #include "cfile.h"
  27
  28
  29 //==========================================================================
  30 // This installs the int9 vector and initializes the keyboard in buffered
  31 // ASCII mode. key_close simply undoes that.
  32 extern void key_init();
  33 extern void key_close();
  34
  35 //==========================================================================
  36 // These are configuration parameters to setup how the buffer works.
  37 // set keyd_buffer_type to 0 for no key buffering.
  38 // set it to 1 and it will buffer scancodes.
  39 extern unsigned char keyd_buffer_type;
  40 extern unsigned char keyd_repeat;     // 1=allow repeating, 0=dont allow repeat
  41
  42 // keyd_editor_mode... 0=game mode, 1=editor mode.
  43 // Editor mode makes key_down_time always return 0 if modifiers are down.
  44 extern unsigned char keyd_editor_mode;
  45
  46 // Time in seconds when last key was pressed...
  47 extern volatile int keyd_time_when_last_pressed;
  48
  49 //==========================================================================
  50 // These are the "buffered" keypress routines.  Use them by setting the
  51 // "keyd_buffer_type" variable.
  52
  53 extern void key_putkey (unsigned short); // simulates a keystroke
  54 extern void key_flush();    // Clears the 256 char buffer
  55 extern int key_checkch();   // Returns 1 if a char is waiting
  56 extern int key_getch();     // Gets key if one waiting other waits for one.
  57 extern int key_inkey();     // Gets key if one, other returns 0.
  58 extern int key_inkey_time(fix *time);     // Same as inkey, but returns the time the key was pressed down.
  59 extern int key_peekkey();   // Same as inkey, but doesn't remove key from buffer.
  60
  61 extern unsigned char key_to_ascii(int keycode );
  62
  63 extern void key_debug();    // Does an INT3
  64
  65 //==========================================================================
  66 // These are the unbuffered routines. Index by the keyboard scancode.
  67
  68 // Set to 1 if the key is currently down, else 0
  69 extern volatile unsigned char keyd_pressed[];
  70 extern volatile unsigned char keyd_last_pressed;
  71 extern volatile unsigned char keyd_last_released;
  72
  73 // Returns the seconds this key has been down since last call.
  74 extern fix key_down_time(int scancode);
  75
  76 // Returns number of times key has went from up to down since last call.
  77 extern unsigned int key_down_count(int scancode);
  78
  79 // Returns number of times key has went from down to up since last call.
  80 extern unsigned int key_up_count(int scancode);
  81
  82 // Clears the times & counts used by the above functions
  83 // Took out... use key_flush();
  84 //void key_clear_times();
  85 //void key_clear_counts();
  86
  87 extern char * key_text[256];
  88
  89 /* Write key bindings to file */
  90 void key_write_bindings(CFILE *file);
  91
  92 /* get the action bound to a key, if any */
  93 char *key_binding(ubyte keycode);
  94
  95 /* execute actions bound to key (or other button) */
  96 void key_handle_binding(int keycode, int state);
  97
  98 /* handler for keys including mouse/joystick buttons */
  99 void vkey_handler(int keycode, int state);
 100
 101
 102 #define KEY_SHIFTED     0x100
 103 #define KEY_ALTED       0x200
 104 #define KEY_CTRLED      0x400
 105 #define KEY_DEBUGGED    0x800
 106 #define KEY_METAED      0x1000
 107 #define KEY_COMMAND     KEY_METAED // Mac meta key
 108
 109 #define KEY_0           0x0B
 110 #define KEY_1           0x02
 111 #define KEY_2           0x03
 112 #define KEY_3           0x04
 113 #define KEY_4           0x05
 114 #define KEY_5           0x06
 115 #define KEY_6           0x07
 116 #define KEY_7           0x08
 117 #define KEY_8           0x09
 118 #define KEY_9           0x0A
 119
 120 #define KEY_A           0x1E
 121 #define KEY_B           0x30
 122 #define KEY_C           0x2E
 123 #define KEY_D           0x20
 124 #define KEY_E           0x12
 125 #define KEY_F           0x21
 126 #define KEY_G           0x22
 127 #define KEY_H           0x23
 128 #define KEY_I           0x17
 129 #define KEY_J           0x24
 130 #define KEY_K           0x25
 131 #define KEY_L           0x26
 132 #define KEY_M           0x32
 133 #define KEY_N           0x31
 134 #define KEY_O           0x18
 135 #define KEY_P           0x19
 136 #define KEY_Q           0x10
 137 #define KEY_R           0x13
 138 #define KEY_S           0x1F
 139 #define KEY_T           0x14
 140 #define KEY_U           0x16
 141 #define KEY_V           0x2F
 142 #define KEY_W           0x11
 143 #define KEY_X           0x2D
 144 #define KEY_Y           0x15
 145 #define KEY_Z           0x2C
 146
 147 #define KEY_MINUS       0x0C
 148 #define KEY_EQUAL       0x0D
 149 //Note: this is what we normally think of as slash:
 150 #define KEY_DIVIDE      0x35
 151 //Note: this is BACKslash:
 152 #define KEY_SLASH       0x2B
 153 #define KEY_COMMA       0x33
 154 #define KEY_PERIOD      0x34
 155 #define KEY_SEMICOL     0x27
 156
 157 #define KEY_LBRACKET    0x1A
 158 #define KEY_RBRACKET    0x1B
 159
 160 #define KEY_RAPOSTRO    0x28
 161 #define KEY_LAPOSTRO    0x29
 162
 163 #define KEY_ESC         0x01
 164 #define KEY_ENTER       0x1C
 165 #define KEY_BACKSP      0x0E
 166 #define KEY_TAB         0x0F
 167 #define KEY_SPACEBAR    0x39
 168
 169 #define KEY_NUMLOCK     0x45
 170 #define KEY_SCROLLOCK   0x46
 171 #define KEY_CAPSLOCK    0x3A
 172
 173 #define KEY_LSHIFT      0x2A
 174 #define KEY_RSHIFT      0x36
 175
 176 #define KEY_LALT        0x38
 177 #define KEY_RALT        0xB8
 178
 179 #define KEY_LCTRL       0x1D
 180 #define KEY_RCTRL       0x9D
 181 #define KEY_LMETA       0x9E
 182 #define KEY_RMETA       0x9F
 183
 184 #define KEY_F1          0x3B
 185 #define KEY_F2          0x3C
 186 #define KEY_F3          0x3D
 187 #define KEY_F4          0x3E
 188 #define KEY_F5          0x3F
 189 #define KEY_F6          0x40
 190 #define KEY_F7          0x41
 191 #define KEY_F8          0x42
 192 #define KEY_F9          0x43
 193 #define KEY_F10         0x44
 194 #define KEY_F11         0x57
 195 #define KEY_F12         0x58
 196 #define KEY_F13         0x59
 197 #define KEY_F14         0x5A
 198 #define KEY_F15         0x5B
 199 #define KEY_F16         0x5C
 200 #define KEY_F17         0x5D
 201 #define KEY_F18         0x5E
 202 #define KEY_F19         0x5F
 203
 204 #define KEY_PAD0        0x52
 205 #define KEY_PAD1        0x4F
 206 #define KEY_PAD2        0x50
 207 #define KEY_PAD3        0x51
 208 #define KEY_PAD4        0x4B
 209 #define KEY_PAD5        0x4C
 210 #define KEY_PAD6        0x4D
 211 #define KEY_PAD7        0x47
 212 #define KEY_PAD8        0x48
 213 #define KEY_PAD9        0x49
 214 #define KEY_PADMINUS    0x4A
 215 #define KEY_PADPLUS     0x4E
 216 #define KEY_PADPERIOD   0x53
 217 #define KEY_PADDIVIDE   0xB5
 218 #define KEY_PADMULTIPLY 0x37
 219 #define KEY_PADENTER    0x9C
 220 #define KEY_PADEQUALS   0x9B
 221
 222 #define KEY_INSERT      0xD2
 223 #define KEY_HOME        0xC7
 224 #define KEY_PAGEUP      0xC9
 225 #define KEY_DELETE      0xD3
 226 #define KEY_END         0xCF
 227 #define KEY_PAGEDOWN    0xD1
 228 #define KEY_UP          0xC8
 229 #define KEY_DOWN        0xD0
 230 #define KEY_LEFT        0xCB
 231 #define KEY_RIGHT       0xCD
 232
 233 #define KEY_PRINT_SCREEN 0xB7
 234 #define KEY_PAUSE       0x61
 235
 236 #define KEY_MB1         0x80
 237 #define KEY_MB2         0x81
 238 #define KEY_MB3         0x82
 239 #define KEY_MB4         0x83
 240 #define KEY_MB5         0x84
 241 #define KEY_MB6         0x85
 242 #define KEY_MB7         0x86
 243 #define KEY_MB8         0x87
 244 #define KEY_MB9         0x88
 245 #define KEY_MB10        0x89
 246 #define KEY_MB11        0x8a
 247 #define KEY_MB12        0x8b
 248 #define KEY_MB13        0x8c
 249 #define KEY_MB14        0x8d
 250 #define KEY_MB15        0x8e
 251 #define KEY_MB16        0x8f
 252
 253 #define KEY_JB1         0xe0
 254 #define KEY_JB2         0xe1
 255 #define KEY_JB3         0xe2
 256 #define KEY_JB4         0xe3
 257 #define KEY_JB5         0xe4
 258 #define KEY_JB6         0xe5
 259 #define KEY_JB7         0xe6
 260 #define KEY_JB8         0xe7
 261 #define KEY_JB9         0xe8
 262 #define KEY_JB10        0xe9
 263 #define KEY_JB11        0xea
 264 #define KEY_JB12        0xeb
 265 #define KEY_JB13        0xec
 266 #define KEY_JB14        0xed
 267 #define KEY_JB15        0xee
 268 #define KEY_JB16        0xef
 269 #define KEY_JB17        0xf0
 270 #define KEY_JB18        0xf1
 271 #define KEY_JB19        0xf2
 272 #define KEY_JB20        0xf3
 273 #define KEY_JB21        0xf4
 274 #define KEY_JB22        0xf5
 275 #define KEY_JB23        0xf6
 276 #define KEY_JB24        0xf7
 277 #define KEY_JB25        0xf8
 278 #define KEY_JB26        0xf9
 279 #define KEY_JB27        0xfa
 280 #define KEY_JB28        0xfb
 281 #define KEY_JB29        0xfc
 282 #define KEY_JB30        0xfd
 283 #define KEY_JB31        0xfe
 284 #define KEY_JB32        0xff
 285
 286
 287 #endif