home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / zsys / znode-12 / s / z3help13.lbr / Z3LIB.HZP / Z3LIB.HLP
Encoding:
Text File  |  1993-06-12  |  7.0 KB  |  212 lines
  1. ;
  2.                                   Z3LIB.REL                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. Z3LIB.REL     12k (90)   4EDE  4.0        Harold Bower 4/89        Z3LIB4
  6. Z3LIBS.REL    11k (82)   6EAB  4.0        Harold Bower 4/89        Z3LIB4
  7.  
  8.   1- Introduction  2- Extended Environment Definition                         
  9.  
  10. Z3LIB - the ZCPR3-specific libraries
  11.   A - Access to the ZCPR3 Environment:   Command Line, CRT/PRT Data, External
  12.                                          FCB, Environment, FCP Address, File 
  13.                                          Names, Initialize
  14.   B - Access to the ZCPR3 Environment:   IOP, DU/Max DU, Messages, Named Dir,
  15.                                          Path, Processor Speed, Quiet Flag, 
  16.                                          RCP Address, Shell Stack, Wheel Byte
  17.   C - Flow and ZEX Control Under ZCPR3
  18.   D - Access to the ZCPR3 Messages
  19.   E - General-Purpose ZCPR3 Utilities
  20. :1
  21.  
  22.  
  23. Introduction:
  24.  
  25.    Z3LIB is one  of three libraries provided with the ZCPR3 System,  the other
  26. two being SYSLIB and VLIB.   Z3LIB contains  a host of support utilities which 
  27. provide access to ZCPR3-specific features and capabilities.   SYSLIB is a host
  28. of general-purpose  utilities and VLIB is  a set  of machine-independent  (via
  29. Z3TCAP) utilities which support CRT control and utilitization.
  30.  
  31.    SYSLIB is documented in a collection of SYSLIB*.HLP files, as is VLIB.
  32.  
  33.  
  34.      Z3LIB routines can be divided into four categories:
  35.  
  36.           1.   ZCPR3 Environment Access 
  37.                -- Those utilities which allow the programmer to easily extract
  38. data from the Z3 Environment  Descriptor  and  modify  certain  Z3 environment 
  39. parameters
  40.  
  41.           2.  ZCPR3 Flow Control 
  42.                -- Those  utilities  which  permit  the  programmer  to  easily 
  43. manipulate  the flow  control environment of ZCPR3,  enabling him to raise the 
  44. level or lower the level of the current IF condition and to toggle the current
  45. IF condition as desired
  46.  
  47.           3.  ZCPR3 Messages 
  48.                -- Those utilities  providing  access  to  the  ZCPR3 messages, 
  49. allowing the program to read and write messages from and to the system
  50.  
  51.           4.  ZCPR3 Utilities 
  52.                -- Useful  utilities   which   relieve   the   programmer  from 
  53. constantly reprogramming some  commonly-used ZCPR3 features
  54. :2
  55.  
  56.  
  57.  Extended Environment Description 
  58.  
  59.    Version 4 of Z3LIB incorporates  many enhanced functions  developed  by Joe 
  60. Wright and Jay Sage in NZCOM and  ZCPR33 and 34.   Due to redefinition of some 
  61. of the bytes in the Environment Descriptor, a few of the original modules will
  62. not  perform  as originally intended.   For example,  only  one  Console  (CRT 
  63. device) is  supported.   The remaining space  in  the  ENV contains vectors to 
  64. system segments.
  65.  
  66.    Some programs such as  Plu*Perfect Systems' JETLDR and Alpha Systems' NZCOM 
  67. set  an  existing Environment Descriptor  to  reflect  the  necessary extended 
  68. definitions.  If you do not routinely use either of these products, you should 
  69. create a  new SYS.ENV file for  use with your existing ZCPR3 system.   The new
  70. definitions  are  marked with  an asterisk (*) in  the  following  source code 
  71. sample Environment Descriptor.
  72.  
  73.  ; Library:  NZENV.LIB
  74.  ; Author:   Joe Wright
  75.  ; Version:  1.0
  76.  ; Date:     29 Nov 87
  77.  
  78.  ; Adapted from Rick Conn's original SYSENV.LIB circa 1984
  79.  
  80. Z3ENV:    JP    CBIOS+6        ;* Real BIOS Addr (+6) for your
  81.                 ;  system (* Was JP 0 *)
  82.  
  83.     DEFB    'Z3ENV'        ; Environment ID
  84.  
  85.     DEFB    80H        ;* Extended Env shown by Bit 7
  86.  
  87.     DEFW    EXPATH        ; External Path address
  88.     DEFB    EXPATHS        ; # of 2-byte elements in Path
  89.  
  90.     DEFW    RCP        ; RCP address
  91.     DEFB    RCPS        ; # of 128-byte blocks in RCP
  92.  
  93.     DEFW    IOP        ; IOP address
  94.     DEFB    IOPS        ; # of 128-byte blocks in IOP
  95.  
  96.     DEFW    FCP        ; FCP address
  97.     DEFB    FCPS        ; # of 128-byte blocks in FCP
  98.  
  99.     DEFW    Z3NDIR        ; NDR address
  100.     DEFB    Z3NDIRS        ; # of 18-byte entries in NDR
  101.  
  102.     DEFW    Z3CL        ; ZCPR3 Command Line
  103.     DEFB    Z3CLS        ; # of bytes in Command Line
  104.  
  105.     DEFW    Z3ENV        ; ZCPR3 Environment Descriptor
  106.     DEFB    Z3ENVS        ; # of 128-byte blks in ENV
  107.  
  108.     DEFW    SHSTK        ; Shell Stack address
  109.     DEFB    SHSTKS        ; # SHSIZE-byte entries in Stk
  110.     DEFB    SHSIZE        ; Size of a Shell Stack entry
  111.  
  112.     DEFW    Z3MSG        ; ZCPR3 Message Buffer
  113.  
  114.     DEFW    EXTFCB        ; ZCPR3 External FCB
  115.  
  116.     DEFW    EXTSTK        ; ZCPR3 External Stack
  117.  
  118.     DEFB    0        ; Quiet flag (0=not quiet)
  119.  
  120.     DEFW    Z3WHL        ; Address of Wheel Byte
  121.  
  122.     DEFB    4        ; Processor Speed in MHz
  123.  
  124.     DEFB    'P'-'@'        ; Maximum Disk
  125.     DEFB    31        ; Maximum User
  126.     DEFB    1        ; 1=Ok to accept DU:, 0=Not Ok
  127.  
  128.     DEFB    0        ;* CRT Selection   (* Unused *)
  129.     DEFB    0        ; Printer Sel (only 0 or 1)
  130.  
  131.     DEFB    80        ; Width of CRT 0
  132.     DEFB    24        ; Number of lines on CRT 0
  133.     DEFB    22        ; Number of text lines on CRT 0
  134.  
  135.  ; CRT 1 descriptor is replaced with this Valid Drive Vector.
  136.  ; The Command Processor ignores 'Maximum disk' above, and uses
  137.  ; this vector instead.  This allows 'holes' in the disk map.
  138.  ; A user might have drives A, B, E, F and G for example. In
  139.  ; this case, his vector would look like:
  140.  ;    DEFW    0000000001110011B
  141.  ; The Command Processor will treat drive C the same as drive H
  142.  ; (unavailable) and take appropriate action.  
  143.  
  144.     DEFW    1111111111111111B ;* Valid drive vector (16)
  145.     DEFB    0        ;* Not used
  146.  
  147.     DEFB    80        ; Width of Printer 0
  148.     DEFB    66        ; Number of lines on Printer 0
  149.     DEFB    58        ; Number of text lines on Ptr 0
  150.     DEFB    1        ; H/W Form Feed (0=can't,1=can)
  151.  
  152.     DEFB    102        ; Width of Printer 1
  153.     DEFB    66        ; Number of lines on Printer 1
  154.     DEFB    58        ; Number of text lines on Ptr 1
  155.     DEFB    1        ; H/W Form Feed (0=can't,1=can)
  156.  ;* Descriptors for Printers 2 and 3 replaced with System Data
  157.  
  158.     DEFW    CCP        ;* ZCPR 3.x start loc'n       3FH
  159.     DEFB    CCPS        ;* Size in records       41H
  160.  
  161.     DEFW    DOS        ;* DOS starting location   42H
  162.     DEFB    DOSS        ;* Size in records       44H
  163.  
  164.     DEFW    BIOS        ;* NZBIO starting location 45H
  165.  
  166.     DEFB    'SH      '    ; Shell Variable Filename
  167.     DEFB    'VAR'        ; Shell Variable Filetype
  168.  
  169.     DEFB    '        '    ; Filename 1
  170.     DEFB    '   '        ; Filetype 1
  171.  
  172.     DEFB    '        '    ; Filename 2
  173.     DEFB    '   '        ; Filetype 2
  174.  
  175.     DEFB    '        '    ; Filename 3
  176.     DEFB    '   '        ; Filetype 3
  177.  
  178.     DEFB    '        '    ; Filename 4
  179.     DEFB    '   '        ; Filetype 4
  180.  
  181.     DEFB    0        ;* Public drive OFF       7EH
  182.     DEFB    0        ;* Public user OFF       7FH
  183.                 ;  (* Only defined for ZRDOS *)
  184.  
  185.  ; This dummy Terminal Capabilities description (Z3TCAP) will
  186.  ; normally be replaced with a tailored MYTERM.Z3T on start up.
  187.  
  188. ENVORG2: DEFB    '               ' ; Terminal Name (15 chars)
  189.     DEFB    0        ; No terminal attributes
  190.     DEFB    'E'-'@'        ; Cursor Up
  191.     DEFB    'X'-'@'        ; Cursor Down
  192.     DEFB    'D'-'@'        ; Cursor Right
  193.     DEFB    'S'-'@'        ; Cursor Left
  194.     DEFB    0        ; Cl delay
  195.     DEFB    0        ; Cm delay
  196.     DEFB    0        ; Ce delay
  197.  
  198.     DEFB    0        ; Cl string
  199.     DEFB    0        ; Cm string
  200.     DEFB    0        ; Ce string
  201.     DEFB    0        ; So string
  202.     DEFB    0        ; Se string
  203.     DEFB    0        ; Ti string
  204.     DEFB    0        ; Te string
  205.  
  206.  ; File filled with Zeros to end of 128-byte segment
  207. :A:Z3LIB1
  208. :B:Z3LIB2
  209. :C:Z3LIB3
  210. :D:Z3LIB4
  211. :E:Z3LIB5
  212.