home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / sysutl / tess_a.arc / TESS.INC < prev    next >
Text File  |  1988-07-03  |  18KB  |  457 lines
  1.         PAGE 60,132
  2. ;       TITLE TESS.INC - TesSeRact Copyright Notice and Data Definitions
  3. ;----------------------------------------------------------------------------
  4. ;SUBTTL TesSeRact Revision Level 1
  5. ;-----------------------------------------------------------------------------
  6. ;   TesSeRact(TM) -- A Library of Routines for Creating Ram-Resident (TSR)
  7. ;                    programs for the IBM PC and compatible Personal
  8. ;                    Computers.
  9. ;
  10. ;The software, documentation and source code are: 
  11. ; 
  12. ;       Copyright (C) 1986, 1987, 1988 Tesseract Development Team
  13. ;       All Rights Reserved 
  14. ; 
  15. ;-----------------------------------------------------------------------------
  16. COMMENT | 
  17.  
  18.      This product  supports the  TesSeRact(TM)  Standard  for  Ram-Resident
  19.      Program Communication.   For  information about TesSeRact, contact the
  20.      TesSeRact Development Team at:
  21.      
  22.           TesSeRact Development Team
  23.           c/o Chip Rabinowitz
  24.           2084 Woodlawn Avenue
  25.           Glenside, PA 19038
  26.           1-215-884-3373
  27.      
  28.           Compuserve:    70731,20
  29.           MCIMAIL:       315-5415
  30.      
  31.      This MCIMAIL  Account has  been provided  to the TesSeRact Development
  32.      Team by Borland International, Inc.  The TesSeRact Development Team is
  33.      in no  way associated with Borland International, Inc.  TesSeRact is a
  34.      trademark of the TesSeRact Development Team.
  35.  
  36. ***************************************************************************
  37.                              Copyright Notice
  38. ***************************************************************************
  39.  
  40. This  document,   other  accompanying  written  and  disk-based  notes  and
  41. specifications, and all referenced and related program files, demonstration
  42. code and  object modules  accompanying this document are copyrighted by the
  43. TesSeRact Development  Team.   The copyright  owner hereby licenses you to:
  44. use the  software; make as many copies of the software and documentation as
  45. you wish;  give exact  copies of the original to anyone; and distribute the
  46. software and  documentation in  its unmodified  form via  electronic means.
  47. There is no charge for any of the above.
  48.  
  49. You are specifically prohibited from charging, or requesting donations, for
  50. any such  copies, however made.  Exceptions may be granted to organizations
  51. which charge  a small  fee for  materials, handling,  postage  and  general
  52. overhead.  NO   ORGANIZATION  IS   AUTHORIZED  TO  CHARGE  ANY  AMOUNT  FOR
  53. DISTRIBUTION OF  THE SOFTWARE  OR DOCUMENTATION UNDER ANY OTHER CONDITIONS.
  54. Organizations which  charge a fee for distribution of any and all TesSeRact
  55. materials, except  as noted  above or  with the express, written consent of
  56. the TesSeRact  Development Team,  will be  considered in  violation of this
  57. copyright, and will be prosecuted to the full extent of the law.
  58.  
  59. In addition,  you are specifically prohibited from making any modifications
  60. to the  TesSeRact Library  Routines and/or documentation, unless you have a
  61. license for  the use  of the  source code.   Under  no circumstances is the
  62. copyright notice embedded in the TesSeRact code to be modified or removed.
  63.  
  64. This is  not free  software.   This license allows you to use this software
  65. without charge  for a period of 30 days.  In order to include this software
  66. as part  of any  product, either commercial, shareware, freeware, or public
  67. domain, registration  is required.   TesSeRact  may not  be included in any
  68. product for  any use  without registration.   Any such use of the TesSeRact
  69. product are in violation of federal copyright laws, and will be prosecuted.
  70.  
  71. No copy  of the  software may  be distributed  or given  away without  this
  72. accompanying documentation; this notice must not be removed.
  73.  
  74.  
  75. ***************************************************************************
  76.                                  Warranty
  77. ***************************************************************************
  78.  
  79. There is  no warranty  of any  kind associated  with this software, and the
  80. copyright owner  is not  liable for  damages of  any kind.   By  using this
  81. software, you  agree to  this.  Every effort has been made by the TesSeRact
  82. Development Team  to make  this product  bug-free.   However, the nature of
  83. software development  is  that  it  is  impossible  to  guarantee  bug-free
  84. software.
  85.  
  86. In the event a verifiable bug is found, the TesSeRact Development Team will
  87. make every  attempt to  repair the  bug as  soon as possible.  
  88.  
  89. ***************************************************************************
  90.                              Acknowledgements
  91. ***************************************************************************
  92.  
  93. Grateful appreciation  is expressed  to CompuServe Information Service, the
  94. IBM Software  Forums and  their Sysops, and Computer Language Magazine, for
  95. providing us  with the  means to  accomplish the  development of TesSeRact.
  96. Without their  gracious assistance,  TesSeRact could  never have  come into
  97. existence.
  98.  
  99. And let's not forget Anne Marie, who suffered through the long evenings and
  100. nights spent getting this product ready.
  101.  
  102. ***************************************************************************
  103. The TesSeRact Development Team:
  104. ***************************************************************************
  105.      
  106.      Team Leader:   Chip Rabinowitz
  107.      Developers:    Lane Ferris
  108.                     Kim Kokkonen
  109.                     Jim Kyle
  110.                     Neil J. Rubenking
  111.                     Barry Simon
  112.                     Rick Wilson
  113.      Contributors:  Thomas Brandenborg
  114.                     Chris Dunford
  115.                     John Friend
  116.                     Mark Horvatich
  117.                     John Hensley
  118.      Advisors:      Robert Bierman
  119.                     David Intersimone
  120.                     Rick Kraus
  121.                     David Moskowitz
  122.                     Gary Saxer
  123.  
  124. ***************************************************************************
  125.  
  126. |                                       ; end of comment block
  127.  
  128.  
  129. Pascal equ 1                            ;defined for mixed.inc
  130.  
  131. ;
  132. ; dos delimiters and other utility equates
  133. ;
  134. CR              equ     0dh
  135. LF              equ     0ah
  136. SPACE           equ     ' '
  137. COMMA           equ     ','
  138. SEMICOLON       equ     ';'
  139. EQUAL_SIGN      equ     '='
  140. TAB             equ     9
  141.  
  142. ;
  143. ; These are the bits of the shift register at absolute 40:17 HEX
  144. ;
  145. ALTBIT          equ     08h
  146. CTLBIT          equ     04h
  147. LSHBIT          equ     02h
  148. RSHBIT          equ     01h
  149.  
  150. ;
  151. ; These are the keyboard ports
  152. ;
  153. KB_DATA         equ     60h
  154. KB_CTL          equ     61h
  155.  
  156. ;
  157. ; BIOS data areas
  158. ;
  159. KB_FLG1         equ     17h
  160. KB_FLG2         equ     18h
  161. BIOS_DATA       equ     40h
  162.  
  163. ;
  164. ; Command word 3 of the 8259 interrupt ctrlr
  165. ;
  166. OCW3_8259       equ     20h
  167.  
  168.  
  169. ;------------------------------------------------------------------------------
  170. ;       Text Equates for Global Variables
  171. ;------------------------------------------------------------------------------
  172.  
  173. TsrIntTable struc
  174.         OldVector       dd  ?           ;Old Interrupt Vector
  175.         IntNumber       db  ?           ;Interrupt Number
  176.         NewVector       dw  ?           ;offset of new vector
  177. TsrIntTable ends
  178.  
  179. ExtraHot struc
  180.         ExtHotKey       db  ?           ;hotkey to check for
  181.         ShiftState      db  ?           ;shift state for this hot key
  182.         FlagByte        db  ?           ;flag value to use
  183.                                         ; MAY NOT BE ZERO!!!
  184. ExtraHot ends
  185.  
  186. REVLVL        equ  <TESS_GLOBALS>       ;Revision Level of TESS Lib
  187. SAVEDINDOSFLG equ  <TESS_GLOBALS + 1>   ;Type of popup in effect
  188. WASINT8       equ  <TESS_GLOBALS + 2>   ;An Interrupt 08h occurred
  189. WASINT13      equ  <TESS_GLOBALS + 3>   ;An Interrupt 13h occurred
  190. INTFLAGS      equ  <TESS_GLOBALS + 4>   ;Which interrupts are active
  191. SOFTINTFLAGS  equ  <TESS_GLOBALS + 5>   ;Which soft ints are active
  192. DOSVERSION    equ  <TESS_GLOBALS + 6>   ;current major revision of DOS
  193. WAITCOUNT     equ  <TESS_GLOBALS + 7>   ;Count to wait before popping up
  194. INDOSFLAG     equ  <TESS_GLOBALS + 8>   ;Pointer to DOS INDOS flag
  195. DOSCRITERR    equ  <TESS_GLOBALS + 12>  ;Pointer to DOS Critical Error
  196. USERPSP       equ  <TESS_GLOBALS + 16>  ;PSP segment of user program
  197. USER28PSP     equ  <TESS_GLOBALS + 18>  ;PSP segment of user program
  198. USERDTA       equ  <TESS_GLOBALS + 20>  ;DTA of interrupted program
  199. USER28DTA     equ  <TESS_GLOBALS + 24>  ;DTA of interrupted program
  200. USERSS        equ  <TESS_GLOBALS + 28>  ;Stack segment of user program
  201. USERSP        equ  <TESS_GLOBALS + 30>  ;Stack pointer of user program
  202. USER28SS      equ  <TESS_GLOBALS + 32>  ;Stack segment of user program
  203. USER28SP      equ  <TESS_GLOBALS + 34>  ;Stack pointer of user program
  204. USERINT24     equ  <TESS_GLOBALS + 36>  ;pointer to use INT 24 handler
  205. OLDEXTERR     equ  <TESS_GLOBALS + 40>  ;storage for old DOS 3 extended
  206.                                         ;    error information
  207. OLDBREAK      equ  <TESS_GLOBALS + 46>  ;Old Break Setting
  208. OLDVERIFY     equ  <TESS_GLOBALS + 47>  ;Old Verify Setting
  209. INWORD4       equ  <TESS_GLOBALS + 48>  ;flag to indicate in WORD 4.0
  210. WASWORD4      equ  <TESS_GLOBALS + 49>  ;word 4 special popup flag
  211. NEWKBDFLAG    equ  <TESS_GLOBALS + 50>  ;Enhanced Keyboard Call in use
  212. WORD4DELAY    equ  <TESS_GLOBALS + 51>  ;Delay for Word 4
  213.  
  214. OLDINT8       equ  <TESS_GLOBALS + 52>  ;Interrupt vector tables
  215. OLDINT9       equ  <TESS_GLOBALS + 59>  ;
  216. OLDINT13      equ  <TESS_GLOBALS + 66>  ;
  217. OLDINT16      equ  <TESS_GLOBALS + 73>  ;
  218. OLDINT1C      equ  <TESS_GLOBALS + 80>  ;
  219. OLDINT21      equ  <TESS_GLOBALS + 87>  ;
  220. OLDINT28      equ  <TESS_GLOBALS + 94>  ;
  221. OLDINT2F      equ  <TESS_GLOBALS + 101> ;
  222. OLDINT1B      equ  <TESS_GLOBALS + 108> ;
  223. OLDINT24      equ  <TESS_GLOBALS + 115> ;
  224.  
  225.  
  226. USERPARMS     equ  <TESS_USERPARMS>      ;Unique TSR Identification String
  227.                                          ;NOTE -- NOT NULL-TERMINATED
  228. IDNUM         equ  <TESS_USERPARMS + 8>  ;Unique TSR Identification Number
  229. FUNCFLG       equ  <TESS_USERPARMS + 10> ;Bit map of supported functions
  230. HOTKEY        equ  <TESS_USERPARMS + 14> ;Hotkey used by TSR for popup
  231. SHIFTST       equ  <TESS_USERPARMS + 15> ;ShiftState used by this TSR pop
  232. HOTFLAG       equ  <TESS_USERPARMS + 16> ;which hotkey is in use
  233. HOTCOUNT      equ  <TESS_USERPARMS + 17> ;Number of Extra Hotkeys to use
  234. EXTRAHOTK     equ  <TESS_USERPARMS + 18> ;Pointer to extra hotkeys
  235. STATUS        equ  <TESS_USERPARMS + 22> ;Current TSR Status Flags
  236. OURPSP        equ  <TESS_USERPARMS + 24> ;TSR's PSP Segment
  237. OURDTA        equ  <TESS_USERPARMS + 26> ;Pointer to TSR's DTA region
  238. OURDSEG       equ  <TESS_USERPARMS + 30> ;TSR's Default Data Segment
  239. OURSSSP       equ  <TESS_USERPARMS + 32> ;Pointer to Popup Stack Area
  240. OUR28SP       equ  <TESS_USERPARMS + 36> ;Pointer to Background Stack
  241.  
  242. ;
  243. ;       Keyboard Scan Codes
  244. ;
  245. TSRHOT_A        equ     1eh
  246. TSRHOT_B        equ     30h
  247. TSRHOT_C        equ     2eh
  248. TSRHOT_D        equ     20h
  249. TSRHOT_E        equ     12h
  250. TSRHOT_F        equ     21h
  251. TSRHOT_G        equ     22h
  252. TSRHOT_H        equ     23h
  253. TSRHOT_I        equ     17h
  254. TSRHOT_J        equ     24h
  255. TSRHOT_K        equ     25h
  256. TSRHOT_L        equ     26h
  257. TSRHOT_M        equ     32h
  258. TSRHOT_N        equ     31h
  259. TSRHOT_O        equ     18h
  260. TSRHOT_P        equ     19h
  261. TSRHOT_Q        equ     10h
  262. TSRHOT_R        equ     13h
  263. TSRHOT_S        equ     1fh
  264. TSRHOT_T        equ     14h
  265. TSRHOT_U        equ     16h
  266. TSRHOT_V        equ     2fh
  267. TSRHOT_W        equ     11h
  268. TSRHOT_X        equ     2dh
  269. TSRHOT_Y        equ     15h
  270. TSRHOT_Z        equ     2ch
  271. TSRHOT_0        equ     0bh
  272. TSRHOT_1        equ     02h
  273. TSRHOT_2        equ     03h
  274. TSRHOT_3        equ     04h
  275. TSRHOT_4        equ     05h
  276. TSRHOT_5        equ     06h
  277. TSRHOT_6        equ     07h
  278. TSRHOT_7        equ     08h
  279. TSRHOT_8        equ     09h
  280. TSRHOT_9        equ     0ah
  281. TSRHOT_F1       equ     3bh
  282. TSRHOT_F2       equ     3ch
  283. TSRHOT_F3       equ     3dh
  284. TSRHOT_F4       equ     3eh
  285. TSRHOT_F5       equ     3fh
  286. TSRHOT_F6       equ     40h
  287. TSRHOT_F7       equ     41h
  288. TSRHOT_F8       equ     42h
  289. TSRHOT_F9       equ     43h
  290. TSRHOT_F10      equ     44h
  291.     
  292. ;
  293. ;Enhanced Keyboards only
  294. ;
  295. ;May not work with all computers, keyboards
  296. ;
  297. TSRHOT_F11      equ     57h
  298. TSRHOT_F12      equ     58h
  299.  
  300. ;
  301. ;defines for ShiftState
  302. ;
  303. TSRPOPRSHIFT    equ     01h
  304. TSRPOPLSHIFT    equ     02h
  305. TSRPOPCTRL      equ     04h
  306. TSRPOPALT       equ     08h
  307.  
  308. ; 
  309. ;  #defines for TSRFLAGS
  310. ;  
  311. TSRUSEPOPUP     equ     0010h   ;Use TsrMain()
  312. TSRUSEBACK      equ     0020h   ;Use TsrBackProc()
  313. TSRUSETIMER     equ     0040h   ;Use TsrTimer()
  314. TSRUSEUSER      equ     0100h   ;Use TsrUserProc()
  315. NOPOPGRAPH      equ     1000h   ;Don't pop over graphics
  316. NOPOPCOMMAND    equ     2000h   ;Don't pop over command-line
  317.  
  318. ; 
  319. ;  #defines for TsrStatus flags
  320. ;  
  321. HOTKEYON        equ     01h     ;hot key pressed
  322. SHIFTSON        equ     02h     ;shift states match
  323. TSRACTIVE       equ     04h     ;tsr is running in foreground
  324. INT28ACTIVE     equ     08h     ;INT28 routine is running in background
  325. ;
  326. POPUPSET        equ     10h     ;Popup resident routine installed
  327. BACKSET         equ     20h     ;Interrupt 28 Background routine installed
  328. TIMERSET        equ     40h     ;Interrupt 1C Timer Tick routine installed
  329. EXTRAHOTSET     equ     80H     ;Extra Hot Keys have been installed
  330. ;
  331. USERPROCON      equ     100h    ;User-defined procedure installed
  332. TSRENABLED      equ     200h    ;TSR currently enabled
  333. TSRRELEASED     equ     400h    ;TSR being released
  334. EXTRAINT24      equ     800h    ;user installed replacement INT 24h routine
  335. ;------------------------------------------------------------------------------
  336.  
  337. ;
  338. ; EQUates for IntFlags and SoftFlags
  339. ;
  340. ININT13         equ     04h     ;Interrupt 13 is currently active
  341. ININT21         equ     08h     ;Interrupt 21 is currently active
  342. ININT16         equ     10h     ;Interrupt 16 is currently active
  343. ININT28         equ     20h     ;Interrupt 28 is currently active
  344. ININT08         equ     40h     ;Interrupt 08 is currently active
  345. ININT1C         equ     80h     ;Interrupt 1C is currently active
  346.  
  347. ;
  348. ; EQUates for Keyboard Stuffing
  349. ;
  350. STUFF_SLOW      equ     0
  351. STUFF_MED       equ     1
  352. STUFF_FAST      equ     2
  353.  
  354. ;
  355. ; EQUates used internally by TesSeRact routines
  356. ;
  357. BIOSI8          equ     08h     ;Bios Timer interrupt
  358. BIOSI9          equ     09h     ;BIOS Hardware Keyboard interrupt
  359. BIOSIB          equ     0Bh
  360. BIOSIC          equ     0Ch
  361. BIOSI10         equ     10h
  362. BIOSI13         equ     13h     ;Bios Disk interrupt
  363. BIOSI14         equ     14h
  364. BIOSI15         equ     15h
  365. BIOSI16         equ     16h     ;Bios Keyboard interrupt
  366. BIOSI17         equ     17h
  367. BIOSI1C         equ     1Ch
  368. DOSI21          equ     21h     ;DOS service router interrupt
  369. DOSI28          equ     28h     ;DOS Idle interrupt
  370. BIOSI1B         equ     1Bh
  371. DOSI23          equ     23h
  372. DOSI24          equ     24h
  373. DOSI2F          equ     2fh
  374. BIOSI5          equ     05h
  375.  
  376. NUMINTS_1       equ     8
  377. NUMINTS_2       equ     3
  378. NUMINTS_3       equ     5
  379.  
  380. ;------------------------------------------------------------------------------
  381. ;       General Text Equates
  382. ;------------------------------------------------------------------------------
  383.  
  384. BPTR            equ     <BYTE PTR>
  385. WPTR            equ     <WORD PTR>
  386. DPTR            equ     <DWORD PTR>
  387.  
  388. ;------------------------------------------------------------------------------
  389. ;       Macros
  390. ;------------------------------------------------------------------------------
  391.  
  392. setdta  macro   ddptr
  393.         push    ds
  394.         mov     ax,1a00h                ;;Function used to set current DTA 
  395.         mov     dx,word ptr ddptr       ;;Offset of DTA 
  396.         mov     ds,word ptr ddptr+2     ;;Segment of DTA
  397.         int     21h                     ;;Execute MSDos function request
  398.         pop     ds
  399.         endm
  400.  
  401. getdta  macro   ddptr
  402.         push    es
  403.         mov     ax,2f00h                ;;Function used to get current DTA 
  404.         int     21h                     ;;Execute MSDos function request
  405.         mov     word ptr ddptr+2,es     ;;Segment of DTA returned by DOS
  406.         mov     word ptr ddptr,bx       ;;Offset of DTA returned
  407.         pop     es
  408.         endm
  409.  
  410. ASSUMENODS macro                        ;; Macro to set assumes for various
  411. IFDEF   TP4                             ;; segment configurations
  412. IFNDEF  ASMCOM                          ;; this one is used when DS register
  413.         ASSUME  CS:CODE, DS:NOTHING     ;; is undefined
  414. ELSE
  415.         ASSUME  CS:@code, DS:NOTHING
  416. ENDIF
  417. ELSE
  418.         ASSUME  CS:@code, DS:NOTHING
  419. ENDIF
  420.         endm
  421.  
  422. ASSUMEDS macro                          ;; Macro to set assumes for various
  423. IFDEF   TP4                             ;; segment configurations
  424. IFNDEF  ASMCOM                          ;; this one is used when DS register
  425.         ASSUME  CS:CODE, DS:CODE        ;; is same as CS register
  426. ELSE
  427.         ASSUME  CS:@code, DS:@code
  428. ENDIF
  429. ELSE
  430.         ASSUME  CS:@code, DS:@code
  431. ENDIF
  432.         endm
  433.  
  434. POPFF   macro                           ;; Macro used to avoid the 'popf'
  435. IFNDEF  TP4                             ;; bug on early 80286 chips
  436. IFNDEF  ASMCOM
  437.         EXTRN _TESS_INTERRUPTRETURN:near
  438. ENDIF
  439. ENDIF
  440.         push    cs
  441.         call    _TESS_INTERRUPTRETURN
  442.         endm
  443.  
  444. IFDEF TP4
  445.         ENDIT MACRO
  446.                 PAGE
  447.         ENDM
  448. ELSE
  449. IFDEF MASM
  450.         ENDIT MACRO
  451.                 END
  452.         ENDM
  453. ELSE
  454.         ENDIT equ END
  455. ENDIF
  456. ENDIF
  457.