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