home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / program / c / xaes_new / nkcc.h < prev    next >
C/C++ Source or Header  |  1994-01-16  |  10KB  |  259 lines
  1. /***************************************************************************
  2. *
  3. *                 NORMALIZED KEY CODE CONVERTER DEFINITIONS
  4. *
  5. *  Edition  :  22
  6. *  Author   :  Harald Siegmund
  7. *  Notes    :  this file is for usage with Turbo C
  8. *  History  :
  9. *
  10. *  1990:
  11. *     May 23-24: creation of file
  12. *     Jul 09: nkc_kstate()
  13. *     Aug 03: nkc_cmp(); NK_MASK
  14. *     Sep 15: nkc_init(): beflag,vdihnd; BE_...
  15. *             nkc_exit() has now a result
  16. *     Sep 16: nkc_timer()
  17. *     Oct 03: nkc_vlink()/vunlink(); NKXM_...
  18. *     Oct 07: removing NK_MASK (use nkc_cmp() for key code comparism!)
  19. *     Nov 13: NK_LEFT/NK_RIGHT exchanged
  20. *     Dec 11: MU_XTIMER
  21. *  1991:
  22. *     Apr 13: nkc_conv() renamed to nkc_tconv()
  23. *             nkc_gconv()
  24. *             rearranging prototypes
  25. *     May 29: nkc_toupper, nkc_tolower
  26. *     Aug 22: NKS_DEADKEY changed
  27. *             NKS_D_...
  28. *             nkc_set() changed
  29. *             nkc_init() now returns version #
  30. *     Aug 26: NK_INVALID
  31. *     Sep 07: NK_TERM
  32. *     Sep 14: NKF_IGNUM
  33. *     Nov 16: NKS_CTRL
  34. *     Dec 29: NK_RVD...
  35. *  1992:
  36. *     Jan 03: redefining BE_...
  37. *             NKI_...
  38. *             first parameter of nkc_init() is now of type 'unsigned long'
  39. *     Jan 12: NK_TERM: int-cast added
  40. *
  41. ***************************************************************************/
  42. /*KEY _NAME "NKCC C definitions" */
  43.  
  44.  
  45. #ifndef __NKCC__
  46. #define __NKCC__
  47.  
  48.  
  49.    /* flags for NKCC initialization */
  50.  
  51. #define NKI_BUTHND   0x00000001UL   /* install button event handler */
  52. #define NKI_BHTOS    0x00000002UL   /* additional flag: only if TOS has */
  53.                                     /*  mouse click bug */
  54. #define NKI_NO200HZ  0x00000004UL   /* don't install 200 Hz clock interrupt */
  55.                                     /*  (this flag is ignored if the button */
  56.                                     /*  event handler is being activated) */
  57.  
  58.  
  59.  
  60.    /* flag combinations for compatibility with old versions of NKCC */
  61.  
  62. #define BE_ON        NKI_BUTHND
  63. #define BE_OFF       0
  64. #define BE_TOS       (NKI_BUTHND | NKI_BHTOS)
  65.  
  66.  
  67.  
  68.    /* flags for special key code handling */
  69.  
  70. #define NKS_ALTNUM   0x00000001UL   /* Alt + numeric pad -> ASCII */
  71. #define NKS_CTRL     0x00000002UL   /* Control key emulation */
  72.                                     /* deadkey management: */
  73. #define NKS_D_CIRCUM 0x00010000UL   /* ^  accent circumflex */
  74. #define NKS_D_TILDE  0x00020000UL   /* ~  accent tilde */
  75. #define NKS_D_AGUI   0x00040000UL   /* '  accent agui */
  76. #define NKS_D_GRAVE  0x00080000UL   /* `  accent grave */
  77. #define NKS_D_UMLAUT 0x00100000UL   /* ¨  umlaut */
  78. #define NKS_D_QUOTE  0x00200000UL   /* "  quote, synonym for umlaut */
  79. #define NKS_D_SMOERE 0x00400000UL   /* °  smoerebroed */
  80. #define NKS_D_CEDIL  0x00800000UL   /* ,  cedil */
  81. #define NKS_D_SLASH  0x01000000UL   /* /  slash, for scandinavian characters */
  82. #define NKS_DEADKEY  0xffff0000UL   /* all deadkeys */
  83.  
  84.  
  85.  
  86.    /* NKCC key code flags */
  87.  
  88. #define NKF_FUNC     0x8000         /* function          */
  89. #define NKF_RESVD    0x4000         /* resvd, ignore it! */
  90. #define NKF_NUM      0x2000         /* numeric pad       */
  91. #define NKF_CAPS     0x1000         /* CapsLock          */
  92. #define NKF_ALT      0x0800         /* Alternate         */
  93. #define NKF_CTRL     0x0400         /* Control           */
  94. #define NKF_SHIFT    0x0300         /* any Shift key     */
  95. #define NKF_LSH      0x0200         /* left Shift key    */
  96. #define NKF_RSH      0x0100         /* right Shift key   */
  97.  
  98. #define NKF_IGNUM    NKF_RESVD      /* special flag for nkc_cmp() */
  99.  
  100.  
  101.  
  102.    /* special key codes for keys performing a function */
  103.  
  104. #define NK_INVALID   0x00           /* invalid key code  */
  105. #define NK_UP        0x01           /* cursor up         */
  106. #define NK_DOWN      0x02           /* cursor down       */
  107. #define NK_RIGHT     0x03           /* cursor right      */
  108. #define NK_LEFT      0x04           /* cursor left       */
  109. #define NK_RVD05     0x05           /* reserved!         */
  110. #define NK_RVD06     0x06           /* reserved!         */
  111. #define NK_RVD07     0x07           /* reserved!         */
  112. #define NK_BS        0x08           /* Backspace         */
  113. #define NK_TAB       0x09           /* Tab               */
  114. #define NK_ENTER     0x0a           /* Enter             */
  115. #define NK_INS       0x0b           /* Insert            */
  116. #define NK_CLRHOME   0x0c           /* Clr/Home          */
  117. #define NK_RET       0x0d           /* Return            */
  118. #define NK_HELP      0x0e           /* Help              */
  119. #define NK_UNDO      0x0f           /* Undo              */
  120. #define NK_F1        0x10           /* function key #1   */
  121. #define NK_F2        0x11           /* function key #2   */
  122. #define NK_F3        0x12           /* function key #3   */
  123. #define NK_F4        0x13           /* function key #4   */
  124. #define NK_F5        0x14           /* function key #5   */
  125. #define NK_F6        0x15           /* function key #6   */
  126. #define NK_F7        0x16           /* function key #7   */
  127. #define NK_F8        0x17           /* function key #8   */
  128. #define NK_F9        0x18           /* function key #9   */
  129. #define NK_F10       0x19           /* function key #10  */
  130. #define NK_RVD1A     0x1a           /* reserved!         */
  131. #define NK_ESC       0x1b           /* Esc               */
  132. #define NK_RVD1C     0x1c           /* reserved!         */
  133. #define NK_RVD1D     0x1d           /* reserved!         */
  134. #define NK_RVD1E     0x1e           /* reserved!         */
  135. #define NK_DEL       0x1f           /* Delete            */
  136.  
  137.                                     /* terminator for key code tables */
  138. #define NK_TERM      ((int)(NKF_FUNC | NK_INVALID))
  139.  
  140.  
  141.  
  142.    /* ASCII codes less than 32 */
  143.  
  144. #define NUL          0x00           /* Null */
  145. #define SOH          0x01           /* Start Of Header */
  146. #define STX          0x02           /* Start Of Text */
  147. #define ETX          0x03           /* End Of Text */
  148. #define EOT          0x04           /* End Of Transmission */
  149. #define ENQ          0x05           /* Enquiry */
  150. #define ACK          0x06           /* positive Acknowledgement */
  151. #define BEL          0x07           /* Bell */
  152. #define BS           0x08           /* BackSpace */
  153. #define HT           0x09           /* Horizontal Tab */
  154. #define LF           0x0a           /* Line Feed */
  155. #define VT           0x0b           /* Vertical Tab */
  156. #define FF           0x0c           /* Form Feed */
  157. #define CR           0x0d           /* Carriage Return */
  158. #define SO           0x0e           /* Shift Out */
  159. #define SI           0x0f           /* Shift In */
  160. #define DLE          0x10           /* Data Link Escape */
  161. #define DC1          0x11           /* Device Control 1 */
  162. #define XON          0x11           /* same as DC1 */
  163. #define DC2          0x12           /* Device Control 2 */
  164. #define DC3          0x13           /* Device Control 3 */
  165. #define XOFF         0x13           /* same as DC3 */
  166. #define DC4          0x14           /* Device Control 4 */
  167. #define NAK          0x15           /* Negative Acknowledgement */
  168. #define SYN          0x16           /* Synchronize */
  169. #define ETB          0x17           /* End of Transmission Block */
  170. #define CAN          0x18           /* Cancel */
  171. #define EM           0x19           /* End of Medium */
  172. #define SUB          0x1a           /* Substitute */
  173. #define ESC          0x1b           /* Escape */
  174. #define FS           0x1c           /* Form Separator */
  175. #define GS           0x1d           /* Group Separator */
  176. #define RS           0x1e           /* Record Separator */
  177. #define US           0x1f           /* Unit Separator */
  178.  
  179.  
  180.  
  181.    /* XBRA vector link/unlink modes */
  182.  
  183. #define NKXM_NUM     0              /* by vector number */
  184. #define NKXM_ADR     1              /* by vector address */
  185.  
  186.  
  187.  
  188.    /* additional flag in event mask */
  189.  
  190. #define MU_XTIMER    0x100
  191.  
  192.  
  193.  
  194.    /* global variables */
  195.  
  196.    /* lower case -> upper case translation table */
  197. extern unsigned char nkc_toupper[256];
  198.  
  199.    /* upper case -> lower case translation table */
  200. extern unsigned char nkc_tolower[256];
  201.  
  202.  
  203.  
  204.    /* prototypes */
  205.  
  206.    /* install NKCC */
  207. int   nkc_init(unsigned long flags,int vdihnd);
  208.  
  209.    /* uninstall NKCC */
  210. int   nkc_exit(void);
  211.  
  212.    /* set special key flags */
  213. void  nkc_set(unsigned long flags);
  214.  
  215.    /* NKCC key input via GEMDOS */
  216. int   nkc_conin(void);
  217.  
  218.    /* console input status via GEMDOS */
  219. int   nkc_cstat(void);
  220.  
  221.    /* NKCC multi event */
  222. int cdecl nkc_multi(
  223.       int mflags,
  224.       int mbclicks,int mbmask,int mbstate,
  225.       int mm1flags,int mm1x,int mm1y,int mm1width,int mm1height,
  226.       int mm2flags,int mm2x,int mm2y,int mm2width,int mm2height,
  227.       int *mmgpbuff,
  228.       int mtlocount,int mthicount,
  229.       int *mmox,int *mmoy,int *mmbutton,int *mmokstate,
  230.       int *mkreturn,int *mbreturn);
  231.  
  232.    /* convert key code in TOS format to normalized format */
  233. int   nkc_tconv(long toskey);
  234.  
  235.    /* convert key code in GEM format to normalized format */
  236. int   nkc_gconv(int gemkey);
  237.  
  238.    /* return shift key state */
  239. int   nkc_kstate(void);
  240.  
  241.    /* get 200 Hz system clock counter */
  242. unsigned long nkc_timer(void);
  243.  
  244.    /* compare two key codes due to standard comparism rules */
  245. int   nkc_cmp(int refkey,int kcode);
  246.  
  247.    /* link function to XBRA vector list */
  248. void  nkc_vlink(long vector,int mode,void *pfnc);
  249.  
  250.    /* unlink function from XBRA vector list */
  251. int   nkc_vunlink(long vector,int mode,void *pfnc);
  252.  
  253.  
  254. #endif      /* #ifndef __NKCC__ */
  255.  
  256.  
  257. /*EOF*/
  258.  
  259.