home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / msdos / turbopas / tppop16.arc / POPUP.DOC < prev    next >
Text File  |  1988-10-04  |  14KB  |  380 lines
  1.  
  2.                           T U R B O    P O P
  3.  
  4.              Memory Resident PopUp Routines Version 1.6
  5.                      for Turbo Pascal Version 4.0
  6.  
  7.                           Copyright (c)1988
  8.                        Ross Neilson Wentworth
  9.  
  10.                 Custom software at reasonable prices!
  11.  
  12.                   THIS PACKAGE IS NOT PUBLIC DOMAIN
  13.  
  14.                           All Rights Reserved
  15.  
  16.  
  17.                               DISCLAIMER
  18.  
  19.                     This software is provided without
  20.                      warranty, expressed or implied.
  21.  
  22.  
  23. The Turbo Pascal Units contained in this package will enable you to
  24. quickly and easily create popup programs.  Also included is a very simple
  25. windowing package.
  26.  
  27. All source code is included so that you may modify it to your hearts
  28. desire.  Do NOT release modified versions of this package under any
  29. circumstances.
  30.  
  31. Turbo Pascal Version 4.0 is required to use this package.  MASM 5.1
  32. is required to to re-assemble the low-level modules.
  33.  
  34. If you find this code useful, please send $10 to the address below or
  35. make a $10 donation to the "The Historic Oaks Foundation", located in
  36. Agoura Hills and Novato, California.  Let me know if you make the
  37. donation and you will receive full credit for registration (receipt or
  38. copy of cancelled check required).
  39.  
  40. If you use this code in any commerical program this payment is required.
  41. Shareware is considered commercial upon receipt of first registration.
  42.  
  43.                    Ross Neilson Wentworth
  44.                    Serendipity Software
  45.                    1422 Elkgrove Circle, #3
  46.                    Venice, CA  90291
  47.                    (213)399-1244
  48.  
  49.  
  50. Features of This Package
  51. ========================
  52.  
  53.   o Easily create memory resident popup programs (SideKick-like).
  54.   o Automatic program detection to prevent multiple loading. (new!)
  55.   o Allows TSR's with conflicting hot-keys   (new!)
  56.   o Simple program removal (new!)
  57.   o Uses proven TSR techniques.
  58.   o All DOS functions allowed from within resident program (except
  59.     I/O redirection), you can safely access the disk!
  60.   o No load-order limitations (except those imposed by other TSR's).
  61.   o Low code overhead, slightly over 1k EXE size increase to standard
  62.     application.
  63.  
  64. One of the problems with writing popup programs is DOS is not reentrant.
  65. That is, if you popup while DOS is busy you are very likely to crash the
  66. system.  This package does all the necessary checking and will only popup
  67. when it is safe.  This allows your program to do virtually anything including
  68. file access.  The one limitation is that it can not allocate additional memory.
  69. You can still use heap memory, just don't use the DOS function to allocate or
  70. modify a current memory block.
  71.  
  72. To guarantee a safe pop-up program it is necessary to grab hold of several
  73. interrupt vectors.  When the program is first initialized the following
  74. vectors are intercepted:
  75.  
  76.      09h      keyboard
  77.      13h      disk i/o
  78.      1Ch      timer
  79.      28h      backprocess
  80.      2Fh      multiplex
  81.  
  82. When the program is popped up, two additional vectors are also intercepted:
  83.  
  84.      23h      control-break
  85.      24h      critical error
  86.  
  87. In addition, a couple of other internal values are changed while the
  88. program is active:
  89.  
  90.      The Disk-Transfer-Area is saved and the popup's installed
  91.      The BREAK status is saved then turned off
  92.  
  93. These four items are restored when the TSR relinquishes control.
  94.  
  95. A sample program is provided that shows how to implement a popup program.
  96.  
  97. ===============================================================================
  98. Contents of POPUP:
  99.  
  100.   Function ReadKey : Char;
  101.  
  102.     Use this function instead of the one provided in the CRT unit.  Using
  103.     this routine will for keyboard entry will prevent other resident programs
  104.     from being "locked" out.  To guarantee that the correct READKEY is being
  105.     used, precede it with it's unit name, i.e., CH := POPUP.READKEY
  106.  
  107.   Function Installed(OurID : Byte) : Byte;
  108.  
  109.     Given a unique program ID number, this function returns zero (0) if
  110.     the program has not already been installed.  A nonzero value indicates
  111.     it has been installed or an error has occured:
  112.  
  113.        1 : PRINT.COM detected.  The TSR must be loaded before PRINT.COM.
  114.        2 : The program is already installed.
  115.        3 : Internal error, can't install.
  116.  
  117.     Error 3 is usually caused by a poorly designed TSR program that has
  118.     already been loaded into memory.  Try loading your program before any
  119.     others.  Experimenting with the order of loading should point out the
  120.     bad TSR.
  121.  
  122.   Procedure StayResident(OurID : Byte;ProgramAdress : Pointer;HotKey: Word);
  123.  
  124.     HOTKEY is your key combination that will activate your program.  It is of
  125.     type WORD where the low byte is the scan code and the high byte is the
  126.     shift status (ALT, CTRL, SHIFT, etc.  See below).  ProgramAddress is a
  127.     pointer to your popup procedure that you want called.  Precede the
  128.     program name with an '@' to pass a pointer.
  129.  
  130.          StayResident($69,@NotePad,Alt+LeftShift + $20);  (ALT-LeftShift-D);
  131.  
  132.     The shift status values are documented below.
  133.  
  134.     OurID is a unique number for your resident program.  Each different
  135.     TSR that you write should have a different ID number.  For maximum
  136.     compatibility, you should allow the user to change the ID number,
  137.     perhaps by using a 'command-line' option, i.e. /I=155.  MS-DOS reserves
  138.     ID numbers 0 to 80h for internal use.
  139.  
  140.   Procedure ReleaseBlock(Segment : Word);
  141.  
  142.     This inline macro releases the block of memory given a segment number.
  143.  
  144.   Procedure ReleaseEnvironment;
  145.  
  146.     Releases the block of memory holding the program's environment.  It keeps
  147.     track of whether it has already been called so that multiple calls will
  148.     not be harmful.
  149.  
  150. ===============================================================================
  151. Contents of UNHOOK:
  152.  
  153.   Function Installed(MultID : Byte) : Boolean;
  154.  
  155.     Returns TRUE if the resident program is in memory.
  156.  
  157.   Function OKToUnload(MultID : Byte) : Boolean;
  158.  
  159.     Returns TRUE if it is safe to unload the resident program from memory.
  160.  
  161.   Procedure RemoveProgram(MultID : Byte);
  162.  
  163.     Releases the memory and restores the interrupt vectors used by the
  164.     resident program.
  165.  
  166. ===============================================================================
  167. Contents of WINDOWS:
  168.  
  169.   Procedure MakeWindow(X1,Y1,X2,Y2,Foreground,Background : Word;Border : BorderType);
  170.  
  171.    This procedure saves the current screen memory and creates a bordered
  172.    window.  X1, Y1, X2, and Y2 are the same values used by Turbo's WINDOW
  173.    procedure.  Foreground and Background are the color attributes of the
  174.    border.  Border is the type of border desired.  Possible border types
  175.    are:
  176.  
  177.           NONE          -   no border
  178.           SINGLE        -   single line
  179.           DOUBLE        -   double line
  180.           DOUBLETOP     -   double top lines, single side lines
  181.           DOUBLESIDE    -   double side lines, single top lines
  182.           SOLID         -   solid block (space character)
  183.  
  184.     Example useage:
  185.  
  186.             MakeWindow(5,5,30,10,Black,White,Double);
  187.  
  188.   Procedure DrawBox(X1,Y1,X2,Y2,Forground,Background : Word;Border : BorderType);
  189.  
  190.     Works just like MakeWindow but doesn't save the underlying screen and
  191.     doesn't use a matching RemoveWindow.
  192.  
  193.   Procedure RemoveWindow;
  194.  
  195.     Removes the current top window, does nothing if there isn't any windows
  196.     defined with the MakeWindow procedure.
  197.  
  198.   Procedure SetCursor(Cursor : Word);
  199.  
  200.     Sets the cursor shape.  Some software packages turn off the cursor
  201.     so this is provided so you can set your prefered cursor shape.  The
  202.     windowing package saves the cursor shape of the underlying screen so
  203.     there is no need to restore it.
  204.  
  205.   Var VideoMode : Word;
  206.  
  207.     A DOS variable that holds the current video mode.  Use this to test
  208.     for and avoid popping in graphics modes.
  209.  
  210. ===============================================================================
  211. SAMPLE PROGRAMS
  212. ===============
  213.  
  214. POPDICE is a fully functional sample pop-up program.  After loading, pressing
  215. ALT-LeftShift-D will pop-up a fancy dice rolling program designed for war
  216. games and roll-playing games.
  217.  
  218. NODICE will remove POPDICE from memory if it is safe to do safe.  Alternately,
  219. a second program, REMOVE, can be used to unload ANY resident program written
  220. with this package.  A companion batch file, NODICE.BAT, is used to drive the
  221. universal program and to display the proper messages.  REMOVE accepts a single
  222. I.D. number on the command line.  This is the same as the program's signature.
  223.  
  224. You must delete or rename NODICE.EXE for NODICE.BAT to work since DOS will
  225. execute an EXE before a BAT file of the same name.
  226. ===============================================================================
  227.  
  228. Caveats
  229. =======
  230.  
  231. You MUST handle all possible errors.  If at any time the program halts
  232. due to a runtime, I/O, or critical error the system will probably crash.
  233. Before the resident program is entered, Turbo's critical error handle
  234. is restored so that you can query IOResult for errors.
  235.  
  236. Use the $M directive to reduce memory requirements.  Slightly more than 4000
  237. bytes are required for each window created by MakeWindow (to save the under-
  238. lying screen).  Make a high guess of memory requirements for your program
  239. then double or triple it.  Compile and run the program to make sure it runs.
  240. If it doesn't increase memory.  If it does run decrease it.  Keep decreasing
  241. the memory until the program crashes then increase memory and add a little
  242. extra for slop.
  243.  
  244. You should test the video mode when your routine is first run.  The windows
  245. unit can not properly save graphics screens so you might want to beep and
  246. exit.  You could, of course, write your own windowing package that can save
  247. graphics screens.  This could be a problem with some of the new video modes
  248. that have tremendous memory requirements.
  249.  
  250. Shift Keys
  251. ==========
  252.  
  253. RightShift  $01
  254. LeftShift   $02
  255. Control     $04
  256. ALT         $08
  257.  
  258. ScrollLock  $10   { these four are not supported in this version }
  259. NumLock     $20   {  "     "     "     "     "     "     "     " }
  260. CapLock     $40   {  "     "     "     "     "     "     "     " }
  261. Insert      $80   {  "     "     "     "     "     "     "     " }
  262.  
  263. The shift status values are defined in the interface portion of the PopUp
  264. unit.  The values are already shifted to the left 8 bits to save you the
  265. trouble.  Simple add the different shift keys you want to the scan code
  266. and pass that value to StayResident.  For example, for a program to popup
  267. when both shift keys are pressed as well as the period you would issue
  268. the command:
  269.  
  270.           StayResident(@MyPopUp,RightShift + LeftShift + $34);
  271.  
  272. The coding of the popup routines makes undefined keys possible, thus
  273. reducing the chance of keyboard confict.  For example the numeric pad
  274. '5' (the center key) is undefined for most combinations.  This allows
  275. you to use combinations such as (Control + LeftShift + $4C) with a
  276. high degree of certainty that it won't conflict with other programs.
  277.  
  278. Keyboard Scan Codes
  279. ===================
  280.  
  281. 0  $0B     6  $07     C  $2E     I  $17     O  $18     U  $16
  282. 1  $02     7  $08     D  $20     J  $24     P  $19     V  $2F
  283. 2  $03     8  $09     E  $12     K  $25     Q  $10     W  $11
  284. 3  $04     9  $0A     F  $21     L  $26     R  $13     X  $2D
  285. 4  $05     A  $1E     G  $22     M  $32     S  $1F     Y  $15
  286. 5  $06     B  $30     H  $23     N  $31     T  $14     Z  $2C
  287.  
  288. BS   $0E
  289. CTL  $1D
  290. ESC  $01
  291. TAB  $0F
  292. RET  $1C
  293.  
  294. -  $0C     `  $29
  295. =  $0D     \  $2B
  296. [  $1A     ,  $33
  297. ]  $1B     .  $34
  298. ;  $27     /  $35
  299. '  $28
  300.  
  301. LeftShift   $2A
  302. RightShift  $36
  303. ALT         $38
  304. Space       $39
  305. CapLock     $3A
  306.  
  307. F1  $3B     F2  $3C     F3  $3D     F4  $3E     F5   $3F
  308. F6  $40     F7  $41     F8  $42     F9  $43     F10  $44
  309.  
  310. NumLock     $45       ScrollLock  $46       Home        $47
  311. UpArrow     $48       PageUp      $49       grey -      $4A
  312. RightArrow  $4B       Center      $4C       LeftArrow   $4D
  313. grey +      $4E       End         $4F       DownArrow   $50
  314. PageDown    $51       Ins         $52       Del         $53
  315.  
  316. ==============================================================================
  317. Version History
  318.  
  319. 1.6  1 October 1988
  320.  
  321.      Added experimental unload procedure.  Minor cosmetic changes.
  322.      Improved support for conflicting hot-keys.  Removed RestoreVectors
  323.      and placed in a separate unit.
  324.  
  325. 1.5  20 September 1988
  326.  
  327.      Code added to detect programs that have already been loaded, thus
  328.      preventing multiple loading of the same TSR.  Minor bug fix.
  329.      Documentation corrections.
  330.  
  331. 1.4  31 August 1988
  332.  
  333.      All source code now included in the archive.
  334.      Removed the FREE unit due to problems.  Use Mark/Release instead.
  335.  
  336. 1.2  21 March 1988
  337.  
  338.      Minor correction in the low-level popup code - not all of the
  339.      registers were being saved.
  340.  
  341. 1.1  13 March 1988
  342.  
  343.      Changed popup code so the user procedure is declared as FAR rather
  344.      than as INTERRUPT.
  345.  
  346. 1.0  Original version
  347.  
  348. REFERENCES
  349. ==========
  350.  
  351. Advanced MS-DOS, Ray Duncan, Microsoft Press
  352.  
  353. The MS-DOS Encyclopedia, Microsoft Press
  354.  
  355. Magazine articles too numerous to list.
  356.  
  357. ACKNOWLEDGEMENTS
  358. ================
  359.  
  360. I wish to thank the many programmers who pioneered the development of
  361. Terminate-and-Stay-Resident programs, on whom's shoulders I am standing.
  362.  
  363. ===============================================================================
  364. Other Turbo Pascal units by Ross Neilson Wentworth
  365. (## indicates a two digit version number)
  366.  
  367. TPENV##    Easily access the environment.  Includes a routine to automatically
  368.            search the PATH for a specified file.  Other nice features.
  369.  
  370. VOLUME     Add, read, change, delete the DOS volume label.
  371.  
  372. TEXT##     Adds three new procedures for TEXT files, TEXTFILEPOS, TEXTFILESIZE
  373.            TEXTSEEK.  Makes moving around in a text file possible.
  374.  
  375.  
  376. LEGAL STUFF
  377.  
  378. Sidekick and Turbo Pascal are Trademarks or Registered Trademarks
  379. of Borland International, Inc.
  380.