<<>>
<<AdobeCommonInternal.mesa>>
<<Copyright Ó 1990, 1991, 1992 by Xerox Corporation. All rights reserved.>>
<<Philip James, March 10, 1992 2:23 pm PST>>

    DIRECTORY 
        AdobeOps USING [ARNumber, ARSystemHandle, DependsOnIndex, FieldType, SetOfARs, ToolType, QueryList],
        AdobeServer USING [StringArray],
        AdobeToolContext USING [UserContext],
        AdobeP75V2 USING [Relation],
        BasicTime USING [GMT],
        IO USING [STREAM, Value],
        PFS USING [OpenFile],
        Rope USING [ROPE],
        ViewerTools USING [SelPos];

    AdobeCommon: CEDAR DEFINITIONS = {

        Selection: TYPE = RECORD [
            num: CARDINAL,
            ropes: LIST OF Rope.ROPE
            ];
        Selections: TYPE = REF SelectionsSequence;
        SelectionsSequence: TYPE = MACHINE DEPENDENT RECORD [
            seq: PACKED SEQUENCE length: CARDINAL OF Selection
            ];

        ButtonType: TYPE = {string, bounded, number, enumerated};
        ARState: TYPE = {Normal, CheckedOut};

        DependentsSequence: TYPE = REF DependentsSequenceRec;
        DependentsSequenceRec: TYPE = MACHINE DEPENDENT RECORD [
            seq: PACKED SEQUENCE length: CARDINAL OF EnumeratedTypes
            ];

        EnumeratedTypes: TYPE = REF EnumeratedTypesRec Ź NIL;
        EnumeratedTypesRec: TYPE = RECORD [
            dependentsSequence: DependentsSequence Ź NIL,
            button: REF ANY Ź NIL,
            adjButton: REF ANY Ź NIL,
            currentHeight: CARD Ź 1,
            mainViewer: Handle Ź NIL,
            dependentOn: EnumeratedTypes Ź NIL,
            controllerOf: REF ANY Ź NIL,
            currentMenu: CARDINAL Ź 0,
            currentSelection: CARDINAL Ź 0,
            allSelections: Selections Ź NIL,
            type: AdobeOps.FieldType,
            stream: IO.STREAM Ź NIL,
            boolVal: BOOL Ź FALSE,
            maxLength: CARD Ź 0,
            defaults: ARRAY AdobeOps.ToolType OF Rope.ROPE,
            fieldNum: CARD Ź 0];

        ButtonsSeq: TYPE ~ REF ButtonSeqObject;
        ButtonSeqObject: TYPE ~ MACHINE DEPENDENT RECORD [
            seq: PACKED SEQUENCE length: CARDINAL OF EnumeratedTypes
            ];

        SystemType: TYPE = Rope.ROPE;
        SystemsList: TYPE = LIST OF SystemType;

        ButtonViewer: TYPE = RECORD [
            outer: REF ANY Ź NIL
            ];

        FieldViewer: TYPE = RECORD [
            outer: REF ANY Ź NIL,
            buttons: ButtonsSeq Ź NIL
            ];

        MessageViewer: TYPE = RECORD [
            outer: REF ANY Ź NIL,
            reportStream: IO.STREAM Ź NIL
            ];

        Box: TYPE = REF ANY;

        ReportProc: TYPE = PROCEDURE [h: Handle, format: Rope.ROPE, v1, v2, v3: IO.Value Ź [null[]]];
        AnotherToolProc: TYPE = PROCEDURE [parent: Handle Ź NIL];
        GetContentsProc: TYPE = PROCEDURE [box: Box] RETURNS [r: Rope.ROPE];
        GetSelectionContentsProc: TYPE = PROCEDURE [box: Box Ź NIL] RETURNS [r: Rope.ROPE];
        SetContentsProc: TYPE = PROCEDURE [box: Box, r: Rope.ROPE];
        SetSelectionProc: TYPE = PROCEDURE [box: Box, selection: ViewerTools.SelPos Ź NIL];
        SetDisplayStyleProc: TYPE = PROCEDURE [box: Box, style: ATOM];
        SetIconProc: TYPE = PROCEDURE [h: Handle, function: ATOM];
        AddButtonsProc: TYPE = PROCEDURE [h: Handle];
        PaintBoxProc: TYPE = PROCEDURE [box: Box, which: ATOM];
        ReLabelBoxProc: TYPE = PROCEDURE [box: Box, newLabel: Rope.ROPE];
        NewMenuEntryProc: TYPE = PROCEDURE [entryName: Rope.ROPE] RETURNS [REF ANY];
        FindMenuEntryProc: TYPE = PROCEDURE [h: Handle, entryName: Rope.ROPE] RETURNS [REF ANY];
        ReplaceMenuEntryProc: TYPE = PROCEDURE [h: Handle, menu: REF ANY, oldEntry, newEntry: REF ANY];
        InhibitEditsProc: TYPE = PROCEDURE [box: Box];
        EnableEditsProc: TYPE = PROCEDURE [box: Box];
        PopUpRequestProc: TYPE = PROCEDURE [title: Rope.ROPE, selections: LIST OF Rope.ROPE] RETURNS [INT];
        DestroyBoxProc: TYPE = PROCEDURE [h: Handle, box: Box, draw: BOOLEAN Ź TRUE];
        GetBoxGeometryProc: TYPE = PROCEDURE [box: Box] RETURNS [x, y, w, h: INT];
        SetBoxGeometryProc: TYPE = PROCEDURE [box: Box, x, y, w, h: INT, draw: BOOL Ź TRUE];
        NewFieldBoxProc: TYPE = PROCEDURE [parent: Box, x, y, w, h: INT, scrollable: BOOL Ź TRUE, border: BOOL Ź FALSE] RETURNS [b: Box];
        NewLabelBoxProc: TYPE = PROCEDURE [parent: Box, x, y: CARD, name: Rope.ROPE, border: BOOL Ź FALSE] RETURNS [b: Box];
        SetContainerNameProc: TYPE = PROCEDURE [box: Box, name: Rope.ROPE];
        SetMainNameProc: TYPE = PROCEDURE [box: Box, name: Rope.ROPE];
        GetMainNameProc: TYPE = PROCEDURE [box: Box] RETURNS [name: Rope.ROPE];
        MakeButtonProc: TYPE = PROCEDURE [parent: Box, x, y: CARD, name: Rope.ROPE, data: REF ANY , scrollable: BOOLEAN Ź TRUE, proc: ATOM, 
        cData: REF ANY, paint: BOOL Ź FALSE] RETURNS [b: Box];
        AssistLoginProc: TYPE = PROCEDURE;
        GetBoxNameProc: TYPE = PROCEDURE [box: Box] RETURNS [name: Rope.ROPE];
        XBoundBoxProc: TYPE = PROCEDURE [parent, box: Box];
        SetBoxScrollableProc: TYPE = PROCEDURE [box: Box];

        Handle: TYPE = REF AdobeViewerDataRec;
        AdobeViewerDataRec:    TYPE = RECORD [
            isBusy: BOOL Ź FALSE,
            outer: REF ANY Ź NIL,
            buttonViewer: ButtonViewer,
            messageViewer: MessageViewer,
            fieldViewer: FieldViewer,
            menu: REF ANY,
            <<Menus.Menu _ NIL,>>
            tool, oldtool: AdobeOps.ToolType Ź edit,
            knownSystems: SystemsHandle, --SystemsList Ź NIL,
            system, oldsystem: CARDINAL Ź LAST[CARDINAL],
            systemName: Rope.ROPE Ź NIL,
            unboundFieldHeight: CARD Ź 3,
        <<newSystem: LONG STRING _ NIL,>>
        <<system, oldsystem: SystemType _ NIL,>>
            systemHandle: AdobeOps.ARSystemHandle Ź NIL,
            systemMenuItem: REF ANY,
            <<Menus.MenuEntry _ NIL,>>
            currentAR, oldCurrentAR: CARDINAL Ź 0,
            currentARState: ARState Ź Normal,
        <<lastButton: ViewerClasses.Viewer _ NIL,>>
            useQLButton, overwriteButton, formatButton: REF ANY Ź NIL,
            controlButtons: ControlSeq Ź NIL,
            editors: ARRAY[1..4] OF REF ANY Ź ALL[NIL],
            context: AdobeToolContext.UserContext Ź NIL,
            ARFile: PFS.OpenFile Ź NIL,
            instanceData: REF ANY Ź NIL,
            report: ReportProc,
            getContents: GetContentsProc,
            getSelectionContents: GetSelectionContentsProc,
            setContents: SetContentsProc,
            setSelection: SetSelectionProc,
            setDisplayStyle: SetDisplayStyleProc,
            setIcon: SetIconProc,
            addButtons: AddButtonsProc,
            paintBox: PaintBoxProc,
            popUpRequest: PopUpRequestProc,
            reLabelBox: ReLabelBoxProc,
            newMenuEntry: NewMenuEntryProc,
            findMenuEntry: FindMenuEntryProc,
            replaceMenuEntry: ReplaceMenuEntryProc,
            makeAnotherTool: AnotherToolProc,
            inhibitEdits: InhibitEditsProc,
            enableEdits: EnableEditsProc,
            getBoxGeometry: GetBoxGeometryProc,
            setBoxGeometry: SetBoxGeometryProc,
            getBoxName: GetBoxNameProc,
            destroyBox: DestroyBoxProc,
            setBoxScrollable: SetBoxScrollableProc,
            xBoundBox: XBoundBoxProc,
            newFieldBox: NewFieldBoxProc,
            newLabelBox: NewLabelBoxProc,
            setContainerName: SetContainerNameProc,
            setMainName: SetMainNameProc,
            getMainName: GetMainNameProc,
            makeButton: MakeButtonProc,
            assistLogin: AssistLoginProc,
            extraData: REF ANY Ź NIL
            ];

        ControlSeq: TYPE ~ REF ControlSeqRec Ź NIL;
        ControlSeqRec: TYPE = RECORD[
            SEQUENCE len: CARD OF REF ANY];
        SystemsHandle: TYPE = REF Systems Ź NIL;
        Systems: TYPE = RECORD[
            next: CARDINAL Ź 0,
            system: REF SysList];
        SysList: TYPE = RECORD[SEQUENCE maxLength: CARDINAL OF Rope.ROPE];

        SysDescPtr: TYPE = REF SysDesc;
        SysDesc: TYPE = RECORD[
            arSH: AdobeOps.ARSystemHandle Ź NIL,
            nextNode: SysDescPtr Ź NIL];
        LockedSysDescPtr: TYPE = REF LockedPtr;
        LockedPtr: TYPE = MONITORED RECORD[
            nodePtr: SysDescPtr];

        StringArray: TYPE = AdobeServer.StringArray;

        DataHandle: TYPE = REF Data;
        Data: TYPE = RECORD [
            window: REF ANY Ź NIL,
            msgSW: REF ANY Ź NIL,
            cmdSW: REF ANY Ź NIL,
        <<deacAgent: Supervisor.SubsystemHandle,>>
        <<logonAgent: Supervisor.SubsystemHandle,>>
        <<swapAgent: Supervisor.SubsystemHandle,>>
        <<processID: PROCESS,>>
            tool: AdobeOps.ToolType Ź submit,
            knownSystems: SystemsHandle Ź NIL,
            system: CARDINAL Ź LAST[CARDINAL],
            newSystem: Rope.ROPE Ź NIL,
        <<systemMenu: Menu.Handle _ NIL,>>
            changingSystem: BOOLEAN Ź FALSE,
            isBusy: BOOLEAN Ź FALSE,
            dontCleanUp: BOOLEAN Ź FALSE,
            heap: UNCOUNTED ZONE Ź NIL,
            context: AdobeToolContext.UserContext Ź NIL,
        <<accessSession: ARAccess.Session _ NIL,>>
        <<non-specific pointer to allow other tools implemented on Adobe's>>
        <<interfaces to define their own instanceData>>
            instanceData: REF ANY Ź NIL];

        ReportFields: TYPE = REF ReportFieldsSeq;
        ReportFieldsSeq: TYPE = RECORD [
            seq: SEQUENCE length: CARDINAL OF BOOLEAN];
        OrderInfo: TYPE = REF OrderInfoObject;
        OrderInfoObject: TYPE = RECORD [
            widths: SEQUENCE length: CARDINAL OF OrderItem];
        OrderItem: TYPE = RECORD [
            flName: Rope.ROPE Ź NIL,
            flIndex: CARDINAL Ź 0,
            colWidth: CARDINAL Ź 0,
            colIndex: CARDINAL Ź 0];
        RowBuffer: TYPE = REF RowBufferRec;
        RowBufferRec: TYPE = RECORD [s: Rope.ROPE Ź NIL, next: RowBuffer Ź NIL];
        TemplateEntry: TYPE = {fixed, variable, string};
        Template: TYPE = REF TemplateObject;
        TemplateObject: TYPE = RECORD [
            next: Template Ź NIL,
            body: SELECT type: TemplateEntry FROM
            fixed => [width: CARDINAL Ź 0],
            variable => NULL,
            string => [
            s: Rope.ROPE Ź NIL, 
            suppressFieldName: BOOLEAN Ź FALSE, 
            nameStart, nameLength: CARDINAL Ź 0],
            ENDCASE];
        FormatType: TYPE = {plain, columns, template};
        SetStatus: TYPE = RECORD [runOffset, setIndex: CARDINAL];

    <<constants>>
        InitialSetStatus: SetStatus = [LAST[CARDINAL], LAST[CARDINAL]];
        ColSpace: CARDINAL = 2;

        ValidRelations: TYPE = ARRAY AdobeOps.FieldType OF Operations;
        Operations: TYPE = PACKED ARRAY AdobeP75V2.Relation OF BOOLEAN;

        validRelations: ValidRelations = [
            arId: [equal: TRUE, notEqual: TRUE, lessThan: TRUE,
            lessThanOrEqual: TRUE, greaterThan: TRUE,
            greaterThanOrEqual: TRUE, in: FALSE, notIn: FALSE],
            dateTime: [equal: TRUE, notEqual: TRUE, lessThan: TRUE,
            lessThanOrEqual: TRUE, greaterThan: TRUE,
            greaterThanOrEqual: TRUE, in: FALSE, notIn: FALSE],
            numeric: [equal: TRUE, notEqual: TRUE, lessThan: TRUE,
            lessThanOrEqual: TRUE, greaterThan: TRUE,
            greaterThanOrEqual: TRUE, in: FALSE, notIn: FALSE],
            fixedLengthString: [equal: TRUE, notEqual: TRUE, lessThan: FALSE,
            lessThanOrEqual: FALSE, greaterThan: FALSE,
            greaterThanOrEqual: FALSE, in: TRUE, notIn: TRUE],
            enumerated: [equal: TRUE, notEqual: TRUE, lessThan: FALSE,
            lessThanOrEqual: FALSE, greaterThan: FALSE,
            greaterThanOrEqual: FALSE, in: FALSE, notIn: FALSE],
            string: ALL[FALSE]];

        --procedures

        NoCredentials: ERROR;

        CatchErrors: PROCEDURE[
        h: Handle, --item: FormSW.ItemHandle, index: CARDINAL,
        --windowData: DataHandle, --proc: PROC[h: Handle]];

        EnableAdobeAborts: PROCEDURE[w: REF ANY];
        DisableAdobeAborts: PROCEDURE[w: REF ANY];

        SetFSWOrderAndDefaultFromUserFile: PROCEDURE[systemName: Rope.ROPE, arSH: AdobeOps.ARSystemHandle, server: Rope.ROPE];

        GetFullLoginName: PROCEDURE [h: Handle Ź NIL] RETURNS [loginName: Rope.ROPE];
        GetData: PROCEDURE[w: REF ANY] RETURNS [Handle];
        GetDataSW: PROCEDURE[sw: REF ANY] RETURNS [Handle];

        CreateOtherSWs: PROCEDURE[w: Handle, makeCmdSW: BOOLEAN Ź TRUE];
        DestroyOtherSWs: PROCEDURE[data: Handle, killCmdSW: BOOLEAN Ź TRUE];
        ChangeFormSW: PROCEDURE[w: REF ANY];

        PostMessage: PROCEDURE [handle: Handle, postCR: BOOL, message: Rope.ROPE];
    <<, v1, v2, v3: IO.Value _ [null[]]];>>
        PostNumber: PROCEDURE[sw: Handle, postCR: BOOLEAN, number: CARD];

        SearchKnownSysDescList: PROCEDURE[head: LockedSysDescPtr, systemName: Rope.ROPE]
        RETURNS[arSH: AdobeOps.ARSystemHandle Ź NIL];
        AddToKnownSysDescList: PROCEDURE[head: LockedSysDescPtr,
        arSH: AdobeOps.ARSystemHandle];
        DeleteSysDescList: PROCEDURE[head: LockedSysDescPtr]
        RETURNS[nilHead: LockedSysDescPtr Ź NIL];
        GetDescList: PROCEDURE RETURNS [LockedSysDescPtr];
        FindSystem: PROCEDURE[head: LockedSysDescPtr, toolData: Handle,
        systemName: Rope.ROPE, useDescList: BOOLEAN]
        RETURNS [arSH: AdobeOps.ARSystemHandle];
        AdobeTimeRope: PROCEDURE [time: BasicTime.GMT] RETURNS [timeRope: Rope.ROPE];
    <<Routine to change systems>>
        ChangeSystem: PROCEDURE [toolData: Handle, systemIndex: CARDINAL, 
        useDescList: BOOLEAN];

    <<Routines to manage known systems  >>
        LocateSystemInKnownSystems: PROCEDURE[name: Rope.ROPE,systems: SystemsHandle] RETURNS[system: CARDINAL];
        AddSystemToKnownSystems: PROCEDURE[name: Rope.ROPE, systems: SystemsHandle];
        RemoveSystemFromKnownSystems: PROCEDURE[name: Rope.ROPE, 
        systems: SystemsHandle];
        AllocateKnownSystems: PROCEDURE[oldSeq: SystemsHandle] 
        RETURNS[newSeq: SystemsHandle];

        --Procedures for QueryLists
    <<QLNameHints: Buttons.ButtonProc; --provides list of available query lists>>
        FreeHintStrings: PROCEDURE; --should work for any hint menu.
        CountARs:  PROCEDURE [set: AdobeOps.SetOfARs] 
        RETURNS [n: CARDINAL]; --counts the number of ars in a query list.
        GetNextAR: PROCEDURE[set: AdobeOps.SetOfARs, current: SetStatus]
        RETURNS[nextAR: AdobeOps.ARNumber, newStatus: SetStatus];--get next ar in query list/SetOfARs
        GetPreviousAR: PROCEDURE[set: AdobeOps.SetOfARs, current: SetStatus]
        RETURNS[nextAR: AdobeOps.ARNumber, newStatus: SetStatus];--get previous ar in query list/SetOfARs
        FindThisQL: PROCEDURE[qlName: Rope.ROPE, arSH: Handle] 
        RETURNS [qlHandle: AdobeOps.QueryList];--get queryList given name
        AndSets: PROCEDURE[set1, set2: AdobeOps.SetOfARs] 
        RETURNS [resultSet: AdobeOps.SetOfARs];--ANDs set1 and set2 and returns the resulting set
        OrSets: PROCEDURE[set1, set2: AdobeOps.SetOfARs] 
        RETURNS[resultSet: AdobeOps.SetOfARs];--ORs set1 and set2 and returns the resulting set
        AddToSet: PROCEDURE[arNum: AdobeOps.ARNumber, set: REF AdobeOps.SetOfARs,
        lastRef: CARDINAL]  RETURNS[thisRef: CARDINAL];--adds arNum to set
        GrowSet: PROCEDURE [oldSet: REF AdobeOps.SetOfARs];
        AddToOtherQLList: PROCEDURE [arSH: AdobeOps.ARSystemHandle, 
        ql: AdobeOps.QueryList];--adds ql to otherQLs of the arSH

        --Procedure to reset dependent enumerated item after item it depends on has been changed
        SetChoicesForEnumerated: PROCEDURE[--sw: Window.Handle, --windowData: Handle, itemIndex: CARDINAL, fli: AdobeOps.DependsOnIndex, 
        displayIndex: CARDINAL,
        reset: BOOLEAN];

    <<FindSystem: PROCEDURE[systemName: Rope.ROPE] RETURNS [arSH: AdobeOps.ARSystemHandle];>>

        }.