Types defined elsewhere
Ref: TYPE = TiogaOpsDefs.Ref;
Offset: TYPE = TiogaOpsDefs.Offset;
Location: TYPE = TiogaOpsDefs.Location;
Order: TYPE = TiogaOpsDefs.Order;
WhichNodes: TYPE = TiogaOpsDefs.WhichNodes;
SelectionGrain: TYPE = TiogaOpsDefs.SelectionGrain;
WhichSelection: TYPE = TiogaOpsDefs.WhichSelection;
The preceding types are defined in TiogaOpsDefs. The "definitions" below are actually comments, included in this interface for convenience.
Ref: TYPE = REF NodeBody; -- points to a Tioga node.
Offset: TYPE = INT; -- character offset in a node. starts at zero.
Location: TYPE = RECORD [node: Ref, where: Offset];
Order: TYPE = { before, same, after, disjoint };
WhichNodes: TYPE = { root, selection };
SelectionGrain: TYPE = {point, char, word, node, branch};
WhichSelection: TYPE = { primary, secondary, feedback };
Feedback selection is provided as a mechanism for giving visible mark without changing edit selections. You can explicitly cancel it, but it will go away automatically as soon as a non-feedback selection is made in the same viewer.
Operations on/using selections
Caret Operations (for primary selection)
GetCaret:
PROC
RETURNS [loc: Location];
GoToNextCharacter:
PROC [n:
INT ← 1];
GoToNextWord:
PROC [n:
INT ← 1];
GoToNextNode:
PROC [n:
INT ← 1];
GoToPreviousCharacter:
PROC [n:
INT ← 1];
GoToPreviousWord:
PROC [n:
INT ← 1];
GoToPreviousNode: PROC [n: INT ← 1];
Edits requiring secondary selections
Transpose: PROC;
Editing applying to primary selection
InsertLineBreak:
PROC;
-- inserts a CR and then copies blanks from front of previous line
BackSpace:
PROC [n:
INT ← 1];
BackWord:
PROC [n:
INT ← 1];
DeleteNextCharacter:
PROC [n:
INT ← 1];
DeleteNextWord:
PROC [n:
INT ← 1];
InsertBrackets:
PROC [left, right:
CHAR];
MakeControlCharacter:
PROC;
UnMakeControlCharacter:
PROC;
MakeOctalCharacter:
PROC;
UnMakeOctalCharacter:
PROC;
ExpandAbbreviation:
PROC;
SaveSpanForPaste:
PROC [startLoc, endLoc: Location, grain: SelectionGrain ← char];
-- like SaveForPaste, but saves the given span rather than the selection
-- use grain = node or branch to simulate node or branch selections
-- span need not come from document currently in a viewer
Undo: PROC;
Node Editing
UnNest: PROC;
Looks
SetSelectionLooks:
PROC [which: WhichSelection ← primary];
sets the selection looks from the looks of the character next to the caret
WhichLooks:
TYPE = { caret, selection };
SetLooks:
PROC [looks:
ROPE, which: WhichLooks ← selection];
AddLooks:
PROC [looks:
ROPE, which: WhichLooks ← selection];
SubtractLooks:
PROC [looks:
ROPE, which: WhichLooks ← selection];
ClearLooks:
PROC [which: WhichLooks ← selection];
CopyLooks: PROC; -- copies looks from secondary selection to primary selection
--see LooksRead.Mesa if you need to read a lot of looks
Formats
SetFormat:
PROC [format:
ROPE, which: WhichNodes ← selection];
CaretNodeFormat:
PROC;
will delete the word to the left of the caret and make it the format of the caret node
InsertFormat:
PROC;
-- inserts the format name
CopyFormat: PROC; -- copies format from secondary selection to primary selection
Styles
SetStyle: PROC [style: ROPE, which: WhichNodes ← selection];
Searching
To search for a specified pattern, see SelectionSearch in section on Search below.
SelectMatchingBrackets: PROC [before, after: CHAR] RETURNS [found: BOOL];
NextPlaceholder:
PROC [dir: Dir ← forward, gotoend:
BOOL,
startBoundaryNode, endBoundaryNode: Ref ← NIL,
startBoundaryOffset: Offset ← 0, endBoundaryOffset: Offset ← LAST[Offset]]
RETURNS [found, wenttoend: BOOL];
If gotoend is true and doesn't find placeholder and not already at end of document,
will make point selection at end and return with found=false and wenttoend=true.
NextViewer: PROC [dir: Dir ← forward] RETURNS [found: BOOL];
Dir: TYPE = { forward, backwards };
Note The FindText, FindWord, and FindDef commands correspond to the commands on the Places menu.
FindText:
PROC [viewer: Viewer, rope:
ROPE ←
NIL, whichDir: SearchDir ← forwards
,
which: WhichSelection ← primary,
case: BOOL ← TRUE -- case => case of characters is significant -- ]
RETURNS [found: BOOL];
if rope is NIL, uses contents of primary selection instead
doesn't give user message if fails to find
which parameter determines which selection to make
FindWord:
PROC [viewer: Viewer, rope:
ROPE ←
NIL, whichDir: SearchDir ← forwards
,
which: WhichSelection ← primary,
case: BOOL ← TRUE -- case => case of characters is significant -- ]
RETURNS [found: BOOL];
FindDef:
PROC [viewer: Viewer, rope:
ROPE ←
NIL, whichDir: SearchDir ← forwards
,
which: WhichSelection ← primary,
case: BOOL ← TRUE -- case => case of characters is significant -- ]
RETURNS [found: BOOL];
Making/changing a selection
GetSelection:
PROC [which: WhichSelection ← primary]
RETURNS [
viewer: Viewer,
start, end: Location,
level: SelectionGrain,
caretBefore: BOOL,
pendingDelete: BOOL];
SelectionRoot:
PROC [which: WhichSelection ← primary]
RETURNS [root: Ref];
Returns the document root for the selection.
SetSelection:
PROC [
viewer: Viewer,
start, end: Location,
level: SelectionGrain ← char,
caretBefore: BOOL ← TRUE,
pendingDelete: BOOL ← FALSE,
which: WhichSelection ← primary];
SelectPoint:
PROC [
viewer: Viewer,
caret: Location,
which: WhichSelection ← primary];
SelectNodes:
PROC [
viewer: Viewer,
start, end: Ref,
level: SelectionGrain ← node,
caretBefore: BOOL ← TRUE,
pendingDelete: BOOL ← FALSE,
which: WhichSelection ← primary];
SelectBranches:
PROC [
viewer: Viewer,
start, end: Ref,
level: SelectionGrain ← node,
caretBefore: BOOL ← TRUE,
pendingDelete: BOOL ← FALSE,
which: WhichSelection ← primary];
SelectDocument:
PROC [
viewer: Viewer,
level: SelectionGrain ← node,
caretBefore: BOOL ← TRUE,
pendingDelete: BOOL ← FALSE,
which: WhichSelection ← primary];
SelectionError: ERROR [ec: SelectionErrorCode]; -- can be raised by the above procedures
SelectionErrorCode:
TYPE = {
IllegalViewer, -- either NIL or destroyed or no document data
IllegalNode, -- either start or end node is NIL
WrongDoc, -- start node not part of the viewer document
WrongOrder, -- start location doesn't come before end location
BadStartOffset, -- not within size of start node
BadEndOffset }; -- not within size of end node
CancelSelection:
PROC [which: WhichSelection ← primary];
GrowSelectionToBlanks:
PROC;
GrowSelectionToSomething:
PROC [left, right:
PROC [
CHAR]
RETURNS [
BOOLEAN]];
grows until procs return true.
Locking a Selection
Note: CallWithLocks, described below, is the recommended way of locking selections and documents. If for some reason you cannot use CallWithLocks, here are more primitive locking procedures.
LockSel:
PROC [which: WhichSelection ← primary];
ensures that no other process will change primary selection. same process can re-Lock several times.
UnlockSel:
PROC [which: WhichSelection ← primary];
make sure you UnlockSel as many times as you LockSel.
Operations on nodes
GetRope:
PROC [node: Ref]
RETURNS [
ROPE];
-- the contents of the node
Parent:
PROC [node: Ref]
RETURNS [Ref];
Root:
PROC [node: Ref]
RETURNS [Ref];
Next:
PROC [node: Ref]
RETURNS [Ref];
returns next sibling of n
returns NIL if n is last sibling
Previous:
PROC [node: Ref, parent: Ref ←
NIL]
RETURNS [nx: Ref];
returns previous sibling of n
returns NIL if n is first sibling
runs faster if can supply parent
StepForward:
PROC [node: Ref]
RETURNS [nx: Ref];
returns next node in standard tree walk order
StepBackward:
PROC [node: Ref, parent: Ref ←
NIL]
RETURNS [back: Ref];
returns preceeding node in standard tree walk order
FirstSibling:
PROC [node: Ref]
RETURNS [Ref];
LastSibling:
PROC [node: Ref]
RETURNS [Ref];
LastWithin:
PROC [node: Ref]
RETURNS [Ref];
returns the last node within the branch
i.e., goes to last child of last child of last child ... until no child
FirstChild:
PROC [node: Ref]
RETURNS [Ref];
LastChild:
PROC [node: Ref]
RETURNS [Ref];
ViewerDoc:
PROC [viewer: Viewer]
RETURNS [Ref];
Returns root node for a text or typescript viewer.
Searching
See NodeSearch in section on Search below
Location procedures
LocRelative:
PROC [
location: Location, count: Offset, break: NAT ← 1, skipCommentNodes: BOOL ← FALSE]
RETURNS [Location];
count is interpreted as a character offset from given location
returns <node,offset> location corresponding to count
adds in break at the end of each text node
if skipCommentNodes is true, then ignores them in walking the tree
LocOffset:
PROC [loc1, loc2: Location,
break: NAT ← 1, skipCommentNodes: BOOL ← FALSE] RETURNS [count: Offset];
returns character offset of location2 relative to location1
loc1 and loc2 can be in same node
but loc2 must not be in node before loc1 or get ERROR BadArgs
if skipCommentNodes is true, then ignores them in walking the tree
BadArgs: ERROR;
LastLocWithin:
PROC [node: Ref]
RETURNS [Location];
returns the last location within the branch
Jump:
PROC [viewer: Viewer, loc: Location];
Normalizes the viewer with respect to the indicated location. loc must be in the document already being displayed in the viewer.
Property Lists
PutProp:
PROCEDURE [n: Ref, name:
ATOM, value:
REF];
NIL is a valid value. Use RemProp to remove property. (Although GetProp will not distinguish between property value NIL and no property present, it is useful to be able to have NIL values to avoid creating garbage. Setting to NIL doesn't release the property record, so don't need to reallocate when next set to a non-NIL value.
GetProp: PROCEDURE [n: Ref, name: ATOM] RETURNS [REF];
Note: SetProp, RemProp, and MapProps are defined in TiogaExtraOps.
Text keys: persistent "addresses" for characters in text nodes
PutTextKey:
PROC [node: Ref, where: Offset, key:
REF];
Associates the key with the given offset in the text node. Key moves with the text as edits take place in the node. Key can move to new node.
GetTextKey:
PROC [node: Ref, key:
REF]
RETURNS [loc: Location];
Tells you where the key is in the node at the current time.
loc node may be different if addr has been moved
TextKeyNotFound: ERROR; -- raised by GetTextKey
Note: RemoveTextKey and MapTextKeys are defined in TiogaExtrasOps.
Looks, Formats, Styles
FetchLooks: PROC [node: Ref, index: Offset] RETURNS [ROPE];
GetFormat:
PROC [node: Ref]
RETURNS [
ROPE];
-- NIL for default
SetNodeFormat:
PROC [format:
ROPE, node: Ref];
will set format on a given node that need not be selected at the time
GetStyle:
PROC [node: Ref]
RETURNS [
ROPE];
-- NIL for default
SetNodeStyle:
PROC [style:
ROPE, node: Ref];
will set style on a given node that need not be selected at the time
Comment Property
IsComment:
PROC [node: Ref]
RETURNS [
BOOL];
SetComment:
PROC;
-- applies to all selected nodes
SetNotComment: PROC; -- applies to all selected nodes
Dirty and New bits on nodes
IsDirty:
PROCEDURE [n: Ref]
RETURNS [
BOOL];
IsNew:
PROCEDURE [n: Ref]
RETURNS [
BOOL];
ClearDirty:
PROC [n: Ref];
-- turns off the dirty bit on the node
ClearNew: PROC [n: Ref]; -- turns off the new bit on the node
Comparing order of nodes or locations in document
CompareLocOrder: PROCEDURE [loc1, loc2: Location] RETURNS [order: Order];
CompareNodeOrder: PROCEDURE [node1, node2: Ref] RETURNS [order: Order];
Locking a node
CallWithLocks:
PROC [proc:
PROC [root: Ref], root: Ref ←
NIL];
This is the recommended way to take care of locking selections and documents. This procedure locks the primary selection. If root is NIL, it gets SelectionRoot[]. Then it locks the document by calling Lock[root]. After calling proc with the root, it unlocks both the document and the selection. It also takes care of unlocking them if it sees an UNWIND signal. If root is NIL and there is no selection, it raises the error NoSelection.
NoSelection: ERROR; -- raised by CallWithLocks
If for some good reason you cannot use CallWithLocks, here are the primitive locking procedures.
Lock:
PROC [root: Ref];
ensures that no other process will edit document. same process can re-Lock several times.
Unlock:
PROC [root: Ref];
make sure you Unlock as many times as you Lock. repaints are deferred until document is unlocked.
Searching
SelectionSearch searches the document that contains the current selection, and when finished, changes the current selection. NodeSearch is not tied to, nor does it change, the selection, but starts with a specified node, and traverses the tree, returning a location if the search is successful. Both take patterns which can be created as described below.
SelectionSearch:
PROC [
pattern: Pattern, whichDir: SearchDir ← forwards, interrupt: REF BOOL ← NIL,
startBoundaryNode, endBoundaryNode: Ref ← NIL,
startBoundaryOffset: Offset ← 0, endBoundaryOffset: Offset ← LAST[Offset]]
RETURNS [found: BOOL];
startBoundaryNode and startBoundaryOffset limit how far backwards the search will go. if startBoundaryNode=NIL, search will go to start of document
endBoundaryNode and endBoundaryOffset limit how far forwards the search will go. if endBoundaryNode=NIL, search will go to end of document.
NodeSearch:
PROC [
pattern: Pattern, whichDir: SearchDir ← forwards,
startLoc, endLoc: Location, interrupt: REF BOOL ← NIL,
startBoundaryNode, endBoundaryNode: Ref ← NIL,
startBoundaryOffset: Offset ← 0, endBoundaryOffset: Offset ← LAST[Offset]]
RETURNS [found: BOOL, start, end: Location];
Similar to SelectionSearch, but doesn't change the selection. Just returns the result.
startLoc and endLoc args serve to determine where to start the search just as primary selection serves in LookForPattern. This can be used to search in documents that are not currently being displayed in a viewer.
SearchDir: TYPE = { forwards, backwards, anywhere };
CreateSimplePattern:
PROC [
target: ROPE, -- node from which to get the pattern
case: BOOL ← TRUE, -- if true, match case
literal: BOOL ← FALSE, -- if true, treat target literally rather than as a pattern
word: BOOL ← FALSE, -- if true, match words only
addBounds: BOOL ← FALSE] -- if true, add |'s to both ends of pattern
RETURNS [pattern: Pattern];
CreateGeneralPattern:
PROC [
target: Ref, -- node from which to get the pattern
text: BOOL ← TRUE, -- if true, match target text
looks: BOOL ← FALSE, -- if true, match target looks
format: BOOL ← FALSE, -- if true, match target format
style: BOOL ← FALSE, -- if true, match target style
comment: BOOL ← FALSE, -- if true, match target comment property
case: BOOL ← TRUE, -- if true, match case
literal: BOOL ← FALSE, -- if true, treat target literally rather than as a pattern
word: BOOL ← FALSE, -- if true, match words only
subset: BOOL ← TRUE, -- if true, use subset for looks test, else use equality
addBounds: BOOL ← FALSE] -- if true, add |'s to both ends of pattern
RETURNS [pattern: Pattern];
CreateSimplePattern and CreateGeneralPattern can result in MalformedPattern being raised.
MalformedPattern: ERROR [ec:PatternErrorCode];
PatternErrorCode:
TYPE = {
toobig, -- pattern too long
endquote, -- pattern ends with '
endtilda, -- pattern ends with ~
boundary, -- pattern has | inside rather than at beginning or end
missingNameEnd, -- pattern has < without matching >
unmatchedNameEnd -- pattern has > without previous <
};
Pattern:
TYPE =
REF PatternRec;
PatternRec:
TYPE = RECORD [
finder: Finder,
text: BOOLEAN,
looks: BOOLEAN,
looksExact: BOOLEAN,
word: BOOLEAN,
commentControl: CommentControl,
checkType: BOOLEAN,
type: ROPE,
checkStyle: BOOLEAN,
style: ROPE,
searchLooks: ROPE];
Finder: TYPE = REF FinderRec;
FinderRec: TYPE;
CommentControl: TYPE = { includeComments, excludeComments, commentsOnly };
Registering Command procedures
These operations let you modify and extend the standard Tioga commands or add new commands of your own. The Tioga command interpreter keeps a table mapping each command atom to a list of CommandProc's. When it is given an atom to interpret, it gets the corresponding list of command procs and calls them one-by-one until someone returns with quit=TRUE. If any command proc returns with recordAtom=TRUE, the atom will be added to the repeat list for the current edit event (and will thus be re-interpreted if the user hits Repeat).
The viewer argument to the command proc is the one passed to the interpreter which typically is the input focus viewer. For menu commands, the viewer is the one that contains the button.
CommandProc:
TYPE =
PROC [viewer: Viewer ←
NIL]
RETURNS [recordAtom: BOOL ← TRUE, quit: BOOL ← FALSE];
RegisterCommand:
PROC [name:
ATOM, proc: CommandProc, before:
BOOL ←
TRUE];
If before is true, proc goes at front of list. Else goes at end of list.
UnRegisterCommand: PROC [name: ATOM, proc: CommandProc];
Remove the proc from the list for the atom. Defined in TiogaExtraOps. Wouldn't fit here.
Interpret:
PROC [viewer: Viewer, params:
LIST
OF
REF
ANY];
this calls the Tioga interpreter.
params can be atoms or ropes.
atoms are interpreted in manner described above, ropes are inserted at the caret.
January 9, 1983 5:16 pm moved SelectPoint, LastLocWithin here. Deleted Search, Find, LocWithin.