DgnLinkTree.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <ECObjects/ECObjectsAPI.h>
#include <DgnPlatform/DgnPlatform.h>
#include <Bentley/WString.h>

DGNPLATFORM_TYPEDEFS(DgnLinkTreeSpec);
DGNPLATFORM_TYPEDEFS(DgnLinkTreeNode);
DGNPLATFORM_TYPEDEFS(DgnLinkTreeLeaf);
DGNPLATFORM_TYPEDEFS(DgnLinkTreeBranch);
DGNPLATFORM_TYPEDEFS(DgnLinkTree);
DGNPLATFORM_TYPEDEFS(DgnLinkUserData);
DGNPLATFORM_TYPEDEFS(DgnLinkSetHandler);
DGNPLATFORM_TYPEDEFS(DgnLinkSet);
DGNPLATFORM_TYPEDEFS(DgnLinkHandler);
DGNPLATFORM_TYPEDEFS(DgnLink);
DGNPLATFORM_TYPEDEFS(DgnLinkSet);
DGNPLATFORM_TYPEDEFS(DgnLinkValidationCenter);
DGNPLATFORM_TYPEDEFS(DgnLinkBookmarkProvider);
DGNPLATFORM_TYPEDEFS(DgnLinkUserDataList);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef RefCountedPtr<DgnLinkTreeSpec>   DgnLinkTreeSpecPtr;
typedef RefCountedPtr<DgnLinkTree>       DgnLinkTreePtr;
typedef RefCountedPtr<DgnLinkUserData>   DgnLinkUserDataPtr;
typedef RefCountedPtr<DgnLinkSet>        DgnLinkSetPtr;

typedef bvector<DgnLinkTreeNodeP>  DgnLinkTreeNodeList;

/*---------------------------------------------------------------------------------**/
struct ITempObjectOwner
    {
protected:
    ITempObjectOwner() { }
public:
    virtual void        Release() = 0;
    };

/*---------------------------------------------------------------------------------**/
template<typename T> struct TempObjectOwner : ITempObjectOwner
    {
private:
    T*          m_pointee;

    void swap (TempObjectOwner&&);
    TempObjectOwner (TempObjectOwner const&);
    TempObjectOwner& operator=(TempObjectOwner const&);
protected:
    virtual void    Release() override { release(); }
public:
    explicit TempObjectOwner (T* pointee) : m_pointee (nullptr)
        {
        BeAssert (nullptr == pointee || !pointee->HasTempOwner());
        if (nullptr != pointee && !pointee->HasTempOwner())
            {
            m_pointee = pointee;
            m_pointee->SetTempOwner (this);
            }
        }

    TempObjectOwner() : m_pointee (nullptr)
        {
        //
        }

    TempObjectOwner (TempObjectOwner&& source) : m_pointee (source.release())
        {
        if (nullptr != m_pointee)
            m_pointee->SetTempOwner (this);
        }

    ~TempObjectOwner()
        {
        reset();
        }

    TempObjectOwner& operator=(TempObjectOwner&& source)
        {
        reset (source.release());
        return *this;
        }

    T& operator*() const
        {
        BeAssert (nullptr != get());
        return *get();
        }

    T* operator->() const
        {
        BeAssert (nullptr != get());
        return get();
        }

    T* get() const
        {
        return m_pointee;
        }

    T* release()
        {
        T* pointee = get();
        m_pointee = nullptr;
        if (nullptr != pointee)
            pointee->SetTempOwner (nullptr);

        return pointee;
        }

    void reset (T* pointee = nullptr)
        {
        if (get() != pointee)
            {
            if (nullptr != m_pointee)
                m_pointee->ReleaseTempOwner (this);

            m_pointee = pointee;
            if (nullptr != m_pointee)
                m_pointee->SetTempOwner (this);
            }
        }

    bool    IsNull() const
        {
        return nullptr == get();
        }

    bool    IsValid() const
        {
        return !IsNull();
        }
    };

typedef TempObjectOwner<DgnLinkTreeNode>     TempDgnLinkTreeNodeOwner;
typedef TempObjectOwner<DgnLinkTreeLeaf>     TempDgnLinkTreeLeafOwner;
typedef TempObjectOwner<DgnLinkTreeBranch>   TempDgnLinkTreeBranchOwner;


enum class DgnLinkAddChildStatus
    {
    Success = 0,
    GeneralError,
    DuplicateChild
    };

//struct DgnFileAdapter;
struct DgnLinkHolder;
/*=================================================================================**/
struct DgnLinkUserDataList
    {

    typedef bvector<DgnLinkUserDataPtr> DgnLinkUserDataVector;

    typedef DgnLinkUserDataVector::const_iterator const_iterator;

private:
    const bvector<DgnLinkUserDataPtr> &m_userDataVector;

    DGNPLATFORM_EXPORT DgnLinkUserDataList (const DgnLinkUserDataVector& userDataVector);

public:
    DGNPLATFORM_EXPORT DgnLinkUserDataList (const DgnLinkUserDataList& list);

    DGNPLATFORM_EXPORT const_iterator begin () const;

    DGNPLATFORM_EXPORT const_iterator end () const;
    };

/*=================================================================================**/
struct DgnLinkTreeNode
    {
protected:
    friend struct TempObjectOwner<DgnLinkTreeNode>;
    DGNPLATFORM_EXPORT bool     HasTempOwner() const;
    DGNPLATFORM_EXPORT void     SetTempOwner (ITempObjectOwner* owner);
    DGNPLATFORM_EXPORT void     ReleaseTempOwner (ITempObjectOwner* owner);
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT TempDgnLinkTreeNodeOwner Copy (DgnLinkTreeSpecCR) const;

    DGNPLATFORM_EXPORT StatusInt            SetName (WCharCP name, bool checkForDuplicateNames = true);

    DGNPLATFORM_EXPORT WCharCP              GetName () const;

    DGNPLATFORM_EXPORT WString              GetPathName () const;

    DGNPLATFORM_EXPORT WString              GetHybridPathName () const;

    DGNPLATFORM_EXPORT WString              GetHandlerKey () const;

    DGNPLATFORM_EXPORT DgnLinkTreeCP        GetTreeCP () const;

    DGNPLATFORM_EXPORT DgnLinkTreeP         GetTreeP ();

    DGNPLATFORM_EXPORT DgnLinkTreeBranchCP  GetParentCP () const;

    DGNPLATFORM_EXPORT DgnLinkTreeBranchP   GetParentP ();

    DGNPLATFORM_EXPORT bool                 IsDirty () const;

    DGNPLATFORM_EXPORT void                 SetDirtyFlag ();

    DGNPLATFORM_EXPORT void                 ClearDirtyFlag ();

    DGNPLATFORM_EXPORT size_t               GetUserDataCount (UInt32 *pAppID, UInt32 *pSubID) const;

    DGNPLATFORM_EXPORT DgnLinkUserDataCP    GetUserData (UInt32 *pAppID, UInt32 *pSubID, UInt32 index) const;

    DGNPLATFORM_EXPORT StatusInt            AddUserData (DgnLinkUserDataR);

    DGNPLATFORM_EXPORT StatusInt            RemoveUserData (DgnLinkUserDataCR value);

    DGNPLATFORM_EXPORT DgnLinkUserDataList  GetUserDataList () const;

    DGNPLATFORM_EXPORT UInt32               GetNodeId() const;

    DGNPLATFORM_EXPORT DgnLinkTreeBranchCP  AsDgnLinkTreeBranchCP() const;

    DGNPLATFORM_EXPORT DgnLinkTreeBranchP   AsDgnLinkTreeBranchP();

    DGNPLATFORM_EXPORT DgnLinkTreeLeafCP  AsDgnLinkTreeLeafCP() const;

    DGNPLATFORM_EXPORT DgnLinkTreeLeafP   AsDgnLinkTreeLeafP();
    }; // DgnLinkTreeNode

/*=================================================================================**/
struct DgnLinkTreeBranch : public DgnLinkTreeNode
    {
    friend struct TempObjectOwner<DgnLinkTreeNode>;
    friend struct TempObjectOwner<DgnLinkTreeBranch>;
private:
    virtual void MakeClassAbstract() = 0;
public:

public:
    DGNPLATFORM_EXPORT DgnLinkSetHandlerP       GetHandler () const;
    DGNPLATFORM_EXPORT DgnLinkSetCP             GetLinkSetCP () const;
    DGNPLATFORM_EXPORT DgnLinkSetP              GetLinkSetP();
    DGNPLATFORM_EXPORT size_t                   GetChildCount () const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeP         GetChildP (size_t iChild);
    DGNPLATFORM_EXPORT DgnLinkTreeNodeCP        GetChildCP(size_t iChild) const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeCP        FindChildNode (WCharCP path, bool searchProxyTrees) const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeP         FindChildNode(WCharCP path, bool searchProxyTrees);
    DGNPLATFORM_EXPORT StatusInt                FindChildIndex (WCharCP name, size_t &index) const;
    DGNPLATFORM_EXPORT size_t                   FindChildIndex(DgnLinkTreeNodeCR childP) const;
    DGNPLATFORM_EXPORT DgnLinkAddChildStatus    AddChild (DgnLinkTreeNodeR newNode, size_t index);
    DGNPLATFORM_EXPORT StatusInt                DropChild (size_t iChild);
    DGNPLATFORM_EXPORT WString                  GetUniqueChildName (WCharCP namePrefix) const;
    DGNPLATFORM_EXPORT TempDgnLinkTreeBranchOwner   DeepCopy (DgnLinkTreeSpecCR) const;
    }; // DgnLinkTreeBranch

/*=================================================================================**/
struct  DgnLinkTreeLeaf : public DgnLinkTreeNode
    {
    friend struct TempObjectOwner<DgnLinkTreeNode>;
    friend struct TempObjectOwner<DgnLinkTreeLeaf>;
private:
    virtual void MakeClassAbstract() = 0;
public:
protected:
    virtual ~DgnLinkTreeLeaf ();
public:
    DGNPLATFORM_EXPORT DgnLinkHandlerP          GetHandler () const;
    DGNPLATFORM_EXPORT DgnLinkCP                GetLinkCP () const;
    DGNPLATFORM_EXPORT DgnLinkP                 GetLinkP();
    DGNPLATFORM_EXPORT bool                     GetValidFlag () const;
    DGNPLATFORM_EXPORT void                     SetValidFlag(bool val);
    DGNPLATFORM_EXPORT size_t                   GetSequenceNumber ();

    }; // DgnLinkTreeLeaf

enum class DgnLinkTreeKey
    {
    Invalid          =   0,
    Project          =   1,
    Bookmarks        =   2,
    Annotation       =   3,
    SheetIndex       =   4,
    };

/*=================================================================================**/
struct DgnLinkTreeSpec : public RefCountedBase
    {

public:
    DGNPLATFORM_EXPORT DgnLinkTreeKey           GetTypeKey () const;
    DGNPLATFORM_EXPORT WCharCP                  GetTreeName () const;
    DGNPLATFORM_EXPORT WString                  GetFilePath() const;
    DGNPLATFORM_EXPORT DgnDocumentMonikerCR     GetDocumentMoniker() const;
    DGNPLATFORM_EXPORT DgnDocumentMonikerPtr    GetDocumentMonikerPtr() const;
    DGNPLATFORM_EXPORT WCharCP                  GetModelName() const;
    DGNPLATFORM_EXPORT ElementId                GetElementId() const;
    DGNPLATFORM_EXPORT int                      Compare (DgnLinkTreeSpecCR otherSpec) const;
    };

/*=================================================================================**/
struct DgnLinkTree : RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT WString                      GetName () const;
    DGNPLATFORM_EXPORT DgnLinkTreeSpecCR            GetTreeSpec () const;
    DGNPLATFORM_EXPORT DgnLinkTreeSpecPtr           GetTreeSpecPtr() const;
    DGNPLATFORM_EXPORT WString                      GetFilePath () const;
    DGNPLATFORM_EXPORT void                         TransformTo(DgnDocumentMonikerCR dest);
    DGNPLATFORM_EXPORT DgnLinkTreeBranchCR          GetRoot () const;
    DGNPLATFORM_EXPORT DgnLinkTreeBranchR           GetRootR();
    DGNPLATFORM_EXPORT void                         SetRoot(DgnLinkTreeBranchR root);
    DGNPLATFORM_EXPORT DgnLinkTreeNodeCP            FindNode (WCharCP path, bool searchBookmarkTree) const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeP             FindNode(WCharCP path, bool searchBookmarkTree);
    DGNPLATFORM_EXPORT DgnLinkTreeLeafCP            GetBookmarkProviderNode () const;
    DGNPLATFORM_EXPORT void                         SetBookmarkProviderNode(DgnLinkTreeLeafCR providerNode);
    DGNPLATFORM_EXPORT UInt32                       GetTreeId () const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeCP            FindNodeById (UInt32 nodeId) const;
    DGNPLATFORM_EXPORT DgnLinkTreeNodeP             FindNodeById (UInt32 nodeId);
    DGNPLATFORM_EXPORT UInt64                       GetLastModifiedTime () const;
    DGNPLATFORM_EXPORT static DgnLinkTreePtr        Create (DgnLinkTreeBranchP root, DgnDocumentMonikerP ownerMoniker, DgnLinkTreeLeafCP provider);
    }; // DgnLinkTree

END_BENTLEY_DGNPLATFORM_NAMESPACE