Object Handling

4XTRA contains a group of funtions to manuipulate and enquire on the various system files. They can be divided into 3 functional areas: those which manuipulate objects; those which define groups; and enquiry functions.

oGET

		res ¬ 'file' oGET 'list'
		This is the basic retrieval function. The right argument is the list of objects or groups to be fetched into the workspace. Those marked as variables are assigned and all functions fixed.
		Special characters can be included: Ñ list contains group names not object names * only fetch objects if not already in workspace ¦ remove comments from functions
		If there is no left argument the system file assigned to the logical name 'SYSTEM' is read. The left agrument can override this to specify a particular file. The result is a matrix of the names of all objects fetched into the workspace.

oPUT

		res ¬ 'file' oPUT 'list'
		The basic replacement function. The right argument is the list of objects to write to the system file specified by the left argument.
		If there is no left argument the system file assigned to the logical name 'SYSTEM' is written to.
		The result is a matrix of the names of all objects processed and a set of messages informing the user if the object was written to file or not (giving a reason if not).
		If called directly from immediate execution the function also displays file path and name which has been updated. If the objects do not exist on the file or have no version number comment they will NOT be written.

oADD

		res ¬ 'file' oADD 'list'
		This function adds new objects to a system file. It will not write over existing objects. Otherwise it behaves in a similar fashion to oPUT,

oDEF_GRP

		res ¬ 'group name\|file' oDEF_GRP 'list'
		This function is used to alter the definition of a group held on a system file.
		The left argument is the name of an existing group, plus an optional file name seprated by a '\|' (if not supplied the system file associated with the logical name 'SYSTEM' is assumed).
		The right argument is a list of object and/or group names (groups are prefixed by 'Ñ'), which must be present on the same file as the group. The definition is redefined to the contents of the list.
		The result is a status message indicating the success or reason for failure of the attempted alteration.

oADD_GRP

		res ¬ 'group name\|file' oADD_GRP 'list'
		This function will define a new group on a system file. It has the same relationship to oDEF_GRP as oADD has to oPUT. It behaves in a similar fashion to oDEF_GRP.

oFIND

		res ¬ 'objects\|file' oFIND 'string'
		Search all objects (or the subset defined by the left argument) on the file associated with the locigal name 'SYSTEM' (or that defined by the portion of the left arguemtn after the '\|' delimiter) for occurences of the character string in the right argument.
		Displays the objects and lines where the string is encounters, returns the list of objects as a result.
		It also defines all objects containing the string into the workspace. See oSEARCH.

oDEL

		res ¬ 'file' oDEL 'list'
		Marks the objects in 'list' for deletion. If already 'deleted', reinstates them. If 'Ñ' in right argument, then process group names not object names.

oCOMP

		oCOMP 'file'
		Recreates the system file named in right argument. Removes any groups or objects marked for deletion. Regenerates files in 'best' read order.

oFORM

		res¬ '' oFORM ''
		Sub-function used by oPUT etc to format the result.

oMEMBERS

res ¬ '' oMEMBERS ''
Sub-function used by oGET to determine the members of a group

oPARSE

		res ¬ '' oPARSE ''
		Sub-function used by oGET to analyse the right argument and return the list of object names types and locations on file which are to be processed.

oREAD

		vector ¬ 'file' oREAD 'object name'
		Similar to oGET, but returns a single object as a character or numeric string rather than defining it directly into the workspace.

oCLIENT_FILE

		vector ¬ oCLIENT_FILE
		Returns the name of the client specific system file, e.g. for client Nordbanken the file name is 'SYSNORD'.

oHOLD

res ¬ 'flag' oHOLD 'list'

oWARN

res¬ '' oWARN ''

oCOMPARE

'file' oCOMPARE 'object name'

oENQ

The function returns information about the group and object cross-references on the system file. LA always pertains to the group names, RA to the object names. Four special characters are used to indicate the type of enquiry; one argument is one or two special characters only, and the other argument is a namelist. The argument containing the special characters determines the namelist which is returned: if the LA, a group namelist is returned; if the RA, an object namelist is returned.

Function oENQ, SYSTEM file enquiries.

Syntax: R LA oENQ RA

See the examples below.

R LA oENQ RA where,

R a 2 dimensional character namelist which contains no duplicates and is in alphabetical order by name. If not empty,

		col. 1 the status flag: 'd' if the entry is disabled ie, awaiting deletion from the SYSTEM file), 'e' otherwise;
		col. 2 the name type flag: 'g' (group name), 'f' (function), 'p' (tPACKed variable), 'u' (unpacked variable);
		col. 3 onwards is the group or object name.

LA a special character or a namelist of group names.

RA a special character or a namelist of object names.

The permitted special characters are:

		'?' to return the complete namelist of groups (if in LA) or objects (if in RA); this is a special case of 'È' (see below) which has been implemented to speed things up.
		'È' to return a union or common set of names;
		'Ç' to return an intersection set of names;
		'~' used with 'È' or 'Ç' to return the negation of each.

Examples: (NOTE: {namelist}, if empty, implies ALL.)

Expression

Result

'?' oENQ {namelist}

list of all group names ({namelist} ignored);

{namelist} oENQ '?'

list of all object names ({namelist} ignored).

'Ç' oENQ {namelist}

list of group names each of which refers to ALL objects in {namelist} (intersection).

'È' oENQ {namelist}

list of group names each of which refers to ANYof the objects in {namelist} (union).

'~Ç' oENQ {namelist}

list of group names each of which does not refer to ALL objects in {namelist}.

'~È' oENQ {namelist}

list of group names each of which does not refer to ANY objects in {namelist}.

{namelist} oENQ 'Ç'

list of objects which are COMMON to all groups in {namelist} (intersection).

{namelist} oENQ 'È'

list of all the objects referred to by the groups in {namelist} (union).

{namelist} oENQ '~Ç'

list of objects which are not COMMON to all groups in {namelist}.

{namelist} oENQ '~È'

list of objects which are not referred to by ANY group in {namelist}.

oCOMP_FILES_FILE

		oCOMP_FILES_FILE 'file'
		Compresses out deleted entries from the logical file names file in the same way as oCOMP cleans up system files

oMATCH_GRPS

res ¬ 'file 1' oMATCH_GRPS 'file 2'

oMATCH_WS

		res ¬ oMATCH_WS 'file'
		Compares objects in the workspace to those on the specified file. If the workspace objects are not present on the file or the object is marked as deleted on file this also counts as a difference. The result is the objects which are different, an asterisk is used to delimit the object names which are not present from those which show content differences.

oMAN

Fetchs all objects required to run oMANAGER and then invokes that function

oMANAGER

Object management routine.

oSEARCH

		res ¬ 'filter\|file' oSEARCH 'string'
		Finds objects containing string. File defaults to 'SYSTEM'. Searches all objects in file or those matching filter if present (see oNAMES below for description). String is any alpha string with logical parsing .

oMENU

		res ¬ '' oMENU ''
		Sub-function used by oMANAGER for screen display and selection.

oNAMES

		res ¬ 'file' oNAMES 'filter'
		Finds object names (or group if 'Ñ' in filter) matching filter.
		File defaults to 'SYSTEM' but can be alternative name or tie number. If the latter then the file is left tied.
		Filter is 'prefix', 'infix' or 'suffix' or combination of these with logical parsing .
		Result is new-line delimited string of names or if 'i' in filter then it is directory indices of objects.

oFILES

		res ¬ 'files' oFILES 'filter'
		Finds files containing object names (or group if 'Ñ') matching filter. Files defaults to 'SYS' prefixed files in library of fNAME 'SYSTEM'. It can be a libno or a 2d or new-line del'd list of filenames. Result is a 2d list of filenames.
		For description of filter see oNAMES above.

COMPARE_SYSTEM_FILES

res ¬ 'file 1' COMPARE_SYSTEM_FILES 'file 2'

oFIND_UNUSED

		res ¬ oFIND_UNUSED 'file'

[4xtra Features] [Overview] [Using The System] [Developers] [Administrators]