Filedef Factory

An OS program factory that creates Filedef domains

GNFDEF(0;SB,M,SB ==> c;,,,CO)

For return codes see (p2,os-factory-ret-codes).

CO(0,DIRECTORY ==>0;FILEDEF_DEFINE,FILEDEFQUERY)
DIRECTORY is a key to the root of some directory structure. At present this is a name sequence record collection.

FILEDEF_DEFINE,FILEDEFQUERY see (p2,filedef)

GNFDEF(kt; ==>x'10')

A DDNAME is a string of up to 8 printable EBCDIC characters. {These are matched with the ddname's of OS style programs.}

A .pathnames is a string of up to 256 characters. {A .pathname is a registry style name {with dots in it (registry)} that is used to consult the directory referred to by this object. The sequence of .pathnames has more than one element in it when "dataset concatenation" is involved.}

A jfcb is a 176 byte encoding of file format information.

FILEDEF_DEFINE
FILEDEF_DEFINE(0,command-image;==>rc,error-message;)
A value which is a directory name and a jfcb built from the options, becomes associated with a DDNAME. The Command-image is an EBCDIC string as follows:

<ddname> <directory-name> <options>

<ddname> is the os ddname used by the os program.

<directory-name> is the name of the object to be used by the program. It will be used to locate the key for the object in the hierarchical directory accessed by filedef.

<options> are as follows:

CLEAR To clear an existing filedef.

RECFM <os-record-format>

LRECL <number>

BLOCK <number>

KEYLEN <number>

FSQ <number>

DISP <os disposition>

CONCAT - To concatenate this object to a previous filedef for the same ddname.

Object Type options (use only one)

<none> - same as DIRECTORY

DIRECTORY - If the object is created by FILEDEF it will be created as a named record collection.

SEGMENT - If the object is created by FILEDEF it will be created as a fresh segment.

FILE - If the object is created by FILEDEF it will be created as a unnamed record collection.

TERMINAL - No key exists. The OS simulator is to use its terminal support for this file.

TAPE - either a TAPEKEY or a TAPEACCESS key is specified. The file is on a physical tape designated by the TAPEKEY {indirectly by the TAPEACCESS key}.

{ni}Some options will specify one of three types of co-routines. However co-routines will not be created by FILEDEF {where would the other end go?}.

Rc is 0 and error-message is null if the command was correct (table entry built or modified). Rc is kt+3 and error-message contains an english explanation of what is wrong if the command-image is in error (no table entry built or modified).

{ni}FILEDEF_DEFINE(1,command-image;OBJ==>rc,error-message;)
A value which is a key and a jfcb built from the options, becomes associated with a DDNAME.

Similar to the above. <object-name> is not present; OBJ has a key to the object.

FILEDEF_DEFINE(kt;==>X'410';)

FILEDEF_DEFINE(kt+4 ==>0) destroys the filedef domain

FILEDEF_QUERY
DDNAME OPERATIONS
FILEDEF_QUERY(oc,((8,DDNAME),(4,n));==>rc,JFCB;FK) Returns information from FILEDEF tables. DDNAME is the 8 character OS ddname.
If the value associated in FILEDEF with ddname is a key then FK is that key. Otherwise it is the result of accessing the associated directory with the directory name.

Order codes:

Oc=0 for object n (first = 0) of a concatenated input (directory entry must already exist),

Oc=1 for output (n must be 0, directory entry may be created).

Outcomes:
rc=0 176 byte os standard jfcb describes information from FILEDEF_DEFINE, FK is key to data source/sink.

rc=1 No filedef for that ddname exists or n exceeds the number of concatenated objects. No jfcb is returned.

rc=2 Directory entry for object does not exist (oc=0 only). The 176 byte os standard jfcb information from FILEDEF_DEFINE is returned.

rc=3 parameter error.

rc=4 Filedef was to a terminal. Only the JFCB is returned.

{arcane}{ni}There will be an operation to be invoked when a file which is a co-routine is closed, to put a key back in the directory.

{arcane}{ni}{and probably not as part of filedef}OBJECT NAME OPERATIONS
FILEDEF_QUERY(oc,object-name;==>rc;FK) Returns information from the directory associated with FILEDEF. Object-name is the path name of the directory entry starting with FILEDEF's directory.
Order codes:
Oc=10 for input, directory entry and object will not be created.

Oc=11 for output, directory entry and object may be created.

Outcomes:
rc=0 Object found, FK is key to data source/sink.

rc=1 No directory entry found.

FILEDEF_QUERY(oc,(8,ddname)[(data-set name)] ==> c,(string)) return information about the filedef command image.
Order codes
OC= 20 Return the first Command Image for the filedef with DDNAME = ddname.

OC=21 Return the Next Command image after the DDNAME, Data-Set-Name specified. "Next" may be either the next concatenated dataset or the next DDNAME in the list.

Outcomes
c=0 string is the command image.

c=1 no such command image.

FILEDEF_QUERY(kt;==>X'510';)