.PAGE;.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 it's 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" ection 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 - INITALIZING A NEW DATABASE FILE ROOT BLOCK\\
.PAGE
.INDENT 50
<BLDHDR
.SKIP 1
.CENTER
^^BLDHDR - INITALIZING 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 INITALIZE 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 BUFER 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 ACCEPT 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,60]CETUS
.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 DIMENTIONED 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 EXPENCE 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 ^LINHARDT, 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,60]CETUS
.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 OMMITTED, YOU 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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.SKIP 1
.INDENT -10
.SD
.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,60]CETUS
.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 RE-WRITE 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 FO 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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <DELKEY - ^^DELETES A DATABASE KEY AND ALL IT'S OFSPRING\\
.INDENT 50
<DELKEY
.SKIP 1
.CENTER
<DELKEY - ^^DELETES A DATABASE KEY AND ALL IT'S OFSPRING\\
.SKIP
.LEFT MARGIN 10
.INDENT -10
^^PURPOSE:\\ ^TO DELETE THE CURRENTLY ACTIVE  DATABASE KEY AND ALL OF
IT'S OFSPRING.
.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,60]CETUS
.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 INITALIZED 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 INITALIZE <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	;INITALIZE THE ARG LIST
	MOV	#ROOT,R4	;INITALIZE 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,60]CETUS
.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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.FILL
.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 NECESARY 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,60]CETUS
.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 ANT 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,60]CETUS
.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.
.INDENT -4
<ERR ^THE ERROR RETURN STATUS, WHERE:
.BREAK
<ERR=###0 MEANS YOU CAN'T BACKUP THAT FAR.
.BREAK
<ERR=##-1 MEANS SUCCESSFUL RETURN.
.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,60]CETUS
.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 SIBBLING 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 SIBBLINGS 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,60]CETUS
.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
DIMENTIONED 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:
.INDENT -4
<LEVTAB(1,N) ^THE TOTAL SIZE IN BYTES OF A KEY AT THE ^NTH LEVEL OF THE STRUCTURE.
.INDENT -4
<LEVTAB(2,N) ^THE SIZE OF THE SCAN SECTION OF A KEY AT THE ^N'TH LEVEL OF
THE STRUCTURE.
.INDENT -4
<LEVTAB(3,N) ^THE TYPE OF DATA STORED IN THE DATA SECTION IN THE ^N'TH LEVEL,
WHERE <0=NONE,
<1=INTEGER, <2=REAL, AND <3=ASCII.  ^THESE DATA TYPES MAY BE ^O^RED IN ANY
COMBINATION.
.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 EVER MADE IN THE WAY THAT THE DATABASE
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,60]CETUS
.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 INCRIMENTS 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 TOGEHTER 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,60]CETUS
.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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.FILL
.PAGE;.TITLE <SYNCBF - ^^UPDATES THE DISK IMMAGE 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,60]CETUS
.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 RE-USING 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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.TITLE <B$DELETEDATA - ^^INTERNAL ROUTINE TO DELETE OFSPRING\\
.PAGE
.INDENT 45
<B$DELETEDATA
.SKIP 1
.CENTER
<B$DELETEDATA - ^^INTERNAL ROUTINE TO DELETE OFSPRING\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$DELETEDATA\\
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^TO DELETE ALL THE OFSPRING 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,60]CETUS
.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 SIBBLINGS AND INITALIZE 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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.FILL
.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 SIBBLINGS 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,60]CETUS
.SKIP 1
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS
.PAGE;.TITLE <B$ALOCATE - ^^INTERNAL DATABASE ROUTINE FOR ALOCATING BLOCKS\\
.INDENT 50
<B$ALOCATE
.SKIP 1
.CENTER
<B$ALOCATE -^^INTERNAL DATABASE ROUTINE FOR ALOCATING BLOCKS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$ALOCATE
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^ALOCATES 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 ALOCATED
WAS JUST DEALOCATED RECENTLY.  ^THE DE-ALOCATED BLOCK WILL STILL BE IN CORE,
AND ALOCATE 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 DEALOCATE BLOCKS\\
.INDENT 45
<B$DEALOCATE
.SKIP 1
.CENTER
<B$DEALOCATE - ^^INTERNAL ROUTINE TO DEALOCATE BLOCKS\\
.LEFT MARGIN 10
.SKIP 1
.INDENT -10
^^ROUTINE NAME: <B$DEALOCATE
.SKIP 1
.INDENT -10
^^PURPOSE:\\ ^DEALOCATES 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 REGESTER USED TO HOLD THE ADDRESS OF THE BLOCK TO BE DEALOCATED.
.INDENT -3
<R2 ^THE LEVEL TABLE STACK POINTER.
.INDENT -3
<R1 ^SCRATCH REGESTER 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,60]CETUS
.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 INITALIZING 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,60]CETUS
.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,60]CETUS
.SKIP
.INDENT -10
^^MAINTENANCE:\\ ^SEE ^MIKE ^HIGGINS