CDDirectory.mesa (a ChipNDale module)
Copyright © 1983, 1985 by Xerox Corporation. All rights reserved.
by Christian Jacobi, 23-Aug-83
last edited Christian Jacobi, May 1, 1985 10:44:09 am PDT
DIRECTORY
Rope USING [ROPE],
CD USING [Design, ObPtr, DesignPosition, ObjectProcs];
CDDirectory: CEDAR DEFINITIONS =
BEGIN
-- directory layer
-- all object which contain other objects are supposed to be in the directory;
-- which is necessary for enumeration and for repositioning
-- calls handling the same design must be sequential, otherwise the design can be clobbered
Fetch:
PROC [design:
CD.Design, name: Rope.
ROPE]
RETURNS [found:
BOOL, object:
CD.ObPtr];
-- search for object in directory
Remove:
PROC [design:
CD.Design, name: Rope.
ROPE, expectObject:
CD.ObPtr←
NIL]
RETURNS [done:
BOOL];
-- if expectObject#NIL removes name only, iff named object=expectObject
-- if removed objects are still used, they are neither enumerated correctly anymore,
-- nor repositioned if internal objects change
Include:
PROC [design:
CD.Design, object:
CD.ObPtr,
alternateName: Rope.ROPE←NIL, fiddleName: BOOL←TRUE] RETURNS [done: BOOL];
-- it is an ERROR to include an object into several design's
-- even if it fiddles the name, it does not change the first character
Rename:
PROC [design:
CD.Design, object:
CD.ObPtr,
newName: Rope.ROPE ← NIL, fiddleName: BOOL←FALSE] RETURNS [done: BOOL];
Enumerate:
PROC [design:
CD.Design, action: EachEntryAction]
RETURNS [quit:
BOOL];
-- enumerates objects currently in directory in unspecified order
-- objects inserted/deleted during enumeration may or may not be seen
-- applies action to each object until action returns TRUE or no more objects
-- returns quit: TRUE if some action returns TRUE
EachEntryAction: TYPE = PROC [name: Rope.ROPE, ob: CD.ObPtr] RETURNS [quit: BOOL�LSE];
EnumerateChildObjects:
PROC[me:
CD.ObPtr, p: EnumerateObjectsProc, x:
REF←NIL] =
INLINE {
IF me.p.inDirectory THEN ObToDirectoryProcs[me].enumerateChildObjects[me, p, x]
};
Name:
PROC[me:
CD.ObPtr]
RETURNS [Rope.
ROPE] =
INLINE {
RETURN [IF me.p.inDirectory THEN ObToDirectoryProcs[me].name[me] ELSE NIL]
};
Another:
PROC [me:
CD.ObPtr, from, to:
CD.Design]
RETURNS [
CD.ObPtr]
;
--CAUTION: goes only one Layer deep; caller MUST go down the hierachy and
--replace children if from#to; name might change due to conflicts
Expand:
PROC [me:
CD.ObPtr, from, to:
CD.Design]
RETURNS [
CD.ObPtr];
--May succeed or not, returns NIL if no success;
--returned object is of expand-simpler object class (half ordered); but
-- it will generate exactly the same mask.
--When "me" later changes, this has no influence on result;
--Each call delivers a new copy of result
--goes only one Layer deep; caller MUST go down the hierachy and
--replace children if from#to; name might change due to conflicts
ExpandHard:
PROC [me:
CD.ObPtr, from, to:
CD.Design]
RETURNS [
CD.ObPtr]
;
--calls Expand first, but if doesn't succeed and makes sense it calls ExpandByDraw
ExpandByDraw:
PROC [me:
CD.ObPtr, from, to:
CD.Design]
RETURNS [
CD.ObPtr];
--does not check environment dependency or inDirectory
-- implementation of compound objects
DirectoryProcs:
TYPE =
PRIVATE RECORD [
name: RopeProc,
enumerateChildObjects: EnumerateChildObjectsProc,
--at least once, but eventualy duplications; only its immediate childs or
--descendants as soon as it is included in directory,
replaceDirectChilds: ReplaceDChildsProc,
another: AnotherProc,
--may be defaulted:
--results in crazy another proc which makes a copy of the object-definition
expand: AnotherProc, --may be defaulted
setName: SetRopeProc, -- but name must be same as Include used
includeEtAll: IncludeEtAllProc
];
ObToDirectoryProcs:
PRIVATE PROC [ob:
CD.ObPtr]
RETURNS [
REF DirectoryProcs] =
INLINE {
RETURN [NARROW[ob.p.directoryProcs, REF DirectoryProcs]]
};
InstallDirectoryProcs:
PRIVATE
PROC [type:
REF CD.ObjectProcs]
RETURNS [
REF DirectoryProcs];
--and set type.inDirectory
--objects which are in the directory must not cause drawing with a context directly
EnumerateChildObjectsProc: TYPE = PROC [me: CD.ObPtr, p: EnumerateObjectsProc, x: REF];
EnumerateObjectsProc: TYPE = PROC [me: CD.ObPtr, x: REF];
RopeProc: TYPE = PROC [me: CD.ObPtr] RETURNS [Rope.ROPE];
SetRopeProc: TYPE = PROC [me: CD.ObPtr, r: Rope.ROPE];
IncludeEtAllProc: TYPE = PROC [me: CD.ObPtr, design: CD.Design, name: Rope.ROPE];
ReplaceList: TYPE = LIST OF REF ReplaceRec;
ReplaceRec:
TYPE =
RECORD [
old: CD.ObPtr,
oldSize: CD.DesignPosition, -- never changed
new: CD.ObPtr,
newSize: CD.DesignPosition, -- will be computed once before calling client procedures
off: CD.DesignPosition
];
ReplaceDChildsProc:
TYPE =
PROC [
me: CD.ObPtr,
design: CD.Design,
replace: ReplaceList
] RETURNS [changed: BOOL←FALSE];
AnotherProc: TYPE = PROC[me: CD.ObPtr, from, to: CD.Design] RETURNS [CD.ObPtr];
RepositionObject:
PROC [design:
CD.Design,
ob: CD.ObPtr,
oldSize: CD.DesignPosition,
baseOff: CD.DesignPosition←[0, 0]
];
--CHANGES THE OBJECT !
--all over in the design tries to reposition ob;
--may be delayed;
--does notify Event $reposition; x of type ReplaceRec
ReplaceObject:
PROC [design:
CD.Design,
old: CD.ObPtr,
new: CD.ObPtr,
off: CD.DesignPosition←[0, 0]
];
--all over in the design replace old by new
--may be delayed
DoReplaceDirectChild: ReplaceDChildsProc;
PropagateChange:
PROC [ob:
CD.ObPtr, design:
CD.Design];
-- processes an CDEvent $AfterChange
END.