.STANDARD;.FL CAPITALIZE
.TITLE <ARTDEF- ^^GLOBAL SYMBOL DEFINITIONS FOR ARITHMETIC SUBROUTINES\\
.SKIP 1
.CENTER
<ARTDEF- ^^GLOBAL SYMBOL DEFINITIONS FOR ARITHMETIC SUBROUTINES\\
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <ARTDEF\
.SKIP 1
.INDENT -10
WILL NEED THIS MODULE FOR OVERLAY DESIGN OF LARGE PROGRAMS.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ NOT "CALLABLE"
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <ARTDEF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.FLAGS CAPITALIZE
.PAGE;.SD;.FLAGS CAPITALIZE
.TITLE  <EVALAE - ^^SUBROUTINE TO EVALUATE AN <RPN TABLE\\
.INDENT 50
<EVALAE
.SKIP 1
.CENTER
<EVALAE - ^^SUBROUTINE TO EVALUATE AN <RPN TABLE\\ 
.LM 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <EVALAE\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO PERFORM THE FUNCTIONS STORED IN THE REVERSE POLISH TABLE 
PARSED BY ^^PARSAE.\\  <EVALAE IS A REAL FUNCTION AND MUST BE DECLARED REAL IF YOU USE 
IMPLICIT INTEGER.

.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN.\\
<CALL ^^EVALAE (RPNTAB,VALUE)\\
.BREAK
.CENTER
 OR
.CENTER
 ^^VALUE = EVALAE (RPNTAB)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^RPNTAB---A\\ REVERSE POLISH TABLE.  ^THIS TABLE MUST BE DIMENSIONED 
 TO 2 TIMES THE MAXIMUM NUMBER OF ANTICIPATED OPERATIONS, +1 (IN WORDS).
.INDENT -9
^^VALUE----T\\HE RESULT OF THE ARITHMETIC STATEMENT.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^THE ROUTINES USED BY ^^EVALAE\\ ARE DEFINED IN THE MODULE
^^ARTDEF\\ AND ARE STORED IN THE FILE <MATHLIB.FTN.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ <VALUE=EVALAE(RPNTAB)
.SKIP 1
.INDENT -10
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^EVALAE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ ^JANUARY 78
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE ^^GETVAL-RETRIEVING THE VALUE OF A SYMBOL\\
.PAGE
.INDENT 50
<GETVAL
.SKIP 1
.CENTER
^^GETVAL-RETRIEVING THE VALUE OF A SYMBOL\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: GETVAL\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO RETRIEVE A VALUE FROM THE SYMBOL TABLE DEFINED BY <PARSAE
AND MANIPULATED BY <EVALAE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN
.CENTER
  <CALL ^^GETVAL(SYMTAB,SYM,VAL[,ERR])\\
.CENTER
 OR
.CENTER
 ^^ERR=GETVAL(SYMAB,SYM,VAL [,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^SYMTAB---A\\N <INTEGER ARRAY FOR THE SYMBOL TABLE--SEE <PARSAE.
.SKIP;.INDENT -9
^^SYM------A\\N 8 BYTE <ASCII STRING.
<GETVAL SEARCHES <SYMTAB FOR <SYM AND RETURNS THE VALUE OF <SYM IN 
<VAL.  ^THIS SYMBOL MUST BE LEFT JUSTIFIED AND SPACE FILLED TO 8 BYTES.
.SKIP;.INDENT -9
^^VAL------A\\ FLOATING POINT (<REAL*4) NUMBER TO RECIEVE THE CURRENT 
VALUE OF <SYM.
.INDENT -9
.SKIP
^^ERR------ERR=\\ -1 IF SUCCESSFUL.  <ERR= 0 IF NO SUCH SYMBOL.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:  CALL GETVAL(SYMTAB,'TITER...',TITER)
.SKIP 1;\\
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <GETVAL
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS.OLB
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^LINDA ^MUNDY OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE <MATHER- <MATHER
.PAGE
.INDENT 50
<MATHER
.SKIP 1
.CENTER
<MATHER- <MATHER
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <MATHER\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^A NAMED COMMON TO CONTROL THE ERROR PRINTING OPTION IN THE
^ARITHMETIC PACKAGE. 
 ^THE FLAGS IN THIS COMMON DETERMINE WHAT IS DONE WITH
DIVISION BY ZERO, LOG OF NON POSITIVE NUMBER, OR THE SQUARE ROOT OF A 
NEGATIVE NUMBER.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN-- DECLARE THE NAMED COMMON TO GAIN ACCESS TO THESE VALUES AND FLAGS.
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^MATHER---T\\HE NAMED COMMON BLOCK CONTAINING 4 <INTEGER*2 VARIABLES.
.SKIP;.INDENT -9
^^WORD 0---T\\HIS WORD IF EQUAL TO ONE, TURNS OFF THE JOBLOG ERROR MESSAGES.
^IF EQUAL TO 0 THEN ERROR MESSAGES ARE PRINTED.  (SEE <BATDEF FOR DESCRIPTION
OF <JOBLOG)
.SKIP;.INDENT -9
^^WORD 1---A\\N ACCUMULATOR NUMBER OF DIVIDE BY ZERO ERRORS.
.SKIP;.INDENT -9
^^WORD 2---A\\CCUMULATOR FOR NUMBER OF LOG OF NON-POSITIVE NUMBERS.
.SKIP;.INDENT -9
^^WORD 3---A\\CCUMULATOR FOR NUMBER OF SQUARE ROOT BY NEGATIVE NUMBERS.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^USES <JOBLOG <LUN DEFINED IN <BATDEF
P
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ <COMMON/MATHER/PRIN,DIVID,NLOG,NSQRT
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS.OLB
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^LINDA ^MUNDY OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.SD;.FLAGS CAPITALIZE
.TITLE ^^PARSAE- ^ARITHMETIC EXPRESSION PARSER
.PAGE
.INDENT 50
^^PARSAE
.SKIP 1
.CENTER
^^PARSAE- ^ARITHMETIC EXPRESSION PARSER
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: ^^PARSAE\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO PARSE A GENERALIZED ARITHMETIC EXPRESSION INTO
A REVERSE POLISH TABLE THAT CAN BE EVALUATED BY THE
^^EVALAE\\ SUBROUTINE.  ^IT ALSO PRODUCES A SYMBOL 
TABLE THAT CAN BE ACCESSED BY THE ^^SETVAL\\ AND ^^GETVAL\\ SUBROUTINES.
^^NOTE:\\ ^^EVALAE\\ IS A REAL FUNCTION ONLY, AND YOU MUST DECLARE IT SPECIFICALLY REAL IF YOUR PROGRAMS USE IMPLICIT
INTEGER.  ^ALL VALUES IN AN EQUATION ARE TREATED AS REAL ALSO.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN
.CENTER
   ^^CALL PARSAE (STRING,LEN,RPNTAB,SYMTAB)[,<ERR])
.CENTER
^^OR\\
  ^^ ERR=PARSAE(STRING,LEN,RPNTAB,SYMTAB)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^STRING---T\\HE ARITHMETIC EXPRESSION CONTAINING SYMBOLS AND
CONSTANTS COMBINED WITH THE FOLLOWING LEGAL OPERATIONS:
.SK;.INDENT 15
^^&BINARY FUNCTIONS&\\
.SK;.INDENT 15
.INDENT 15
*    MULTIPLICATION
.INDENT 15
/    DIVISION
.INDENT 15
-    SUBTRACTION
.INDENT 15
+    ADDITION
.INDENT 15
**   EXPONENTIATION
.SKIP
.INDENT 15
^^&RELATIONAL FUNCTIONS&\\
.INDENT 15
|	VERTICAL BAR - "^^OR"\\
.INDENT 15
_&	LOGICAL ^^"AND"\\
.INDENT 15
_\	"OR" (EQUIVALENT TO |)
.INDENT 15
_>=	greater than or equal to
.INDENT 15
_<_>	Not equal to
.INDENT 15
_<=	less than or equal to
.INDENT 15
_>	greater than
.INDENT 15
_<	less than
.INDENT 15
==	is equal to
.INDENT 15
=	arithmatic replacement
.INDENT 15
.skip
.INDENT 15
^^UNARY FUNCTIONS\\
.INDENT 15
^^SQRT\\(x)	square root of x
.INDENT 15
^^LN\\(x)	natural log of x
.INDENT 15
^^EXP\\(x)	e to the x
.INDENT 15
^^NOT\\(x)	the complement of x
.INDENT 15
^^ABS\\(x)	the magnitude of x
.INDENT 15
^^CONF\\05(N) 95% CONFIDENCE INTERVAL
.INDENT 15
^^CONF\\0l(N) 99% CONFIDENCE INTERVAL
.SKIP 1
.INDENT 5
.SKIP
^FULLY PARENTHESIZED EXPRESSIONS ARE SUPPORTED
.SKIP
^^BUILT IN CONSTANTS\\
.INDENT 15
^^PIE\\------3.1415927
.INDENT 15
<E  ---------2.7182818
.INDENT 15
^^TRUE\\ ----1.0
.INDENT 15
^^FALSE\\-----0.0
.SKIP 1
(ALSO SEE <CALC DOCUMENTATION)
.SKIP 1
^^STRING\\ MUST BE DIMENSIONED TO THE EXPECTED LENGTH PLUS ONE.
.SK;.INDENT -10
^^LEN\\-------^THE LENGTH IN BYTES OF ^^STRING\\ DEFAULT IS 32.  ^SET ^^SETMAX\\ 
TO CHANGE DEFAULT.
.SK;.INDENT -10
^^RPNTAB\\----^REVERSE POLISH TABLE.  ^AN ARRAY FOR STORING AN
EXPRESSION.  ^THIS SHOULD BE DIMENSIONAL 2 WORDS ACROSS AND N 
WORDS DOWN WHERE N IS THE NUMBER OF EXPECTED OPERANDS PER
EXPRESSION.
.SK;.INDENT -10
<SYMTAB----^SYMBOL TABLE ARRAY.  ^THIS SHOULD BE DIMENSIONED
TO (12*^M)+1 WORDS, WHERE ^M IS THE EXPECTED NUMBER OF SYMBOLS.
^ALL SYMBOL NAMES ARE STORED AS LEFT JUSTIFIED, SPACE FILLED 8 BYTE FIELDS,
AND ALL VALUES ARE REAL*4. ^SYMBOL NAMES IN AN EXPRESSION MUST START WITH AN
ALPHA (WHICH INCLUDES $ AND _%) BUT CAN HAVE ALPHA AND NUMERIC CHARACTERS IN
THE REMAINING 7 POSITIONS.
.SK;.INDENT -10
^^ERR\\------^^ERR\\=0  <PARSAE FAILED
^^ERR.NE.0\\  <PARSAE WAS SUCCESSFUL.
.PAGE
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^ARTDEF\\ <FINP
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP
.I -10
^^CALL PARSAE('X=LN(20)*TITER/2**5',19,RPNTAB,SYMTAB)\\
.INDENT -10
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^mike ^higgins
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^august 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^MACRO\-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^PARSAE\\
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ ^a ^while ^ago
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ see ^mike ^higgins
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE <SETVAL - <SETVAL
.PAGE
.INDENT 50
<SETVAL
.SKIP 1
.CENTER
<SETVAL - <SETVAL
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETVAL\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO INSERT A VALUE INTO THE SYMBOL TABLE FOR THE GIVEN <ASCII SYMBOL.
<NOTE:  YOUR SYMBOL TABLE AND SYMBOL ARRAY MUST BEGIN ON AN EVEN ADDRESS,
OTHERWISE YOU WILL GET ODD ADDRESS TRAPS.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN:
.SKIP;.CENTER
 <CALL ^^SETVAL(SYMTAB,SYMB,VAL[,ERR])\\
.CENTER
 OR
.CENTER
 ^^ERR=SETVAL^^(SYMTAB,SYM,VAL)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^SYMTAB---T\\HIS (AN INTEGER ARRAY) IS WHERE YOUR SYMBOL TABLE SHOULD
BE -- SEE <PARSAE.  ^THE SYMBOL TABLE MUST BE INITIALIZED BEFOREHAND BY AT LEAST ONE CALL TO
<PARSAE.
.SKIP;.INDENT -9
^^SYM------A\\N <ASCII STRING THAT SHOULD BE DEFINED IN <SYMTAB.  <SETVAL
SEARCHES <SYMTAB FOR <SYM AND PUTS <VAL INTO THE SYMBOL TABLE AT <SYM
(I.E., <SYM TAKES ON <VAL)
.SKIP;.INDENT -9
^^VAL\\------^A FLOATING POINT (REAL*4)\\ NUMBER TO REPLACE THE PREVIOUS
VALUE OF <SYM.
.SKIP;.INDENT -9
^^ERR------ERR = -1\\ IF SUCCESSFUL.  <ERR = 0 IF NOT SUCCESSFUL.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SETVAL
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS.OLB
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^LINDA ^MUNDY OR ^MIKE ^HIGGINS
.PAGE
.INDENT -10
.FLAGS CAPITALIZE
.paper size 58,70
.left margin 10
.right margin 70
.title ^^DATABASE SUBROUTINE CALLING CONVENTIONS\\
.CENTER
^^BIO-DATA BASE SUBROUTINES\\
.skip
.indent -5
^^BLDHDR (root,nlv,levtab[,datype])\\
.BREAK
^Initializes the root block for a new file.
.skip
.indent -5
^^OPENBF err=openbf(root,name,lun,access[,err])\\
.BREAK
^Opens a data base file.
.skip
.indent -5
^^WRTKEY err=wrtkey(root[,key][,val][,mode][,err])\\
.BREAK
^Writes a unique key.
.skip
.indent -5
^^WRTELE err=wrtele(root[,key][,val][,nul][,err])\\
.BREAK
^Writes an element (no check for duplicates.)
.skip
.indent -5
^^FNDKEY err=fndkey(root[,patt][,key][,val][,err])\\
.BREAK
^Finds the next key that matches your pattern.
.skip
.indent -5
^^MATCHK err=matchk(root[,patt][,key][,val][,err])\\
.BREAK
^Finds the next key that matches your pattern.
.skip
.indent -5
^^GETKEY err=getkey(root[,nul][,key][,val][,err])\\
.BREAK
^Returns the currently active key.
.skip
.indent -5
^^MODKEY err=modkey(root[,nul][,key][,val][,err])\\
.BREAK
^Modifies a database key.
.skip
.indent -5
^^DELKEY err=delkey(root[,err])\\
.BREAK
^Deletes current key and all itS offspring.
.skip
.indent -5
^^FILEID (root,nlv[,levtab][,datype][,verson])\\
.BREAK
^Inverse of BLDHDR, returns info from root block.
.skip
.indent -5
^^LEVELD (root[,levno][,scansz][,datasz][,datype])\\
.BREAK
^Returns info about current level.
.skip
.indent -5
^^KEYAGE err=(root,age[,err])\\
.BREAK
^Returns age of currently active key.
.skip
.indent -5
^^RESETB (root)\\
.BREAK
^Resets search to first sibling in active branch of tree.
.skip
.indent -5
^^PUSHLV err=pushlv(root[,err])\\
.BREAK
^Pushes down to next level of tree.
.skip
.indent -5
^^BACKUP err=backup(root[,err])\\
.BREAK
^Backs up to the previous level of the tree.
.skip
.indent -5
^^SYNCBF (root)\\
.BREAK
^Forces the disk file to match the core image.
.skip
.indent -5
^^CLOSBF (root)\\
.BREAK
^Syncs and closes the DATABASE file.
.page
.CENTER
^^PARAMETER SUMMARY\\
.skip
.indent -5
^^ROOT\\
.BREAK
^A scratch area for the routines to store all core resident file blocks.
.skip
.indent -5
^^NRLEVS\\
.BREAK
^The number of levels in the tree structure.
.skip
.indent -5
<LEVTAB
.BREAK
^A table describing the levels in the tree.
.skip
.indent -5
^^DATYPE\\
.BREAK
^A word describing the type of file.
.skip
.indent -5
^^NAME\\
.BREAK
^The name of the file.
.skip
.indent -5
^^LUN\\
.BREAK
^Logical unit number to open DATABASE file under.
.skip
.indent -5
^^ACCESS\\
.BREAK
^The mode that the file will be opened under.
.BREAK
0=Shared.
.BREAK
1=Read only.
.BREAK
2=Read write.
.BREAK
3=read, write, and create.
.BREAK
4=Force new file.
.skip
.indent -5
^^ERR\\
.BREAK
^The return status of many DATABASE routines.  ^In general, positive
means success, zero or negative means failure.
.skip
.indent -5
^^KEY\\
.BREAK
^The "scan" section of a node in the tree.
.skip
.indent -5
^^VALS\\
.BREAK
^The "data" Section of a node in the tree.
.skip
.indent -5
^^MODE\\
.BREAK
^The mode that is to be used when writing a key.
.BREAK
0=Error if key is a duplicate.
.BREAK
1=Delete old data under a duplicate key.
.BREAK
2=Open a duplicate key for appending more data.
.BREAK
3=Modify KEY if it is not unique and try it again.
.skip
.indent -5
^^NUL\\
.BREAK
^A null parameter present only for compatability with similar DATABASE routines.
.skip
.indent -5
^^PATT\\
.BREAK
^A search pattern for finding keys.
.skip
.indent -5
^^VERSON\\
.BREAK
^The structure version number of the file. (^Only of intrest if the internal
structure of a DATABASE file is ever changed).
.skip
.indent -5
^^LEVNO\\
.BREAK
^The currently active level of the tree.
.skip
.indent -5
^^SCANSZ\\
.BREAK
^The size of the "scan" area of a key at the current level.
.skip
.indent -5
^^DATASZ\\
.BREAK
^The size (in bytes) of the "data" section of a key at the current level.
.skip
.INDENT -5
^^AGE\\
.BREAK
^The age of the currently active key.
.PAGE;.TITLE ^^BLDHDR - INITIALIZING A NEW DATABASE FILE ROOT BLOCK\\
.PAGE
.INDENT 50
<BLDHDR
.SKIP 1
.CENTER
^^BLDHDR - INITIALIZING A NEW DATABASE FILE ROOT BLOCK\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: BLDHDR\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <BLDHDR IS CALLED BEFORE <OPENBF TO INITIALIZE A NEW ROOT BLOCK WHEN
THE FILE BEING OPENED MAY BE A NEW ONE.  <BLDHDR MUST BE CALLED BEFORE
USING <MODE=4 TO <OPENBF, AND PROBABLY SHOULD BE CALLED BEFORE USING
<MODE=3 TO <OPENBF.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL BLDHDR(ROOT,NRLEVS,LEVTAB[,DATYPE])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.INDENT -5
<ROOT = ^THE IN CORE DATABASE BUFFER FOR THE FILE.
.INDENT -7
<NRLEVS = ^THE NUMBER OF  LEVELS IN THE DATABASE FILE STRUCTURE
.BREAK
.INDENT -7
<LEVTAB = ^A TABLE DESCRIBING EVERY LEVEL OF THE NEW FILES TREE STRUCTURE.
<LEVTAB MUST BE
DIMENTIONED TO 3 BY <NRLEVS WORDS.  ^THE MEANINGS OF THE THREE WORDS FOR
EACH LEVEL ARE:
.INDENT -4
<LEVTAB(1,I) = ^THE TOTAL NUMBER OF BYTES IN A KEY AT LEVEL ^I.
^THE TOTAL SIZE MUST TAKE
INTO ACCOUNT THE NUMBER OF BYTES IN THE SCAN AREA OF A KEY,
IN THE DATA SECTION, PLUS FOUR BYTES IN ALL LEVELS EXCEPT THE BOTTOM LEVEL.
.INDENT -4
<LEVTAB(2,I) = ^THE NUMBER OF BYTES IN THE SCAN SECTION OF A KEY AT LEVEL ^I.
.INDENT -4
<LEVTAB(3,I) = ^THE TYPE OF DATA STORED IN THE DATA SECTION, WHERE
1 MEANS INTEGERS, 2 MEANS REALS, 4 MEANS <ASCII.  ^THE DATA TYPES CAN BE
^O^RED TOGETHER FOR COMBINATIONS.
.INDENT -7
<DATYPE = ^A ONE WORD DATA TYPE FOR IDENTIFYING THE TYPE OF STRUCTURE.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ ^^CALL BLDHDR(ROOT,3,LEVTAB,'TR')\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <BLDHDR
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <OPENBF- ^^OPEN A DATABASE FILE\\
.PAGE
.INDENT 50
<OPENB
.SKIP 1
.CENTER
<OPENBF- ^^OPEN A DATABASE FILE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <OPENBF\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO OPEN AN EXISTING DATABASE FILE, OR TO CREATE A NEW FILE INITALIZED
BY <BLDHDR.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^BY <FORTRAN ONLY:
.BREAK
^^CALL OPENBF(ROOT,NAME,LUN,MODE[,ERR])\\
.CENTER
OR
^^ERR=OPENBF(ROOT,NAME,LUN,MODE[,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.BREAK
.INDENT -5
<ROOT ^THE CORE BUFFER FOR STORING THE ROOT BLOCK AND ALL <I/O BUFFERS
FOR EACH LEVEL.  <ROOT MUST BE DIMENSIONED TO 512*<NRLEVS+512 BYTES, WHERE
<NRLEVS IS THE NUMBER OF LEVELS IN THE FILES STRUCTURE.
.INDENT -5
<NAME ^A STRING CONTAINING THE FILE SPECIFIER FOR THE DATABASE FILE YOU
WISH TO OPEN.  ^NAME MUST BE TERMINATED WITH A <NUL.
^THE DEFAULT DEVICE IS <BD:, THE DEFAULT FILE TYPE IS <'.BDB'., AND
THE DEFAULT <UIC IS THE UIC THAT THE PROGRAM IS RUNNING UNDER.
.INDENT -4
<LUN ^THE <FORTRAN ^LOGICAL ^UNIT ^NUMBER THAT YOU WISH TO OPEN THE
FILE UNDER
.INDENT -5
<MODE ^THE MODE THAT THE FILE IS TO BE OPENED UNDER:
.INDENT -2
<MODE=0 ^MEANS SHARED <LUN.  ^THE SAME FILE CAN BE OPENED UNDER MORE THAN
ONE IN CORE <ROOT BUFFER WITH THE SAME LUN.  ^THIS ALLOWS YOU TO DO TWO
SETS OF FILE MANIPULATIONS ON THE SAME DATABASE FILE.  ^IN OTHER WORDS,
KEEP TWO (OR MORE) POINTERS INTO THE FILE AT THE EXPENSE OF TWO OR MORE
CORE <ROOT BUFFERS.
.INDENT -2
<MODE=1 ^MEANS READ ONLY.
.INDENT -2
<MODE=2 ^READ AND WRITE.
.INDENT -2
<MODE=3 ^READ, WRITE AND CREATE (MUST HAVE CALLED <BLDHDR)
.INDENT -2
<MODE=4 ^FORCES CREATION OF NEW FILE (MUST HAVE CALLED <BLDHDR).
.SKIP
.INDENT -4
<ERR ^ERROR RETURN VALUE.  ^RETURNS -100 FOR MISSING <BLDHDR CALL OR
CORRUPTED DATABASE FILE, 0 MEANS SUCCESS, ALL OTHER NEGATIVE ERROR
RETURNS ARE <FCS ERROR CODES.  ^SEE THE <RSX11M ^POCKET ^REFERENCE FOR
A COMPLETE LIST OF <FCS <I/O ERROR CODES.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <$FCHNL, <OPEN$ MACRO
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL OPENBF(ROOT,'DP:[60,200]DICT',8,1)
.SKIP
INTEGER OPENBF
.BREAK
IF (OPENBF(DBUF,STRING,DLUN,8,2)
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^PETE ^LINHARD, WITH MODS BY ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <OPENBF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <WRTKEY - ^^WRITES A UNIQUE DATABASE KEY\\
.PAGE
.INDENT 50
<WRTKEY
.SKIP 1
.CENTER
<WRTKEY - ^^WRITES A UNIQUE DATABASE KEY\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <WRTKEY\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS PROCEDURE WRITES A UNIQUE KEY IN A DATABASE FILE AT THE CURRENTLY
ACTIVE LEVEL.  ^SEVERAL ACTIONS CAN BE SELECTED FOR A NON-UNIQUE KEY (SEE
THE <MODE PARAMETER).
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN
.BREAK
^^CALL WRTKEY(ROOT,KEY[,DATA][,MODE][,ERR])
.INDENT 20
\\OR^^
.BREAK
ERR=WRTKEY(ROOT,KEY[,DATA][,MODE][,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS
.INDENT -4
<KEY ^A STRING TO USE FOR THE SCAN SECTION OF THE NEW KEY.  ^THIS NEW
KEY CAN HAVE WILD CARD CHARACTERS (_\) IN IT, BUT THE RESULT DEPEND ON THE
<MODE OF THE WRITE.  ^IF YOU ATTEMPT TO WRITE BACKSLASHES INTO A NEW KEY,
THEY WILL BE TURNED INTO BLANKS.
^THE KEY IS ASSUMED TO BE THE SAME LENGTH AS THE SCAN SIZE FOR KEYS AT
THIS LEVEL, IF THE KEY IS TERMINATED PREMATURELY BY A <NUL, IT IS ASSUMMED
TO BE PADDED WITH BACKSLASHES.
.INDENT -5
<VALS ^THE DATA SECTION OF THE NEW KEY. ^IF THE <VALS SECTION OF A NEW KEY
IS OMITTED, THE KEY WILL BE CREATED WITH UNPREDICTABLE DATA IN THE
DATA SECTION.
.INDENT -5
<MODE ^THE ACTION TO TAKE WHEN THE KEY IS NOT UNIQUE.  ^THE DIFFERENT MODES
SUPPORTED ARE:
.BREAK
<MODE=0 ^ERROR RETURN IF KEY IS NOT UNIQUE.
.BREAK
<MODE=1 ^DELETE OLD DATA UNDER EXISTING KEY AND RETURN SUCCESS.
.BREAK
<MODE=2 "<FNDKEY" MODE.  ^THE ALREADY EXISTING KEY IS ACTIVATED AS IF IT
WAS FOUND BY <FNDKEY.
.BREAK
<MODE=3 ^MODIFY KEY PARAMETER IF IT IS NOT UNIQUE.  ^THE KEY IS MODIFIED
BY DOING A SUCCESSOR FUCTION ON THE FIRST FEW BYTES OF THE KEY.
.INDENT -4
<ERR ^ERROR RETURN PARAMETER.  ^POSSIBLE ERRORS ARE:
.BREAK
<ERR=-100 ^BAD <ROOT BLOCK.
.BREAK
<ERR=#-99 ^YOU DO NOT HAVE WRITE ACCESS.
.BREAK
<ERR=###0 ^KEY WAS NOT UNIQUE (<MODE=0).
.BREAK
<ERR=##+N ^SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$ACTIVATE <B$ALOCATE <B$DELETEDATA <B$GETNEXT <B$IOERROR,
<READVB AND <WRITEVB MACROS.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL WRTKEY(ROOT,'NEW KEY',,0,ERR)
CALL WRTKEY(ROOT,KEY,DATA,,2)
IF (WRTKEY(ROOT,KEY,DATA) .LE. 0) GOTO 999
\\
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <WRTKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <WRTELE- ^^WRITES A NON-UNIQUE KEY\\
.PAGE
.INDENT 50
<WRTELE
.SKIP 1
.CENTER
<WRTELE- ^^WRITES A NON-UNIQUE KEY\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <WRTELE\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^WRITES A KEY IN A DATABASE FILE WITHOUT CHECKING TO ASSURE THAT THE KEY IS
UNIQUE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTAN ONLY:
.BREAK
^^CALL WRTELE(ROOT[,KEY][,VAL][,NUL][,ERR])
.INDENT 20
\\OR^^
.BREAK
ERR=WRTELE(ROOT[,KEY][,VAL])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<KEY ^THE SCAN SECTION OF THE KEY TO BE WRITTEN.
.INDENT -4
<VAL ^THE DATA SECTION OF THE KEY.
.INDENT -4
<NUL ^AN IGNORED PARAMETER THAT MAKES <WRTELE CALLS COMPATIBLE WITH <WRTKEY CALLS.
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER. ^POSSIBLE ERRORS ARE:
.BREAK
<ERR=-100 ^BAD ROOT BLOCK.
.BREAK
<ERR=#-99 ^WRITE PERMISSION DENIED.
.BREAK
<ERR=###0 ^COULD NOT WRITE AT THIS LEVEL.
.BREAK
<ERR=##+N ^SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$ACTIVATE <B$ALOCATE <B$GETNEXT
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL WRTELE(ROOT,'TI')
ERR=WRTELE(ROOT,,VAL)
IF (WRTELE(ROOT,KEY,,,ERR) .LE. 0) GOTO 999
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <WRTELE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <MODKEY - ^^MODIFIES THE CURRENTLY ACTIVE KEY\\
.PAGE
.INDENT 50
<MODKEY
.SKIP 1
.CENTER
<MODKEY - ^^MODIFIES THE CURRENTLY ACTIVE KEY\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <MODKEY\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <MODKEY ALLOWS YOU TO MODIFY THE CURRENTLY ACTIVE KEY IN PLACE WITHOUT HAVING
TO DELETE IT AND REWRITE IT.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL MODKEY(ROOT[,KEY][,VAL][,NUL][ERR])
.INDENT 15
\\OR^^
.BREAK
ERR=MODKEY(ROOT[,KEY][,VAL])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS
.INDENT -4
<KEY ^THE PATTERN FOR REPLACING THE SCAN SECTION OF THE CURRENT KEY.  ^IF THIS
PATTERN IS PREMATURELY TERMINATED WITH A <NUL, THEN THE REST OF THE CURRENT
KEY IS LEFT UNCHANGED.  ^IF THIS PATTERN CONTAINS BACKSLASHES (_\), THEN JUST
THE CHARACTERS CORRESPONDING TO THE BACKSLASHES IN THE CURRENT KEY ARE LEFT
UNCHANGED, AND ALL OTHER CHARACTERS ARE REPLACED.
.INDENT -4
<VAL ^THE NEW DATA SECTION OF THE KEY.  ^IF THIS PARAMETER IS PRESENT, ALL OF
THE BYTES ARE ASSUMED TO BE PRESENT AND ARE REPLACED IN THE KEY.  ^IF THIS
PARAMETER IS MISSING OR NULL, THE DATA SECTION FOR THE CURRENT KEY IS LEFT
UNCHANGED.
.INDENT -4
<NUL ^AN IGNORED PARAMETER INCLUDED TO MAKE <MODKEY CALLS COMPATABLE WITH
<WRTELE AND <WRTKEY CALLS.
.INDENT -4
<ERR ^ERROR RETURN PARAMETER. ^POSSIBLE ERROR VALUES ARE:
.BREAK
<ERR=-100 ^BAD ROOT BLOCK.
.BREAK
<ERR=#-99 ^WRITE PERMISSION DENIED.
.BREAK
<ERR=###0 ^YOU DON'T HAVE A KEY ACTIVE.
.BREAK
<ERR=##+N ^SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL MODKEY(ROOT,'_\_\_\_\_\2_\_\',,,ERR)
ERR=MODKEY(ROOT,,NEWDAT)
IF(MODKEY(ROOT,PATT,NEWDAT) .LE. 0) GOTO 999\\
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <MODKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <DELKEY - ^^DELETES A DATABASE KEY AND ALL ITS OFFSPRING\\
.INDENT 50
<DELKEY
.SKIP 1
.CENTER
<DELKEY - ^^DELETES A DATABASE KEY AND ALL ITS OFFSPRING\\
.SKIP
.LEFT MARGIN 10
.INDENT -10
^^PURPOSE:\\ ^TO DELETE THE CURRENTLY ACTIVE  DATABASE KEY AND ALL OF
IT'S OFFSPRING.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY.
.BREAK
^^CALL DELKEY(ROOT[,ERR])
.INDENT 10
\\OR^^
.BREAK
ERR=DELKEY(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<ERR ^THE ERROR STATUS RETURN.  ^POSSIBLE ERROR RETURNS ARE:
.BREAK
<ERR=-100 ^MEANS BAD ROOT BLOCK.
.BREAK
<ERR=###0 ^MEANS CANNOT PERFORM DELETE.
.BREAK
<ERR=##-1 ^SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$DELETEDAT
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL DELETE(ROOT)
.BREAK
IF (DELETE(ROOT) .NE. -1) GOTO 999
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <DELKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <FNDKEY - ^^DATABASE SEARCH ROUTINE\\
.PAGE
.INDENT 50
<FNDKEY
.SKIP 1
.CENTER
<FNDKEY - ^^DATABASE SEARCH ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: FNDKEY\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <FNDKEY FINDS THE NEXT DATABASE KEY THAT MATCHES YOUR PATTERN AND OPENS IT
FOR READING, WRITING, OR MODIFYING.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN OR <MACRO
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ ^FROM <FORTRAN:
.BREAK
^^CALL FNDKEY(ROOT[,PATT][,KEY][,VAL][,ERR])
.INDENT 24
\\OR^^
.BREAK
ERR=FNDKEY(ROOT[,PATT][,KEY][,VAL][,ERR])\\
.SKIP
.INDENT -5
<ROOT ^THE DATA BUFFER INITIALIZED BY <BLDHDR OR <OPENBF THAT IS USED BY ALL
DATABASE ROUTINES TO STORE TEMPORARY VARIABLES AND <I/O BUFFERS IN.
.INDENT -5
<PATT ^A SIMPLE PATTERN TO SEARCH FOR IN THE DATABASE.  ^THIS "PATTERN" IS A
STRING OF CHARACTERS WITH BACKSLASH (_\) CHARACTERS AS "WILD CARD" CHARACTERS.
^THE PATTERN IS ASSUMED TO BE THE SAME LENGTH AS THE SCAN SECTION OF THE KEYS
BEING SEARCHED FOR, BUT IF IT IS PREMATURELY TERMINATED BY A <NUL, THE REMAINING
CHARACTERS OF THE PATTERN ARE ASSUMED TO BE BACKSLASHES.
.INDENT -4
<KEY ^A BUFFER FOR <FNDKEY TO RETURN THE ACTUAL STRING THAT YOUR PATTERN MATCHED.
^THIS BUFFER <MUST BE LARGE ENOUGH FOR THE WHOLE SCAN SECTION OF A KEY TO FIT INTO,
OR YOU WILL GET VERY STRANGE RESULTS FROM YOUR FORTRAN PROGRAMS.
.INDENT -4
<VAL ^A BUFFER FOR STORING THE DATA SECTION OF A KEY IN.  ^AGAIN, THIS BUFFER
<MUST BE LARGE ENOUGH TO HOLD THE COMPLETE DATA SECTION OF A KEY.
.INDENT -4
<ERR ^A WORD THAT THE STATUS OF THE SEARCH IS RETURNED IN. ^POSSIBLE
ERROR VALUES ARE:
.BREAK
<ERR= ##+N MEANS SUCCESSFULL RETURN.
.BREAK
<ERR= ###0 MEANS THERE WERE NO KEYS THAT MATCHED.
.BREAK
<ERR= ##-1 MEANS THERE ARE NO MORE KEYS THAT MATCH.
.BREAK
<ERR= -100 MEANS YOU CALLED <FNDKEY WITH A BAD <ROOT PARAMETER.
.SKIP 1
.INDENT -10
<PARAMETERS: ^FROM A <MACRO PROGRAM:
.BREAK
.INDENT -3
<R5 ^POINTS TO A <FORTRAN LIKE PARAMETER LIST, ESSENTIALLY THE SAME AS
<FORTRAN WOULD HAVE PRODUCED.
.INDENT -3
<R4 ^POINTS TO THE <ROOT BUFFER.  ^THE <FORTRAN PARAMETER LIST MUST HAVE
ALL THE PARAMETERS, INCLUDING A SLOT FOR THE ROOT BUFFER, BUT IT NEED
NOT ALSO HAVE THE <ROOT POINTER.
.INDENT -3
<R0 ^THE ERROR RETURN IS ALSO RETURNED HERE.
.INDENT -5
<B$READKEY ^IS THE ENTRYPOINT FOR THE <MACRO SECTION OF <FNDKEY.  ^YOU CAN
CALL VIA THE <FNDKEY ENTRYPOINT, AND THE ROUTINE WILL INITIALIZE <R4 FOR YOU.
^THIS IS RARELY DONE BECAUSE CODE FOR CHECKING THE ROOT BLOCK IS ALSO EXECUTED
IN THIS ENTRYPOINT.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^B$ACTIVATE B$GETNEXT B$GETKEY $CMPS\\
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
.NOFILL
^^CALL FNDKEY(ROOT,'TI',,,ERR)
IF (FNDKEY(ROOT,PATTRN) .LE. 0) GOTO 999
CALL FNDKEY(ROOT,,KEY,,ERR)
.INDENT 20
\\FROM ^^MACRO:
.LEFT MARGIN 0
	.PSECT DATA
PLIST:	.WORD	4	;4 ARGUMENTS
	.WORD	ROOT	;POINTER TO ROOT BLOCK
	.WORD	-1	;NUL PATT PARAMETER
	.WORD	KEY	;BUFFER FOR KEY
	.WORD	VAL	;BUFFER FOR DATA
KEY:	.BLKB	56
VAL:	.BLKB	14
	.PSECT
	MOV	#PLIST,R5	;INITIALIZE THE ARG LIST
I	MOV	#ROOT,R4	;INITIALIZE THE ROOT POINTER
	JSR	PC,B$READKEY	;CALL FNDKEY
	TST	R0		;CHECK ERR RETURN
	BLE	ERROR		;ERR WAS <= 0
.LEFT MARGIN 10
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <FNDKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <MATCHK- ^^DATABASE FILE SEARCH ROUTINE\\
.PAGE
.INDENT 50
<MATCHK
.SKIP 1
.CENTER
<MATCHK- ^^DATABASE FILE SEARCH ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <MATCHK
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <MATCHK SEARCHES DATABASE STRUCTURES EXACTLY THE SAME WAY THAT <FNDKEY
DOES ACCEPT A MORE COMPLEX "STRING PATTERN RECOGNITION" IS DONE TO FIND
THE KEY THAT MATCHES.  ^NOT ONLY CAN THE PATTERN CONTAIN WILDCARDS IN THE
FORM OF BACKSLASHES (_\), BUT THE FOLLOWING CONSTRUCTS ARE ALSO RECOGNIZED:
.INDENT -2
* ^THE ASTERISK MATCHES ANY SUB-STRING, INCLUDING THE NULL SUBSTRING.
.INDENT -3
-C (^WHERE C REPRESENTS ANY CHARACTER) ^MATCHES ANY CHARACTER THAT IS NOT
EQUAL TO C.
.INDENT -6
[SET] (^WHERE SET REPRESENTS ANY SET OF CHARACTERS) ^MATCHES ANY ONE OF
THE CHARACTERS IN THE SET.
.INDENT -7
-[SET] ^MATCHES ANY CHARACTER NOT IN THE SET. ^EXAMPLE: -[AEIOUY] WILL MATCH
ANY CONSONANT.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL MATCHK(ROOT,PATT[,KEY][,VAL][,ERR])
.INDENT 20
\\OR^^
.BREAK
ERR=MATCHK(ROOT,PATT[,KEY][,VAL])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -5
<PATT ^THE PATTERN TO SEARCH FOR.  ^THIS PATTERN <MUST BE TERMINATED WITH A
<NUL BYTE OR YOUR PROGRAM WILL BLOW UP.
.INDENT -4
<KEY ^A BUFFER TO STORE THE ACTUAL STRING MATCHED TO.
.INDENT -4
<VAL ^A BUFFER TO CONTAIN THE DATA SECTION OF THE KEY FOUND
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER, WHERE THE POSSIBLE ERRORS ARE:
.BREAK
<ERR= ##+N MEANS SUCCESSFUL RETURN.
.BREAK
<ERR= ###0 MEANS NO KEYS MATCHED YOUR PATTERN.
.BREAK
<ERR= ##-1 MEANS NO MORE KEYS MATCH YOUR PATTERN.
.BREAK
<ERR= -100 MEANS YOU SENT ME A BAD ROOT BLOCK.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^B$ACTIVATE B$GETKEY B$GETNEXT $MATCH
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL MATCHK(ROOT,'*MUTAGENISIS*',KEY,ERR)
IF (MATCHK(ROOT,PATTRN,KEY) .LE. 0) GOTO 999\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <MATCHK
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <GETKEY- ^^RETURNS THE SCAN AND DATA SECTIONS OF A KEY\\
.INDENT 50
<GETKEY
.SKIP 1
.CENTER
<GETKEY- ^^RETURNS THE SCAN AND DATA SECTIONS OF A KEY\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <GETKEY\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <GETKEY RETURNS THE SCAN AND/OR THE DATA SECTION OF THE
CURRENTLY ACTIVE KEY.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN OR <MACRO
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ ^FROM <FORTRAN:
.BREAK
^^CALL GETKEY(ROOT[,NULL][,KEY][,VAL][,ERR])
.INDENT 20
\\OR^^
.BREAK
ERR=GETKEY(ROOT[,NULL][,KEY][,VAL])\\
.SKIP
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND BUFFERS.
.INDENT -5
<NULL ^A NULL PARAMETER NECESSARY TO MAKE <GETKEY CALLS COMPATABLE
WITH <FNDKEY.
.INDENT -4
<KEY ^A BUFFER TO RETURN THE SCAN SECTION OF THE KEY IN.
.INDENT -4
<VAL ^A BUFFER TO RETURN THE DATA SECTION OF THE KEY.
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER. ^POSSIBLE ERROR VALUES ARE:
.BREAK
<ERR= ##+N MEANS SUCCESSFULL RETURN.
.BREAK
<ERR= ###0 MEANS YOU HAVE NO KEY OPEN TO GET.
.BREAK
<ERR= -100 MEANS YOU SENT ME A BAD <ROOT BUFFER.
.SKIP
^TO CALL FROM <MACRO, USE THE ENTRYPOINT <B^GETKEY AND FOLLOW
THE EXAMPLE GIVEN FOR THE <FNDKEY <MACRO CALL.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL GETKEY(ROOT,,KEY,VALS)
.BREAK
IF (GETKEY(ROOT,,KEY,VALS) .LE. 0) GOTO 999
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <GETKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <PUSHLV- ^^PUSHES TO NEXT LEVEL OF TREE STRUCTURE\\
.PAGE
.INDENT 50
<PUSHLV
.SKIP 1
.CENTER
<PUSHLV- ^^PUSHES TO NEXT LEVEL OF TREE STRUCTURE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <PUSHLV
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO PUSH DOWN TO THE NEXT LEVEL OF THE TREE STRUCTURE IN A
DATABASE FILE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL PUSHLV(ROOT[,ERR])\\
.INDENT 10
OR
.BREAK
^^ERR=PUSHLV(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.INDENT -5
<ROOT ^THE BUFFER CONTAINING THE ROOT BLOCK AND THE <I/O BUFFERS.
^YOU MUST HAVE A KEY ACTIVE AT THE CURRENT LEVEL TO PUSH DOWN
TO THE NEXT.
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER, WHERE:
.BREAK
<ERR= ##-1 (<FORTRAN <.TRUE.) MEANS SUCCESS.
.BREAK
<ERR= ###0 (<.FALSE.) YOU CAN'T PUSH FROM HERE.
.BREAK
<ERR= -100 ^MEANS BAD ROOT BLOCK.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL PUSHLV(ROOT)
.BREAK
IF (.NOT. PUSHLV(ROOT)) GOTO 999
\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <PUSHLV
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.TITLE <BACKUP- ^^BACKS UP TO PREVIOUS LEVEL OF STRUCTURE\\
.PAGE
.INDENT 50
<BACKUP
.SKIP 1
.CENTER
<BACKUP- ^^BACKS UP TO PREVIOUS LEVEL OF STRUCTURE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <BACKUP
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO BACK UP TO THE PREVIOUS LEVEL OF THE TREE STRUCTURE OF A
DATABASE FILE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL BACKUP(ROOT[,ERR])\\
.INDENT 4
OR
.BREAK
^^ERR=BACKUP(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
<ERR ^THE ERROR RETURN STATUS, WHERE:
.INDENT 4;.BREAK
<ERR=###0 MEANS YOU CAN'T BACKUP THAT FAR.
.INDENT 4;.BREAK
<ERR=##-1 MEANS SUCCESSFUL RETURN.
.INDENT 4;.BREAK
<ERR=-100 MEANS BAD ROOT BLOCK.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL BACKUP(ROOT)
.BREAK
IF (BACKUP(ROOT) .EQ. 0) GOTO 999\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO
11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <BACKUP
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <RESETB- ^^RESET DATABASE SEARCHES\\
.PAGE
.INDENT 50
<RESETB
.SKIP 1
.CENTER
<RESETB- ^^RESET DATABASE SEARCHES\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <RESETB
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <RESETB FORCES THE NEXT SEARCH TO RESET TO THE FIRST SIBLING
IN THE CURRENT LEVEL BEFORE STARTING THE SEARCH.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL RESETB(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ <ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ ^^CALL RESETB(ROOT)
.SKIP 1
.INDENT -10
^^FEATURES:\\ ^NO <I/O IS DONE UNTIL THE NEXT SEARCH (<FNDKEY, <MATCHK) IS
REQUESTED, AND EVEN THEN, NO <I/O IS DONE IF THE FIRST BLOCK
OF SIBLINGS IS ALREADY IN CORE.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH  <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <RESETB
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <FILEID - ^^RETURNS INFORMATION ABOUT DATABASE FILE STRUCTURES\\
.SKIP
.INDENT 50
<FILEID
.SKIP 1
.CENTER
<FILEID - ^^RETURNS INFORMATION ABOUT DATABASE FILE STRUCTURES\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <FILEID\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO RETURN ALL THE INFORMATION ABOUT A DATABASE FILE THAT WAS
INITALIZED BY <BLDHDR.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL FILEID(ROOT,NLV[,LEVTAB][,DATYPE][,VERSION])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<NLV ^THE NUMBER OF LEVELS IN THE STRUCTURE.
.INDENT -7
<LEVTAB ^A TABLE WHICH DESCRIBES EACH LEVEL OF THE STRUCTURE.  <LEVTAB
MUST BE DIMENSIONED TO (3,<NLV) OR GREATER.
(^IF YOU DO NOT KNOW HOW BIG <NLV IS BEFOREHAND, YOU HAD BETTER MAKE
EXTRA ROOM).
^THE VALUES RETURNED FOR EACH LEVEL ARE:
.LM 14
<LEVTAB(1,N) ^THE TOTAL SIZE IN BYTES OF A KEY AT THE ^NTH
LEVEL OF THE STRUCTURE.
.BREAK
<LEVTAB(2,N) ^THE SIZE OF THE SCAN
SECTION OF A KEY AT THE ^NTH LEVEL OF THE STRUCTURE.
.BREAK
<LEVTAB(3,N) ^THE TYPE OF DATA STORED IN THE DATA SECTION
IN THE ^NTH LEVEL, WHERE <0=NONE, <1=INTEGER, <2=REAL,
AND <3=ASCII.  ^THESE DATA TYPES MAY BE
^O^RED IN ANY COMBINATION.
.LM 10
.INDENT -7
<DATYPE ^THE DATA TYPE WORD FOR THIS FILE.  ^THE DATA TYPE IS ANY
16-BIT BIT PATTERN WHICH IS USED TO IDENTIFY THE TYPE OF
THE FILE.  ^SOME PROGRAMS, LIKE <FILEDIT WILL PERFORM
DIFFERENTLY FOR DIFFERENT DATA TYPES.  ^MANY PROGRAMS WILL
ONLY WORK WHEN THEY RECOGNIZE THE CORRECT VALUE IN THIS WORD.
.INDENT -8
<VERSION ^THE DATABASE ROUTINES VERSION NUMBER.
^THIS NUMBER CURRENTLY RETURNS AN INTEGER
VALUE OF 3.  IF CHANGES ARE PRIMATIVES STORE DATA,
THIS WORD WILL CHANGE TO INDICATE A "NEW" TYPE OF
DATABASE FILE.

.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL FILEID(ROOT,N)
CALL FILEID(ROOT,N,,TYPE)\\
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <FILEID
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE ^^LEVELD - ^^RETURNS INFORMATION ABOUT THE CURRENTLY ACTIVE LEVEL\\
.INDENT 50
<LEVELD
.SKIP 1
.CENTER
<LEVELD - ^^RETURNS INFORMATION ABOUT THE CURRENTLY ACTIVE LEVEL\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: LEVELD\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO RETURN ALL INFORMATION ABOUT KEYS IN THE CURRENTLY ACTIVE LEVEL OF A
DATABASE FILE.  ^THIS INFORMATION IS INITIALLY SET BY <BLDHDR.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.INDENT -5
^^CALL LEVELD(ROOT[,LEVNO][,SCANSZ][,DATASZ][,DATAYP])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -6
<LEVNO ^THE DEPTH OF THE CURRENTLY ACTIVE LEVEL, WHERE THE FIRST LEVEL IS 1,
AND EVERY <PUSHLV CALL INCREMENTS THE DEPTH BY ONE.
.INDENT -7
<SCANSZ ^THE SIZE IN BYTES OF THE SCAN SECTION OF A KEY AT THIS LEVEL.
.INDENT -7
<DATASZ ^THE SIZE IN BYTES OF THE DATA SECTION OF KEYS AT THIS LEVEL.
.INDENT -7
<DATAYP ^THE TYPE OF DATA STORED IN THIS LEVEL, WHERE <DATAYP=0 MEANS NO DATA,
<1=INTEGER, <2=REAL, <3=ASCII, AND THESE TYPES CAN BE ^O^RED TOGETHER IN ANY
COMBINATION.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL LEVELD(ROOT,LVN,,,TYPE)
CALL LEVELD(ROOT,,SCANSZ,DS)
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <LEVELD
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <KEYAGE - ^^RETURNS THE AGE OF A KEY\\
.PAGE
.INDENT 50
<KEYAGE
.SKIP 1
.CENTER
<KEYAGE - ^^RETURNS THE AGE OF A KEY\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: KEYAGE\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS ROUTINE CALCULATES AND RETURNS THE AGE OF THE CURRENTLY ACTIVE KEY.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL KEYAGE(ROOT,AGE[,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<AGE ^RETURN PARAMETER FOR THE AGE OF THE KEY.
.INDENT -4
<ERR ^ERROR RETURN PARAMETER, WHERE:
.BREAK
<ERR=0 ^MEANS FAILURE (BAD ROOT BLOCK OR NO KEY CURRENTLY ACTIVE).
.BREAK
<ERR=-1 ^MEANS SUCCESSFUL RETURN
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^NONE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^CALL KEYAGE(ROOT,AGE,ERR)
ERR=KEYAGE(ROOT,KEY)\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <KEYAGE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <SYNCBF - ^^UPDATES THE DISK IMAGE OF A DATABASE FILE\\
.INDENT 50
<SYNCBF
.SKIP 1
.CENTER
<SYNCBF - ^^UPDATES THE DISK IMMAGE OF A DATABASE FILE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SYNCBF\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\  ^TO WRITE OUT ALL MODIFIED BLOCKS IN
THE IN-CORE BUFFERS OF A DATABASE FILE.
^THIS ASSURES THAT THE DISK VERSION IS UPDATED TO BE THE SAME
AS THE CORE VERSION.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL SYNCBF(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE IN-CORE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER, WHERE:
.BREAK
<ERR=-100 ^MEANS CORRUPPTED ROOT BLOCK.
.BREAK
<ERR=##+1 ^MEANS SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <READVB AND <WRITEVB MACROS.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL SYNCBF(ROOT)\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SYNCBF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <CLOSBF - ^^CLOSES A DATABASE FILE\\
.PAGE
.INDENT 50
<CLOSBF
.SKIP 1
.CENTER
<CLOSBF - ^^CLOSES A DATABASE FILE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: CLOSBF\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\  ^TO UPDATE THE DISK IMAGE OF A DATABASE FILE, CLOSE IT,
AND RETURN THE <LUN TO A STATE THAT ALLOWS
REUSING IT FROM <FORTRAN.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY:
.BREAK
^^CALL CLOSBF(ROOT[,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -5
<ROOT ^THE DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -4
<ERR ^THE ERROR RETURN PARAMETER, WHERE:
.BREAK
<ERR=-100 ^MEANS CORRUPT ROOT BLOCK.
.BREAK
<ERR=##+1 ^SIGNIFIES SUCCESSFULL RETURN.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <WRITEVB MACRO.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^CALL CLOSBF(ROOT)\\
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CLOSBF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <B$DELETEDATA - ^^INTERNAL ROUTINE TO DELETE OFFSPRING\\
.PAGE
.INDENT 45
<B$DELETEDATA
.SKIP 1
.CENTER
<B$DELETEDATA - ^^INTERNAL ROUTINE TO DELETE OFFSPRING\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$DELETEDATA\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO DELETE ALL THE OFFSPRING OF THE CURRENTLY ACTIVE KEY.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ONLY
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -3
<R5 ^MUST POINT TO A ZERO WORD.
.INDENT -3
<R4 ^POINTER TO DATABASE ROOT BLOCK AND <I/O BUFFERS.
.INDENT -3
<R3 ^SCRATCH USED AS BUFFER ADDRESS.
.INDENT -3
<R2 ^STACK POINTER TO LEVEL TABLE.
.INDENT -3
<R1 ^USED AS SCRATCH
.INDENT -3
<R0 ^USED AS SCRATCH.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$ACTIVATE <B$DEALOCATE <B$READKEY
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO1 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$DELE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <B$ACTIVATE  ^^INTERNAL ROUTINE TO ACTIVATE A LEVEL\\
.INDENT 50
<B$ACTIVATE
.SKIP 1
.CENTER
<B$ACTIVATE  ^^INTERNAL ROUTINE TO ACTIVATE A LEVEL\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$ACTIVATE
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO READ IN THE FIRST BLOCK OF SIBLINGS AND INITIALIZE
THE STACK ENTRY FOR THE CURRENT LEVEL OF A DATABASE FILE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO PROGRAMS ONLY.
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.BREAK
<R0 ^IS USED AS A SCRATCH VARIABLE.
.BREAK
<R2 ^LEVEL STACK POINTER.
.BREAK
<R3 ^IS RETURNED AS CURRENT <I/O BUFFER ADDRESS.
.BREAK
<R4 ^POINTER TO ROOT BLOCK.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <WRITEVB AND <READVB MACROS
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^MOV @RT(R5),R4
MOV R4,R2
ADD _#RT.1ST+LV.SIZE,R2
JSR PC,B$ACTIVATE\\
.SKIP 1
.INDENT -10
^^FEATURES:\\ ^WRITES OUT THE <I/O BUFFER IF IT CONTAINS A MODIFIED DATA
BLOCK.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$ACTI
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <B$GETNEXT - ^^INTERNAL ROUTINE TO READ NEXT BLOCK OF SIBLINGS\\
.PAGE
.INDENT 50
<B$GETNEXT
.SKIP 1
.CENTER
<B$GETNEXT - ^^READS NEXT BLOCK OF SIBLINGS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$GETNEXT\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO READ IN THE NEXT BLOCK OF SIBLINGS IN A DATABASE FILE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ONLY.
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.NOFILL
<R2 ^THE LEVEL STACK POINTER.
<R3 ^THE POINTER TO THE <I/O BLOCK FOR THIS LEVEL.
<R4 ^THE POINTER TO THE ROOT BLOCK.
.INDENT 3
^RETURNS CARRY BIT SET ON ERROR.
.FILL
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <READVB AND <WRITEVB MACROS
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
^^MOV 2(R5),R4
MOV RT.BUF(R4),R3
MOV RT.PCL(R4),R2
JSR PC,B$GETNEXT
BCS ERROR\\
.FILL
.SKIP 1
.INDENT -10
^^FEATURES:\\ ^WRITES OUT THE <I/O BUFFER IF IT CONTAINS A MODIFIED BLOCK.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$GETN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <B$ALOCATE - ^^INTERNAL DATABASE ROUTINE FOR ALLOCATING BLOCKS\\
.INDENT 50
<B$ALOCATE
.SKIP 1
.CENTER
<B$ALOCATE -^^INTERNAL DATABASE ROUTINE FOR ALLOCATING BLOCKS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$ALOCATE
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^ALLOCATES BLOCKS OFF OF THE FREE LIST OR THE END OF A FILE FOR NEW KEYS
IN A DATABASE FILE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ONLY
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.BREAK
.INDENT -3
<R4 ^POINTER TO ROOT BLOCK AND <I/O BUFFERS.
.INDENT -3
<R3 ^RETURNS POINTING AT THE BUFFER.
.INDENT -3
<R2 ^POINTER TO THE LEVEL TABLE STACK.
.INDENT -3
<R1 ^SCRATCH USED FOR STORING BLOCK NUMBERS.
.INDENT -3
<R0 ^SCRATCH USED TO STORE LAST LEGAL ADDRESS OF BLOCK.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <READVB AND <WRITEVB MACROS
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
.NOFILL
^^SCALL B$ALOCATE
ON.ERROR THEN GOTO EROUTINE\\
.FILL
.SKIP 1
.INDENT -10
^^FEATURES:\\<B$ALOCATE WILL CONSERVE <I/O OPERATIONS WHEN THE BLOCK ALLOCATED
WAS JUST DEALLOCATED RECENTLY.  ^THE DEALLOCATED BLOCK WILL STILL BE IN CORE,
AND ALLOCATE WILL GRAB IT WITHOUT EVER WRITING IT INTO THE DISK VERSION OF
THE FREE LIST.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$ALOC
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]MIKESLIB
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <B$DEALOCATE - ^^INTERNAL ROUTINE TO DEALLOCATE BLOCKS\\
.INDENT 45
<B$DEALOCATE
.SKIP 1
.CENTER
<B$DEALOCATE - ^^INTERNAL ROUTINE TO DEALLOCATE BLOCKS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$DEALOCATE
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^DEALLOCATES BLOCKS IN A DATABASE FILE AND ADDS THEM TO THE FREE LIST.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ONLY.
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -3
<R4 ^POINTER TO ROOT BLOCK AND <I/O BUFFERS.
.INDENT -3
<R3 ^SCRATCH REGISTER USED TO HOLD THE ADDRESS OF THE BLOCK TO BE DEALLOCATED.
.INDENT -3
<R2 ^THE LEVEL TABLE STACK POINTER.
.INDENT -3
<R1 ^SCRATCH REGISTER TO CONTAIN THE BLOCK NUMBER.
.INDENT -3
<R0 ^ANOTHER SCRATCH BLOCK NUMBER.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <B$IOERROR, <READVB AND <WRITEVB MACROS.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$DEAL
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <B$OPENFOR - ^^INTERNAL ROUTINE TO OPEN A FORTRAN FILE\\
.INDENT 50
<B$OPENFOR
.SKIP 1
.CENTER
<B$OPENFOR - ^^INTERNAL ROUTINE TO OPEN A FORTRAN FILE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: B$OPENFOR\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO OPEN A FILE IN SUCH A MANNER THAT <FORTRAN WILL THINK HE OPENED IT
HIMSELF.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ONLY.
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.INDENT -3
<R0 ^FDB ADDRESS.
.INDENT -3
<R1 ^ADDRESS OF AN ERROR ROUTINE (USUALLY <B$IOERROR).
.INDENT -3
<R3 ^ADDRESS OF THE <FORTRAN OBJECT TIME SYSTEM VARIABLES AREA (<@#$OTSV).
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^RUN TIME <FDB INITIALIZING MACROS, PLUS THE <OPEN$W MACRO.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ ^THIS ROUTINE IS USED BY THE <SUPERMAC <PUTLINE MACRO, YOU SHOULD NEVER NEED TO
USE IT OTHERWISE.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$OPEN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <B$IOERROR - ^^PRINTS AN I/O ERROR ON JOBLOG AND EXITS\\
.PAGE
.INDENT 50
<B$IOERROR
.SKIP 1
.CENTER
<B$IOERROR - ^^PRINTS AN I/O ERROR ON JOBLOG AND EXITS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$IOERROR\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^WRITES AN FCS ERROR MESSAGE ON THE JOBLOG AND EXITS FROM A <FORTRAN PROGRAM.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <MACRO ROUTINES WITHIN <FORTRAN PROGRAMS ONLY.
.SKIP 1
.INDENT -10
^^PARAMETER:\\<R0 MUST CONTAIN THE  <FDB ADDRESS OF THE FILE IN WHICH
AN ERROR HAS OCCURED.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <CONV, <PUTLINE AND <PRINT MACROS.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.BREAK
^^LET R0 := RT.FDB(ROOT)
.BREAK
SCALL B$IOERROR\\
.SKIP 1
.INDENT -10
^^FEATURES:\\^BECAUSE <B$IOERROR USES THE <FORTRAN <EXIT ROUTINE, ALL ^FORTRAN FILES WILL
BE CLOSED AUTOMATICLY BEFORE YOUR <FORTRAN MAIN PROGRAM TERMINATES.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO11 WITH <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <B$IOER
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <[60,100]DATABASE
.SKIP
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.FL CAPITALIZE;.PAGE
.TITLE ^^ATTACH/DETACH IO DEVICE TO/FROM A FORTRAN PROGRAM 
.INDENT 37
<ATTACH/DETACH
.SKIP 1
.CENTER
^^ATTACH/DETACH IO DEVICE TO/FROM A FORTRAN PROGRAM 
.SKIP 1
.LEFT MARGIN 10
.INDENT -10
^^ROUTINE NAME: ATTACH/DETACH
.SKIP 1
.INDENT -10
PURPOSE:\\ ^WHEN A PROGRAM ATTACHES TO DEVICE NO OTHER PROGRAM CAN ACCESS THAT DEVICE
UNTIL THE ATTACHED PROGRAM ISSUES A CALL TO <DETACH FROM <FORTRAN.  ^IF A
DEVICE IS ATTACHED ALREADY  WHEN THE CALL TO <ATTACH IS MADE BY YOUR PROGRAM
, <ATTACH WILL WAIT FOR A DETACH OF THE OWNING PROGRAM TO EXIT.  ^AT THAT
TIME YOUR CALL TO <ATTACH WILL COMPLETE ITS EXECUTION AND RETURN.
.PARAGRAPH
^THIS ROUTINE IS PARTICULARY USEFUL FOR TEXT EDITING TYPE APPLICATIONS.
^A LIST COMMAND FOR EXAMPLE MAY TAKE AN APPRECIABLE AMOUNT OF TIME TO
EXECUTE WHEN ONLY A SUBSET OF THE LISTED CONTENT WAS DESIRED.  ^THE TYPICAL
<FORTRAN WRITE STATEMENT TO A TERMINAL CAN BE SUPPRESSED BY TYPING A 
CONTROL 'O'.  ^HOWEVER THIS IS ONLY ON A LINE BY LINE BASSES IF THE TERMINAL IS 
NOT ATTACHED TO THE EDITING TERMINAL.  ^IF A CALL TO <ATTACH IS MADE BEFORE
A WRITE LOOP IS EXECUTED THE USER SITTING AT THE TERMINAL MAY TYPE A 
CONTROL 'O' AND ALL OUTPUT THAT WOULD HAVE BEEN TYPED OUT ON THE TERMINAL
IS SUPPRESSED UNTIL A CALL TO <DETACH IS MADE OR THE USER TYPES A 
CONTROL "^O" A SECOND TIME (NOTE: <ATTACH SHOULD ONLY BE USED
ON TERMINALS OR PRINTERS).
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^^FROM FORTRAN -- CALL DETACH(LUN)
.INDENT 17
^^CALL ATTACH(LUN)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ LUN = LOGICAL UNIT NUMBER
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^QIO$S\\
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP 1
.LEFT MARGIN 2
.NOFILL
	^^CALL ATTACH(LPR)
	DO 234 I=1,NOFLIN
234	WRITE(LPR,101)(TEXT(J),J=1,80)
	CALL DETACH(LPR)
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS\\
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^^APRIL 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^ATTACH AND DETACH
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NO MODIFICATIONS SINCE WRITING.
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^^NO FORMAL MAINTAINCE.
.SKIP 1
.INDENT -10
.STANDARD
.STANDARD;.FL CAPITALIZE;
.TITLE <DELETE- ^^DELETING A FILE FROM FORTRAN
.PAGE
.INDENT 50
<DELETE
.SKIP 1
.CENTER
<DELETE- ^^DELETING A FILE FROM FORTRAN
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <DELETE\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS ROUTINE WILL DELETE THE FILE ASSOCIATED WITH THE LOGICAL UNIT
NUMBER GIVEN THE ONE AND ONLY ARGUMENT.  <DELETE CAN BE USED A A FUNCTION
TO GET THE <FCS ERROR STATUS OF THE DELETE OPERATION.  ^BUT
IT MUST BE DECLARED INTEGER FOR THIS TO WORK PROPERLY.  ^IT IS
QUITE USEFUL TO DELETE A SCRATCH FILE DURING RUN TIME.
(NOTE: THE FILE MUST BE OPEN, OR <DESIGN MUST BE USED TO FILL IN THE
ENTIRE FILE NAME, INCLUDING THE SPECIFIC VERSION NUMBER IN THE FDB).
^INVALID <LUN WILL RESULT IN A <FORTRAN ERROR TRAPPED BY
 THE <FORTRAN <RTS.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN - ^^CALL DELETE(\\LUN)
			      ^^OR ERR=DELETE (LUN)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ <LUN = LOGICAL UNIT NUMBER
 	      <ERR=FCS ERRON STATUS
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^DELET$, $FCHNL, $OTSV
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LEFT MARGIN 2
.NOFILL
PROGRAM TO EXCHANGE THREE INTEGER FIELDS.

^^	CALL ASSIGN (1,'DATA.DAT')
	CALL ASSIGN (2,'SCRATCH')
	DO 100 I=1,NLINES
	READ(1,END=99)IVAL1,IVAL2,IVAL3
100	WRITE(2)      IVAL3,IVAL1,IVAL2
	CALL DELETE (1) !*\\*********  DELETE THE OLD FILE.^^
99	CALL RENAME (2,'DATA.DAT') !\\CREATE A NEW ONE.
^^	CALL EXIT
	END
.SKIP 1
.INDENT -10
^^FEATURES:\\ CALLABLE FROM <FORTRAN AS A FUNTION OR A SUBROUTINE.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ SOME TIME A GO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <DELETE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS.OLB
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ UNKNOWN
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ NOT FORMALLY MAINTAINED.
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE ^^DUMPBF DUMP ROOT BLOCK PARAMETERS
.PAGE
.INDENT 50
^^DUMPBF
.SKIP 1
.CENTER
^^DUMPBF DUMP ROOT BLOCK PARAMETERS
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: ^^DUMPBF
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^USED AS A DEBUGGING AID IN CONJUNCTION WITH THE
^^CETUS DATABASE\\ ROUTINES.  ^^DUMPBF\\ WILL PRINT
ON THE ^^LUN\\ SPECIFIED IN THE COMMON BLOCK NAMED ^^CONSOL\\.  ^THE DEFAULT
DEFINED BY ^^BATDEF\\ IS 5.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN\\ -- ^^CALL DUMPBF(ROOT)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^ROOT\\-----^THE ROOT BLOCK ARRAY (SEE ^^OPENBF\\
AND ^^BLDHDR)\\
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI OF ^^CETUS\\ ^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^MARCH 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^DUMPBF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE <GETVER - ^^GETTING THE VERSION NUMBER OF A FILE 
.PAGE
.INDENT 50
<GETVER
.SKIP 1
.CENTER
<GETVER - ^^GETTING THE VERSION NUMBER OF A FILE 
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: GETVER\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^IN MOST CASES OF FILE NAME SPECIFICATION, VERSION NUMBERS OF FILES ARE 
RARELY SPECIFIED EXPLICITLY.  ^THE DEFAULT <FCS USES IS VERSION 0 IE. THE
MOST RECENT VERSION OF A FILE.
.SKIP
^ONE USEFUL APPLICATION OF <GETVER WAS FOR A COMPILE LINK AND GO ROUTINE
WHERE A SCRATCH FILE WAS KEPT FOR VARIOUS USER PROGRAM ATTRIBUTES.  ^ONE
OF THESE PARAMETERS WAS THE USER'S SOURCE FILE VERSION NUMBER.
  ^WHEN THE USER MADE MODIFICATIONS TO THE SOURCE
AND TYPED '<GO' A VERSION NUMBER CHECK WAS MADE TO DETERMINE IF IT WAS NECESSARY
TO COMPILE AGAIN.  ^IF THE VERSION NUMBER DID NOT CHANGE THE SOURCE WAS
NOT RECOMPILED.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN - ^^VERNO=GETVER(\\LUN)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ <LUN = LOGICAL UNIT NUMBER
.SKIP 1
.INDENT -10
^^ROUTINE USED:\\ ^THE <FORTRAN <RTS ROUTINES <$FCHNL
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LEFT MARGIN 2
.NOFILL
^C	^CHECK HIS VERSION NUMBER TO SEE IF WE SHOULD
^C	RECOMPILE.
^C
	^^READ(SCRLUN'VERPNT)OLDVER
	NEWVER=GETVER(SOURCE)
	IF(NEWVER .EQ. OLDVER) GO TO 890
C
C     \\^THE OLD VERSION IS DIFFERENT SO COMPILE THE NEW VERSION
^C     AND UPDATE THE PARAMETER FILE.
^C
	WRITE(SCRLUN'VERPNT)NEWVER
	CALL COMPILE
	.
	.
	.
.PAGE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^JACK MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^^SEPTEMBER 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <GETVER
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ ^STILL UNMODIFIED.
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^NOT FORMALLY MAINTAINED.
.PAGE
.SKIP 1
.INDENT -10
.FL CAPITALIZE;.STANDARD
.TITLE ^^TURN OFF FORTRAN CARRIAGE CONTROL.\\
.INDENT 50
<NOTFTN
.SKIP 1
.CENTER
^^ TURN OFF FORTRAN CARRIAGE CONTROL.\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: NOTFTN\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\  ^THIS SUBROUTINE WILL TURN OFF <FORTRAN CARRIAGE CONTROL ON THE 
FILE ATTACHED TO THE LOGICAL UNIT NUMBER.  ^THE FILE MUST BE OPEN
FOR THIS ROUTINE TO WORK.  ^IT IS SUGGESTED THAT YOU CALL THIS ROUTINE
AFTER YOUR FIRST READ OR WRITE, OR JUST BEFORE YOU CLOSE YOUR <LUN.
^AN INVALID LOGICAL UNIT MUMBER WILL RESULT IN A <FORTRAN ERROR 
TRAPPED BY THE <FORTRAN <RTS (ERROR 32).
.SKIP 1
.INDENT -10
^^CALLABLE:\\ BY <FORTRAN --^^CALL NOTFTN(LUN)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ LUN = LOGICAL UNIT NUMBER.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ THE <FORTRAN <RTS ROUTINE <$FCHNL.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP 2
.NOFILL
.LEFT MARGIN 2
.RIGHT MARGIN 81
	^^CALL ASSIGN(SRT,NAME)		!\\LINK THE FILE TO A <LUN.
420^^	IF(GETSRT(SRTBUF,BUF) .LT. 0) GO TO 430
^C
^C	^GET A LINE FROM SORTED FILE/BUFFER IF THERE ARE ANY MORE.
^C	IF NO MORE LINES THEN TURN OFF <FORTRAN C.C AND CLOSE THE FILE.
^C
	^^N=LEN(BUF,BREC)		!\\GET LENGTH OF THIS LINE.
	^^WRITE(SRT,4000,ERR=480)(BUF(I),I=1,N) 
4000	^^FORMAT(140A1)
	GO TO 420
430	CALL NOTFTN(SRT)	!\\TURN OFF CC BIT IN FDB.
	^^CALL CLOSE(SRT)		!\\AND CLOSE THIS LUN.
.FILL
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ <SEPTEMBER 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <NOTFTN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.FLAGS CAPITALIZE;.STANDARD
.TITLE <RENAME- ^^CHANGING A FILE NAME FROM FORTRAN
.PAGE
.INDENT 49
<RENAME
.SKIP 1
.CENTER
<RENAME- ^^CHANGING A FILE NAME FROM FORTRAN
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <RENAME\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <RENAME IS A ROUTINE USED TO CHANGE A FILE NAME BY
ITS <LUN AND CLOSE IT.  ^THE NEW FILE NAME GIVEN IS SPECIFIED BY THE 
SECOND ARGUMENT - A BYTE ARRAY CONTAINING THE NEW FILE NAME.  ^THIS ARRAY MUST BE 
TERMINATED BY A NULL.  ^THE FILE THAT IS BEING RENAMED MUST BE OPEN BEFORE A 
CALL TO <RENAME. <RENAME CAN BE CALLED AS A SUBROUTINE OR
USED AS A FUNCTION IF IT IS DECLARED INTEGER.  ^THE VALUE OF THE FUNCTION IS THE <FCS
ERROR STATUS.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN - ^^CALL RENAME(LUN,NEWFIL)
.BREAK
\\OR ^^ FCS=RENAME(LUN,NEWFIL)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP ;.INDENT -9
^^LUN\\------^LOGICAL UNIT NUMBER
.SKIP ;.INDENT -9
^^NEWFIL\\---^THE NEW FILE NAME - A BYTE ARRAY TERMINATED BY A NULL.
.SKIP ;.INDENT -9
^^FCS\\-----^THE FCS ERROR STATUS.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^$FCHNL
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LM 2
.NOFILL
.UC
C
C   PROGRAM TO EXCHANG THREE INTEGER FIELDS.
C
	CALL ASSIGN(1,'DATA.DAT')
	CALL ASSIGN(2,'SCRATCH')
	DO 100 I=1,NLINES
	READ(1,END=99)IVAL1,IVAL2,IVAL3
100	WRITE(2)IVAL3,IVAL1,IVAL2
	CALL CLOSE(1)
99	FCS=RENAME(2,'DATA.DAT') !CREATE NEW VERSION.
	CALL EXIT
	END
.FILL
.LC
.LM 10
.BREAK
.SKIP 1
.INDENT -10
^^AUTHOR:\\ <MIKE <HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ <JANUARY 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <RENAME
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^LINDA ^MUNDY
.SKIP 1
.INDENT -10
.TITLE <BATDEF - <BATDEF
.PAGE
.INDENT 50
<BATDEF
.SKIP 1
.CENTER
<BATDEF - <BATDEF
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <BATDEF\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS MODULE IS A BLOCK DATA SUBROUTINE CONTAINING 3 COMMON BLOCKS
EACH DEFINING A LOGICAL UNIT NUMBER FOR <BATCH INPUT, OUTPUT AND
JOBLOG.  ^MANY OF THE ^CETUS LIBRARY ROUTINES USE THESE COMMONS TO WRITE SCRATCH
DATA ON, OR TO WRITE ERROR CODES.  ^YOU CAN CHANGE THE <LUN VALUES IN YOUR FORTRAN MAINRAN
MAIN PROGRAM BY DECLARING THE NAMED COMMON S AND RE-ASSIGNING THE VALES AT RUN
TIME (A DATA STATEMENT WILL NOT DO).

.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN - ^IS LINKED AT TASK BUILD TIME AS AN OBJECT
MODULE EXPLICITLY, I.E., ^^CETUS/LB=BATDEF\\ OR BY DECLARING
^^BATDEF EXTERNAL\\ IN YOUR <FORTRAN SOURCE.  ^IF ONE OF THE <MACRO
SUBROUTINES IN ^CETUS LIBRARY IS USED, <BADEF IS
BUILT INTO YOUR TASK IMAGE AUTOMATICALLY, AND IT IS NOT NECESSARY TO SPECIFICALLY
ASK FOR <BATDEF IN YOUR TASKBUILD COMMAND FILE.

.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
/^^SCRAT\\1/-^THE NAMED COMMON BLOCK CONTAINING THE 1ST SCRATCH ^^LUN\\
USED BY THE ^SORT ^PACKAGE.  ^DEFAULT IS 1, CHANGES TO 2.
.SKIP;.INDENT -9
/^^SCRAT\\2/-^THE COMMON CONTAINING THE 2ND SCRATCH ^^LUN\\ USED BY THE ^SORT
^PACKAGE.^DEFAULT IS 2 (CHANGES TO 1).  ^THE SORT PACKAGE
ALWAYS USES ^^SCRAT 1\\ FOR AN OPEN MERGE FILE AND ^^SCRAT 2\\
IS GUARANTEED TO BE FREE INBETWEEN SORT ROUTINE
OPERATIONS.  ^SEVERAL ^CETUS LIBRARY ROUTINES DEPEND ON THIS AND USE ^^SCRAT 2\\
AS A SCRATCH ^^LUN\\.  ^IF YOU ARE USING ^^LUNS\\ 1 AND 2, AND YOU ARE USING 
ONE OF THOSE ROUTINES, YOU MUST DECLARE ^^SCRAT 1\\ IN YOUR MAIN PROGRAM AND
REASSIGN IT TO AN UNUSED ^^LUN\\ AT RUN TIME.  (^A DATA STATEMENT WILL NOT  
DO).  ^IF YOU ARE USING THE ^SORT ^PACKAGE AND YOU WISH TO USE ^^SCRAT 2\\ 
BETWEEN CALLS TO SORT ROUTINES, YOU CAN, BUT YOU MUST ALWAYS USE THE SYMBOLIC
NAME.  ^THE ^^LUN\\ THAT IS ACTUALLY FREE ALTERNATES BETWEEN THE TWO, BUT THE
VALUE OF THE FREE ONE IS ALWAYS STORED IN SCRAT 2.
.SKIP;.INDENT -9
^^JOBLOG---T\\HE NAMED COMMON BLOCK CONTAINING THE ^INTEGER VARIABLE FOR 
THE ^^JOBLOG LUN\\.  ^DEFAULT IS 7.
.SKIP;.INDENT -9
^^BATIN----T\\HE COMMON BLOCK CONTAINING THE <LUN FOR <BATCH INPUT
I.E., YOU READ FROM THIS <LUN)
.SKIP;.INDENT -9
^^BATOUT---T\\HE NAMED COMMON BLOCK CONTAINING THE <LUN FOR <BATCH OUTPUT
(I.E., YOU WRITE YOUR OUTPUT HERE.)
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.INDENT -9
 ^^COMMON/JOBLOG/JL\\

.INDENT -9
^^COMMON/BATIN/CARDS\\

.INDENT -9
^^COMMON/BATOUT/PRNTER\\
.SKIP 1
.INDENT -10
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <BATDEF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS.OLB
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JOHN ^JAMES OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE <CURSE -^^SUBROUTINE TO POSITION THE CRT CURSOR\\
.PAGE
.INDENT 50
<CURSE
.SKIP 1
.CENTER
^^CURSE - SUBROUTINE TO POSITION THE CRT CURSOR\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <CURSE\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO POSITION THE CURSOR OF A <VT52 OR ^TELERAY TO COLUMN <X AND ROW ^Y
OF THE SCREEN AND OPTIONALLY PRINT A STRING.  1_<=^Y_<=24.  ^IF STRING
IS MISSING THE CURSOR IS POSITIONED BUT NOTHING IS PRINTED.  ^IF <LEN
IS MISSING, <MAXLEN OR THE FIRST NUL (WHICHEVER COMES FIRST) ARE ASSUMED.
.SKIP 1
^^COORDINATES OF THE SCREEN
.BREAK
(1,1)----- UPPER LEFT HAND CORNER.
.BREAK
(80,1)---- UPPER RIGHT HAND CORNER.
.BREAK
(80,24)--- LOWER RIGHT HAND CORNER.
.BREAK
(1,24)---- LOWER LEFT HAND CORNER.
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN
.SKIP
.INDENT -9
^^CALL CURSE (X,Y[,STRING[,LEN]])
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^X--------T\\HE <X COORDINATE ON THE SCREEN 1-80.
.SKIP;.INDENT -9
^Y--------^THE ^Y COORDINATE ON THE SCREEN 1-24.
.SKIP;.INDENT -9
^^STRING---T\\HE STRING OF CHARACTERS TO PRINT AT <X,<Y.
.SKIP;.INDENT -9
^^LEN------T\\HE LENGTH OF THE STRING IF NOT TERMINATED BY A NULL.
^IF LEN IS OMITTED <MAXLEN CHARACTERS ARE PRINTED (SEE <SETMAX).
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <QIO - WRITE ALL BITS
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JULY 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CURSE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE FREZLP - DISSABLING LINE PRINTER DEMON
.PAGE
.INDENT 50
<FREZLP
.SKIP 1
.CENTER
^^FREZLP - DISSABLING LINE PRINTER DEMON\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: FREZLP\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^BY CALLING ^^FREZLP\\, A GLOBAL EVENT FLAG IS SET
WHICH ^^LPDEMON\\ RECOGNIZES AS A COMMAND TO SUSPEND ITSELF AT THE END OF THE
CURRENT PRINTOUT, AND NOT PRINT THE NEXT
JOB IN THE OUTPUT QUEUE.  ^THIS EVENT FLAG IS CHECKED BY ^^LPDEMON\\ BEFORE 
EACH JOB IS PRINTED.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN\\ CALL ^^FREZLP()
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ NONE
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ THE ^EXECUTIVE ^ROUTINE ^^SETEF
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^FREEZLP
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\  NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE RULES - TO DISPLAY FILE CONTENTS 23 LINES/SCREEN.
.PAGE
.INDENT 50
<RULES
.SKIP 1
.CENTER
^^RULES - TO DISPLAY FILE CONTENTS 23 LINES/SCREEN.\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: RULES\\
.SKIP 1
.INDENT -10
^^PURPOSE:  \\^PROMPTS THE TERMINAL WITH THE QUESTION:
  ^^DO YOU NEED INSTRUCTIONS?\\. ^ANY ANSWER THAT DOES NOT START WITH THE LETTER 'Y' 
CAUSES <RULES TO RETURN IMMEDIATELY,
OTHERWISE <RULES FILLS THE SCREEN WITH THE NEXT 23 RECORDS OF A CARD
IMAGE FILE FOLLOWED BY THE
PROMPT.:
.SKIP;.I 5
  ^^HIT RETURN FOR MORE RULES\\
.SK
 ^A CONTROL-^Z AT THIS TIME WILL CAUSE RULES TO CLOSE THE RULES
FILE AND RETURN WITHOUT PRINTING MORE RULES.
^THERE IS SOME SYNTAX THAT CAN CONTROL THE OUTPUT TO THE
SCREEN.  ^A HAT (_^) IN COL 1 OF THE DISPLAY FILE WILL CAUSE RULES TO
QUIT BEFORE 23 LINES AND PROMPT AGAIN.  ^A SEMICOLON
IN COL 1 CAUSES THAT LINE TO BE IGNORED.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--CALL RULES(FILENAME)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^FILENAME-T\\HE FILENAME SPECIFIER--^STANDARD ^FILES-11
FORMAT MAY BE AN ARRAY OR A QUOTED STRING.
.SKIP 1
.INDENT -10
^^FEATURES: \\^USES NAMED COMMON </CONSOLE/ AS THE <TI: - TERMINAL <LUN. ^USES THE LABELED
COMMON <SCRAT2 TO OPEN THE RULES FILE.  ^SEE <BATDEF FOR A DESCRIPTION OF ALL
THE SPECIAL <LUNS IN NAMED COMMONS.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JULY 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^RULES
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE <SWAPB -  (<WORD)
.PAGE
.INDENT 50
<SWAPB
.SKIP 1
.CENTER
<SWAPB -  (<WORD)
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <SWAPB\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS SUBROUTINE IS AN INTEGER FUNCTION TO RETURN <WORD WITH
THE BYTES REVERSED.  <WORD ITSELF IS NOT MODIFIED UNLESS YOU CALL
THUSLY: <WORD=SWAPB(WORD).  <SWAPB ALSO CLEARS THE PARITY BITS (BIT 7) IN
EACH BYTE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\FROM <FORTRAN - <CALL <SWAPB(WORD)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -9
<WORD --- ^WORD CONTAINS THE TWO BYTES THAT WILL BE SWAPPED
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.LM 2
	^^WORD=SWAPB(AWORD)
.SKIP
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SWAPB
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]<MIKES
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.FLAGS CAPITALIZE
.SD;.FLAGS CAPITALIZE
.TITLE <UPRINT- UNFORMATED TERMINAL PRINTING ROUTINE
.PAGE
.INDENT 49
<UPRINT
.SKIP 1
.CENTER
^^UPRINT- UNFORMATED TERMINAL PRINTING ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <UPRINT
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <UPRINT IS A ONE ARGUMENT SUBROUTINE WHICH ACCEPTS AN ARRAY OF BYTES AND 
SIMPLY PRINTS THE ARRAY ON THE <LUN SPECIFIED BY THE ^^COMMON/CONSOL/TTY\\
IN <ASCII FORMAT.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN --  ^^CALL UPRINT(BUF)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -9
^^BUF\\------AN ARRAY OF BYTES TO BE PRINTED ON THE USER'S TERMINAL.
^THIS ARRAY CANNOT EXCEED 80 BYTES AND MUST BE TERMINATED BY A NULL OR FILLED WITH TRAILING BLANKS.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <LEN AND ^^BADEF LUN\\ DEFINITIONS.
 
.SKIP 1
.INDENT -10
^^FEATURES:\\^THE ^^COMMON/CONSOL/TTY\\ CAN BE CHANGED TO ANY <LUN IF 5 
(THE DEFAULT) IS IN USE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI
^^CETUS CORPORATION\\
.SKIP 1
.INDENT -10
^^WRITTEN:\\ <JUNE 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <UPRINT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^JACK ^MARTINELLI OR ^LINDA ^MUNDY
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE <WAL - <WAL <(STRING,LEN)
.PAGE
.INDENT 50
<WAL
.SKIP 1
.CENTER
<WAL - <WAL <(STRING,LEN)
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <WAL\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <WRT PERFORMS A ^Q^I0 WITH FUNCTION <IO.WAL (WRITE ALL BITS)
FROM <FORTRAN.  ^CHARACTERS WRITTEN IN THIS MANNER CAN BE 
TABS, FORMFEEDS, ETC., AND WILL NOT BE CHECKED OR DELETED BY
THE <TELETYPE DRIVER.  ^ALSO THESE CHARACTERS ARE NOT COUNTED
TOWARDS THE AUTOMATIC CARRIAGE RETURN AT THE END OF A LINE.
^THE <LEN ARG IS MANDATORY.  ^OUTPUT GOES TO THE ^^LUN\\ SPECIFIED BY THE NAMED COMMON ^CONSOL, (SEE
^^BATDEF).

.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN.  ^^CALL WRT(STRING,LEN)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^STRING--A\\ STRING OF ANY <ASCII CHARACTERS.
.SKIP
.INDENT -9
^^LEN------N\\UMBER OF BYTES IN STRING.
.SKIP 1
.INDENT -10
^^ROUTINES USED:  BATDEF\\ 
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JULY 1978
<GETSRT.
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP;.INDENT -10
<EXAMPLE:
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <WAL ^^(STRING,LEN)\\

.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE DSKSRT - ^^FORCING A DISK IMAGE OF SORT BUFFER/SCRATCH-FILE

.PAGE
.INDENT 50
<DSKSRT
.SKIP 1
.CENTER
<DSKSRT - ^^FORCING A DISK IMAGE OF SORT BUFFER/SCRATCH-FILE
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: DSKSRT\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THE DISK SORT ROUTINE WILL TAKE ALL OF THE PREVIOUSLY SORTED RECORDS
(SEE <SETSRT,PUTSRT) AND PUT THEM INTO A FILE.  ^THIS FILE CAN BE READ
FROM THE <LUN RETURNED BY <DSKSRT.  ^IT IS YOUR RESPONSIBILITY TO CLOSE, RENAME OR DELETE THIS <LUN WHEN YOU
ARE DONE, SO THAT THE SORT PACKAGE CAN REUSE IT ON ANY FOLLOWING SORT
OPERATIONS.  ^IF YOU MUST KEEP THE <LUN OPEN, AND YOU NEED TO DO ANOTHER SORT,
YOU CAN CHANGE THE </SCRAT 1/ </SCRAT 2/ VALUES OR USE DIFFERENT <LUNS IN THE
<SETSQT CALL.

.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN
.SKIP
.CENTER
^^ CALL <DSKSRT(SRTBUF,LUN,ERR)
.CENTER
 OR
.CENTER
 <ERR=DSKSRT(SRTBUF,LUN,ERR)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
<SRTBUF---A SORT BUFFER AND SCRATCH AREA FOR INTERNAL PARAMETERS USED
BY THE SORT PACKAGE.  
.SKIP;.INDENT -9
<LUN------^AN INTEGER VARIABLE IN WHICH THE LOGICAL UNIT NUMBER OF
THE SORTED FILE IS RETURNED.  ^THIS FILE IS AN UNFORMATED BINARY FILE,
WITH RECORD SIZE EQUAL TO THE <RECSIZ ARGUMENT TO <SETSRT.
.SKIP;.INDENT -9
<ERR------A ZERO
IF SUCCESSFUL, -1 IF FAILURE.  
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <SMERGE, <KSORT
.SKIP;.INDENT -10
<EXAMPLE:
.NOFILL
.SKIP
.BREAK
.LM2
	^^CALL DSKSRT (BUF,L)
10	READ (2,END=20) REC
	WRITE (CONSOL,200) REC
	GO TO 10
20	(ALL) DELETE (L)
.LM 10
.SKIP
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <DSKSRT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ ^MAY 1978
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD
.FL CAPITALIZE
.TITLE <KSORT - ^^KEY SORTING ROUTINE\\
.PAGE
.INDENT 50
.SKIP 1
.CENTER
<KSORT - ^^KEY SORTING ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <KSORT\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <KSORT IS DESIGNED TO MOVE THE MINIMUM AMOUNT OF INFORMATION IN A SORT EXCHANGE.
^THAT IS RATHER THAN MOVING 80 <BYTE RECORDS AROUND IN MEMORY ONLY
POINTERS TO THOSE RECORDS ARE MOVED.
.SKIP
^TO SET UP FOR A CALL TO <KSORT THE <KEY ARRAY NEEDS TO BE INITIALIZED.  
^NORMALLY THE ELEMENTS IN THE <KEY ARRAY ASCEND 1,2,3...N WHERE EACH INTEGER
REPRESENTS A POINTER TO A RECORD AND N IS THE TOTAL NUMBER OF RECORDS
AND <KEY ELEMENTS.  ^THE FOLLOWING IS AN EXAMPLE OF INITIALIZING THE <KEY
ARRAY:
.BREAK
.SKIP
.NOFILL
^^#####DO 10 I=1,50
10###KEY(I)=I\\
.FILL
.SKIP
^IF YOU ARE SORTING FIXED LENGTH RECORDS AND YOU CANNOT FIT ALL RECORDS IN
MEMORY, YOU SHOULD USE <SETSRT, <PUTSRT AND <GETSRT INSTEAD OF THIS ROUTINE.
^EVEN FOR SMALL SORTS, THOSE ROUTINES ARE EASIER TO USE THAN <KSORT AND THEY
EVENTUALLY WILL CALL <KSORT FOR YOU.
.SKIP 2
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ^^CALL KSORT(INP,NI,ISIZE,KEY,ICMP)
.INDENT -10
.SKIP
^^PARAMETERS:\\
.SKIP
.INDENT -9
<INP------^A NON-VECTORED ARRAY TO CONTAIN THE RECORDS TO BE SORTED.
.SKIP
.INDENT -9
^^NI\\-------\\^THE NUMBER OF ELEMENTS IN THE <KEY ARRAY AND THE NUMBER OF
 RECORDS TO BE SORTED.
.SKIP
.INDENT -9
^^ISIZE\\----\\^THE RECORD LENGTH IN <WORDS
.SKIP
.INDENT -9
^^KEY\\------^THE POINTER ARRAY (^^INTEGER*2\\)
.SKIP
.INDENT -9
^^ICMP\\-----^THE ADDRESS OF THE USER DEFINED COMPARE ROUTINE.  ^THE COMPARE
ROUTINE MUST BE AN INTEGER FUNCTION - FOR EXAMPLE:
.BREAK
.NOFILL
.SKIP
.SKIP
.LM 15
^C
^^C  COMPARE ROUTINE FOR DESCENDING SORT
C
	^^INTEGER FUNCTION COMPAR(REC1,REC2)
	BYTE REC1(1),REC2(1)
	COMMON /LENGTH/ NBYTES
	DO 10 I=1,NBYTES
	IF (REC1(I)-REC2(I)) 20,10,30
.INDENT -5
10####CONTINUE
	COMPAR=0
	RETURN
.INDENT -5
20####COMPAR=1
	RETURN
.INDENT -5
30####COMPAR=-1
	RETURN
	END\\
.FILL
.LM 10
.SKIP
^NOTE THAT THIS FUNCTION MUST BE DECLARED <EXTERNAL BY THE ROUTINE CALLING
<KSORT
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <ICMP-- THE USER DEFINED RECORD COMPARE ROUTINE.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.NOFILL
.SKIP
.BREAK
.LM 2
^^PROGRAM EXAMPLE
C---------------<SORT A BUNCH OF RECORDS
	EXTERNAL COMPAR
	BYTE RECORD(80,50)
	INTEGER*2 KEY(50)
	COMMON /LENGTH/ NBYTES
	NBYTES=80
	CALL ASSIGN(1,'INFILE') !FOR READ ONLY
	READ(1,10)((FECORD(I,J),I=1,80),J=1,50) 
10	FORMAT(80A1)
	D0 15 I=1,50
15	KEY(I)=I
	CALL KSORT(RECORD,50,40,KEY,COMPAR) !ISIZE IN WORDS.
	CALL CLOSE(1)
	CALL ASSIGN(1,'INFILE') !FOR WRITING.
	WRITE(1,10)((RECORD(I,KEY(J)),I=1,80),J=1,50)
	CALL EXIT
	END
.LM 10
.SKIP 1
.INDENT -10
.FILL
^^FEATURES:\\ ^CAN BE USED TO SORT VARIABLE LENGTH RECORDS BY INITIALIZING THE KEY ARRAY
IN A STRATIGIC METHOD AND WRITING THE COMPARE ROUTINE SO IT CAN EXTRACT FROM
A RECORD THE LENGTH.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ORIGINALLY WRITEN BY <KNUTH 
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <KSORT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.FLAGS CAPITALIZE
.STANDARD
.TITLE <PUTSRT- PUTSRT
.PAGE
.INDENT 49
<PUTSRT
.SKIP 1
.CENTER
<PUTSRT- <PUTSRT
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <PUTSRT\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO ADD TO THE SORT BUFFER A NEW RECORD.  ^TO RETRIEVE THE RECORDS IN 
SORTED ORDER -- SEE <GETSRT.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN--CALL ^^PUTSRT(SRTBUF,RECORD[,ERR])\\
.CENTER; OR ^^ERR=PUTSRT(SRTBUF,^^RECORD)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SK;.INDENT -9
 <SRTBUF---A BUFFER TO CONTAIN ELEMENTS TO BE SORTED.  ^THIS BUFFER MUST BE INITALIZED BY <SETSRT BEFORE THE 1ST CALL TO <PUTSORT
OR AN ERROR WILL OCCUR.
  
.SK;.INDENT -9
<RECORD-- ^THE BUFFER WHICH CONTAINS THE INFORMATION TO BE SORTED.  ^THIS CAN 
BE OF ANY VARIABLE TYPE SO LONG AS THE COMPARE ROUTINE (SEE <SETSRT) KNOWS
WHAT TO EXPECT.  ^THE SIZE OF <RECORD IS DETERMINED BY THE <RECSIZ ARGUMENT TO
<SETSRT.
.SKIP;.INDENT -9
^^ERR------T\\HE COMPLETION STATUS OF THE OPERATION   0 - OPERATION SUCCESSFUL
-1 - OPERATION FAILED.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <SMERGE, <KSORT
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.NF;.NJ
^C
^C   ^READ A RECORD FROM NAMES FILE FOR SORTING
^C
10  <READ(NAMES,15)L,LSTNAM
15  <FORMAT(Q,4A1)
    <CALL <PUTSRT(SRTBUF,LSTNAM)
.SKIP 1
.INDENT -10
.STANDARD
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ AUGUST 77
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <PUTSRT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE <SETSRT- <SETSRT
.PAGE
.INDENT 49
<SETSRT
.SKIP 1
.CENTER
<SETSRT- <SETSRT
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <SETSRT\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO INITIALIZE THE PARAMETERS OF THE SORT PACKAGE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN  ^^CALL SETSRT(SRTBUF,SIZBUF,RECSIZ,COMPL1,L2)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SK;.I -9
<SRTBUF--A BUFFER TO CONTAIN ELEMENTS TO BE SORTED.
.SK;.I -9
<SIZBUF-- ^THE SIZE OF THE SORT BUFFER IN <WORDS.  ^THIS ARRAY SHOULD BE
AT LEAST 1^K WORDS, WE USUALLY START WITH 4^K.  ^SINCE SOME PARTS OF THE ARRAY
ARE ALLOCATED FOR POINTERS AND COUNTERS, THE ABSOLUTE MINIMUM SIZE IS NO WORDS.

.SK;.I -9
<RECSIZ-- ^THE MAXIMUM RECORD SIZE EXPECTED.
.SK ;.I -9
<COMP---- ^THE NAME OF A COMPARE FUNCTION.  ^THIS FUNCTION MUST BE WRITTEN WITH
TWO ARGUMENTS WHICH WILL BE COMPARED.  ^THE RETURNED VALUE OF THE FUNCTION
 MUST RETURN A POSITIVE,
 0 OR NEGATIVE RESULT DEPENDING ON WHETHER AN ASCENDING
OR DESCENDING SORT IS PREFERRED (SEE <KSORT EXAMPLE).
.SK;.I -9
<LUN1---- ^A LOGICAL UNIT NUMBER TO BE USED AS SCRATCH FILE <LUN FOR
SORT-MERGE OPERATION.  ^DEFAULT IS </SCRAT 1/
.SK;.I -9
<LUN2-----^A 2ND SCRATCH <LUN.  ^THESE TWO <LUN'S ARE SHUFFLED BACK AND FORTH
DURING THE SORT-MERGE.  ^DEFAULT IS </SCRAT 2/.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^AUGUST 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SETSRT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.STANDARD;.FLAGS CAPITALIZE
.SD;.FLAGS CAPITALIZE
.TITLE <SMERGE- ^^SORT-MERGE PACKAGE
.PAGE
.INDENT 48
<SMERGE
.SKIP 1
.CENTER
<SMERGE- ^^SORT-MERGE PROGRAM
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <SMERGE\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <SMERGE IS AN OLD ROUTINE THAT IS HARDER TO USE THAN <SETSRT, <PUTSRT AND
<GETSRT.  ^YOU SHOULD USE THOSE ROUTINES BECAUSE THEY EVENTUALLY SET UP THE
CORRECT PARAMETERS AND CALL <SMERGE FOR YOU ANYWAY.  ^ALSO, THE NEW ROUTINES WILL
USE <KSORT AND BYPASS THE DISK <I/O IF THE ENTIRE SORT WILL FIT IN MEMORY.
.SKIP 1
<SMERGE WILL TAKE AN UN-SORTED ARRAY - SORT IT AND WRITE IT OUT TO A FILE.
^IF THIS FILE ALREADY CONTAINS PREVIOUSLY SORTED RECORDS, THEN THIS FILE
WILL BE READ FROM AND MERGE WITH THE IN CORE ARRAY INTO A SECOND FILE.
.SKIP
 <SMERGE CAN ONLY SORT DATA WITH ELEMENTS OF 132 BYTES OR SMALLER.
.SKIP
<SMERGE USES SYMBOLIC <LUN'S <SCRAT1 AND <SCRAT2 FOR ALL SORTING.
^IF THIS IS NOT ACCEPTABLE, YOU CAN DEFINE THE FOLLOWING COMMONS IN YOUR MAIN
PROGRAM AND SET THEM TO OTHER VALUES.
^NOTE THAT <SMERGE ALWAYS KEEPS ONE OF THE <LUNS OPEN, AND JUGGLES THE VALUES
IN COMMON SO THAT THE UNUSED ONE IS ALWAYS IN <SCRAT2.  ^YOU MAY USE THIS <LUN 
BETWEEN <SMERGE CALLS ONLY IF YOU USE IT BY ITS SYMBOLIC NAME AND MAKE SURE IT IS 
CLOSED BEFORE THE NEXT CALL TO <SMERGE.
.NOTE
^IF YOU GET AN ILLEGAL <LUN ERROR IN <SMERGE, IT MAY BE NECESSARY TO 
<CALL <BATDEF() IN YOUR CALLING PROGRAM.  <BATDEF IS A '<BLOCK <DATA 
<SUPROGRAM' OF SORTS AND THE CALL TO IT IS ONLY TO ASSURE THAT IT IS 
TASKBUILT INTO YOUR PROGRAM SO THAT IT CAN DEFINE THE VALUES
OF YOUR <LUN'S.  ^IF YOU CALL A <DATABASE ROUTINE, FOR EXAMPLE, <BATDEF WILL
AUTOMATICALLY BE INCLUDED WITHOUT SPECIAL CALLS.
.ENDNOTE
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN - ^^CALL SMERGE(NFILES,INP,NI,ISIZE,ICMP)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -9
^^NFILES\\---^YOU MUST SET THIS VARIABLE TO ZERO THE FIRST TIME 
THAT YOU CALL <SMERGE SO IT CAN SET UP FOR SUCCESSIVE MERGES.
^THE <LUN OF THE LAST WRITTEN OUTPUT FILE IS ALWAYS RETURNED IN THIS PARAMETER.
^THE FILE IS RETURNED REWOUND AND OPEN READY TO BE READ.  ^TO KEEP YOUR DISK CLEAN,
AND TO FREE UP THE <LUN FOR THE NEXT SMERGE, YOU SHOULD CALL <DELETE WITH THIS 
<LUN AS SOON AS YOU ARE DONE READING THE SORTED FILE.
.SKIP
.INDENT -9
^^INP\\------^THE NAME OF THE ARRAY THAT CONTAINS THE NEXT CORE RESIDENT BLOCK
 OF ELEMENTS TO BE SORTED.
.SKIP
.INDENT -9
^^NI\\-------^THE SIZE OF A SINGLE ELEMENT IN THE <INP ARRAY IN WORDS!
.SKIP 1
.INDENT -9
^^ISIZE\\----^THE NUMBER OF ELEMENTS IN THE <INP ARRAY.  ^THESE TWO
PARAMETERS ARE EFFECTIVELY THE DIMENSIONS OF THE INP ARRAY, THUSLY: INP(NI,ISIZE).
.SKIP 1
.INDENT -9
^^KEY\\------^THE NAME OF AN INTEGER ARRAY FOR <SMERGE TO STORE THE SORT KEYS IN.
^ON RETURNING FROM <SMERGE, THIS ARRAY WILL CONTAIN NO INFORMATION USEFUL TO YOU.
^MAKE SURE THAT KEY IS DIMENSIONED TO AT LEAST <ISIZE WORDS.
.SKIP 1
.INDENT -9
^^ICMP\\-----^THE NAME OF AN INTEGER FUNCTION (DECLARED EXTERNAL IN YOUR
CALLING PROGRAM) THAT DOES THE COMPARING (SEE <KSORT).
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^YOUR COMPARE ROUTINE AND <KSORT
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SMERGE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ ^AUGUST 78
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^LINDA ^MUNDY
.SKIP 1
.INDENT -10
.STANDARD;.FL CAPITALIZE
.TITLE <CHANGE- ^^ SUBROUTINE TO MODIFY A STRING
.PAGE
.INDENT 49
<CHANGE
.SKIP 1
.CENTER
<CHANGE- ^^SUBROUTINE TO MODIFY A STRING 
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <CHANGE\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <CHANGE SEARCHES A STRING UP TO <MAXLEN CHARACTERS LONG (SEE
<SETMAX SUBROUTINE) FOR A SUBSTRING.  ^IF THE SUBSTRING IS FOUND
IT IS REPLACED WITH THE GIVEN REPLACEMENT STRING.  ^CHANGE WILL
ALSO RETURN A POINTER TO THE FIRST CHARACTER OF THE NEW SUBSTRING
AND THE NEW LENGTH OF THE WHOLE STRING.  ^ALL STRING ARGUMENTS MUST 
BE TERMINATED BY A NULL.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN --
.SKIP
.INDENT -9
^^CALL CHANGE(STRING,FROMST,TOST,LENGTH,PNTR)\\
.SKIP
OR
.SKIP
.INDENT -9
^^PNTR=CHANGE(STRING,FROMST,TOST,LENGTH,X)\\ (5TH ARGUMENT MUST BE
INCLUDED.)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP
.INDENT -9
<STRING --^THE STRING CONTAINING CHARACTERS TO BE CHANGED.  ^MUST BE
TERMINATED BY A NULL.
.SK
.INDENT -9
<LENGTH --^THE NEW LENGTH OF <STRING AFTER CALL TO <CHANGE.  ^AN
INTEGER VARIABLE.
.SK
.INDENT -9
<FROMST --^THE STRING OF CHARACTERS TO SEARCH FOR IN <STRING.
^MUST BE TERMINATED BY A NULL.
.SK
.INDENT -9
<TOST --- ^THE STRING TO REPLACE <FROMST IN <STRING.  ^MUST BE TERMINATED
BY A NULL.
.SK
.INDENT -9
<PNTR ----^THE POINTER TO THE FIRST CHARACTER OF THE REPLACEMENT STRING 
WITHIN THE NEW MODIFIED STRING.  ^IF <FROMST WAS NOT FOUND <PNTR IS
RETURNED AS ZERO.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <POS,CONCAT,SETMAX
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FLECS
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CHANGE
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.FLAGS CAPITALIZE;.STANDARD
.TITLE <CMPS - ^^COMPARE STRING FUNCTION
.PAGE
.INDENT 4
<CMPS
.SKIP 1
.CENTER
<CMPS - ^^COMPARE STRING FUNCTION
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <CMPS\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <CMPS COMPARES TWO BYTE STRINGS AND RETURNS A VERDICT OF GREATER,
EQUALS OF, LESS THAN ZERO.  ^THE STRINGS ARE SCANNED FROM LEFT TO RIGHT
UNTIL A PAIR IS FOUND WHICH ARE NOT EQUAL.  ^IF THE <ASCII VALUES OF THE TWO
BYTES IS LESS, THEN THE RESULT OF THE FUNCTION IS LESS, ETC.  ^IF NONE OF
THE CHARACTERS DIFFER, THE RESULT IS EQUAL.
.SKIP
^THE SPECIAL CHARACTER '_\' (BACKSLASH - NOT THE DIVISION OPERATOR)
IS A "WILD CARD" MATCH CHARACTER.  ^IF THIS CHARACTER OCCURS IN EITHER OF
THE STRINGS, IT ALWAYS MATCHES ANY CHARACTER IN THE OTHER STRING.
.SKIP
.LM18
^THE TWO STRINGS ARE TERMINATED BY:
.SKIP
.INDENT -4
1)    ^A NULL BYTE.
.BREAK
.INDENT -4
2)    ^THE <LEN'TH BYTE IF THE LEN ARGUMENT IS PRESENT AND
A NULL IS NOT ENCOUNTERED FIRST.
.INDENT -4
3)    ^THE <MAXLEN'TH BYTE IF THE LEN ARGUMENT IS MISSING.
(SEE THE SETMAX SUBROUTINE FOR THE DEFAULT VALUE OF MAXLEN AND HOW TO CHANGE
IT).
.INDENT -4
4)    ^TRAILING SPACES.  ^THIS IS ONLY SIGNIFICANT IF ONE OF THE STRINGS IS
TERMINATED BY A NULL.  ^IF THE OTHER STRING WAS EQUAL UP TO THAT POINT, AND
ALL THE REST OF ITS CHARACTERS ARE SPACES, THE STRINGS ARE CONSIDERED TO BE
EQUAL.
.LM10
.PAGE
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN- VERDICT=^^CMPS(STRNG1,STRNG2[,LEN])\\
.SKIP
.INDENT -10
<PARAMETERS:
.SKIP
.INDENT -10
<STRING 1-- THE FIRST STRING
.SKIP 
.INDENT -10
.SKIP
<STRING 2-- THE SECOND STRING
.SKIP
.INDENT -10
<LEN------^^THE MAXIMUM LENGTH TO SCAN THE TWO STRINGS.\\
.SKIP 
<MACRO-11 CONVENTION
.SKIP
.INDENT -5
^R0 MUST POINT TO THE FIRST CHARACTER OF THE FIRST STRING.
.INDENT -5
^R1 MUST POINT TO THE SECOND STRING.
.INDENT -5
^R2 MUST CONTAIN THE MAXIMUM LENGTH TO SCAN THE TWO STRINGS.
.SKIP
.INDENT -5
^^CALL WITH\\
.SKIP
^^JSR      PC,$CMPS\\
.SKIP
^R0 RETURNS THE VERDICT.
.BREAK
^R1 POINTS SOMEWHERE IN THE SECOND STRING OR PAST IT.
.BREAK
^R2 CONTAINS SOME NUMBER LESS THAN OR EQUAL THE VALUE BEFORE THE CALL.
.BREAK
^ALL OTHER REGISTERS ARE UNCHANGED.
.SKIP
.INDENT -9
.SK
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.LEFT MARGIN 2
.NOFILL
.SKIP
^^C GET THE LENGTH OF THIS STRING AND TAG ON A NULL
C 
	LSUB0=LEN(INPBUF) !IGNORE THE TRAILING SPACES
	INPBUF(LSUB0)=0   !TAG ON A NULL.
	IF(CMPS(INBUF,BUF,80)) 100,120,180 
	.
	.
	.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CMPS
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP0:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ 21-<MAR-78
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ NOT FORMALLY MAINTAINED.
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE COMMA - TO INSERT COMMAS INTO REAL NUMBER
.PAGE
.INDENT 50
<COMMA
.SKIP 1
.CENTER
^^COMMA - TO INSERT COMMAS INTO REAL NUMBER\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: COMMA\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^^COMMA\\ TAKES A SINGLE OR DOUBLE PRECISION FLOATING
POINT NUMBER AND RETURNS AN ^^ASCII\\ STRING (RIGHT
JUSTIFIED WITH LEADING BLANKS) REPRESENTATION
OF THE ^^F.P.\\ NUMBER WITH A COMMA EVERY 3RD DIGIT.
^THE NUMBER IS ROUNDED AND RETURNED AS A WHOLE NUMBER.
.SKIP 1
.INDENT -10
^^CALLABLE:\\FROM ^^FORTRAN--CALL COMMA (FLOTR,STR,LEN)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SKIP;.INDENT -9
^^FLOATR---T\\HE REAL NUMBER TO ENCODE INTO ^^ASCII.
.SKIP;.INDENT -9
^^STR------T\\HE ^^BYTE\\ ARRAY THAT WILL ACCEPT THE
^^ASCII\\ STRING.  ^SHOULD BE DIMENSIONED TO AT LEAST
^^LEN BYTES.\\
.SKIP;.INDENT -9
^^LEN------T\\HE LENGTH OF THE ARRAY RECIEVING THE STRING OF 
NUMERALS.  ^^LEN\\ SHOULD BE SOMEWHAT GENEREOUS TO TAKE INTO ACCOUNT
THE INSERTION OF COMMAS INTO ^^STR.\\
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^INPL
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^SEPTEMBER 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^COMMA
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60.60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE CONCAT - CONCAT
.PAGE
.INDENT 50
<CONCAT
.SKIP 1
.CENTER
^^CONCAT - CONCAT\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: CONCAT\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO CONCATENATE A SERIES OF BYTE STRINGS INTO A SINGLE ARRAY.  ^EACH
OF THE SMALLER STRINGS MUST BE TERMINATED BY A NULL.
.SKIP 1
.INDENT -10
^^CALLABLE:\\FROM <FORTRAN -- CALL <CONCAT(BIG,STR1,STR2...STRN)
.CENTER
OR <LEN=CONCAT(BIG,STR1,STR2...STRN)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SK
.INDENT -9
<BIG -----^THE ARRAY TO RECIEVE THE CONCATENATED STRINGS.
.SK;.INDENT -9
<STR1-----ONE OF THE SERIES OF STRINGS TO BE CONCATENATED INTO <BIG.
^MUST BE TERMINATED BY <NULL.
.SK;.INDENT -9
<STR2-----SAME AS <STR1.  ^ANY NUMBER OF STRINGS MAY BE CONCATENATED 
PER CALL.
.SK;.INDENT -9
<STRN-----^THE LAST STRING TO BE TACKED ON TO <BIG.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP
.LM 2
.NOFILL
 ^^BYTE STR1(4),STR2(4), BIG(10)
^^DATA STR1/'A', 'B',  'C', 0/!NOTE THE NULLS\\
^^DATA STR2/'D', 'E', 'F', 0/\\
^^L=CONCAT(BIG,STR1,STR2)\\
^WRITE (5,10)(BIG(I),I=1,L)\\
10 <FORMAT (1X,80^A1)
^^CALL EXIT\\
^END\\
.SKIP
THE RESULT:
.SKIP
<ABCDEF
.SKIP 1
.SD;.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CONCAT
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <CONV - (^^NUMBER,STRING,LENGTH[,RADIX][,FILL][,ERR])
.INDENT 50
<CONV
.SKIP 1
.CENTER
<CONV - (^^NUMBER,STRING,LENGTH[,RADIX][,FILL][,ERR])
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME:
.SKIP
.INDENT -9
^^CONV - (NUMBER,STRING,LENGTH[,RADIX][,FILL][,ERR])
.INDENT -9 <CONV(<NUMBER,STRING,LENGTH[,RADIX][,FILL][,ERR])\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^ENCODES A POSITIVE BINARY INTEGER OR MAGNATUDE INTO A STRING
USING ANY RADIX 2 THROUGH 10.  <CONV WILL LEFT-FILL WITH ANY
CHARACTER YOU SEND IN THE <FIL ARGUMENT (DEFAULT IS SPACE).
^DEFAULT RADIX IS BASE 10.  ^RETURNS 0 FOR FAILURE IF THE
NUMBER WOULD NOT FIT IN <LENGTH BYTES.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ 
.SKIP
.INDENT -9
.NOFILL
FROM <FORTRAN - <CALL(NUMBER,STRING,LENGTH[,RADIX][,FILL][,ERR])
.FILL
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -9
^^NUMBER - A \\NUMBER TO BE ENCODED
.SK;.INDENT -9
^^STRING\\ - ^THE ADDRESS OF A PLACE TO PUT THE RESULTING STRING
.SK;.INDENT -9
^^LENGTH\\ - ^THE LENGTH OF THE STRING IN BYTES\\
.SK;.INDENT -9
<RADIX ---^THE RADIX TO USE ON CONVERSION.  ^RANGE IS 2-10, DEFAULT IS 10
.SK;.INDENT -9
^^FILL\\-----^THE FILL CHARACTER TO USE ON THE STRING.  ^DEFAULT IS SPACE\\
.SK;.INDENT -9
<ERR----- ^RETURNS .TRUE.  (-1) FOR SUCCESS, .FALSE. (0) FOR FAILURE.
^AN ERROR WILL ONLY HAPPEN IF THE NUMBER DOES NOT FIT IN <'LENGTH'
^CHARACTERS.   ^ON AN ERROR RETURN, <CONV RETURNS ONLY THE LOWER
<'LENGTH' CHARACTERS OF THE RESULT. <CONV CAN BE CALLED AS A 
^FUNCTION, AND WILL RETURN <'ERR' AS ITS VALUE.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
.PAGE;.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <CONV
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <FINP - ^^ASCII TO REAL NUMBER CONVERSION ROUTINE
.PAGE
.INDENT 50
<FINP
.SKIP 1
.CENTER
<FINP - ^^ASCII TO REAL NUMBER CONVERSION ROUTINE
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <FINP\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO CONVERT A STRING OF <ASCII CHARACTERS INTO A FLOATING POINT REAL NUMBER.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ 
.SKIP
^FROM ^^FORTRAN - REAL=FINP(ARRAY,INDEX,MAXL)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP
.INDENT -9
^^ARRAY\\----^LOGICAL*1 ARRAY THAT CONTAINS THE STRING TO BE CONVERTED.
^NUMBERS CAN BE IN ALMOST ANY FORM, FROM "12   " (CONVERTS TO 12.0,
NOTE LEFT JUSTIFICATION, CAN BE RIGHT ALSO) TO "-12.34^E-3" (CONVERTS TO 0.01234)
OR JUST ABOUT ANYWHERE IN BETWEEN.  ^DECIMALS ARE ONLY NECESSARY WHERE
THEY MAKE SENSE.
.SK;.INDENT -9
^^INDEX\\----^AN INTEGER INDEX INTO <ARRAY.  ^THIS SHOULD POINT TO THE FIRST
CHARACTER THAT IS EXPECTED TO BE CONVERTED.  ^UPON RETURN, <INDEX WILL BE
UPDATED TO POINT TO THE LAST CHARACTER PROCESSED.
^IF THE NUMBER IN THE LOGICAL*1 ARRAY WAS LEFT JUSTIFIED, <INDEX WILL POINT
TO THE FIRST SPACE AFTER THE NUMBER.  ^IF THE NUMBER WAS RIGHT JUSTIFIED
IN THE ARRAY, <INDEX WILL POINT TO A CHARACTER AFTER THE LAST ONE,
EVEN IF THIS MIGHT CAUSE <INDEX TO GO OUT OF BOUNDS IN YOUR
MAIN PROGRAM.  ^IF THE NUMBER IN THE <LOGICAL*1 ARRAY WAS TERMINATED
BY A COMMA, <INDEX WILL BE RETURNED, POINTING TO THAT COMMA.  ^IF THERE WAS AN
ILLEGAL CHARACTER (AND ^CETUS HAS A LOT OF STRANGE CHARACTERS, YOU MUST ADMIT)
 IN THE STRING, <INDEX WILL BE RETURNED POINTING TO THE OFFENDING CHARACTER.
.SK;.INDENT -9
^^MAXL\\-----^THIS INTEGER VARIABLE OF VALUE TELLS <FINP THE MAXIMUM NUMBER OF
CHARACTERS TO SCAN WHEN CONVERTING A NUMBER.  ^THIS PARAMETER IS 
ABSOLUTELY NECESSARY.  ^WHEN YOU ARE READING RIGHT JUSTIFIED OR FIXED
FORMAT DATA WITH <FINP, BUT WHEN YOU ARE READING NUMBERS THAT ARE
TERMINATED BY SPACES OR A COMMA, YOU CAN JUST STICK ANY NUMBER LARGE ENOUGH
IN <MAXL TO GUARANTEE THAT THE DELIMITING CHARACTER IS FOUND.
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LM 1
.NOFILL
^^L1=LEN(STR2,32)#####!SEE THE WRITE-UP FOR THE LEN ROUTINE.
L2=LEN(STR1,32)
X=1
Y=1
RESULT=FINP(STR1,X,L1)-FINP(STR2,Y,L2)
.FILL
.LM 10
.SKIP
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <FINP
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE ^^FULDAT - DAY OF WEEK AND DATE\\
.PAGE
.INDENT 49
^^FULDAT
.CENTER
^^FULDAT - DAY OF WEEK AND DATE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: ^^FULDAT
.SKIP 1
.INDENT -10
\^PURPOSE:\\ ^^FULDAT\\ IS AN ^^INTEGER\\ FUNCTION WHICH WILL RETURN AS ITS 
FUNCTION VALUE THE NUMERICAL EQUIVALENT OF THE DAY OF THE WEEK,
I.E., A VALUE OF 1 FOR ^SUNDAY - A VALUE OF 7 FOR ^SATURDAY.
^^FULDAT\\  ALSO RETURNS THE DAY OF THE WEEK WITH THE CURRENT
DATE AS AN ^^ASCII\\ ARRAY. E.G. <SAT 02-<DEC-78
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN\\
.SK;.CENTER;  <CALL ^^FULDAT(DAY)\\
.CENTER;OR
.CENTER;<ITODAY=FULDAT(DAY)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^ARRAY\\----^A ^^BYTE\\ ARRAY DIMENSIONED TO AT LEAST 13 ^^BYTES\\.
^WILL CONTAIN THE DATE AFTER THE CALL TO ^^FULDAT.\\
.SK;.I -9
^^ITODAY\\---^THE INTEGER EQUIVALENT OF THE DAY OF THE WEEK.  1-7 FOR <SUN-SAT.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^THE ^^FORTRAN LIBRARY\\ SUBROUTINES - ^^IDATE, IABS, MOD, DATE\\
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP
.NO FILL
.LEFT MARGIN 10
	^^PROGRAM PURGE\\
^^C
C   IF TODAY IS FRIDAY AND IT IS
C   AFTER 11:00 ^^PM PURGE THE
C   ENTIRE DISK
C
    INTEGER FULDAT
    BYTE DAY (14)
    DATA MCR/1/
    X = SECONDS (0.0)
    IF (FULDAT(DAY).NE.6) CALL EXIT
    IF (X.LT.39600.) CALL EXIT
    CALL ASNLUN (1,'MC',0)
    WRITE (MCR,10)
10  FORMAT('PIP DP:[*,*]*.*/PU')
    CALL EXIT
    END
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI OF ^^CETUS\\ ^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JULY 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ OPEN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^FULDAT\\
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.FLAGS CAPITALIZE
.SD;.FLAGS CAPITALIZE
.TITLE <INPH - ^^HEXADECIMAL TO BINARY CONVERSION ROUTINE\\
.INDENT 50
<INPH
.SKIP 1
.CENTER
<INPH - ^^HEXADECIMAL TO BINARY CONVERSION ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <INPH\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <INPH ACCEPTS A STRING OF <ASCII HEXADECIMAL NUMERALS(0-8 AND
 ^A-^F) AND CONVERTS THEM TO AN INTEGER OR BINARY
MAGNITUDE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN - ^^RESULT=INPH(BUF,MAX)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -9
^^BUF------\\^THE BYTE ARRAY CONTAINING THE HEX STRING.  ^LEADING BLANKS
ARE IGNORED.  ^A TRAILING BLANK, COMMA OR PERIOD  MARK THE END OF THE STRING.
.SKIP 1
.INDENT -9
^^MAX\\------^THE MAXIMUM EXPECTED LENGTH OF THE STRING.  <INPH WILL QUIT WHEN
IT FINDS THE ^^MAX\\'TH+1 BYTE OR AN ILLEGAL HEX DIGIT.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^THE <FORTRAN LIBRARY FUNCTION <ISHFT
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS,
<CETUS <CORPORATION
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <INPH
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]<CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <INPI - <INPI(STRING[,ERR][,LEN][,I])
.PAGE
.INDENT 50
<INPI
.SKIP 1
.CENTER
<INPI - <INPI(STRING[,ERR][,LEN][,I])
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <INPI\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^DECODES A SIGNED INTEGER FROM THE STRING.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN - CALL <(STRING[,ERR][,LEN][,I])
.SKIP 1
.INDENT -10
^^PARAMETERS:
\\
.SK;.I -9
 ^^STRING\\---^THE STRING THAT IS TO BE CONVERTED FROM DECIMAL NUMBERS TO
BINARY.
.SK;.I -9
^^LEN------\\^THE MAX LENGTH OF THE STRING.  ^IF THIS PARAMETER IS MISSING
           THE STRING IS ASSUMED TO BE TERMINATED BY A ZERO BYTE.
.SK;.I -9
^^ERR\\------^A 0 (.FALSE.) IS RETURNED IN THIS PARAMETER IF THERE IS A 
           CONVERSION ERROR IN THE STRING.
.SK;.I -9
^I\\--------^ALTERNATE RETURN FOR THE RESULT IF <INPI IS CALLED AS A SUBROUTINE
           INSTEAD OF A FUNCTION.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO 11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <INPI
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS\\
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <INPL - ^^LEFT JUSTIFICATION OF A STRING
.PAGE
.INDENT 50
<INPL
.SKIP 1
.CENTER
<INPL - ^^LEFT JUSTIFICATION OF A STRING
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <INPL\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THIS INTEGER FUNCTION IS USED TO CHOP SUCCESSIVE TOKENS OUT
OF AN INPUT COMMAND LINE.  ^CHARACTERS ARE TRANSFERRED FROM <BYTE 
ARRAY ARGUMENT AND LEFT JUSTIFIED INTO AN OUTPUT ARRAY (DISCARDING
THE LAST CHARACTER - THE TERMINATOR)
.SKIP
<INPL RETURNS AS ITS FUNCTION VALUE THE <FORTRAN INTEGER INDEX THAT POINTS TO THE 
TERMINATING CHARACTER IN THE INPUT ARRAY.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN ONLY
.SKIP 1
.LM 15
.INDENT -15
^^PARAMETERS:\\
.SKIP
.INDENT -9
^^INBUF----\\^AN ARRAY OF CONTIGUOUS BYTES TO BE LEFT JUSTIFIED.
.SK;.INDENT -9
^^LEN------\\^THE MAXIMUM LENGTH TO JUSTIFY (DEFAULT IS 80)
.SK;.INDENT -9
^^OUTBUF\\---^THE OUTPUT ARRAY.  ^MUST BE AT LEAST <LEN BYTES LONG.
.SK;.INDENT -9
^^TERM-----\\^STRING OF TERMINATION CHARACTER BYTES.  ^LAST ELEMENT
              MUST BE A NULL.  ^JUSTIFICATION TERMINATES UPON THE
              OCCURANCE OF ONE OF THESE CHARACTERS IN THE INPUT 
              STRING.  ^DEFAULT IS A NULL BYTE.
.SK;.INDENT -9
^^AND------\\^A 0 OR A 1.  ^A FLAG TO INDICATE THAT INCLUSION OF THE
              STRING IN TERM IS TO BE USED FOR TERMINATION OF 
              JUSTIFICATION AND INCLUDE THE TERMINATION STRING.
<AND=0 TO TO INCLUDE TERMINATION STRING.  ^DEFAULT IS <AND=1.
.SKIP 1
.LM 10
.INDENT -10
.TEST PAGE 19
^^EXAMPLE:\\
.SKIP
.LM 2
.NOFILL
.INDENT -8
  ^^C
C	SAMPLE PROGRAM TO CHOP A
C	SENTENCE UP INTO WORDS\\
.SKIP
	^^BYTE BUF(80), TEXT(8), TERM(4)
	DATA TERM/'',',',"10,0/
10	READ(5,100)BUF
100	FORMAT(D80A1)
20	N=1
	N=N+INPL(BUF, 8, TEXT,TERM)
	IF (TEXT(1).EX.TERM(1)) GO TO 10
	WRITE (5,100) TEXT
	GO TO 20
	END
	
	
	
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^JACK MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^^JUNE 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <INPL
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ <MAY 1978
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE <JACK <MARTINELLI
.PAGE
.INDENT -10
.FLAGS CAPITALIZE
.SD;.FLAGS CAPITALIZE
.TITLE <INPH - ^^OCTAL TO BINARY CONVERSION ROUTINE\\
.INDENT 50
<INPH
.SKIP 1
.CENTER
<INPH - ^^OCTAL TO BINARY CONVERSION ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <INPH\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <INPH ACCEPTS A STRING OF <ASCII OCTAL NUMERALS (<ASCII VALUES RANGING
FROM '0'-'8') AND CONVERTS THEM TO AN INTEGER VALUE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN - ^^RESULT=INPH(BUF,MAX)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP 1
.INDENT -8
^^BUF------\\^THE BYTE ARRAY CONTAINING THE OCTAL STRING.  ^LEADING BLANKS
ARE IGNORED.  ^A TRAILING BLANK, COMMA OR PERIOD  MARK THE END OF THE STRING.
.SKIP 1
.INDENT -5
^^MAX\\------^THE MAXIMUM EXPECTED LENGTH OF THE STRING.  <INPH WILL QUIT WHEN
IT FINDS THE ^^MAX\\'TH+1 BYTE OR AN ILLEGAL OCTAL DIGIT.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^THE <FORTRAN LIBRARY FUNCTION <ISHFT
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS,
<CETUS <CORPORATION
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <INPH
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]<CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <LEN - ^^FINDING THE LENGTH OF A STRING.
.PAGE
.INDENT 50
<LEN
.SKIP 1
.CENTER
<LEN - ^^FINDING THE LENGTH OF A STRING.
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: LEN\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THE ROUTINE <LEN FINDS THE LENGTH OF A STRING.  ^THE LENGTH IS DEFINED AS
THE NUMBER OF CHARACTERS BEFORE THE FIRST NULL, THE FIRST TRAILING SPACE,
OR THE <MAX'TH CHARACTER.  <LEN SEARCHES THE FIRST <MAX CHARACTERS LOOKING FOR
THE END, BUT IF THE <MAX PRAMETER IS MISSING, <LEN SEARCHES THE FIRST <MAXLEN
CHARACTERS.  <MAXLEN DEFAULTS TO 32, AND CAN BE CHANGED BY THE <SETMAX 
SUBROUTINE.  <LEN CAN BE CALLED AS A FUNCTION, OR A SUBROUTINE
IF YOU INCLUDE THE ^L ARGUMENT.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN - CALL LEN(STRING [,MAX] [,L] ) \\
.CENTER;OR ^^L=LEN(STRING [MAX])
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.RIGHT MARGIN 40
.SKIP
.INDENT -8
^^STRING\\= ^THE STRING OF BYTES TO BE COUNTED.
.SK;.INDENT -5
<MAX=    ^THE MAXIMUM NUMBER OF BYTES TO SCAN
      IN THIS STRING.  ^THIS ARGUMENT DEFAULTS 
      TO <MAXLEN IF IT IS PRESENT.  ^MAXLEN
      DEFAULTS TO 32(BASE 10) BYTES BUT THIS CAN 
      BE CHANGED BY CALLING THE <SETMAX ROUTINE.
	
.SK;.INDENT -3
<L=       THE RETURNED LENGTH OF THE STRING.
.SKIP 1
.RIGHT MARGIN 60
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LEFT MARGIN 2
.NOFILL
^C FIND THE LENGTH OF THE FILE NAME FOR THE CALL TO <ASSIGN
^C
^^	LENGTH=LEN(NEWFIL) !FIND 1ST TRAILING BLANK\\^^
	NEWFIL(LENGTH +1)=0 !TAG ON A NULL FOR <ASSIGN
	CALL ASSIGN(HISLUN,NEWFIL) !ATTACH A LUN.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ SOME TIME AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <LEN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ <FEBUARY 1978
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <MATCH - <MATCH
.PAGE
.INDENT 50
<MATCH
.SKIP 1
.CENTER
<MATCH - <MATCH
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <MATCH\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <MATCH IS A PATTERN RECOGNITION SUBROUTINE WHICH WILL RETURN A 1 IF THE 
GIVEN STRING MATCHES THE PATTERN, A "0" IF THE MATCH FAILS.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN  CALL ^^MATCH (PATTERN,STRING[,LENGTH][,ERR])\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SK;.INDENT -9

^^PATTERN--I\\S THE STRING THAT CONTAINS THE PATTERN TO BE
COMPARED AGAINST.  ^THIS STRING MUST BE TERMINATED BY A NULL OR
SPACE FILLED.  ^ANOTHER RESTRICTION ON THIS PARAMETER IS ITS LENGTH.
^THE LENGTH MUST BE LESS THAN OR EQUAL TO THE <LENGTH PARAMETER IN 
<BYTES, OR LESS THAN OR EQUAL TO <MAXLEN (SEE <SETMAX).
.SK;.INDENT -9
^^PATTERN ELEMENTS--\\
.BREAK
^THE BACK SLASH SUBSTITUTES FOR ONE CHARACTER.  ^THE CHARACTER
MATCHED MAY BE ANYTHING BUT A NULL.
.SK;.INDENT -9
*--------^AN ASTERICK SUBSTITUTES FOR AN ENTIRE STRING OR SUB-STRING.
E.G., "*CAT" WILL MATCH "^^THE BLACK CAT".\\ AS WILL "^^THE*"\\.

.SK;.INDENT -9
^^[AEIOU]--T\\HIS PATTERN WILL ALLOW ONLY A VOWEL AT A SPECIFIED STRING
POSITION, I.E., ANY ONE OF THE CHARACTERS ENCLOSED IN BRACKETS IS 
ACCEPTABLE AT A GIVEN STRING POSITION,  E.G., ^^"TH[AEIOU]*"\\ WILL
MATCH ^^"THE BLACK CAT".\\
.SK;.INDENT -9
-........^THE MINUS SIGN PRECEEDING A CHARACTER MEANS <NOT THIS CHARACTER,
I.E., ANYTHING BUT THIS CHARACTER AT THIS POSITION, E.G.:
-^A* MEANS TO MATCH ANY STRING THAT DOES NOT START WITH "^A".
.SK;.INDENT -9
^^STRING---I\\S THE STRING THAT CONTAINS THE CHARACTERS TO BE MATCHED TO.
^THIS STRING MUST BE TERMINATED SIMILAR TO THE <PATTERN PARAMETER.  
.SKIP 2
.LM 15
.RM 55
.CENTER
<NOTE
.SKIP
^BOTH OF THE ABOVE STRINGS ARE MODIFIED TO CONTAIN A NULL TERMINATOR.  
^IF THEY DID NOT HAVE ONE ALREADY.  ^YOU MUST MAKE SURE THAT THEY
DIMENSIONED TO ENOUGH BYTES TO CONTAIN THAT EXTRA NULL.
.LM 10
.RM 60
.SK;.INDENT -9
^^LENGTH---T\\HE MAXIMUM LENGTH OF <STRING OR <PATTERN.  ^THIS PARAMETER
DEFAULTS TO <MAXLEN (SEE <SETMAX) IF OMITED.
.SK;.INDENT -9
^^ERR------T\\HE ERROR RETURN VALUE:  <ERR=0 IF PATTERN DID NOT MATCH
<ERR=1 IF PATTERN DID MATCH STRING.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <$MATCH, <LEN

.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^MARCH 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <MATCH
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE NXTKEY - KEY SEQUENCE RETRIEVAL ROUTINE
.PAGE
.INDENT 50
<NXTKEY
.SKIP 1
.CENTER
^^NXTKEY - KEY SEQUENCE RETRIEVAL ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: NXTKEY\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^^NXTKEY\\ IS USED AFTER DEFINING THE NECESSARY PARAMETERS IN
THE ^^TABLE\\ ARGUMENT TO RETRIEVE AN ELEMENT OF A KEY 
SEQUENCE.  ^A KEY MIGHT LOOK LIKE:
.SK;.I 5
  ^^SEPT-78\\ ^^BOILER BLDG-A.\\
.SK
WHICH WOULD BE AN ELEMENT OF THE ^^KEY SEQUENCE:
.SK ;.I 5
  SEPT-78 BOILER BLDG-A>^^BLDG-M\\
.SK
^EACH CALL TO ^^NXTKEY\\ WILL RETRIEVE THE LOGICAL SUCCESSOR
OF THE PREVIOUS ^^KEY\\.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN -- 
.SK;.CENTER;^^CALL NXTKEY(SCRATCH,KEY [,ERR])
.CENTER;\\OR
.CENTER;^^ERR=NXTKEY(SCRATCH,KEY [,ERR])
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT-9
^^SCRATCH\\--^BUFFER SPACE INITIALIZED BY ^^SETKEY\\ (SEE <SETKEY)\\
.SKIP;.INDENT -9
^^KEY\\------^STRING TO RECEIVE THE NEXT KEY.
.SKIP;.INDENT -9
^^ERR\\------^THE NUMBER OF SEQUENCES THAT STARTED
OVER THIS CALL.  ^WHEN ^^ERR=NFLDS\\ (SEE ^^SETKEY)\\
THE KEY SEQUENCE IS DONE.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^NXTSEQ\\
.SK;.I -10
^^EXAMPLE:\\
.SKIP
.LEFT MARGIN 2
.NO FILL
^^C
^C	^^GET THE NEXT SEQUENCE CHECK THE\\
^^C	^^DATABASE FOR EXISTENCE.\\
^C
	^^IF (^^NXTKEY(SCRAT,KEY).EQ.NFLDS)  GO TO 99
	IF (^^FNDKEY(ROOT,KEY,ERR).EQ.0)  GO TO 200
	IF (^^ERR.EQ.-1) GO TO 300
C
C----	^^FOUND IT!
C
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS ^^CETUS \\^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^NXTKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.TITLE NXTSEQ - SEQUENCE RETRIEVAL ROUTINE
.PAGE
.INDENT 50
<NXTSEQ
.SKIP 1
.CENTER
^^NXTSEQ - SEQUENCE RETRIEVAL ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: NXTSEQ\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\  ^^NXTSEQ\\ WILL RETURN THE ^TOKEN ^STRING THAT IS THE 
LOGICAL SUCCESSOR OF THE LAST ^TOKEN RETRIEVED.  ^THE
FIRST CALL TO ^^NXTSEQ\\ WILL RETURN THE BEGINNING ^TOKEN.
^THE LAST CALL RETURNS THE TERMINATING SEQUENCE. (^SEE THE
<SETSEQ DOCUMENTATION)
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--- CALL NXTSEQ(TABLE,STRING,ERR)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ .
.SKIP;.INDENT -9
^^TABLE\\----^THE SAME TABLE INITIALIZED BY ^^SETSEQ\\.
.SKIP;.INDENT -9
^^STRING\\---^A BYTE ARRAY IN WHICH THE NEXT LOGICAL TOKEN FROM
THE SEQUENCE WILL BE STORED.  ^^STRING\\ MUST BE ^^WIDTH\\
BYTES LONG.  ^SEE ^^SETSEQ\\ PARAMETERS.
.SKIP;.INDENT -9
^^ERR------ERR\\=1 SEQUENCE HAS FINISHED
^^ERR=0\\  ERROR IN SEQUENCE
^^ERR\\=-1 SUCCESSFUL RETURN.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS OF ^^CETUS\\ ^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^NXTSEQ
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE POS - POS
.PAGE
.INDENT 50
<POS
.SKIP 1
.CENTER
<POS - <POS
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: POS\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO FIND A SUBSTRING WITHIN A STRING OF BYTES.  ^THE <STRING
PARAMETER IS SEARCHED UP TO <MAXLEN BYTES.
 

 
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN (SEE <SETMAX)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\
.SK;.I -9
^^STRING\\---^THE STRING TO BE SEARCHED FOR <SUBSTR.  <STRING MUST BE
TERMINATED BY A NULL.
.SK;
.I -9
^^SUBSTR\\---^THE SUBSTRING TO HUNT FOR IN <STRING.  <SUBSTR MUST BE 
TERMINATED BY A NULL.
.SK;.I -9
^^POINTR\\---^THE <FORTRAN INDEX TO THE FIRST BYTE OF OCCURANCE OF <SUBSTR
IN <STRING.  ^IF <SUBSTR IS NOT FOUND AFTER <MAXLEN BYTES A ZERO IS 
RETURNED FOR <POINTR.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ ^ITS OBVIOUS.
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1978
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <POS
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE PRED - THE INVERSE OF THE SUCCESSOR FUNCTION.
.PAGE
.INDENT 50
<PRED
.SKIP 1
.CENTER
^^PRED - THE INVERSE OF THE SUCCESSOR FUNCTION0.
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: PRED\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^THE INVERSE OF THE SUCCESSOR FUNCTION.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ <STRING -- ^BYTE ARRAY MODIFIED IN PLACE TO LOGICAL PREDECESSOR
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^PRED 
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FL CAPITALIZE
.TITLE <RTJUST- ^^RIGHT JUSTIFING A STRING\\
.PAGE
.INDENT 49
<RTJUST
.SKIP 1
.CENTER
<RTJUST- ^^RIGHT JUSTIFING A STRING\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <RTJUST\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^RIGHT JUSTIFIES A STRING IN PLACE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN --<CALL <RTJUST(BUF,LEN)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP
.INDENT -9
<BUF --- STRING TO RIGHT JUSTIFIED
.SK;.INDENT -9
<LEN --- STRING LENGTH
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.LM 2
.SKIP 1
^^	CALL RTJUST(BUFER,10)
\\
.LM 10
.SKIP
.INDENT -10
^^AUTHOR:\\ ^ROY ^MERRILL
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\^^RTJUST\\
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:\\[60,60]^^CETUS\\
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE SETDEF - SETTING DEFAULT KEY SEQUENCES
.PAGE
.INDENT 50
<SETDEF
.SKIP 1
.CENTER
^^SETDEF - SETTING DEFAULT KEY SEQUENCES\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETDEF\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^FOR ANY KEY THE DEFUALT FOR A FIELD IS '_\_\_\_\_\_\_\'.  ^THIS
CAN BE CHANGED BY SPECIFYING THE FIELD NUMBER (MUST BE
LESS THAN OR EQUAL TO 10) AND THE NEW SEQUENCE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--CALL SETDEF(MAX,NO,STR)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^MAX------T\\HE MAXIMUM NUMBER OF SEQUENCES TO LOOK AT MUST BE 
LESS THAN OR EQUAL TO 10.
.SKIP;.INDENT -9
^^NO-------T\\HE NUMBER OF THE FIELD YOU WISH TO CHANGE.
.SKIP;.INDENT -9
^^STR------P\\OINTER TO THE STRING TO BE THE DEFAULT
SEQUENCE.  ^THIS STRING MUST BE TERMINATED BY A NULL,
AND CANNOT BE MODIFIED UNLESS YOU CHANGE THE DEFAULT 
OR STOP USING ^^SETSEQ.\\
.SKIP
^IF THERE IS NO ^^STR\\ PARAMETER THE ^^NO\\'TH SEQUENCE
IS RESET TO '_\_\_\_\_\_\_\'.  ^IF THERE IS NOT A ^^NO\\ PARAMETER
ALL OF THE ^^MAX\\'TH SEQUENCES ARE RESET TO '_\_\_\_\_\_\_\'
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^SETSEQ
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ 
.SKIP
.LEFT MARGIN 2
.NO FILL
^^C
C	CHANGE THE 8TH FIELD'S DEFAULT TO 1>99999
C
	^^CALL SETDEF(8,8,'1>99999')
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JULY 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^SETDEF
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE SETKEY - FIELD SEQUENCE DEFINITION ROUTINE
.PAGE
.INDENT 50
<SETKEY
.SKIP 1
.CENTER
^^SETKEY - FIELD SEQUENCE DEFINITION ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETKEY\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\  <SETKEY IS EQUIVALENT TO RUNNING A SERIES OF SEQUENCE DEFINITIONS ALL IN PARALLEL.
^IN A KEY DEFINITION (A STRING SENT TO <SETKEY) THE DIFFERENT SEQUENCE DEFINITIONS ARE
SEPARATED BY TABS OR SPACES.  ^THIS MEANS THAT THE SEQUENCES IN A KEY DEFINITION MAY NOT CONTAIN
SPACES OF TABS THEMSELVES.  ^ANOTHER RESTRICTION IS THE WIDTH OF ALL SEQUENCES IN A
KEY ARE ALWAYS 8 BYTES.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--\\ ^CALL ^^SETKEY(SCRATCH,KEY,MAX,ERR)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT-9
^^SCRATCH--A\\ BUFFER THAT THE KEY SEQUENCE ROUTINES USE TO STORE THEIR INDIVIDUAL
TABLES IN.  ^THIS BUFFER MUST BE DIMENSIONED
TO AT LEAST ^^NFLDS*64+2 BYTES\\.
.SKIP;.INDENT-9
^^KEY------A STRING\\ CONTAINING THE KEY SEQUENCE AS PER E.G., 
^^SETSEQ\\.  ^A KEY SEQUENCE IS DEFINED AS BEING A GROUP OF UP TO 
^^NFLDS\\ ORDINARY SEQUENCES SEPARATED BY SPACES OR TABS.  ^MULTIPLE
TABS WILL SKIP SEQUENCES AND 8 SPACES ARE EQUIVALENT TO A TAB. ^SINCE BOTH SPACES AND TABS
ARE SEPARATORS YOU SHOULD NEVER PUT A SPACE NEXT TO A TAB OR EXTRA SEQUENCES
SILL BE SKIPPED. ^AT <NXTKEY TIME SEQUENCES THAT WERE SKIPPED WILL RETURN ALL
BACKSLASHES: _\_\_\_\_\_\_\_\.
.SKIP;.INDENT -9
^^NFLDS----T\\HE NUMBER OF INDEPENDENT SEQUENCES IN THE ^^KEY.\\
.SKIP;.INDENT -9
^^ERR------\\0 = FAILURE;    -1 = SUCCESS

.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ ^^SETSEQ\\
.SKIP 1
.INDENT -10
^^EXAMPLE:\\
.SKIP
.LEFT MARGIN 2
.NO FILL
^^C	CREATE AN 8 FIELD KEY SEQUENCE
C	DEFINITION
C
	^^CALL SETKEY(SCRAT,'KEY01>KEY99
     1	EXPDA01>EXP-99 TECH-A TECH-B
     2	NO-NH4 WTIH-NH4
     3	2*(ODD EVEN)  SEPT-78'
     4	,8, ERR)
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS ^^CETUS CORP.\\
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^SETKEY
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE ^^SETMAX - SETTING DEFAULT STRING LENGTH
.PAGE
.INDENT 50
<SETMAX
.SKIP 1
.CENTER
^^SETMAX - SETTING DEFAULT STRING LENGTH
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETMAX\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^IN USING THE STRING MANIPULATION ROUTINES IN THIS LIBRARY YOU MAY WISH TO
IGNORE THE MAXIMUM LENGTH PARAMETER, I.E., USE THE DEFAULT.  ^THE DEFAULT IS 
32.  ^HOWEVER BY CALLING <SETMAX YOU CAN CHANGE THIS DEFAULT BY SPECIFYING
A NEW DEFAULT ARGUMENT TO <SETMAX.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN - ^^CALL SETMAX(\\MAXLEN)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ <MAXLEN = THE NEW DEFAULT MAXIMUM STRING LENGTH.
.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ ^^CALL SETMAX(64)
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^MIKE HIGGINS
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^MAXLEN
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE SETSEQ - SEQUENCE DEFINITION ROUTINE
.PAGE
.INDENT 50
<SETSEQ
.SKIP 1
.CENTER
^^SETSEQ - SEQUENCE DEFINITION ROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SETSEQ\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ <SETSEQ IS PART OF A GROUP OF ROUTINES FOR PARSING A SPECIAL KIND OF INPUT DATA,
CALLED SEQUENCE DEFINITONS.  ^SEQUENCE DIFINITIONS ALLOW A DATA ENTRY OPERATOR
TO AVOID REPETITIVE TYPING OF SEQUENTIAL DATA WHEN THE DATA IS GOING TO BE PARSED
BY THESE SEQUENCE ROUTINES.  ^SETSEQ IS THE ROUTINE THAT INITIALIZES PROCESSING
OF A STRING.  ^TO GET SUCCESSIVE TOKENS FROM THE SEQUENCE, SEE THE <NXTSEQ
ROUTINE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM ^^FORTRAN--
.CENTER; CALL SETSEQ(TABLE,MAX,STRING,LEN,WIDTH,ERR)
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP;.INDENT -9
^^TABLE----T\\HE BUFFER SPACE TO STORE THE PARAMETERS OF THE SEQUENCE
DEFINED BY <STRING.  ^<TABLE SHOULD BE DIMENSIONED TO AT LEAST TWICE THE SIZE IN BYTES OF THE LONGEST
STRING YOU PLAN TO PROCESS.
.SK;.I -9
^^MAX------T\\HE SIZE OF ^^TABLE\\ IN ^BYTES.
.SKIP;.INDENT -9
^^STRING---T\\HE SEQUENCE DEFINITION ARRAY.  ^THE SYNTAX FOR
A SEQUENCE IS AS FOLLOWS:
.SKIP;.INDENT -5
[^N*](_<STRING>) ^WHERE ^N IS THE NUMBER OF TIMES
TO REPEAT THE SEQUENCE OF TOKENS IN <_<STRING>. 
E.G., 3*(^A>1^A) WILL GENERATE THE SEQUENCE ^^A,B,C...Z,1A
THREE TIMES.
.SKIP;.INDENT -5
<[^N@](_<STRING>)\\  ^WHERE ^N IS THE NUMBER OF TIMES TO REPEAT EACH
TOKEN IN <_<STRING>.  E.G., 3@(^^A>1A)\\ WILL GENERATE THE
SEQUEN CE ^^A,A,A,B,B,B,C,C,C...Z,Z,Z,1A,1A,1A.\\
^NOTE THAT THE PARENS ARE MANDATORY EVEN IN SIMPLE CASES LIKE 3*(^A) OR 4@(^B).
.SKIP;.INDENT -5
^^TOKEN>TOKEN2.\\  ^THE '>' IS THE 'THROUGH' COMMAND.
^IT RETURNS ^^TOKEN1\\ THE 1ST CALL TO ^^NXTSEQ\\ THEN THE
SUCESSOR OF EACH PREVIOUS ^^TOKEN\\ UNTIL IT HAS RETURNED
TOKEN 2.  NOTE THAT NO CHECKING IS DONE TO ASSURE THAT ^^TOKEN
\\IS GREATER THAN TOKEN 2.
.SKIP;.INDENT -5
<_<^^TOKEN>_<SEPARATOR>_<TOKEN>_<SEPARATOR>_<TOKEN> W\\HERE
SEPARATOR IS SPACE, COMMA, OR TAB. 
AN EXAMPLE OF A MORE COMPLEX SEQUENCE IS:
5*((0^A1>^^OB9), 3@(AB,GG), 3*(QUALITY-CONT))\\
.SKIP;.INDENT -9
.SK;.I -5
_#^^BLANK TOKEN\\--- ^SINCE SPACES ARE TREATED AS SEPERATORS THIS CONVENTION WAS
NECESSARY TO RETURN A <BLANK TOKEN FROM <NXTSEQ.
.SK;.I -9
^^LEN------L\\ENGTH OF STRING IN BYTES.
.SKIP;.INDENT -9
^^WIDTH----T\\HE # OF BYTES IN AN ELEMENT WITHIN THE STRING. ^DEFAULT IS 8 BYTES,
NOTE THAT THIS PARAMETER DETERMINES THE SIZE OF THE STRINGS RETURNED BY
<NXTSEQ, AND THEREBY DETERMINES THE MAXIMUM SIZE OF ANY TOKEN. TOKENS WIDER THAN
WIDTH HAVE THEIR LEFT MOST BYTES DISCARDED UNTIL THEY FIT.
.SKIP;.INDENT -9
^^ERR------.TRUE.  R\\ETURNED FOR AN ERROR CONDITION..^^FALSE. W\\HEN NO ERROR.
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS ^^CETUS\\ ^CORP.
.SKIP 1
.INDENT -10
^^WRITTEN:\\ ^JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ ^^SUPERMAC
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ ^^SETSEQ
.SKIP 1
.INDENT -10
^^LIBRARY:\\ ^^DP:[60,60]CETUS
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ NONE
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS OR ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE SUCC - ^SUCCESSOR FUNCTION
.PAGE
.INDENT 50
<SUCC
.SKIP 1
.CENTER
^^SUCC - ^SUCCESSOR FUNCTION\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: SUCC\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^MODIFIES THE <STRING IN PLACE TO PRODUCE THE NEXT STRING IN A SEQUENCE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ FROM <FORTRAN
		^^CALL SUCC (STRING{,LEN})\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ ^STRING IS A BYTE ARRAY WHICH IS MODIFIED IN PLACE.
.INDENT 3
<LEN IS THE LENGTH OF THE BYTE ARRAY.  ^IF OMITTED, <MAXLEN, OR THE FIRST <NUL
.INDENT 3
BYTE DETERMINES THE LENGTH USED.

.SKIP 1
.INDENT -10
^^ROUTINES USED:\\ <LEN
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^FEATURES:\\ NONE
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
^^WRITTEN:\\ LONG AGO
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <FORTRAN
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <SUCC
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^LAST MODIFICATION:\\ LONG AGO
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI OR ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD;.FLAGS CAPITALIZE
.TITLE <XFRC - ^^CHARACTER TRANSFER SUBROUTINE\\
.PAGE
.INDENT 50
<XFRC
.SKIP 1
.CENTER
<XFRC - ^^CHARACTER TRANSFER SUBROUTINE\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <XFRC\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TRANSFERS <LEN CHARACTERS FROM <INBUF TO <OUTBUF.  <LEN DEFAULTS TO
<MAXLEN FROM THE <SETMAX ROUTINE.
.SKIP 1
.INDENT -10
^^CALLABLE:\\ ^FROM <FORTRAN -- ^^CALL XFRC(STR1,[LEN],STR2)\\
.SKIP 1
.INDENT -10
^^PARAMETERS:\\ 
.SKIP
.INDENT -9
<STR1 --- STRING FROM WHICH CHARACTERS ARE TO BE TRANSFERRED FROM.
.INDENT -9
<LEN  ---- OPTIONAL LENGTH PARAMETER.
.INDENT -9
<STR2  --- STRING WHICH WILL RECIEVE THE TRANSFERRED CHARACTERS.
.SKIP 1
.LM 10
.INDENT -10
^^ROUTINES USED:\\ NONE
.SKIP 1
.INDENT -10
^^EXAMPLE:\\ OPEN
.SKIP 1
.INDENT -10
^^AUTHOR:\\ ^^JACK MARTINELLI\\
.SKIP 1
.INDENT -10
^^WRITTEN:\\ <JUNE 1977
.SKIP 1
.INDENT -10
^^SOURCE LANGUAGE:\\ <MACRO-11
.SKIP 1
.INDENT -10
^^OBJECT MODULE NAME:\\ <XFRC
.SKIP 1
.INDENT -10
^^LIBRARY:\\ <DP:[60,60]MIKES
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ SEE ^JACK ^MARTINELLI
.SKIP 1
.INDENT -10