DIRECTORY
Atom USING [PropList],
Imager USING [Context],
Rope USING [ROPE],
TIPTypes USING [TIPTable];

ViewerClasses: CEDAR DEFINITIONS
= BEGIN

Viewer: TYPE = REF ViewerRec;
ViewerRec: TYPE = PACKED RECORD [
class: ViewerClass м NIL, -- static info for all Viewers of this class **
wx, wy: INTEGER м 0, -- position of viewer window wrt parent's client space
ww, wh: INTEGER м 0, -- size of viewer window area
cx, cy: INTEGER м 0, -- position of client space wrt window **
cw, ch: INTEGER м 0, -- size of viewer client space **
lock: Lock м [NIL, 0], -- locking information used by ViewerLocks * **
tipTable: TIPTable м NIL, -- mouse and keyboard events, initialised from class
name: Rope.ROPE м NIL, -- Viewer name, displayed in caption (optional)
file: Rope.ROPE м NIL, -- backing file name (optional)
label: Rope.ROPE м NIL, -- icon label (optional)
menu: Menu м NIL, -- copied from class; set with ViewerOps.SetMenu
icon: IconFlavor м unInit, -- picture to display when small, initialised from class
column: Column м left, -- screen space algorithm used when viewer is open
caption: BOOL м FALSE, -- viewer has a caption bar at the top
scrollable: BOOL м TRUE, -- viewer has a vertical scroll bar
hscrollable: BOOL м FALSE, -- viewer has a horizontal scroll bar
iconic: BOOL м TRUE, -- small or large representation on screen
border: BOOL м TRUE, -- viewer has a surrounding black border
newVersion: BOOL м FALSE, -- hint that the user has made new edits **
newFile: BOOL м FALSE, -- hint that a backing file does not yet exist **
visible: BOOL м TRUE, -- WMgr maintained hint for repaint use * **
offDeskTop: BOOL м FALSE, -- is viewer off of the current desktop? **
destroyed: BOOL м FALSE, -- hint that viewer has been flushed from window tree **
init: BOOL м FALSE, -- init proc call has been completed after creation * **
saveInProgress: BOOL м FALSE, -- the saveProc has been called but not yet returned **
inhibitDestroy: BOOL м FALSE, -- if TRUE then window menu will not permit destroy
guardDestroy: BOOL м FALSE, -- if TRUE then window menu will always guard destroy
paintingWedged: BOOL м FALSE, -- used to mark a viewer whose paint proc has died * **
transparentTIP: BOOL м FALSE, -- passes user input events without tip table interpretation 
spare0, spare1, spare2, spare3, spare4, spare5: BOOL м FALSE, -- spares
position: [0..256) м 0, -- icon position * **
openHeight: INTEGER м 0, -- "ideal" height hint for open viewer
link: Viewer м NIL, -- ring of linked viewers **
parent: Viewer м NIL, -- NIL if top level viewer **
sibling: Viewer м NIL, -- sibling chain **
child: Viewer м NIL, -- head of children chain **
props: Atom.PropList м NIL, -- clients can associate properties with viewers **
data: REF ANY м NIL, -- data slot for Viewer Class implementor
cursor: CursorType м none -- (see comment below)
];


ViewerClass: TYPE = REF ViewerClassRec;
ViewerClassRec: TYPE = PACKED RECORD [
flavor: ViewerFlavor м NIL, -- name of viewer's class
notify: NotifyProc м NIL, -- TIP input events parsed from tipTable
paint: PaintProc м NIL, -- called whenever the Viewer should repaint its contents
modify: ModifyProc м NIL, -- reports InputFocus changes
destroy: DestroyProc м NIL, -- called before Viewer structures freed on destroy
copy: CopyProc м NIL, -- copy data to new Viewer
set: SetProc м NIL, -- set the viewer contents
get: GetProc м NIL, -- get the viewer contents
init: InitProc м NIL, -- called on creation or reset to init client data
save: SaveProc м NIL, -- requests client to write contents to disk
scroll: ScrollProc м NIL, -- vertical scrolling
hscroll: HScrollProc м NIL, -- horizontal scrolling
caption: CaptionProc м NIL, -- display caption
adjust: AdjustProc м NIL, -- called when viewer size is changed
menu: Menu м NIL, -- template menu used for top-level viewers
tipTable: TIPTable м NIL, -- table to parse mouse & keyboard events
topDownCoordSys: BOOL м FALSE, -- TRUE => children positioned wrt top of client space
bltH: HBltRule м none, -- use blt to copy screen contents (see comment below)
bltV: VBltRule м none, -- use blt to copy screen contents (see comment below)
icon: IconFlavor м document, -- picture to display when small
cursor: CursorType м textPointer, -- standard cursor when mouse is in viewer
props: Atom.PropList м NIL
];

Menu: TYPE ~ REF MenuRec;
MenuRec: TYPE = RECORD [
lines: ARRAY MenuLine OF MenuEntry м ALL[NIL],
x, y: INTEGER м 0,
linesUsed: [0..maxMenuLines] м 1,
lineInverted: MenuLine м 0,
inverted: MenuEntry м NIL
];

maxMenuLines: NAT ~ 5;
MenuLine: TYPE = [0..maxMenuLines);

MenuEntry: TYPE = REF MenuEntryRec;
MenuEntryRec: TYPE = PRIVATE MONITORED RECORD [
link: MenuEntry м NIL,
name: Rope.ROPE,
proc: ClickProc,
width: INTEGER м 0,
xPos: INTEGER м 0,
clientData: REF ANY м NIL,
documentation: REF ANY м NIL,
fork: BOOL м TRUE,
greyed: BOOL м FALSE,
guarded: BOOL м FALSE,
guardState: GuardState м armed
];

GuardState: TYPE = { guarded, arming, armed };

TIPTable: TYPE ~ TIPTypes.TIPTable;

CursorType: TYPE ~ MACHINE DEPENDENT {
activate(0), blank(1), bullseye(2), confirm(3), crossHairsCircle(4),
ftp(5), typeKey(6), hourGlass(7), move(8), menu(9), mouseRed(10),
mouseYellow(11), mouseBlue(12), grow(13), pointDown(14), pointLeft(15),
pointRight(16), pointUp(17), questionMark(18), retry(19), scrollDown(20),
scrollLeft(21), scrollLeftRight(22), scrollRight(23), scrollUp(24),
scrollUpDown(25), textPointer(26), none(27), last(255)};

IconFlavor: TYPE ~ MACHINE DEPENDENT { -- pre-defined icons
document(0),
dirtyDocument(1),
fileCabinet(2),
tool(3),
typescript(4),
private(CARDINAL.LAST-1), -- will cause call of viewer paintProc to paint icon
unInit(CARDINAL.LAST) -- flag for unitialised icon type
};

PaintHint: TYPE = { all, client, menu, caption };

HBltRule: TYPE = { none, left, center, right };
VBltRule: TYPE = { none, top, center, bottom };
PaintRectangle: TYPE = REF PaintRectangleRec;
PaintRectangleRec: TYPE = RECORD[
x, y, w, h: INTEGER м 0
];

ViewerFlavor: TYPE = ATOM;

Lock: TYPE = RECORD [ -- process-reentrant viewer lock
process: UNSAFE PROCESS м NIL, -- current write process
count: CARDINAL м 0 -- number of locks currently granted for this viewer
];

Column: TYPE = MACHINE DEPENDENT {static(0), left(1), right(2), color(3), (CARDINAL.LAST)};


PaintProc: TYPE = PROC [self: Viewer, context: Imager.Context, whatChanged: REF, clear: BOOL] 
RETURNS [quit: BOOL м FALSE];

NotifyProc: TYPE = PROC [self: Viewer, input: LIST OF REF ANY, device: REF м NIL, user: REF м NIL, display: REF м NIL];

ModifyProc: TYPE = PROC [self: Viewer, change: ModifyAction];
ModifyAction: TYPE = {set, push, pop, kill};

DestroyProc: TYPE = PROC [self: Viewer];

CopyProc: TYPE = PROC [self, new: Viewer];

SetProc: TYPE = PROC [self: Viewer, data: REF ANY, finalise: BOOL м TRUE, op: ATOM м NIL];
GetProc: TYPE = PROC [self: Viewer, op: ATOM м NIL] RETURNS [data: REF ANY];

InitProc: TYPE = PROC [self: Viewer];

SaveProc: TYPE = PROC [self: Viewer, force: BOOL м FALSE];
SaveAborted: ERROR[error: Rope.ROPE];

ScrollProc: TYPE = PROC [self: Viewer, op: ScrollOp, amount: INTEGER, 
shift, control: BOOL м FALSE] RETURNS [top, bottom: INTEGER м LAST[INTEGER]];
ScrollOp: TYPE = {query, up, down, thumb};

HScrollProc: TYPE = PROC [self: Viewer, op: HScrollOp, amount: INTEGER, 
shift, control: BOOL м FALSE] RETURNS [left, right: INTEGER м LAST[INTEGER]];
HScrollOp: TYPE = {query, left, right, thumb};

CaptionProc: TYPE = PROC [self: Viewer, context: Imager.Context];

AdjustProc: TYPE = PROC [self: Viewer] RETURNS [adjusted: BOOL м FALSE];


MouseButton: TYPE = {red, yellow, blue};

ClickProc: TYPE = PROC [parent: Viewer, clientData: REF ANY м NIL, 
mouseButton: MouseButton м red, shift, control: BOOL м FALSE];

END.
   >  
ViewerClasses.mesa
Copyright ╙ 1985, 1986, 1987, 1989, 1991, 1992 by Xerox Corporation.  All rights reserved.
Edited by McGregor on October 26, 1982 10:07 am
Last Edited by: Maxwell, January 3, 1983 2:14 pm
Bier, November 30, 1988 5:36:16 pm PST
Pier, November 18, 1988 5:10:10 pm PST
Doug Wyatt, January 19, 1987 11:45:00 pm PST
Michael Plass, October 23, 1991 2:19 pm PDT
Willie-s, October 9, 1991 4:53 pm PDT
Christian Jacobi, February 24, 1992 5:17 pm PST

The cursor field shows the cursor type that will be used when mouse is in viewer.  If this value is "none", the cursor in viewer.class will be used instead.
Instance data for a viewer; please treat * entries as PRIVATE and ** entries as READONLY.

The bltH and bltV fields in the class request that the window package attempt to save some of the current screen contents of a viewer by moving the bits to the new viewer location (e.g. when the viewer is moved).  These rectangle that was thus saved will show up as the whatChanged parameter, as a convenience to clients that keep caches of screen contents.  Client that scale their image to fit the viewer bounding box should not use this feature.

ViewerFlavors predefined by the Viewer package include: $Label, $MessageWindow, $Button, $Container, $Rule.  Tioga implements $Text and $Typescript.
Static documents, such as the message window, may not be open/closed.
The name "color" is wrong, but it is retained for compatibility pending a cleanup.
Called by the window manager when the client should repaint the data on the screen.  The context is clipped to the client screen area.  whatChanged is just passed from the call to ViewerOps.PaintViewer, but will be NIL when the window manager requires a full repaint after moving a viewer on the screen.  clear is a hint that the client background is white, so that the client can paint on the black bits if it so chooses.  See comments for paintRectangles bit in the viewer class.  Return quit~TRUE to stop without painting children.
Input events from the class TIPTable.  Mouse events get passed whenever the mouse is over the viewer, keyboard events get passed if the viewer owns the input focus (see the InputFocus interface).  N.B.  Called at Process.priorityForeground!
Called when the input focus ownership is changing so that the client can modify things like selection feedback on the screen or private data structures and state.
Called when the viewer has been destroyed for some reason.
Copy implementor private data structures.
The op atom for SetProc and GetProc is for private client agreements to get things like selection contents or content representations other than ropes.
Called by the window manager shortly after a viewer is created so that the client can create and initialise private data structures.  Also called on the "Reset" menu command.
Requests client to save data structures on the disk.  force should only be true when called from the emergency backup code on error recovery and requests that the client consider overriding monitors or locks that might otherwise prevent saving the data.
Client scrolling and scrolling feedback.  If op is 'query' the client should return the percentage of the scrollable document at the top and bottom of the screen, or default if unknown.  If op is 'up' or 'down' then amount is number of pixels to glitch.  If op is 'thumb' then amount is percentage into document to scroll.  The shift and control information reflects the state of the shift and control keys during the up, down, and thumb ops and may be interpreted by the client as desired.
Like ScrollProc, for horizontal scrolling.
Allows client to draw caption legend.
Called whenever a viewer's size is changed.  Return adjusted~TRUE to indicate that children were rearranged; ViewerBLT will assume that a full repaint is required if adjusted=TRUE.
Mouse buttons from left to right
For menus, the parent field will contain the parent Viewer; for buttons, parent will be the button Viewer itself; mouseButton indicates how the user invoked the button or menu.  shift and control indicate the state of the shift and control keys when the menu or button was invoked.
 Э╩	ч  ХNewlineDelimiter
Ц(cedarcode) styleЩ codeЪ╧cЩKЪЬ
╧eЬOЩZKЪЭ/Щ/KЩ0KЩ&KЩ&KЩ,KЩ+KЩ%KЩ/KЩ ЧЪ╧k	Ш	KЪЬЯЬШKЪЬЯЬШKЪЬЯЬЯЬШKЪЬ	ЯЬШЧKШ KЪ╨blЬЯШ ЪЬЯШKШ ЧKЪЬЯЬЯЬШЪЬЯЬЯЬЯЬШ!KЪЬЯЬЭ/ШIKЪЬЯЬЭ6ШKKЪЬЯЬЭШ2KЪЬЯЬЭ)Ш>KЪЬЯЬЭ!Ш6KЪЬЯЬЭ/ШFKЪЬЯЬЭ4ШNKЪЬЯЬЯЬЭ/ШFKЪЬЯЬЯЬЭШ6KЪЬЯЬЯЬЭШ0KЪЬЯЬЭ0ШBKЪЬЭ8ШSKЪЬЭ2ШIKЪЬ	ЯЬЯЬЭ&Ш=KЪЬЯЬЯЬЭ#Ш<KЪЬЯЬЯЬЭ%Ш@KЪЬЯЬЯЬЭ*Ш?KЪЬЯЬЯЬЭ(Ш=KЪЬЯЬЯЬЭ+ШEKЪЬ	ЯЬЯЬЭ1ШHKЪЬ	ЯЬЯЬЭ,ШBKЪЬЯЬЯЬЭ(ЬШEKЪЬЯЬЯЬЭ8ШQKЪЬЯЬЯЬЭ8ШLKЪЬЯЬЯЬЭ7ШUKЪЬЯЬЯЬЭ3ШQKЪЬЯЬЯЬЭ5ШQKЪЬЯЬЯЬЭ7ШUKЪЬЯЬЯЬЭ=Ш[KЪЬ0ЯЬЯЬЭ	ШGKЪЬЭШ-KЪЬЯЬЭ&Ш?KЪЬЯЬЭШ0KЪЬЯЬЭШ3KЪЬЯЬЭШ*KЪЬЯЬЭШ1KЪЬЯЬЭ3ШOKЪЬЯЬЯЬЯЬЭ)Ш>KЪЬЭШ0KШKШ KЪЬЭЬЭЬLЩЬKЪЬ6ЯЬЯЬЩYKШ ЧKШ KЪЬЯЬЯЬШ'ЪЬЯЬЯЬЯЬШ&KЪЬЯЬЭШ5KЪЬЯЬЭ(ШBKЪЬЯЬЭ9ШQKЪЬЯЬЭШ7KЪЬЯЬЭ3ШOKЪЬЯЬЭШ0KЪЬЯЬЭШ.KЪЬЯЬЭШ.KЪЬЯЬЭ2ШHKЪЬЯЬЭ,ШBKЪЬЯЬЭШ/KЪЬЯЬЭШ3KЪЬЯЬЭШ.KЪЬЯЬЭ%Ш?KЪЬЯЬЭ+Ш=KЪЬЯЬЭ)ШCKЪ
ЬЯЬЯЬЭ╨ckЭ╨crЭШUKЪЬЭ6ШMKЪЬЭ6ШMKЪЬЭ Ш=KЪЬ"Э*ШLKЪЬЯШKШЧKШ KЪЬЯЬЯЬ	ШЪЬ	ЯЬЯЬШKЪ	ЬЯЬ
ЯЬЯЬЯЬШ.KЪЬЯЬШKШ!KШKЪЬЯШKШKШ ЧKЪЬЯЬШKЪЬ
ЯЬШ#KШ KЪЬЯЬЯЬШ#Ъ	ЬЯЬЯЬЯ	ЬЯЬШ/KЪЬЯЬШKЪЬЯЬШKШKЪЬЯЬШKЪЬЯЬШKЪЬЯЬЯЬЯЬШKЪЬЯЬЯЬЯЬШKЪЬЯЬЯЬШKЪЬЯЬЯЬШKЪЬ	ЯЬЯЬШKШKШKШ ЧЪЬЯЬШ.KШ ЧЪЬ
ЯЬШ#KШ ЧЪЬЯЬЯЬЯ	ЬШ&KШDKШAKШGKШIKШCKШ8KШ ЧЪЬЯЬЯЬЯ	ЬЭШ;KШKШKШKШKШKЪЬЯЬЯЬЭ4ШNKЪЬЯЬЯЬЭ!Ш7KШKШ ЧЪЬЯЬ"Ш1KЩ ЧKШ KЪЬ
ЯЬ!Ш/ЪЬ
ЯЬ!Ш/KЪЭ└Щ└KЩ ЧKЪЬЯЬЯЬШ-ЪЬЯЬЯЬШ!KЪЬЯЬШKЪЬШKШ ЧЪЬЯЬЯЬШKЪЭФЩФKШ ЧЪЬЯЬЯЬЭ Ш6KЪЬ	ЯЬЯЬЭШ7KЪЬЯЬЭ4ШHKШKШ ЧЪЬЯЬЯЬЯ	Ь+ЯЬЯЬШ[KЪЭEЩEKЩRKШ ЧKШ ЪЬЯЬЯЬ6ЯЬ	ЯЬЯЬЯЬЯЬШ|KЪЭ╫бЭ▀ЬЭ'бЭ#ЩЦKШ ЧЪЬЯЬЯЬЯЬЯЬЯЬЯЬ
ЯЬЯЬЯЬЯЬЯЬЯЬШwKЪЭЁЩЁKШ ЧKЪЬЯЬЯЬ&Ш=ЪЬЯЬШ,KЪЭвЩвKШ ЧЪЬЯЬЯЬШ(KЪЭ:Щ:KШ ЧЪЬ
ЯЬЯЬШ*KЪЭ)Щ)KШ ЧKЪЬ	ЯЬЯЬЯЬЯЬЯЬЯЬЯЬЯЬШZЪЬ	ЯЬЯЬЯЬЯЬЯЬЯЬЯЬШLKЪЭЧЩЧKШ ЧЪЬ
ЯЬЯЬШ%KЪЭоЩоKШ ЧЪ	Ь
ЯЬЯЬЯЬЯЬШ:KЪЭ¤Щ¤ЧЪЬЯЬЯЬШ%KШ ЧKЪЬЯЬЯЬ&ЯЬЯЬЯЬЯЬЯЬЯЬЯЬШФЪЬ
ЯЬШ*KЪЭъЩъKШ ЧKЪЬЯЬЯЬ'ЯЬЯЬЯЬЯЬЯЬЯЬЯЬШЦЪЬЯЬШ.KЪЭ*Щ*KШ ЧЪЬЯЬЯЬ)ШAKЪЭ%Щ%KШ ЧЪЬЯЬЯЬЯЬЯЬЯЬШHKЪЬ=ЯЬnЯЬЩ┤KШ ЧKШ ЪЬЯЬШ(KЪЬ Щ KШ ЧЪЬЯЬЯЬЯЬЯЬЯЬ3ЯЬЯЬШВKЪЬЩЩЩЧKШ KЪЯЬШЧ ЕЧ    (  8M  