Category : Forth Source Code
Archive   : FPCSLICE.ZIP
Filename : FORMBLD.HLP

CB.AL Control Block Address Long.
This is a variable that holds the address long of the control
block a slice operation is going to use. Put there by SLICE>>.

CB.AL@ ( -- d ) For convenience in storing and fetching from CB.AL.
& I would like to make these constants changed with !>
CB.AL! ( d -- ) and the like.

XXXPfa Holds the pfa of the current F-VAR, F-SLI, F-LNK working with
in a SLICE>> operation.

XXXPfa! ( n -- ) For convenience in storing to XXXPfa.

SCB.BYTES Total bytes in a slice control block.
LCB.HeaderBytes Total bytes in a linked slice control block.
LCB.NodeBytes Total bytes in an lcb node.

CurrentFormPfa Holds the current form header building or working with.
Strictly for internal use.

LastLinkPfa Holds the pfa of the last F-XXX created for linking together.
Strictly for internal use.

BUMP.FORM.SIZE ( size -- ) Increments the total bytes in the form so
far when a form is being built.
Strictly for internal use.

OFFSET, ( size -- ) Compiles the offset of this F-XXX in the data segment.
The offset is a constant and doesn't change as the sturcture
changes size.
Strictly for internal use.

H-VAR-EXE> Used to specify the word to execute to get the aL of the
data segment the instance is being held in. Used at the
top level of the form structure and only used once in
each structure.

H-VAR.EXE, Compiles the base-exe cfa when the form is being built.
Strictly for internal use.

SET.LAST.LINK Points the last F-XXX built to the current one being built.
Strictly for internal use.

START-FORM Starts building a form. User word

END-FORM Finish a form.

VAR.AL (pfa -- al ) Returns the aL of the XXXpfa it's given. Given
the pfa of an F-SLI or F-LNK it returns the aL of its control block.
Intended for internal use.

F-VAR ( size -- ) Creates a field "size" bytes wide in a form. The
size specified here cannot be changed later. This is the
lowest form element.

COMPILE.SLICE.OP ( -- } slice-op' )
Compiles a slice operation in a colon definition.
Strictly for internal use.

SLICE>> ( -- } pfa'-f-sli cfa'-slice.action )
To compile or execute a slice operation in a high level word.
Syntax: SLICE>> {(l)slice to operate on} {slice operation}
i.e. SLICE>> ML.ON FIRST-USLICE

SLICE.AL (pfa -- aL )
Returns the aL of the current slice of the F-SLI pfa given to it.
Intended for internal use.

F-SLI ( default-#slices -- } header-pfa' )
Slice defining word. Creates "number" slices in the instance
when it is first created. MUST BE AT LEAST ONE!!!
Syntax: {#slices} F-SLI {new name} {of form type}
Syntax: 5 F-SLI ML.ON MLINHEADER

LINK.AL ( pfa -- aL ) Returns the aL of the current node of the F-LNK pfa given to it.
Intended for internal use.

F-LNK ( default-#slices -- } header-pfa' )
Linked slice defining word. Creates "number" linked slices in the
instance when it it first created. MUST BE AT LEAST ONE!!!
Syntax: {#lslices} F-LNK {new name} {of form type}
Syntax: 5 F-SLI MENU.ON MENUHEAD