keyb.h

Go to the documentation of this file.

//& *** (c) 2006-2011 The HPGCC3 Team ***
//& Claudio Lapilli
//& Ingo Blank
//&
//& This file is licensed under the terms and conditions of the
//& HPGCC3 license that is included with the source distribution.
//& *** (c) 2006-2011 The HPGCC3 Team ***

#ifndef _KEYB_H
#define _KEYB_H

// LONG TYPE DEFINITION, ADDED BY CLAUDIO 01/14/05
#ifndef _LONGLONG_DEF
typedef unsigned long long ULONGLONG;
typedef long long LONGLONG;
#define _LONGLONG_DEF
#endif

// KEYBOARD MATRIX HANDLING ROUTINE, ADDED BY CLAUDIO

/* 

KEYBOARD BIT MAP
----------------
This is the bit number in the 64-bit keymatrix.
Bit set means key is pressed.

    A]-+  B]-+  C]-+  D]-+  E]-+  F]-+  
    |41|  |42|  |43|  |44|  |45|  |46|
    +--+  +--+  +--+  +--+  +--+  +--+  

    G]-+  H]-+  I]-+        UP]+        
    |47|  |53|  |54|        |49|      
    +--+  +--+  +--+  LF]+  +--+  RT]+  
                      |50|  DN]+  |52|
    J]-+  K]-+  L]-+  +--+  |51|  +--+  
    |55|  |57|  |58|        +--+    
    +--+  +--+  +--+                    

    M]--+  N]--+  O]--+  P]--+  BKS]+
    | 33|  | 25|  | 17|  | 09|  | 01|
    +---+  +---+  +---+  +---+  +---+

    Q]--+  R]--+  S]--+  T]--+  U]--+
    | 34|  | 26|  | 18|  | 10|  | 02|
    +---+  +---+  +---+  +---+  +---+

    V]--+  W]--+  X]--+  Y]--+  /]--+
    | 35|  | 27|  | 19|  | 11|  | 03|
    +---+  +---+  +---+  +---+  +---+
    
    AL]-+  7]--+  8]--+  9]--+  *]--+
    | 60|  | 28|  | 20|  | 12|  | 04|
    +---+  +---+  +---+  +---+  +---+
    
    LS]-+  4]--+  5]--+  6]--+  -]--+
    | 61|  | 29|  | 21|  | 13|  | 05|
    +---+  +---+  +---+  +---+  +---+
    
    RS]-+  1]--+  2]--+  3]--+  +]--+
    | 62|  | 30|  | 22|  | 14|  | 06|
    +---+  +---+  +---+  +---+  +---+
    
    ON]-+  0]--+  .]--+  SP]-+  EN]-+
    | 63|  | 31|  | 23|  | 15|  | 07|
    +---+  +---+  +---+  +---+  +---+

*/

#define KB_A   41

#define KB_B   42

#define KB_C   43

#define KB_D   44

#define KB_E   45

#define KB_F   46

#define KB_G   47

#define KB_H   53

#define KB_I   54

#define KB_J   55

#define KB_K   57

#define KB_L   58

#define KB_M   33

#define KB_N   25

#define KB_O   17

#define KB_P    9

#define KB_Q   34

#define KB_R   26

#define KB_S   18

#define KB_T   10

#define KB_U    2

#define KB_V   35

#define KB_W   27

#define KB_X   19

#define KB_Y   11

#define KB_Z KB_DIV

#define KB_0   31

#define KB_1   30

#define KB_2   22

#define KB_3   14

#define KB_4   29

#define KB_5   21

#define KB_6   13

#define KB_7   28

#define KB_8   20

#define KB_9   12

#define KB_BKS  1

#define KB_DIV  3

#define KB_MUL  4

#define KB_ADD  6

#define KB_SUB  5

#define KB_DOT 23

#define KB_SPC 15

#define KB_ENT  7

#define KB_UP  49

#define KB_DN  51

#define KB_LF  50

#define KB_RT  52

#define KB_ALPHA   60

#define KB_LSHIFT  61

#define KB_RSHIFT  62

#define KB_ON  63

// MACROS TO CREATE KEYBOARD MASKS
#define KB_MASK(a) (((ULONGLONG)1)<<(a))

// COMMON KEYBOARD MASKS
// ALL CURSOR KEYS

#define KB_CURS ((ULONGLONG)0x001e000000000000)

// ALL FUNCTION KEYS (A-F)
#define KB_FUNC ((ULONGLONG)0x00007e0000000000)


// SHIFT CONSTANTS FOR HIGH-LEVEL KEYBOARD FUNCTIONS

#define SHIFT_LS          0x40

#define SHIFT_LSHOLD      0x80

#define SHIFT_RS         0x100

#define SHIFT_RSHOLD     0x200

#define SHIFT_ALPHA      0x400

#define SHIFT_ALPHAHOLD  0x800

#define SHIFT_ONHOLD    0x1000

#define SHIFT_ANY    0x1fc0    


#define KEYCODE(SHIFTcode) ((SHIFTcode)&0x3f)

#define SHIFTPLANE(SHIFTcode) ((SHIFTcode)&SHIFT_ANY)


// KEYMATRIX TYPE DEFINITION
typedef ULONGLONG keymatrix;

// SCANS THE KEYBOARD AND STORES THE 64-BIT MATRIX
keymatrix keyb_getmatrix();

#define keyb_isKeyPressed(keycode) (keyb_getkey(0)==keycode)

#define keyb_isAnyKeyPressed() (keyb_getmatrix()!=0LL)

#define keyb_isLeft() ((keyb_getmatrix()&KB_MASK(KB_LF))!=0)

#define keyb_isRight() ((keyb_getmatrix()&KB_MASK(KB_RT))!=0)

#define keyb_isUp() ((keyb_getmatrix()&KB_MASK(KB_UP))!=0)

#define keyb_isDown() ((keyb_getmatrix()&KB_MASK(KB_DN))!=0)

#define keyb_isAlpha() ((keyb_getmatrix()&KB_MASK(KB_ALPHA))!=0)

#define keyb_isLS() ((keyb_getmatrix()&KB_MASK(KB_LSHIFT))!=0)

#define keyb_isRS() ((keyb_getmatrix()&KB_MASK(KB_RSHIFT))!=0)

#define keyb_isON() ((keyb_getmatrix()&KB_MASK(KB_ON))!=0)


int keyb_getkey(int wait);


// convenience macro
// < ibl ; 2005-05-08 >

#define WAIT_CANCEL {while(keyb_isON()); while(! keyb_isON());}
#define SLOW_WAIT_CANCEL {cpu_setspeed(6*1000000);while(keyb_isON()); while(! keyb_isON());}

// *************************************
//  NEW HPGCC3 KEYBOARD MACHINERY
// *************************************

#define KM_PRESS  0x0000

#define KM_KEYDN  0x4000

#define KM_KEYUP  0x8000

#define KM_SHIFT 0xc000

#define KM_SHIFTMASK 0x1fc0

#define KM_KEYMASK  0x003f

#define KM_MSGMASK  0xc000


#define KEYB_BUFFER 128

#define KEYB_SCANSPEED 20

#define KM_MESSAGE(a) ( (a) & KM_MSGMASK) 

#define KM_KEY(a) ( (a) & KM_KEYMASK) 

#define KM_SHIFTEDKEY(a) ( (a) & (KM_KEYMASK|KM_SHIFTMASK)) 

#define KM_SHIFTPLANE(a) ( (a) & KM_SHIFTMASK) 



void keyb_postmsg(unsigned int msg);


unsigned int keyb_getmsg();


void keyb_settiming(int repeat,int longpress,int debounce);


void keyb_setrepeat(int repeat);


void keyb_setalphalock(int single_alpha_lock);

void keyb_setshiftplane(int leftshift,int rightshift,int alpha,int alphalock);


#endif