home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / a / a003 / 1.ddi / SAMPLE.ASM < prev    next >
Encoding:
Assembly Source File  |  1986-09-29  |  7.8 KB  |  192 lines
  1.      title     Example Runtime Overlay Loader User Module for PLINK86
  2.      subttl    Phoenix Software Associates Ltd.
  3.      .sfcond
  4. ;
  5. ;
  6.                ;******************************
  7.               ;* Overlay Loader User Module *
  8.               ;******************************
  9. ;
  10. ;    The overlay loader user support module specifies how the overlay loader
  11. ;will handle error conditions like "overlay not found".  It can print messages,
  12. ;modify or replace the file name the overlay loader is trying to use, or
  13. ;terminate the program.
  14. ;    This is a simplified example of how a user support module could be set
  15. ;up for use with MSDOS 2.0.  It modifies all overlay file names by appending a
  16. ;path name to the front (\SAMPLE\).  In other words, all overlay files for the
  17. ;application are assumed to reside in the \SAMPLE directory.  If an error of
  18. ;some kind occurs a message is printed and the program is terminated.
  19. ;    The standard user support module is in "OVUSER.ASM", and is included
  20. ;in OVERLAY.LIB.  Take a look at that one for some more complicated algorithms
  21. ;for finding overlay files.  You may modify that one, or start with this one
  22. ;if your requirements are simple.  Then just link it in with the rest of the
  23. ;program, after the other input files.  Don't put it in an overlay though!
  24. ;    Modifications should be made with care:  Phoenix will probably
  25. ;be unsympathetic to those who write their own user modules and then expect us
  26. ;to help with the debugging.  However, virtually any modifications needed to
  27. ;make your application run smoothly may be accomplished by writing a user
  28. ;support module like this one.
  29. ;    As the program begins execution the $OVLYIU routine is called before
  30. ;the application program is started.  Initialization is performed here (in this
  31. ;simple example, only minimum initialization is done: $OVDOS2 & $OVOM$ must
  32. ;be initialized in $OVLYIU.
  33. ;    The overlay loader calls symbol $OVLYxU each time it is about to open a
  34. ;new overlay file (keep in mind that a file can contain several overlays), or
  35. ;whenever a fatal error is encountered while reading an overlay.  The 'x' is 'M'
  36. ;for MSDOS programs, and 'C' for CP/M-86 programs.  The name of the overlay
  37. ;file being requested is provided in a string area labled by public symbol
  38. ;$OVLYFN, and may be modified if desired.  The file name must be terminated by
  39. ;a NUL, and the string area must be at least 13 bytes long.  As initialized by
  40. ;the overlay loader, the file name consists of a name and type only, of maximum
  41. ;length 8 and 3 chars respectively, separated by a period.  In this sample user
  42. ;module the string "\SAMPLE\" is appended to the front of the file name.
  43. ;    A result code is provided in the AL register describing what happened
  44. ;during the previous attempt to load an current overlay from the current file:
  45. ;
  46. ;0 - The first attempt to load an overlay has not been made yet.
  47. ;1 - The overlay file was not found.
  48. ;2 - The overlay file couldn't be opened due to a disk error.  These errors
  49. ;    are things like no disk in drive, drive not ready, or media errors such
  50. ;    as seek and CRC problems.
  51. ;3 - The overlay couldn't be read completely (premature EOF).  The file
  52. ;    is probably smashed.
  53. ;4 - The overlay couldn't be read because of a disk error (drive not ready,
  54. ;    media error, etc).
  55. ;
  56. ;    After possibly making modifications to the overlay file name, the $OVLYxU
  57. ;routine must return, in the AL register, a function code instructing the
  58. ;overlay loader how to handle the next attempt to load the overlay:
  59. ;
  60. ;0 - Try to load the overlay from the file whose name given in $OVLYFN.
  61. ;1 - Give up.  The program is normally terminated when this code is received.
  62. ;    However, if the user program called the overlay loader itself (at the
  63. ;    $LOAD$ routine, see Plink86 user manual), an error code may be returned to
  64. ;    the user program at its option.
  65. ;
  66. ;    This sample module prints a message and terminates the program whenever
  67. ;an error occurs.
  68. ;
  69.      name OVUSER         ;name of this module
  70.      public    $OVLYIU   ;entry point to initialize user module
  71.      public    $OVLYMU   ;entry point for MSDOS user routine
  72.      public    $OVLYFN   ;overlay file name string for overlay loader to use
  73.                         ;fatal messages
  74.     public    $roverflow    ;      overlay loader reload stack overflow
  75.     public    $runderflow    ;      overlay loader reload stack undeflow
  76.     public    $rnomemory    ;      not enough memory for overlay reload stack
  77.     public    $needdos2        ;      need dos 2.0 i/o capability
  78. ;
  79. ;
  80. ;*******
  81. ;* Sys *
  82. ;*******
  83. ;This is a macro for doing operating system calls.
  84. ;
  85. LodOff    macro     Reg,Var        ;;macro to load variable offset into reg
  86.      mov  Reg,offset Var      ;;MSDOS, offsets are from segment
  87.      endm
  88. ;
  89. Sys  macro     Fun,Arg        ;;macro for invoking Operating system functions
  90.      mov  AH,Fun
  91.      ifnb <Arg>
  92.      LodOff    DX, Arg
  93.      endif
  94.      int  21H
  95.      endm
  96. ;
  97. ;********
  98. ;* Data *
  99. ;********
  100. ;The data area must be set up as shown here so that it will combine properly
  101. ;with the overlay loader's data area.  DS and ES always point to this segment
  102. ;when the overlay loader calls this module.
  103. ;
  104. extrn  $OVOM$: byte      ;open mode for overlay files - 
  105.                          ;    network may be running => shared files
  106. extrn  $OVDOS2: byte     ;-1 => MSDOS >= 2.0 running
  107.  
  108. OVdata    segment   word public 'OVLOADER'
  109. ;
  110. CR   equ  0DH
  111. LF   equ  0AH
  112. ;
  113. DosVer    db   0              ;MSDOS version number.
  114. FNlen     equ  80             ;maximum length of overlay file name
  115. $OVLYFN   db FNlen dup (?)    ;overlay file name work area
  116. PRFlen    equ  8              ;length of my path name
  117. Prefix    db   "\SAMPLE\"     ;my path name for overlay files
  118.                               ;my error message
  119. Err  db   "Fatal error - can't load overlay",CR,LF,"$"
  120. $runderflow    db    "PLINK86 Overlay Loader: stack underflow $"
  121. $roverflow    db    "PLINK86 Overlay Loader: stack overflow $"
  122. $rnomemory    db    "PLINK86 Overlay Loader: not enough memory for stack $"
  123. $needdos2        db    "PLINK86 Overlay Loader: dos 2.0 required $"
  124. ;
  125. ;
  126. OVdata    ends
  127. ;
  128. ;********
  129. ;* Code *
  130. ;********
  131. ;The code segment must be set up as shown here so it will combine properly
  132. ;with the overlay loader's code segment.  All calls to this module are near
  133. ;calls.
  134. ;
  135. OVcode    segment  public 'OVLOADER'
  136.      assume cs:OVcode, ds:OVdata, es:OVdata
  137. ;
  138. ;***********
  139. ;* $OVLYIU *
  140. ;***********
  141. ;Initialization routine: $OVDOS2 & $OVOM$ MUST BE INITIALIZED HERE!!
  142. ;
  143. $OVLYIU   proc near
  144.      Sys  30H            ;AL := DOS version #
  145.      mov  DosVer, AL     ;Save for later.
  146.      cmp  AL,2           ;go away if earlier than 2.0
  147.      jnc  IU2
  148.      jmp  short IUend
  149. IU2:                     ;DOS 2.x or later
  150.      mov  $OVDOS2, -1    ;   -1 => use dos 2.0 file handles
  151.      xor  AL, AL         ;   default to standard file open mode
  152.      mov  $OVOM$, AL     ;   set my open mode
  153. IUend:
  154.      ret
  155. $OVLYIU   endp
  156. ;
  157. ;***********
  158. ;* $OVLYxU *
  159. ;***********
  160. ;If this is the first attempt to load an overlay, append our path name to the
  161. ;front.  Otherwise, print an error message and terminate the program.
  162. ;
  163. $OVLYMU   proc near
  164.      or   AL, AL         ;error on last attempt?
  165.      jnz  Error
  166.                ;shift file name up by length of prefix.
  167.      mov  SI, offset $OVLYFN + FNlen - PRFlen - 1
  168.      mov  DI, offset $OVLYFN + FNlen - 1
  169.      mov  CX, FNlen - PRFlen
  170.      std
  171.      rep movsb
  172.                          ;move our prefix into front of file name area
  173.      mov  SI, offset Prefix
  174.      mov  DI, offset $OVLYFN
  175.      mov  CX, PRFlen
  176.      cld
  177.      rep movsb
  178. ;
  179.      mov  AL, 0          ;Tell loader to try this file name.
  180.      ret
  181. ;
  182. Error:
  183.      mov  AH, 9          ;print our error message.
  184.      mov  DX, offset Err
  185.      int  21H
  186.      mov  AL, 1          ;Stop the program.
  187.      ret  
  188. ;
  189. $OVLYMU   endp
  190. OVcode    ends
  191.      end
  192.