home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / enterprs / cpm / utils / s / scan22.lbr / TCSRC13.DZC / TCSRC13.DOC
Encoding:
Text File  |  1990-05-07  |  8.9 KB  |  204 lines
  1.  
  2. ZCPR3 Z3TCAP (MYTERM.Z3T) file to source code (MYTERM.Z80)
  3. generator.
  4.  
  5. Program Name:  TCSRC
  6. Author:  Terry Hazen
  7. Version:  1.3
  8. Date:  07 May 90
  9.  
  10.  
  11. Since it is difficult to extensively customize an existing
  12. Z3TCAP.Z3T file by patching alone, TCSRC was written to help the
  13. user customize his Z3TCAP by creating a commented source code
  14. file (MYTERM.Z80) from an existing MYTERM.Z3T file for his
  15. terminal, such as one extracted from Z3TCAP.TCP by TCSEL, or from
  16. the current Z3TCAP located in memory in the ZCPR3 environment.
  17. TCSRC also allows you to create a blank commented Z3TCAP source
  18. code file when you want to start from scratch.  The new source
  19. code file can then be edited as desired, assembled to MYTERM.COM
  20. and renamed to MYTERM.Z3T.  It can then be loaded to your
  21. environment using LDR.COM, NZCOM.COM, JETLDR.COM, etc.
  22.  
  23. TCSRC generates Z3TCAP commented source code based on the Z3TCAP
  24. definition contained in VLIB4D.  VLIB4D modifies the sequence of
  25. control strings in the extended Z3TCAP over that specified by
  26. earlier VLIB4 beta releases to bring all the terminal control
  27. strings into a common area located prior to the graphics area,
  28. reduces the length of the terminal name to 13 bytes and adds a
  29. byte defining the offset of the graphics area from the start of
  30. the Z3TCAP.
  31.  
  32. TCSRC expects input files to be subsets of the VLIB4D standard,
  33. such as standard Z3TCAP files.  Consult the current VLIB4 help
  34. files for explanations of each of the defined terminal functions
  35. and consult your terminal manual for information on the terminal
  36. control strings required to implement the terminal functions for
  37. your terminal.
  38.  
  39. Source code generated by TCSRC from earlier extended Z3TCAP files
  40. with different extended formats will begin to be incorrect when
  41. the sequence of control strings begins to differ from the new
  42. VLIB4D standard and will have to be corrected with a text editor.
  43. Lines of source code defining terminal control strings may simply
  44. be moved into the correct order, ignoring both comments and
  45. labels (except for GOELD, which is used to define the graphics
  46. area offset), as the corrected source code file can be assembled
  47. to a COM file and TCSRC can then be used again to quickly
  48. generate a new, correctly commented source code file.
  49.  
  50.  
  51. Syntax
  52. ------
  53.  
  54.      TCSRC [dir:]infile[.z3t] [[dir:]outfile[.z80]]
  55.  
  56.      Special infile names:
  57.           'Z3ENV' creates source code file from the Z3TCAP in the
  58.                environment.
  59.           'BLANK' creates blank commented source code file.
  60.  
  61.      Default outfile is infile.Z80 on default directory.  Any
  62.      existing R/W file of the same name will be overwritten.
  63.  
  64.  
  65. Graphics TCAP Offset
  66. --------------------
  67.  
  68. VLIB4D defines a graphics offset byte at GOFF (Z3TCAP+12), which
  69. contains the offset from the start of the Z3TCAP to the start of
  70. the graphics area at GEOLD, to allow the future addition of
  71. terminal control strings in the terminal control string area
  72. without requiring rewritting of the VLIB graphics routines using
  73. the graphics data.  To compensate for the addition of the
  74. graphics offset byte, the length of the terminal name area has
  75. been reduced to 13 bytes.
  76.  
  77.  
  78. Terminal Configuration Bytes
  79. ----------------------------
  80.  
  81. VLIB4D defines two terminal configuration bytes at B14
  82. (Z3TCAP+14) and B15 (Z3TCAP+15) to allow an application program
  83. access to terminal characteristics not otherwise specified in the
  84. Z3TCAP.  Application programs such as WordStar and SCAN now have
  85. access to information not only about terminal control strings,
  86. but about how users have configured their terminals.  Users can
  87. set configuration bits indicating, for example, whether or not
  88. their terminals are set to auto-wrap at the end of a line or
  89. auto-scroll at the end of a screen, whether their terminals use
  90. ANSI or ASCII control sequences, and whether they use reverse
  91. video or non-reverse (usually dim) video for their standout mode.
  92. Not all application aprograms will check the terminal
  93. configuration bytes, but their presence allows the user some
  94. control over how application programs configure his screen
  95. display.
  96.  
  97. SCAN, for example, checks the auto-wrap and auto-scroll bits to
  98. see whether it can put characters in the last display column on
  99. the screen without causing additional blank lines to be inserted
  100. into the display.  If both bits are 0, the last column is
  101. considered safe, and the whole screen can be used for the
  102. display.  If either bit is set, the last column is considered
  103. reserved and the next-to-last column will be the final column
  104. used.  So if your terminal is configured to not automatically
  105. wrap or scroll, you can set the bits accordingly and SCAN will
  106. use the whole screen.  Joe Wright's WSPAT for WordStar4 uses the
  107. configuration bytes in a similar way, along with the set
  108. attribute string to create WS4 display screens.
  109.  
  110.  
  111. Screen Display Configuration
  112. ----------------------------
  113.  
  114. When you start looking at how many ways a given terminal can be
  115. configured by a user and how that configuration can affect screen
  116. displays, it quickly becomes clear that a standard Z3TCAP for a
  117. given terminal type is not adequate to convey more than basic
  118. standard information for that terminal.  It may make a difference
  119. to a screen display intensive applications program, for example,
  120. whether a screen is configured as dark letters on a light screen
  121. or light letters on a dark screen and whether reverse video or a
  122. non-reverse video mode, such as dim or bold is used as standout.
  123. For example, if dim is used as standout mode on a dark screen,
  124. spaces in standout mode won't show up, but if reverse video is
  125. used, they will, creating quite a different display.
  126.  
  127. If the Z3TCAP for a particular terminal specifies dim as the
  128. standout mode, but the user prefers to use bold, reserving dim
  129. for standard mode, but then wishes to exit to a normal video
  130. command line, he must customize his Z3TCAP to use SO (Start
  131. Standout), SE (End Standout), TI (Terminal Initialization) and TE
  132. (Terminal Deinitialization) to set his terminal according to his
  133. preferences.  In this example, SO would set dim, SE would set
  134. normal, TI would set dim, and TE would set normal video.
  135.  
  136. Still another user of the same terminal type might prefer half
  137. intensity for standout, and would need to customize his Z3TCAP
  138. accordingly.  So many terminal characteristics may be user
  139. configured, in fact, that it is really the user's responsibility
  140. to create a customized Z3TCAP for his system that reflects his
  141. own preferences.  TCSRC attempts to facilitate this process by
  142. providing the user a handy tool to quickly create Z3TCAP source
  143. code files that may be easily edited and used to create his
  144. working customized Z3TCAP.
  145.  
  146.  
  147. Extended Z3TCAP Terminal Control Sequences
  148. ------------------------------------------
  149.  
  150. The source code created by TCSRC includes the LD (delete line at
  151. cursor position) and LI (insert line at cursor position)
  152. sequences added in the extended Z3TCAP defined by VLIB4B.
  153. Applications such as WordStar and SCAN can use these control
  154. sequences to produce better displays.
  155.  
  156. For screen display intensive applications such as WordStar 4.0
  157. patch WSPAT, Joe Wright added a macro to the Z3TCAP and a routine
  158. in VLIB4C to set terminal display attributes.  The source code
  159. created by TCSRC includes the SA (set Attributes) macro and AT
  160. (the attribute string).
  161.  
  162. The source code created by TCSRC also includes a CD (clear screen
  163. from cursor to end-of-screen) sequence.  While sequence is, in
  164. some cases, a duplication of part of the CL (Home Cursor and
  165. Clear Screen) sequence, it is now available as a separate control
  166. sequence.
  167.  
  168.  
  169. Other New VLIB4D Terminal Control Sequences
  170. -------------------------------------------
  171.  
  172. For use with windowing routines used in pull-down menus, the
  173. extended Z3TCAP includes a new RC sequence that reads the
  174. character at the current cursor position and a RL sequence that
  175. reads the entire line up until the cursor position into a buffer.
  176. Consult V4LIBD.HLP for more information.
  177.  
  178.  
  179. Graphics Extensions
  180. -------------------
  181.  
  182. VLIB4D adds a new standardized character graphics area beginning
  183. at GOELD (graphics on/off delay).  Graphics extensions include
  184. GO/GE (graphics mode on and off), and CDO/GDE (turn the cursor
  185. off and on).
  186.  
  187.  
  188. Graphics Characters
  189. -------------------
  190.  
  191. Graphics characters used by VLIB4D are one-byte characters that
  192. produce lines, intersections and corners as well as full and
  193. hashed blocks.  For terminals without graphics capability, very
  194. good results can be obtained using the characters '-' and '|' for
  195. horizontal (GHL) and vertical (GVL) line characters.  The
  196. characters '*' and '#' can be used for full (GFB) and hashed
  197. (GHB) blocks, the characters '+' or '*' can be used for corners
  198. and the character '+' for intersections.
  199.  
  200. Use TCSRC to add graphics characters to your own Z3TCAP and try
  201. BOX.COM from VLIB4D for a demonstration of the new line graphics
  202. as used in a box drawing routine.
  203.  
  204.