DependencyManagerLinkage.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 <Bentley/RefCounted.h>
#include "ITxnManager.h"
#include "DependencyManagerAppid.h"
#include <map>

// a linkage can be up to about 40K in size (including the header)
#define DEPENDENCY_MAX_DATA                         40960                                                   
#define DEPENDENCY_MAX_ELEMIDS_(X)              ((DEPENDENCY_MAX_DATA-X)/sizeof(ElementId))                         
#define DEPENDENCY_MAX_FARELEMIDS_(X)           ((DEPENDENCY_MAX_DATA-X)/sizeof(DependencyRootFarElementID))        
#define DEPENDENCY_MAX_ELEMIDVS_(X)             ((DEPENDENCY_MAX_DATA-X)/sizeof(DependencyRootElementID_V))         
#define DEPENDENCY_MAX_FARELEMIDVS_(X)          ((DEPENDENCY_MAX_DATA-X)/sizeof(DependencyRootFarElementID_V))      
#define SIZEOF_ASSOCPOINT                           40                                                      
#define DEPENDENCY_MAX_ASSOCPOINTS_(X)          ((DEPENDENCY_MAX_DATA-X)/SIZEOF_ASSOCPOINT)                         
#define DEPENDENCY_MAX_ASSOCPOINTIS_(X)         ((DEPENDENCY_MAX_DATA-X)/(SIZEOF_ASSOCPOINT+8))                     

#define DEPENDENCY_MAX_ELEMIDS                  DEPENDENCY_MAX_ELEMIDS_(0)
#define DEPENDENCY_MAX_FARELEMIDS               DEPENDENCY_MAX_FARELEMIDS_(0)
#define DEPENDENCY_MAX_ELEMIDVS                 DEPENDENCY_MAX_ELEMIDVS_(0)
#define DEPENDENCY_MAX_FARELEMIDVS              DEPENDENCY_MAX_FARELEMIDVS_(0)
#define DEPENDENCY_MAX_ELEMIDS_IN_MODEL         DEPENDENCY_MAX_ELEMIDS_IN_MODEL_(0)
#define DEPENDENCY_MAX_ASSOCPOINTS              DEPENDENCY_MAX_ASSOCPOINTS_(0)
#define DEPENDENCY_MAX_ASSOCPOINTIS             DEPENDENCY_MAX_ASSOCPOINTIS_(0)

// Most dependency linkages will have far, far fewer references than that.
// We define an in-memory version of the struct that has a pre-allocated buffer
// of a smaller size. This is just for the convenience of programs that want to
// declare a DependencyLinkage on the stack, without worrying about stack overflow.

#define DEPENDENCY_SOME_DATA                        1024                                                    
#define DEPENDENCY_SOME_ELEMIDS             (DEPENDENCY_SOME_DATA/sizeof(ElementId))                        
#define DEPENDENCY_SOME_FARELEMIDS          (DEPENDENCY_SOME_DATA/sizeof(DependencyRootFarElementID))       
#define DEPENDENCY_SOME_ELEMIDVS            (DEPENDENCY_SOME_DATA/sizeof(DependencyRootElementID_V))        
#define DEPENDENCY_SOME_FARELEMIDVS         (DEPENDENCY_SOME_DATA/sizeof(DependencyRootFarElementID_V))     
#define DEPENDENCY_SOME_ASSOCPOINTS         (DEPENDENCY_SOME_DATA/SIZEOF_ASSOCPOINT)                        
#define DEPENDENCY_SOME_ASSOCPOINTIS        (DEPENDENCY_SOME_DATA/(SIZEOF_ASSOCPOINT+8))                    

//  Identifies type of root data in DependencyLinkage:
#define DEPENDENCY_DATA_TYPE_ELEM_ID                    0       
#define DEPENDENCY_DATA_TYPE_ELEM_ID_V                  1       
#define DEPENDENCY_DATA_TYPE_ASSOC_POINT                2       
#define DEPENDENCY_DATA_TYPE_ASSOC_POINT_I              3       
#define DEPENDENCY_DATA_TYPE_FAR_ELEM_ID                4       
#define DEPENDENCY_DATA_TYPE_FAR_ELEM_ID_V              5       
#define DEPENDENCY_DATA_TYPE_PATH_V                     6       

// Values for copyOptions flag
#define DEPENDENCY_ON_COPY_DropDependency               0       
#define DEPENDENCY_ON_COPY_RemapRootsWithinSelection    1       
#define DEPENDENCY_ON_COPY_DeepCopyRootsAcrossFiles     2       


#define DEPENDENCY_ON_COPY_DeepCopyRootsAlways          3       


#define DEPENDENCY_STATUS_UNCHANGED                     0       
#define DEPENDENCY_STATUS_CHANGED                       1       
#define DEPENDENCY_STATUS_DELETED                       2       
#define DEPENDENCY_STATUS_RESOLVED                      3       
#define DEPENDENCY_STATUS_UNRESOLVED                    4       
// NB: DEPENDENCY_STATUS_UNRESOLVED must be > DEPENDENCY_STATUS_RESOLVED!

#define DEPENDENCY_MAX_TARGETS_PER_ROOT                 4       

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*----------------------------------------------------------------------+
|                                                                       |
|   Typedefs                                                            |
|                                                                       |
+----------------------------------------------------------------------*/

typedef struct DependencyRootFarElementID
{
    ElementId   elemid;
    ElementId   refattid;
}           DependencyRootFarElementID;


typedef struct DependencyRootElementID_V
{
    ElementId   elemid;
    double      value;
}           DependencyRootElementID_V;

typedef struct DependencyRootFarElementID_V
{
    DependencyRootElementID_V s;
    ElementId   refattid;
}           DependencyRootFarElementID_V;

typedef struct
{
    AssocPoint  assoc;
    int         i;
    int         i2;
}           DependencyRootAssocPoint_I;

typedef struct DependencyRootPath_V
{
    UInt32      numElemsInPath;
    UInt32      reserved;
    double      value;
    ElementId   path[1];
} DependencyRootPath_V;

typedef struct  DependencyLinkage
{
    /*-------------------------------------------------------------------
        Header
    -------------------------------------------------------------------*/
    UInt16      appID;
    UInt16      appValue;

    union
        {
        UInt16  flags;
        struct
            {
            UInt16      invalid:1;
            UInt16      deleteRoots:1;
            UInt16      dontRequireAppForDelete:1;
            UInt16      __unused__:4;
            UInt16      allowRemapToOriginal:1;
            UInt16      copyOptions:2;
            UInt16      rootDataType:4;
            UInt16      requireApp:1;
            UInt16      disabled:1;
            }           f;
        }               u;

    /*-------------------------------------------------------------------
        Data (type depends on rootDataType)
    -------------------------------------------------------------------*/
    UInt16      nRoots;
    union                               // ***NB! start of union must be 8-byte aligned!
    {
        UChar                         data        [DEPENDENCY_SOME_DATA];
        ElementId                     elemid      [DEPENDENCY_SOME_ELEMIDS];
        DependencyRootFarElementID    far_elemid  [DEPENDENCY_SOME_FARELEMIDS];
        DependencyRootElementID_V     e_v         [DEPENDENCY_SOME_ELEMIDVS];
        DependencyRootFarElementID_V  far_e_v     [DEPENDENCY_SOME_FARELEMIDVS];
        AssocPoint                    assoc       [DEPENDENCY_SOME_ASSOCPOINTS];
        DependencyRootPath_V          path_v;
    }       root;

}   DependencyLinkage;

typedef struct dependencyRoot
{
    ElementId       elemid;
    ElementId       refattid;
    ElementRefP      ref;
    Transform       refTransform;
} DependencyRoot;



//=======================================================================================
struct          DependencyManagerLinkage : DependencyLinkage
{


/*----------------------------------------------------------------------**/
struct  IRootsChangedCallback : IRefCounted
{
    virtual StatusInt OnRootsChanged
    (
    ElementHandleCR        dependentElement,
    DependencyLinkage const& dependencyData,
    UInt8              *pRootStatus,
    UInt8               selfStatus
    )  = 0;

    virtual WString GetDescription () const = 0;
};


DGNPLATFORM_EXPORT static StatusInt RegisterRootsChangedCallback
(
UShort           appID,
IRootsChangedCallback* cb
);

DGNPLATFORM_EXPORT static StatusInt GetRootsChangedCallback
(
IRootsChangedCallback** cb,
UShort           appID
);

DGNPLATFORM_EXPORT static void      RemoveRootsChangedCallback
(
UShort           appID
);

DGNPLATFORM_EXPORT static void      SetIgnoreMissingCallbacks (bool b);

DGNPLATFORM_EXPORT static bool      GetIgnoreMissingCallbacks (void);

DGNPLATFORM_EXPORT static StatusInt RegisterRootsChangedForUndoRedoCallback
(
UShort           appID,
IRootsChangedCallback* cb
);

DGNPLATFORM_EXPORT static StatusInt GetRootsChangedForUndoRedoCallback
(
IRootsChangedCallback** cb,
UShort           appID
);

DGNPLATFORM_EXPORT static void      RemoveRootsChangedForUndoRedoCallback
(
UShort          appID           // appID of dependency
);




DGNPLATFORM_EXPORT static StatusInt InitLinkage
(
DependencyLinkage& dependencyData,
UShort             appID,
int                dataType,
int                copyOptions
);

DGNPLATFORM_EXPORT static void      DefineElementIDDependency
(
DependencyLinkage&  dependencyData,
UShort              appID,
UShort              appValue,
int                 copyOptions,
ElementId           elementID
);

DGNPLATFORM_EXPORT static StatusInt DefinePathVDependency
(
DependencyLinkage&  dep,
size_t              bufSize,
UShort              appID,
UShort              appValue,
DisplayPathCP        displayPath,
DgnModelRefP        parentModel
);

/*----------------------------------------------------------------------**/
DGNPLATFORM_EXPORT static StatusInt AppendLinkage
(
EditElementHandleR             eh,
DependencyLinkage const&    dependencyData,
size_t                      xtrabytes
);

DGNPLATFORM_EXPORT static int       DeleteLinkage
(
EditElementHandleR    eh,
UShort           appID,
UShort           appValue
);

DGNPLATFORM_EXPORT static StatusInt UpdateLinkage
(
EditElementHandleR             eh,
DependencyLinkage const &   dependencyData,
size_t                      xtrabytes
);

DGNPLATFORM_EXPORT static StatusInt GetLinkage
(
DependencyLinkage const** ppDependencyLinkageInplace,
ElementHandleCR        element,
UShort              appID,
UShort              appValue
);

DGNPLATFORM_EXPORT static size_t    GetSizeofLinkage
(
DependencyLinkage const& dependencyData,
size_t                   xtrabytes
);




DGNPLATFORM_EXPORT static UInt16  GetRoots
(
DependencyRoot    *pRoots,
DgnModelP          homeModel,
DependencyLinkage const& dependencyData,
UInt16             iRoot
);

DGNPLATFORM_EXPORT static void      GetRootElementIds
(
bvector<ElementId>& ids,
ElementHandleCR            eh,
UShort          applicationID,
UShort          applicationValue
);


DGNPLATFORM_EXPORT static size_t    GetSizeofRootDataType
(
int             rootDataType
);







}; // DependencyManagerLinkage


END_BENTLEY_DGNPLATFORM_NAMESPACE