UN_UniGraph.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UN_UniGraph.h ( UN Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UN_UniGraph_h__
#define __UN_UniGraph_h__

#include "UN_API.h"
#include "UN_GraphData.h"
#include "UN_Node.h"
#include "UN_Port.h"
#include "UN_UniInclude.h"
#include <UNI/UNI_GraphHandle.h>

class UN_Category;
class UN_PortType; 
class UNI_Category;
class UNI_Manager;

// ============================================================================
class UN_API UN_UniGraph : public UNI_Graph
{
protected:
    /// Constructor.
    UN_UniGraph();

    /// Sets the graph data. 
    /// Must be called in the sub-class constructor,
    /// or at least before calling any of the methods.
    void            setGraphData( UN_GraphData *graph_data )
                        { myGraphData = graph_data; }

public:
    /// Graph APIs:
    UT_StringHolder name() const override;
    bool            isEmpty() const override;
    UNI_WireStyle   wireStyle() const override;
    void            setWireStyle(UNI_WireStyle wire_style) override;

    bool            isValid( UNI_NodeID node_id ) const override;
    bool            isValid( UNI_PortID port_id ) const override;
    bool            isValid( UNI_WireID wire_id ) const override;
    bool            isValid( UNI_StickyNoteID sticky_note_id ) const override;

    /// Node APIs:
    UNI_NodeID      rootNode() const override;
    UT_StringHolder name( UNI_NodeID node_id ) const override;
    UT_StringHolder path( UNI_NodeID node_id ) const override;
    UT_StringHolder categoryName( UNI_NodeID node_id ) const override;
    UT_StringHolder typeName( UNI_NodeID node_id ) const override;
    UT_StringHolder signatureName( UNI_NodeID node_id ) const override;
    bool            isMultiSignature( UNI_NodeID node_id ) const override;
    UT_Array<UNI_Signature> signatures( UNI_NodeID node_id,
                        bool compatible_only,
                        bool force_include_current ) const override;
    UT_StringHolder helpURL( UNI_NodeID node_id ) const override;

    UNI_NodeID      parentNode( UNI_NodeID node_id ) const override;
    bool            isSubnet( UNI_NodeID node_id ) const override;
    bool            isEditable( UNI_NodeID node_id ) const override;
    bool            isEditableSubnet( UNI_NodeID parent_id ) const override;
    UNI_NodeIDList  childNodes( UNI_NodeID node_id ) const override;
    UNI_NodeID      findNode( UNI_NodeID from_id,
                        const UT_StringRef &path) const override;

    bool            isValidName(const UT_StringRef &name) const override;
    bool            isNameInUse(UNI_NodeID parent_id,
                        const UT_StringRef &name) const override;
    UT_StringHolder findUniqueName(UNI_NodeID parent_id,
                        const UT_StringHolder &name) const override;

    UT_Vector2D     position( UNI_NodeID node_id ) const override;
    UT_Color        color( UNI_NodeID node_id ) const override;
    UT_StringHolder iconName( UNI_NodeID node_id ) const override;
    UT_StringHolder comment( UNI_NodeID node_id ) const override;
    UT_StringArray  tags( UNI_NodeID node_id ) const override;
    UT_StringHolder parmDialogScript( UNI_NodeID node_id ) const override;
    UNI_ParmValue   parmValue( UNI_NodeID node_id,
                        const UT_StringRef &parm_name ) const override;
    bool            parmOverriddenByConnection( UNI_NodeID node_id,
                        const UT_StringRef &parm_name ) const override;

    int             numberOfInputPorts( UNI_NodeID node_id ) const override;
    UNI_PortIDList  inputPorts( UNI_NodeID node_id ) const override;
    UNI_PortID      inputPort( UNI_NodeID node_id, 
                        int port_index ) const override;
    int             findInputPortIndex( UNI_NodeID node_id, 
                        UNI_PortID port_id ) const override;

    int             numberOfOutputPorts( UNI_NodeID node_id ) const override;
    UNI_PortIDList  outputPorts( UNI_NodeID node_id ) const override;
    UNI_PortID      outputPort( UNI_NodeID node_id, 
                        int port_index ) const override;
    int             findOutputPortIndex( UNI_NodeID node_id, 
                        UNI_PortID port_id ) const override;

    bool            hasDynamicPorts( UNI_NodeID node_id ) const override;

    bool            wireDirectlyToContainer() const override;
    UT_Vector2D     containerConnectPosition( UNI_NodeID parent_id,
                        UNI_ContainerConnectType contype ) const override;
    UT_Color        containerConnectColor( UNI_NodeID parent_id,
                        UNI_ContainerConnectType contype ) const override;

    /// Port APIs:
    UNI_NodeID      ownerNode( UNI_PortID port_id ) const override;
    UNI_PortKind    portKind( UNI_PortID port_id ) const override;
    bool            portAcceptsSubPorts( UNI_PortID port_id ) const override;
    bool            portIsSubPort( UNI_PortID port_id ) const override;
    UNI_PortID      outerPort( UNI_PortID port_id ) const override;
    UNI_PortIDList  subnetOutputPorts( UNI_PortID port_id ) const override;
    UNI_PortIDList  subnetInputPorts( UNI_PortID port_id ) const override;
    UT_StringHolder name( UNI_PortID port_id ) const override;
    bool            canSetName( UNI_PortID port_id ) const override;
    UT_StringHolder label( UNI_PortID port_id ) const override;
    UT_StringHolder typeName( UNI_PortID port_id ) const override;
    UT_StringHolder colorName( UNI_PortID port_id ) const override;
    UNI_PortShape   shape( UNI_PortID port_id ) const override;

    /// Wire APIs:
    UNI_WireIDList  childWires( UNI_NodeID node_id ) const override;
    UNI_PortID      srcPort( UNI_WireID wire_id ) const override;
    UNI_PortID      dstPort( UNI_WireID wire_id ) const override;
    UNI_WireIDList  srcWires( UNI_PortID port_id ) const override;
    UNI_WireIDList  dstWires( UNI_PortID port_id ) const override;

    /// Sticky note APIs:
    UNI_StickyNoteIDList childStickyNotes( UNI_NodeID parent_id) const override;
    UNI_StickyNoteID findStickyNote( UNI_NodeID from_id,
                        const UT_StringRef &path) const override;
    UT_StringHolder name( UNI_StickyNoteID note_id ) const override;
    UT_StringHolder path( UNI_StickyNoteID note_id ) const override;
    UNI_NodeID      ownerNode( UNI_StickyNoteID note_id ) const override;
    UT_StringHolder text( UNI_StickyNoteID note_id ) const override;
    UT_Color        textColor( UNI_StickyNoteID note_id ) const override;
    float           textSize( UNI_StickyNoteID note_id ) const override;
    UT_Color        color( UNI_StickyNoteID note_id ) const override;
    UT_Vector2D     position( UNI_StickyNoteID note_id ) const override;
    UT_Vector2D     size( UNI_StickyNoteID note_id ) const override;
    bool            isCollapsed( UNI_StickyNoteID note_id ) const override;
    bool            isBackgroundHidden( UNI_StickyNoteID note_id ) const override;
    bool            copyItems(UNI_NodeID parent_id,
                        const UNI_NodeIDList &node_ids,
                        const UNI_StickyNoteIDList &note_ids,
                        std::ostream &os) const override;

protected:
    /// @{ Non-const methods are all protected.
    UNI_NodeID      createNode( UNI_NodeID parent_id,
                        const UT_StringHolder &node_name,
                        const UT_StringHolder &node_type_name,
                        const UT_StringHolder &signature_name 
                                = UT_StringHolder()) override;
    UNI_NodeID      createSubnet( UNI_NodeID parent_id,
                        const UT_StringHolder &subnet_node_name,
                        const UNI_PortIDList &create_input_ports,
                        const UNI_PortIDList &create_output_ports) override;
    void            setName( UNI_NodeID node_id,
                        const UT_StringHolder &name) override;
    void            setSignature( UNI_NodeID node_id,
                        const UT_StringHolder &signature_name ) override;
    void            updateDownstreamPortTypes( UNI_NodeID node_id,
                        bool update_node ) override;
    void            updateDownstreamPortTypes( UNI_PortID port_id,
                        bool update_port ) override;
    void            setPosition( UNI_NodeID node_id,
                        const UT_Vector2D &pos) override;
    void            setColor( UNI_NodeID node_id,
                        const UT_Color &clr) override;
    void            setComment( UNI_NodeID node_id,
                        const UT_StringHolder &comment) override;
    void            setTags( UNI_NodeID node_id,
                        const UT_StringArray &tags) override;
    void            setParmValue( UNI_NodeID node_id,
                        const UT_StringRef &parm_name,
                        const UNI_ParmValue &value ) override;
    void            destroy( UNI_NodeID node_id ) override;

    void            setContainerConnectPosition( UNI_NodeID parent_id,
                        UNI_ContainerConnectType contype,
                        const UT_Vector2D &pos ) override;
    void            setContainerConnectColor( UNI_NodeID parent_id,
                        UNI_ContainerConnectType contype,
                        const UT_Color &clr ) override;

    void            setName( UNI_PortID port_id,
                        const UT_StringHolder &name ) override;
    UNI_WireID      createWire( UNI_PortID src, UNI_PortID dst ) override;
    void            destroy( UNI_WireID wire_id ) override;

    UNI_StickyNoteID createStickyNote( UNI_NodeID parent_id,
                        const UT_StringHolder &name ) override;
    void            setName( UNI_StickyNoteID note_id,
                        const UT_StringHolder &name ) override;
    void            setPosition( UNI_StickyNoteID note_id,
                        const UT_Vector2D &pos ) override;
    void            setSize( UNI_StickyNoteID note_id,
                        const UT_Vector2D &size ) override;
    void            setColor( UNI_StickyNoteID note_id,
                        const UT_Color &clr ) override;
    void            setText( UNI_StickyNoteID note_id,
                        const UT_StringHolder &text ) override;
    void            setTextColor( UNI_StickyNoteID note_id,
                        const UT_Color &clr ) override;
    void            setTextSize( UNI_StickyNoteID note_id,
                        const float size ) override;
    void            setCollapsed( UNI_StickyNoteID note_id,
                        bool collapsed ) override;
    void            setBackgroundHidden( UNI_StickyNoteID note_id,
                        bool hidden ) override;
    void            destroy( UNI_StickyNoteID note_id ) override;

    bool            pasteItems(UNI_NodeID parent_id,
                        UNI_NodeIDList &node_ids,
                        UNI_StickyNoteIDList &note_ids,
                        std::istream &is,
                        UT_StringMap<UT_StringHolder> *rename_map) override;
    /// @}

    /// Returns the UNI manager this graph belongs to.
    const UNI_Manager * uniManager() const;
    /// @{ Returns the UNI manager this graph belongs to.
    const UNI_Category *uniCategory( const UT_StringRef &category_name ) const;
    const UN_UniCategory *unCategory( const UT_StringRef &category_name ) const;
    /// @}

    /// @{ Returns the underlying UN graph.
    const UN_GraphData &unGraphData() const 
                        {
                            UT_ASSERT(myGraphData);
                            return *myGraphData; 
                        }
    UN_GraphData &      unGraphData()
                        {
                            UT_ASSERT(myGraphData);
                            return *myGraphData; 
                        }
    /// @}

    /// @{ Convenience methods to get a UN items from an UNI ID.
    UN_Node             unNode( UNI_NodeID id )
                            { return UN_Node( &unGraphData(), id ); }
    UN_ConstNode        unNode( UNI_NodeID id ) const
                            { return UN_ConstNode( &unGraphData(), id ); }
    UN_Port             unPort( UNI_PortID id ) 
                            { return UN_Port( &unGraphData(), id ); }
    UN_ConstPort        unPort( UNI_PortID id ) const
                            { return UN_ConstPort( &unGraphData(), id ); }
    const UN_PortType * unPortType( UNI_PortID id  ) const;
    UN_StickyNote       unStickyNote( UNI_StickyNoteID id )
                            { return UN_StickyNote( &unGraphData(), id ); }
    UN_ConstStickyNote  unStickyNote( UNI_StickyNoteID id ) const
                            { return UN_ConstStickyNote( &unGraphData(), id ); }
    /// @}
private:
    /// Helper to update the signatures and port types on downstream nodes.
    void updateDownstreamPortTypes( const UN_WireIDList &originating_wires );

    /// Helper method that updates the dirty signatures on downstream nodes,
    /// as well as the types of the encountered ports on subnets.
    void updateDownstreamDirtyPortTypes(
            const UN_WireIDList &originating_wires,
            UN_GenericNodeDataBufferRef dirty_buf );

    /// Changes the node signature to best matches the input wire types.
    void updateNodeSignature( UN_NodeID node_id );

private:
    /// UN graph data to forward the calls to.
    // Note, this is inteded to be a reference to a sub-class member, or 
    // at least should be managed by sub-class, setting/clearing it as needed.
    UN_GraphData *      myGraphData = nullptr;
};

// ============================================================================
class UN_API UN_BasicUniGraph : public UN_UniGraph
{
protected:
    /// Constructor. 
    /// Intended to be called with the factory function createGraph();
    UN_BasicUniGraph(UN_GraphContext graph_context);

private:
    /// The underlying graph.
    UN_GraphData        myGraphData;
};

#endif